添加错误码和注释

This commit is contained in:
康家辉
2022-05-05 18:59:29 +08:00
parent 19440fe0e2
commit 45a3e4a3a9
3 changed files with 73 additions and 49 deletions
+14 -7
View File
@@ -31,10 +31,8 @@
</select> </select>
</component> </component>
<component name="ChangeListManager"> <component name="ChangeListManager">
<list default="true" id="81247df9-f070-428a-8ff8-85c1a06086e7" name="Default Changelist" comment="完善了一下serializers"> <list default="true" id="81247df9-f070-428a-8ff8-85c1a06086e7" name="Default Changelist" comment="修改了部门详情的model,&#10;添加了对数据库数据输出前的格式验证">
<change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" /> <change beforePath="$PROJECT_DIR$/.idea/workspace.xml" beforeDir="false" afterPath="$PROJECT_DIR$/.idea/workspace.xml" afterDir="false" />
<change beforePath="$PROJECT_DIR$/history/migrations/0001_initial.py" beforeDir="false" />
<change beforePath="$PROJECT_DIR$/history/models.py" beforeDir="false" afterPath="$PROJECT_DIR$/history/models.py" afterDir="false" />
<change beforePath="$PROJECT_DIR$/history/serializers.py" beforeDir="false" afterPath="$PROJECT_DIR$/history/serializers.py" afterDir="false" /> <change beforePath="$PROJECT_DIR$/history/serializers.py" beforeDir="false" afterPath="$PROJECT_DIR$/history/serializers.py" afterDir="false" />
<change beforePath="$PROJECT_DIR$/history/views.py" beforeDir="false" afterPath="$PROJECT_DIR$/history/views.py" afterDir="false" /> <change beforePath="$PROJECT_DIR$/history/views.py" beforeDir="false" afterPath="$PROJECT_DIR$/history/views.py" afterDir="false" />
</list> </list>
@@ -68,7 +66,7 @@
<property name="RunOnceActivity.ShowReadmeOnStart" value="true" /> <property name="RunOnceActivity.ShowReadmeOnStart" value="true" />
<property name="SHARE_PROJECT_CONFIGURATION_FILES" value="true" /> <property name="SHARE_PROJECT_CONFIGURATION_FILES" value="true" />
<property name="WebServerToolWindowFactoryState" value="false" /> <property name="WebServerToolWindowFactoryState" value="false" />
<property name="last_opened_file_path" value="$PROJECT_DIR$/../Todo" /> <property name="last_opened_file_path" value="$PROJECT_DIR$" />
<property name="settings.editor.selected.configurable" value="web.server" /> <property name="settings.editor.selected.configurable" value="web.server" />
</component> </component>
<component name="RunManager"> <component name="RunManager">
@@ -120,7 +118,8 @@
<workItem from="1651235869595" duration="8446000" /> <workItem from="1651235869595" duration="8446000" />
<workItem from="1651248194966" duration="1722000" /> <workItem from="1651248194966" duration="1722000" />
<workItem from="1651275393720" duration="5083000" /> <workItem from="1651275393720" duration="5083000" />
<workItem from="1651322613788" duration="6665000" /> <workItem from="1651322613788" duration="6853000" />
<workItem from="1651741043921" duration="7059000" />
</task> </task>
<task id="LOCAL-00001" summary="fix"> <task id="LOCAL-00001" summary="fix">
<created>1650187914913</created> <created>1650187914913</created>
@@ -143,7 +142,14 @@
<option name="project" value="LOCAL" /> <option name="project" value="LOCAL" />
<updated>1651233809599</updated> <updated>1651233809599</updated>
</task> </task>
<option name="localTasksCounter" value="4" /> <task id="LOCAL-00004" summary="修改了部门详情的model,&#10;添加了对数据库数据输出前的格式验证">
<created>1651329470523</created>
<option name="number" value="00004" />
<option name="presentableId" value="LOCAL-00004" />
<option name="project" value="LOCAL" />
<updated>1651329470523</updated>
</task>
<option name="localTasksCounter" value="5" />
<servers /> <servers />
</component> </component>
<component name="TypeScriptGeneratedFilesManager"> <component name="TypeScriptGeneratedFilesManager">
@@ -177,7 +183,8 @@
<MESSAGE value="fix" /> <MESSAGE value="fix" />
<MESSAGE value="修改+合并前的提交" /> <MESSAGE value="修改+合并前的提交" />
<MESSAGE value="完善了一下serializers" /> <MESSAGE value="完善了一下serializers" />
<option name="LAST_COMMIT_MESSAGE" value="完善了一下serializers" /> <MESSAGE value="修改了部门详情的model,&#10;添加了对数据库数据输出前的格式验证" />
<option name="LAST_COMMIT_MESSAGE" value="修改了部门详情的model,&#10;添加了对数据库数据输出前的格式验证" />
</component> </component>
<component name="com.intellij.coverage.CoverageDataManagerImpl"> <component name="com.intellij.coverage.CoverageDataManagerImpl">
<SUITE FILE_PATH="coverage/ITShowPlatform$urls.coverage" NAME="urls Coverage Results" MODIFIED="1650768597611" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/history" /> <SUITE FILE_PATH="coverage/ITShowPlatform$urls.coverage" NAME="urls Coverage Results" MODIFIED="1650768597611" SOURCE_PROVIDER="com.intellij.coverage.DefaultCoverageFileProvider" RUNNER="coverage.py" COVERAGE_BY_TEST_ENABLED="true" COVERAGE_TRACING_ENABLED="false" WORKING_DIRECTORY="$PROJECT_DIR$/history" />
+29 -22
View File
@@ -6,19 +6,19 @@ from history.models import *
def validate_department(value): def validate_department(value):
reg = re.compile(r'^[\u4e00-\u9fa5A-Za-z]*$') reg = re.compile(r'^[\u4e00-\u9fa5A-Za-z]*$')
if not reg.match(value): if not reg.match(value):
raise serializers.ValidationError("部门名称中只能输入汉字或英文") raise serializers.ValidationError("42011-部门名称中只能输入汉字或英文")
def validate_department_en(value): def validate_department_en(value):
reg = re.compile(r'^[A-Za-z][A-Za-z\s]*$') reg = re.compile(r'^[A-Za-z][A-Za-z\s]*$')
if not reg.match(value): if not reg.match(value):
raise serializers.ValidationError("部门英文名称中只能输入英文") raise serializers.ValidationError("42010-部门英文名称中只能输入英文")
def name_validate(value): def name_validate(value):
reg = re.compile(r'^[\u4e00-\u9fa5A-Za-z]*$') reg = re.compile(r'^[\u4e00-\u9fa5A-Za-z]*$')
if not reg.match(value): if not reg.match(value):
raise serializers.ValidationError("姓名只能输入汉字或英文") raise serializers.ValidationError("42012-姓名只能输入汉字或英文")
# #
# def validate_avatar(value): # def validate_avatar(value):
@@ -27,17 +27,18 @@ def name_validate(value):
class DepartmentSerializer(serializers.Serializer): class DepartmentSerializer(serializers.Serializer):
did = serializers.IntegerField(required=True, error_messages={"blank": '部门ID不能为空', "invalid": '类型错误'}) did = serializers.IntegerField(required=True, error_messages={"blank": '41010-部门ID不能为空', "invalid": '42020-类型错误'})
department = serializers.CharField(max_length=10, required=True, trim_whitespace=True, department = serializers.CharField(max_length=10, required=True, trim_whitespace=True,
validators=[validate_department], validators=[validate_department],
error_messages={"max_length": '长度过长', "blank": '部门名称不能为空'}) error_messages={"max_length": '42021-部门名称长度过长', "blank": '41011-部门名称不能为空'})
department_en = serializers.CharField(max_length=30, required=True, trim_whitespace=True, department_en = serializers.CharField(max_length=30, required=True, trim_whitespace=True,
validators=[validate_department_en], validators=[validate_department_en],
error_messages={"max_length": '长度过长', "blank": '部门英文名称不能为空'}) error_messages={"max_length": '42022-部门英文名称长度过长',
"blank": '41012-部门英文名称不能为空'})
content = serializers.CharField(max_length=800, required=True, trim_whitespace=True, content = serializers.CharField(max_length=800, required=True, trim_whitespace=True,
error_messages={"max_length": '内容过长', "blank": '内容不能为空'}) error_messages={"max_length": '42023-内容过长', "blank": '41013-内容不能为空'})
introduction = serializers.CharField(max_length=800, required=True, trim_whitespace=True, introduction = serializers.CharField(max_length=800, required=True, trim_whitespace=True,
error_messages={"max_length": '内容过长', "blank": '内容不能为空'}) error_messages={"max_length": '42024-介绍内容过长', "blank": '41014-介绍内容不能为空'})
# class Meta: # class Meta:
# model = Department # model = Department
@@ -59,15 +60,16 @@ class DepartmentSerializer(serializers.Serializer):
class MembersSerializer(serializers.HyperlinkedModelSerializer): class MembersSerializer(serializers.HyperlinkedModelSerializer):
did = serializers.IntegerField(required=True, error_messages={"blank": '部门ID不能为空', "invalid": '类型错误'}) did = serializers.IntegerField(required=True, error_messages={"blank": '41010-部门ID不能为空', "invalid": '42020-类型错误'})
department = serializers.CharField(max_length=10, required=True, trim_whitespace=True, department = serializers.CharField(max_length=10, required=True, trim_whitespace=True,
error_messages={"max_length": '部门名称过长', "blank": '部门名称不能为空'}) error_messages={"max_length": '42021-部门名称过长', "blank": '41011-部门名称不能为空'})
grade = serializers.IntegerField(required=True, min_value=2001, max_value=2022, grade = serializers.IntegerField(required=True, min_value=2001, max_value=2022,
error_messages={"max_value": '年级数过大', "blank": "年级数不能为空", "min_value": '年级数过小'}) error_messages={"max_value": '42025-年级数过大', "blank": "41015-年级数不能为空",
"min_value": '42026-年级数过小'})
name = serializers.CharField(required=True, trim_whitespace=True, max_length=6, name = serializers.CharField(required=True, trim_whitespace=True, max_length=6,
error_messages={"blank": '姓名不能为空', "max_length": '姓名过长'}) error_messages={"blank": '41016-姓名不能为空', "max_length": '42027-姓名过长'})
motto = serializers.CharField(required=False, trim_whitespace=True, max_length=25, validators=[name_validate], motto = serializers.CharField(required=False, trim_whitespace=True, max_length=25, validators=[name_validate],
error_messages={"max_length": '座右铭过长'}) error_messages={"max_length": '42028-座右铭过长'})
# avatar = serializers.ImageField(validators=[validate_avatar]) # avatar = serializers.ImageField(validators=[validate_avatar])
class Meta: class Meta:
@@ -91,19 +93,24 @@ class MembersSerializer(serializers.HyperlinkedModelSerializer):
class HistorySerializer(serializers.Serializer): class HistorySerializer(serializers.Serializer):
grade = serializers.IntegerField(required=True, min_value=2001, max_value=2022, grade = serializers.IntegerField(required=True, min_value=2001, max_value=2022,
error_messages={"max_value": '年级数过大', "blank": "年级数不能为空", "min_value": '年级数过小'}) error_messages={"max_value": '42025-年级数过大', "blank": "41015-年级数不能为空",
did = serializers.IntegerField(required=True, error_messages={"blank": '部门ID不能为空', "invalid": '类型错误'}) "min_value": '42026-年级数过小'})
did = serializers.IntegerField(required=True, error_messages={"blank": '41010-部门ID不能为空', "invalid": '42020-类型错误'})
department = serializers.CharField(max_length=10, required=True, trim_whitespace=True, department = serializers.CharField(max_length=10, required=True, trim_whitespace=True,
validators=[validate_department], validators=[validate_department],
error_messages={"max_length": '部门名称过长', "blank": '部门名称不能为空'}) error_messages={"max_length": '42021-部门名称过长', "blank": '41011-部门名称不能为空'})
# class Meta: # class Meta:
# model = History # model = History
# fields = ('grade', 'did', 'department') # fields = ('grade', 'did', 'department')
# #
# def update(self, instance, validated_data):
# instance.department = validated_data.get("department", instance.department) def create(self, validated_data):
# instance.grade = validated_data.get("grade", instance.grade) return History.objects.create(**validated_data)
# instance.did = validated_data.get("did", instance.did)
# instance.save() def update(self, instance, validated_data):
# return instance instance.department = validated_data.get("department", instance.department)
instance.grade = validated_data.get("grade", instance.grade)
instance.did = validated_data.get("did", instance.did)
instance.save()
return instance
+30 -20
View File
@@ -14,16 +14,19 @@ class DepartmentViewSet(APIView):
"code": 20000, "code": 20000,
"msg": "成功", "msg": "成功",
} }
obj = Department.objects.all().filter(did=request.GET.get('did')).first() obj = Department.objects.all().filter(did=request.GET.get('did')).first() # 获取符合did的DepartmentObject
# (默认每个部门只对应一个object)
d = {'did': obj.did, 'department': obj.department, 'department_en': obj.department_en, 'content': obj.content, d = {'did': obj.did, 'department': obj.department, 'department_en': obj.department_en, 'content': obj.content,
'introduction': obj.introduction} 'introduction': obj.introduction} # 将其转为字典类(用于放入serializer检验)
serializer = DepartmentSerializer(data=d) serializer = DepartmentSerializer(data=d)
if serializer.is_valid(): if serializer.is_valid():
response['data'] = serializer.data response['data'] = serializer.data # 在data里返回想得到的信息
return Response(data=response) return Response(data=response)
response['code'] = 40000 key = list(serializer.errors.keys())[0] # 得到错误信息的keys中的第一个key
response['msg'] = "错误" # 用一个key得到一个错误信息,一个错误信息中的错误码与detail用“-”隔开, 通过split分开
response['data'] = serializer.errors value = str(list(serializer.errors.get(key))[0]).split("-")
response['code'] = int(value[0])
response['msg'] = value[1]
return Response(data=response) return Response(data=response)
@@ -37,20 +40,24 @@ class MemberViewSet(APIView):
} }
grade = request.GET.get('grade') grade = request.GET.get('grade')
did = request.GET.get('did') did = request.GET.get('did')
queryset = Members.objects.all().filter(Q(did=did) & Q(grade=grade)) queryset = Members.objects.all().filter(Q(did=did) & Q(grade=grade)) # 获得所有符合要求的object
l = [] l = [] # 建一个列表用于存储最终输出的data
# 对符合要求的每一个object都转为字典并通过serializer检验数据是否合法
for x in queryset: for x in queryset:
# 将符合要求的一个object都转为字典
d = {'id': x.id, 'did': x.did, 'grade': x.grade, 'department': x.department, 'motto': x.motto, d = {'id': x.id, 'did': x.did, 'grade': x.grade, 'department': x.department, 'motto': x.motto,
'name': x.name, 'name': x.name,
'avatar': str(x.avatar)} 'avatar': str(x.avatar)} # 将路径转为字符串格式
serializer = MembersSerializer(data=d) serializer = MembersSerializer(data=d)
if serializer.is_valid(): if serializer.is_valid():
l.append(d) l.append(d) # 将合法数据存入l列表中并继续进行下一个循环
continue continue
response = { # 若出现不合法数据则将错误信息返回前端
"code": 40000, key = list(serializer.errors.keys())[0] # 得到错误信息的keys中的第一个key
"msg": serializer.errors, # 用一个key得到一个错误信息,一个错误信息中的错误码与detail用“-”隔开, 通过split分开
} value = str(list(serializer.errors.get(key))[0]).split("-")
response['code'] = int(value[0])
response['msg'] = value[1]
return Response(data=response) return Response(data=response)
response['data'] = l response['data'] = l
return Response(data=response) return Response(data=response)
@@ -64,17 +71,20 @@ class HistoryViewSet(APIView):
"code": 20000, "code": 20000,
"msg": "成功", "msg": "成功",
} }
ser = History.objects.all() ser = History.objects.all() # 获取全部历史列表信息
# 同上,对每一个object进行判断
for x in ser: for x in ser:
d = {'did': x.did, 'grade': x.grade, 'department': x.department} d = {'did': x.did, 'grade': x.grade, 'department': x.department}
serializer = HistorySerializer(data=d) serializer = HistorySerializer(data=d)
if serializer.is_valid(): if serializer.is_valid():
continue continue
response = { key = list(serializer.errors.keys())[0] # 得到错误信息的keys中的第一个key
"code": 40000, # 用一个key得到一个错误信息,一个错误信息中的错误码与detail用“-”隔开, 通过split分开
"msg": serializer.errors, value = str(list(serializer.errors.get(key))[0]).split("-")
} response['code'] = int(value[0])
response['msg'] = value[1]
return Response(data=response) return Response(data=response)
# 若数据通过判断,则在此处将数据转为要求格式
info = [] info = []
for i in range(2002, 2022): for i in range(2002, 2022):
data = {'grade': i} data = {'grade': i}
@@ -82,7 +92,7 @@ class HistoryViewSet(APIView):
for j in range(0, 6): for j in range(0, 6):
try: try:
a = History.objects.get(Q(did=j) & Q(grade=i)) a = History.objects.get(Q(did=j) & Q(grade=i))
except: except History.DoesNotExist: # 若为空,则继续判断下一个部门
continue continue
x = {'id': a.did, 'department_name': a.department} x = {'id': a.did, 'department_name': a.department}
y.append(x) y.append(x)