Go服务业务状态码设计最佳实践：用魔法打败魔法

后端

2023-10-02 14:47:34

业务状态码：在 Go HTTP 服务中"用魔法打败魔法"

什么是业务状态码？

在处理 Go HTTP 服务的业务逻辑时，仅仅依靠 HTTP 状态码是不够的，还需要一套自定义的业务状态码来传递更细粒度的错误信息。业务状态码是一种用来表示服务端返回的业务状态信息的代码，能够帮助我们更清晰地传达业务错误信息。

如何设计业务状态码？

在设计业务状态码时，应遵循以下原则：

清晰明确： 状态码应易于理解和识别。
唯一性： 每个状态码应代表一个独特的错误。
可扩展性： 状态码体系应易于扩展，以满足未来添加新错误的需求。
语义化： 状态码应具有语义化的含义，便于开发人员根据名称猜测其含义。

使用常量定义业务状态码

为了更好地维护和管理业务状态码，我们可以使用常量对其进行定义，如以下示例所示：

const (
    // 成功
    BizCodeSuccess = 0

    // 未知错误
    BizCodeUnknownError = 1

    // 参数错误
    BizCodeInvalidArgument = 2

    // 资源不存在
    BizCodeNotFound = 3

    // 权限不足
    BizCodePermissionDenied = 4

    // 内部错误
    BizCodeInternalError = 5
)

通过这种方式，我们可以将所有状态码集中在一个地方，方便管理。

在 Go HTTP 服务中使用业务状态码

在 Go HTTP 服务中，我们可以通过如下方式使用业务状态码：

func (s *Server) handleRequest(w http.ResponseWriter, r *http.Request) {
    // 获取业务状态码
    bizCode := s.getBizCode(r)

    // 根据业务状态码设置 HTTP 状态码
    switch bizCode {
    case BizCodeSuccess:
        w.WriteHeader(http.StatusOK)
    case BizCodeInvalidArgument:
        w.WriteHeader(http.StatusBadRequest)
    case BizCodeNotFound:
        w.WriteHeader(http.StatusNotFound)
    case BizCodePermissionDenied:
        w.WriteHeader(http.StatusForbidden)
    case BizCodeInternalError:
        w.WriteHeader(http.StatusInternalServerError)
    default:
        w.WriteHeader(http.StatusInternalServerError)
    }

    // 将业务状态码写入响应体
    w.Write([]byte(strconv.Itoa(bizCode)))
}