【Python使用】嘿马云课堂web完整实战项目第4篇：封装异常处理,封装JSON返回值【附代码文档】

from rest_framework.exceptions import APIExceptionclass BookInfoViewSet(ModelViewSet):...def list(self, request, *args, **kwargs):raise APIException('请求出错！')return super().list(request, *args, **kwargs)

SUCCESS = (True, 10000, "操作成功！")
FAIL = (False, 11111, "操作失败！")
UNAUTHENTICATED = (False, 10001, "此操作需要登陆系统！")
UNAUTHORISE = (False, 10002, "权限不足，无权操作！")
INVALID_PARAM = (False, 10003, "非法参数！")
SERVER_ERROR = (False, 99999, "抱歉，系统繁忙，请稍后重试！")UPLOAD_FILE_REGISTER_FAIL = (False, 22001, "上传文件在系统注册失败，请刷新页面重试！")
UPLOAD_FILE_REGISTER_EXIST = (False, 22002, "上传文件在系统已存在！")
CHUNK_FILE_EXIST_CHECK = (False, 22003, "分块文件在系统已存在！")
MERGE_FILE_FAIL = (False, 22004, "合并文件失败，文件在系统已存在！")
MERGE_FILE_CHECKFAIL = (False, 22005, "合并文件校验失败！")AUTH_USERNAME_NONE = (False, 23001, "请输入账号！")
AUTH_PASSWORD_NONE = (False, 23002, "请输入密码！")
AUTH_VERIFYCODE_NONE = (False, 23003, "请输入验证码！")
AUTH_ACCOUNT_NOTEXISTS = (False, 23004, "账号不存在！")
AUTH_CREDENTIAL_ERROR = (False, 23005, "账号或密码错误！")
AUTH_LOGIN_ERROR = (False, 23006, "登陆过程出现异常请尝试重新操作！")CMS_ADDPAGE_EXISTSNAME = (False, 24001, "页面名称已存在！")
CMS_ADDPAGE_EXISTS = (False, 24002, "页面已存在！")
CMS_GENERATEHTML_DATAURLISNULL = (False, 24003, "从页面信息中找不到获取数据的url！")
CMS_GENERATEHTML_DATAISNULL = (False, 24004, "根据页面的数据url获取不到数据！")
CMS_GENERATEHTML_TEMPLATEISNULL = (False, 24005, "页面模板为空！")
CMS_GENERATEHTML_HTMLISNULL = (False, 24006, "生成的静态html为空！")
CMS_GENERATEHTML_SAVEHTMLERROR = (False, 24007, "保存静态html出错！")
CMS_PAGE_NOTEXISTS = (False, 24008, "页面不存在！")
CMS_COURSE_PERVIEWISNULL = (False, 24009, "预览页面为空！")FS_UPLOADFILE_FILEISNULL = (False, 25001, "上传文件为空！")
FS_UPLOADFILE_BUSINESSISNULL = (False, 25002, "业务Id为空！")
FS_UPLOADFILE_SERVERFAIL = (False, 25003, "上传文件服务器失败！")
FS_DELETEFILE_NOTEXISTS = (False, 25004, "删除的文件不存在！")
FS_DELETEFILE_DBFAIL = (False, 25005, "删除文件信息失败！")
FS_DELETEFILE_SERVERFAIL = (False, 25006, "删除文件失败！")
FS_UPLOADFILE_METAERROR = (False, 25007, "上传文件的元信息请使用json格式！")
FS_UPLOADFILE_USERISNULL = (False, 25008, "上传文件用户为空！")COURSE_NOTEXISTS = (False, 30001, "不存在")
COURSE_DENIED_DELETE = (False, 31001, "删除失败，只允许删除本机构的！")
COURSE_PUBLISH_PERVIEWISNULL = (False, 31002, "还没有进行预览！")
COURSE_PUBLISH_CDETAILERROR = (False, 31003, "创建详情页面出错！")
COURSE_PUBLISH_COURSEIDISNULL = (False, 31004, "Id为空！")
COURSE_PUBLISH_VIEWERROR = (False, 31005, "发布视图出错！")
COURSE_PUBLISH_CREATECOURSEPUB_ERROR = (False, 31006, "创建索引信息出错！"),
COURSE_TEACHPLAN_EXIST = (False, 31050, "已经绑定教学计划")
COURSE_TEACHPLAN_NOTEXISTS = (False, 31051, "计划不存在")
COURSE_MEDIS_URLISNULL = (False, 31101, "选择的媒资文件访问地址为空！")
COURSE_MEDIS_NAMEISNULL = (False, 31102, "选择的媒资文件名称为空！")
COURSE_MEDIA_TEACHPLAN_GRADEERROR = (False, 31104, "只允许选择第三级的计划关联视频！")
COURSE_PIC_NOTEXISTS = (False, 31201, "未找到图片！")
COURSE_PIC_UPLOAD_ERROR = (False, 31202, "图片上传失败！")ORDER_ADD_ITEMISNULL = (False, 41001, "创建订单未选择！")
ORDER_ADD_ORDERNUMERROR = (False, 41002, "生成订单号错误！")
ORDER_ADD_GETCOURSEERROR = (False, 41003, "找不到信息！")
ORDER_FINISH_NOTFOUNDORDER = (False, 41004, "找不到订单信息！")
Pay_NOTFOUNDORDER = (False, 41010, "找不到要支付的订单！")
Pay_USERERROR = (False, 41011, "支付用户与订单用户不一致！")
Pay_NOTFOUNDPAY = (False, 41012, "支付记录不存在！")
COURSE_COMMENT_EXISTS = (False, 41031, "已评价！")PortalView_ADDVIEWCOURSE_COURSEIDISNULL = (False, 42001, "id为空！")
PortalView_PUBLISH_PREVIEWCOURSE_ISNULL = (False, 42002, "预览视图为空！")
PortalView_PUBLISH_PREVIEWMEDIA_ISNULL = (False, 42003, "预览媒资视图为空！")

from rest_framework.exceptions import APIExceptionclass MyAPIException(APIException):
    """
    封装自己的异常处理类，用于返回标准异常信息
    """def __init__(self, detail=None, code=None):# 判断detail是否符合标准异常信息的格式if isinstance(detail, tuple) and len(detail) == 3:# 保存标准异常信息self._error_response = detaildetail = self.default_detailif code is None:code = self.default_codesuper().__init__(detail=detail, code=code)# 封装方法获取异常代码信息def get_error_response(self):return self._error_response

from rest_framework.views import exception_handler
from common.response_code import SERVER_ERRORdef standard_exception_handler(exc, context):
    """
    封装自己的异常处理函数，用于处理抛出的标准异常信息
    """response = exception_handler(exc, context)if isinstance(exc, APIException):if isinstance(exc, MyAPIException):# 获取标准异常信息中的数据，并组装返回数据success, code, message = exc.get_error_response()data = {'success': success, 'code': code, 'message': message, 'data': {}}else:data = {'success': SERVER_ERROR[0], 'code': SERVER_ERROR[1], 'message': exc.detail, 'data': {}}response.data = dataresponse.status_code = 200return response

def cast_exception(code):
    """
    封装异常抛出函数，方便后期修改
    """raise MyAPIException(code)

REST_FRAMEWORK = {'EXCEPTION_HANDLER': 'common.exceptions.standard_exception_handler',
}

from common import exceptions, response_codeclass BookInfoViewSet(ModelViewSet):...def list(self, request, *args, **kwargs):exceptions.cast_exception(response_code.FAIL)return super().list(request, *args, **kwargs)

from rest_framework.renderers import JSONRenderer
from common.response_code import SUCCESSclass StandardJSONRenderer(JSONRenderer):def render(self, data, accepted_media_type=None, renderer_context=None):data = {} if data is None else dataif isinstance(data, dict) and data.get('success') is not None:standard_data = dataelse:standard_data = {'success': SUCCESS[0], 'code': SUCCESS[1], 'message': SUCCESS[2], 'data': data}return super().render(standard_data, accepted_media_type=accepted_media_type, renderer_context=renderer_context)

REST_FRAMEWORK = {'DEFAULT_RENDERER_CLASSES': ('common.renderers.StandardJSONRenderer','rest_framework.renderers.BrowsableAPIRenderer',),
}

from datetime import datetimefrom mongoengine import Document, EmbeddedDocument
from mongoengine.fields import StringField, ReferenceField, DateTimeField, ListField, EmbeddedDocumentField, FileFieldclass CmsSite(Document):
    """
    Cms站点，一个站点包括多个页面
    """# 站点名称siteName = StringField(required=True)# 站点域名siteDomain = StringField(required=True)# 站点端口sitePort = StringField(required=True)# 站点访问地址siteWebPath = StringField(required=True)# 创建时间siteCreateTime = DateTimeField(default=datetime.now)# 站点在服务器中存储的物理路径，绝对路径sitePhysicalPath = StringField(required=True)class CmsTemplate(Document):
    """
    Cms模板，多个页面可以使用相同的模板
    """# 站点IDsiteId = ReferenceField(CmsSite, required=True)# 模版名称templateName = StringField(required=True)# 模版参数templateParameter = StringField()# 模版文件IdtemplateFileId = FileField()class CmsPage(Document):
    """
    Cms页面信息
    """# 站点 *siteId = ReferenceField(CmsSite, required=True)# 页面名称 *pageName = StringField(required=True)# 页面别名pageAlias = StringField(default='', null=True)# 访问地址 *pageWebPath = StringField(required=True)# 页面保存在站点的物理路径，是站点物理路径的子路径 *pagePhysicalPath = StringField(required=True)# 类型（静态/动态）*pageType = StringField(default='0')# 页面模版pageTemplate = StringField()# 页面静态化内容pageHtml = StringField()# 状态pageStatus = StringField(null=True)# 创建时间pageCreateTime = DateTimeField(default=datetime.now)# 模版id *templateId = ReferenceField(CmsTemplate, required=True)# 页面参数列表，暂未使用pageParams = ListField()# 静态文件IdhtmlFileId = FileField(null=True)# 数据UrldataUrl = StringField(null=True)

[
    {
      "siteId": "站点ID",
      "siteName": "站点名称"
    }
]

[
    {
      "templateId": "模板ID",
      "templateName": "模板名称"
    }
]

from rest_framework_mongoengine.serializers import DocumentSerializer
from rest_framework.serializers import CharField
from cms.models import CmsSite, CmsTemplateclass CmsSiteSerializer(DocumentSerializer):siteId = CharField(source='id', read_only=True)class Meta:model = CmsSitefields = ('siteId', 'siteName')class CmsTemplateSerializer(DocumentSerializer):templateId = CharField(source='id', read_only=True)class Meta:model = CmsTemplatefields = ('templateId', 'templateName')

from rest_framework_mongoengine.viewsets import GenericViewSet
from rest_framework.mixins import ListModelMixin
from cms.models import CmsSite, CmsTemplate
from cms.serializers import CmsSiteSerializer, CmsTemplateSerializerclass CmsSiteViewSet(ListModelMixin, GenericViewSet):queryset = CmsSite.objectsserializer_class = CmsSiteSerializerclass CmsTemplateViewSet(ListModelMixin, GenericViewSet):queryset = CmsTemplate.objectsserializer_class = CmsTemplateSerializer

from django.conf.urls import urlfrom cms.views import CmsSiteViewSet, CmsTemplateViewSeturlpatterns = [url(r'^cms/site/list', CmsSiteViewSet.as_view({'get': 'list'})),url(r'^cms/template/list', CmsTemplateViewSet.as_view({'get': 'list'})),
]

import cms.urlsurlpatterns = [...url(r'^', include(cms.urls)),
]

INSTALLED_APPS = [...'cms.apps.CmsConfig',
]