Hello! 欢迎来到小浪资源网！

如何用Django更优雅地封装接口状态码及响应数据？

小浪博主 2024-11-17 21

如何用Django更优雅地封装接口状态码及响应数据？

django 接口状态码封装优化

传统的使用 enum 类来封装接口状态码，会存在一些局限。以下提供了一种更加简洁且灵活的封装方案：

封装方式

使用 enum 和 dataclass 相结合来封装状态码：

import json from enum import enum from dataclasses import dataclass, asdict from typing import any  @dataclass class statusitem:     code: int     msg: str  class status(enum):     success = statusitem(200000, "success")     no_auth = statusitem(300001, "no authorization!")

json 序列化

使用自定义的 jsonencoder 来序列化 statusitem 对象：

class enumencoder(json.jsonencoder):     def default(self, obj):         if isinstance(obj, status):             return asdict(obj.value)          return json.jsonencoder.default(self, obj)

封装响应

使用 dataclass 封装响应数据：

@dataclass class response:     status: status     data: any      def json(self) -> str:         return json.dumps(asdict(self), cls=enumencoder)

使用方式

response = Response(Status.SUCCESS, {"age": 100})  # 直接调用 json() 方法即可获取 JSON 字符串 json_str = response.json()  print(json_str)

优势

代码更加简洁明了
灵活地支持自定义状态码和信息
方便地扩展和维护
响应数据的序列化和反序列化过程更加高效

X