django 接口状态码封装优化方案

django 后端开发中，经常需要对 api 接口返回结果进行状态码封装，以便前端应用程序接收处理。

传统方案采用枚举类 status 封装状态码和信息，并使用 utils 类中的 json_dumps 方法将结果序列化为 json 字符串。

优化方案

然而，这种传统方案存在一定弊端：

• 数据结构复杂，难以扩展。
• 依赖 utils 类，灵活性不足。

因此，推荐使用 dataclass 和 enum 搭配 json 序列化的优化方案：

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!")


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

        return json.jsonencoder.default(self, obj)


@dataclass
class response:
    status: status
    data: any

    def json(self) -> str:
        return json.dumps(asdict(self), cls=enumencoder)


# 使用示例
print(response(status.success, {"age": 100}).json())

优势

• 数据结构清晰: 使用 dataclass 定义对象，数据结构更明确，扩展性更好。
• 无需辅助类: response 类内部直接采用 json.dumps() 序列化，无需依赖其他类。
• 灵活可扩展: 通过调整 statusitem 和 response 的属性，可以轻松扩展和定制状态码和返回数据格式。

使用

1. 定义状态码枚举:

class status(enum):
    success = statusitem(200000, "success")
    no_auth = statusitem(300001, "no authorization!")

2. 创建 response 对象:

response = response(status.success, {"age": 100})

3. 直接调用 json() 方法序列化:

json_str = response.json()

这种优化方案提供了更灵活、更具可扩展性和易于使用的接口状态码封装方式，极大地简化了 django 后端开发中的接口返回处理。