django 全局异常解析 model 验证
settings.py
# 全局异常模块
'EXCEPTION_HANDLER': 'utils.exception.custom_exception_handler',
REST_FRAMEWORK = { # 设置所有接口都需要被验证 'DEFAULT_PERMISSION_CLASSES': ( # 'rest_framework.permissions.IsAuthenticated', #建议是特定接口特定认证 # 'rest_framework.permissions.AllowAny', ), # 全局异常模块 'EXCEPTION_HANDLER': 'utils.exception.custom_exception_handler', }
exception.py
# 自定义异常处理 from rest_framework.views import exception_handler from rest_framework.views import Response from rest_framework import status from django.apps import apps from utils import APIResponseResult # 根据列名获取verbose_name def getmodelfield(appname, modelname, exclude=[]): """ 获取model的verbose_name和name的字段 """ modelobj = apps.get_model(appname, modelname) filed = modelobj._meta.fields print(filed) fielddic = {} params = [f for f in filed if f.name not in exclude] for i in params: fielddic[i.name] = i.verbose_name return fielddic # 将仅针对由引发的异常生成的响应调用异常处理程序。它不会用于视图直接返回的任何响应 # 需要在setting中配置这个异常处理方法,并且异常返回的respose对象还会传到默认返回的json的renderer类中,在setting中drf配置中的DEFAULT_RENDERER_CLASSES # 如果未声明,会采用默认的方式,如下 # # REST_FRAMEWORK = { # 'EXCEPTION_HANDLER': 'rest_framework.views.exception_handler' # } # 下面是我配置的已经自定义的处理 # REST_FRAMEWORK = { # # 全局配置异常模块 # 'EXCEPTION_HANDLER': 'utils.exception.custom_exception_handler', # # 修改默认返回JSON的renderer的类 # 'DEFAULT_RENDERER_CLASSES': ( # 'utils.rendererresponse.customrenderer', # ), # } def custom_exception_handler(exc, context): # 先调用REST framework默认的异常处理方法获得标准错误响应对象 response = exception_handler(exc, context) # print(exc) #错误原因 还可以做更详细的原因,通过判断exc信息类型 # print(context) # 错误信息 # print('1234 = %s - %s - %s' % (context['view'], context['request'].method, exc)) # print(response) # 如果response响应对象为空,则设置message这个key的值,并将状态码设为500 # 如果response响应对象不为空,则则设置message这个key的值,并将使用其本身的状态码 if response is None: return Response({ 'message': '服务器错误:{exc}'.format(exc=exc) }, status=status.HTTP_500_INTERNAL_SERVER_ERROR, exception=True) else: exclude = ['createTime', 'lastTime'] errors = {} verboseNameDict = getmodelfield('app', context['view'].basename, exclude) print('123 = %s - %s - %s' % (context['view'], context['request'].method, exc)) for item in exc.detail: vName = verboseNameDict.get(item, "") eValue = str(exc.detail[item][0]) errors.update({item: f"{vName}{eValue}"}) return Response({"errors": errors}, status=response.status_code, exception=True) return response
rendererresponse.py
''' 自定义返回处理 ''' # 导入控制返回的JSON格式的类 from rest_framework.renderers import JSONRenderer class customrenderer(JSONRenderer): # 重构render方法 def render(self, data, accepted_media_type=None, renderer_context=None): if renderer_context: # print(renderer_context) # print(renderer_context["response"].status_code) # 响应的信息,成功和错误的都是这个 # 成功和异常响应的信息,异常信息在前面自定义异常处理中已经处理为{'message': 'error'}这种格式 # print(data) # 如果返回的data为字典 if "errors" not in data.keys(): # 响应信息中有message和code这两个key,则获取响应信息中的message和code,并且将原本data中的这两个key删除,放在自定义响应信息里 # 响应信息中没有则将msg内容改为请求成功 code改为请求的状态码 #msg = data.pop('message', '') #code = data.pop('code', renderer_context["response"].status_code) ret = data # 如果不是字典则将msg内容改为请求成功 code改为请求的状态码 else: #msg = '' #code = renderer_context["response"].status_code # 自定义返回的格式 ret = { 'code': 400, 'msg': 'error', 'data': data['errors'], } # 返回JSON数据 return super().render(ret, accepted_media_type, renderer_context) else: return super().render(data, accepted_media_type, renderer_context)
最终结果