关于rest:如何在Go HTTP服务器中有条件地设置HTTP状态代码?

How do I set HTTP status code conditionally in a Go HTTP server?

我具有以下HTTP处理函数:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
func (h *UptimeHttpHandler) CreateSchedule(w http.ResponseWriter, r *http.Request) {
    defer r.Body.Close()
    dec := json.NewDecoder(r.Body)

    var req ScheduleRequest
    if err := dec.Decode(&req); err != nil {
        // error handling omited
    }

    result, err := saveToDb(req)
    if err != nil {
        // error handling omited
    }

    // Responding with 201-Created instead of default 200-Ok
    w.WriteHeader(http.StatusCreated)

    enc := json.NewEncoder(w)
    if err := enc.Encode(result); err != nil {
        // this will have no effect as the status is already set before
        w.WriteHeader(http.StatusInternalServerError)
        fmt.Fprintf(w,"%v", err)
    }
}

上面的代码执行以下操作:

  • 请求来自JSON数据。它被解码为req
  • 请求被保留在数据库中。这将返回结果对象,该对象将是响应
  • 现在,在数据库插入成功后,我们将状态代码设置为201。然后使用JSON编码器将JSON编码的值直接流式传输到ResponseWriter

    encode返回错误时,我需要将状态代码更改为500。但是目前我无法做到,因为Go只能设置一次状态代码。

    我可以通过以下方式来解决此问题:将编码后的JSON保留在内存中,并仅在成功时设置状态代码。但这会创建不需要的副本,而且效果不是很好。

    是否有更好的方法来处理此问题?


    扩大我的评论:

    没有缓冲就无法做到这一点。如果您考虑过,即使有,它将如何实施?响应头需要在内容之前发送。如果代码取决于对响应进行编码,则必须首先进行编码,检查结果,设置标题并刷新编码的缓冲区。

    因此,即使Go API支持"已延迟"状态,您也基本上会将缓冲问题向下推到http库:)

    您应该拨打电话-不惜一切代价正确获取响应代码很重要,您可以负担得起,或者您想要流式传输响应并且您不能更改结果。

    从理论上讲,Go可以创建一个编码验证器,以确保您尝试编码的对象在实际编码之前将100%通过。

    顺便说一句,这让我想到了另一件事-响应代码的语义。您返回HTTP Created,对吗?这是正确的代码,因为实际上已经创建了对象。但是,如果由于编码而返回500错误,是否没有创建对象?它仍然有!因此,创建的代码仍然有效,错误仅在编码阶段。因此,也许更好的设计是不将对象作为响应返回?


    如果某些类型(深度)无法序列化为JSON,则JSON编组可能会失败。

    因此您应该问自己:响应的编码会在什么情况下失败?

    如果您知道答案,只需解决这些情况。如果您不知道,可能是这些情况根本不存在。

    如果不确定,捕获错误的唯一方法是缓冲编码。您必须平衡缓冲与不返回清除错误之间的"不好"。

    无论如何,如果仅JSON编码失败,则返回500错误确实不是很好。至少,您应该还原对象的创建(saveToDb的工作),因此您必须package一个事务,该事务将在任何失败的情况下回滚。