GoSuda

更不费力地处理 HTTP 错误 + RFC7807

By snowmerak
views ...

概要

在Go语言中创建HTTP API时，最繁琐的部分是错误处理。典型的代码示例如下。

1func(w http.ResponseWriter, r *http.Request) {
2    err := doSomething()
3    if err != nil {
4        http.Error(w, err.Error(), http.StatusInternalServerError)
5        log.Printf("error occurred: %v", err)
6        return
7    }
8    // ...
9}

如果API数量不多，以这种方式编写可能不会感到特别不便。然而，随着API数量的增加和内部逻辑的复杂化，以下三点将变得令人困扰。

  1. 返回适当的错误代码
  2. 编写大量结果日志
  3. 传输清晰的错误消息

正文

返回适当的错误代码

当然，第一点，返回适当的错误代码，是我个人的抱怨。经验丰富的开发者每次都能找到并正确插入适当的代码，但像我这样不熟练的开发者，随着逻辑的复杂化和调用次数的增多，可能会难以规范地使用合适的错误代码。对此可能存在多种方法，最典型的方法是在设计API逻辑流程后编写代码以返回适当的错误。请照此执行

然而，对于在IDE（或Language Server）协助下的人类开发者而言，这似乎并非最佳方法。此外，鉴于REST API最大限度地利用了错误代码中包含的语义，我们或许可以提出另一种方法。我们可以创建一个名为HttpError的新错误（error）接口实现，使其存储StatusCode和Message。然后提供以下辅助函数。

1err := httperror.BadRequest("wrong format")

BadRequest辅助函数将返回一个HttpError，其StatusCode设置为400，Message设置为作为参数接收的值。除此之外，当然还可以通过自动完成功能查询并添加NotImplement、ServiceUnavailable、Unauthorized、PaymentRequired等辅助函数。这比每次检查预设的设计文档更快，也比每次手动输入数字错误代码更稳定。http.StatusCode常量中都包含了？嘘

编写大量结果日志

发生错误时，自然会记录日志。当API被调用，记录请求成功或失败的日志时，从开始到所有预期终止点都记录日志会导致代码量增加。通过对处理程序本身进行一次封装，可以实现集中管理。

以下是封装chi路由器的示例。

 1package chiwrap
 2
 3import (
 4	"errors"
 5	"net/http"
 6
 7	"github.com/go-chi/chi/v5"
 8
 9	"github.com/gosuda/httpwrap/httperror"
10)
11
12type Router struct {
13	router      chi.Router
14	errCallback func(err error)
15}
16
17func NewRouter(errCallback func(err error)) *Router {
18	if errCallback == nil {
19		errCallback = func(err error) {}
20	}
21	return &Router{
22		router:      chi.NewRouter(),
23		errCallback: errCallback,
24	}
25}
26
27type HandlerFunc func(writer http.ResponseWriter, request *http.Request) error
28
29func (r *Router) Get(pattern string, handler HandlerFunc) {
30	r.router.Get(pattern, func(writer http.ResponseWriter, request *http.Request) {
31		if err := handler(writer, request); err != nil {
32			he := &httperror.HttpError{}
33			switch errors.As(err, &he) {
34			case true:
35				http.Error(writer, he.Message, he.Code)
36			case false:
37				http.Error(writer, err.Error(), http.StatusInternalServerError)
38			}
39			r.errCallback(err)
40		}
41	})
42}

路由器结构体内部包含chi.Router，因此其配置旨在直接使用chi.Router的功能。在Get方法中，它会检查是否返回了我们刚才提议的辅助函数所返回的HttpError结构体，然后适当地返回；如果是error，则统一传递给错误回调函数。此回调通过构造函数接收输入。

以下是使用此包编写的代码。

 1package main
 2
 3import (
 4	"bytes"
 5	"context"
 6	"errors"
 7	"io"
 8	"log"
 9	"net/http"
10
11	"github.com/gosuda/httpwrap/httperror"
12	"github.com/gosuda/httpwrap/wrapper/chiwrap"
13)
14
15func main() {
16    ctx, cancel := signal.NotifyContext(context.Background(), syscall.SIGINT, syscall.SIGTERM)
17    defer cancel()
18
19	r := chiwrap.NewRouter(func(err error) {
20		log.Printf("Router log test: Error occured: %v", err)
21	})
22	r.Get("/echo", func(writer http.ResponseWriter, request *http.Request) error {
23		name := request.URL.Query().Get("name")
24		if name == "" {
25			return httperror.BadRequest("name is required")
26		}
27
28		writer.Write([]byte("Hello " + name))
29		return nil
30	})
31
32	svr := http.Server{
33		Addr:    ":8080",
34		Handler: r,
35	}
36	go func() {
37		if err := svr.ListenAndServe(); err != nil && !errors.Is(err, http.ErrServerClosed) {
38			log.Fatalf("Failed to start server: %v", err)
39		}
40	}()
41
42    <-ctx.Done()
43    svr.Shutdown(context.Background())
44}

如何？如果仅将HttpError作为辅助函数返回，上层作用域便可以以适当的错误代码和消息返回响应，并通过注册回调函数来处理每个实现服务所需的适当日志记录。如果需要，还可以扩展以使用RequestID等进行详细日志记录。

传输清晰的错误消息

RFC7807是为此目的而设计的文档。RFC7807主要定义并使用以下元素。

  • type: 标识错误类型的URI。通常是描述错误的文档。
  • title: 对错误的单行描述。
  • status: 与HTTP Status Code相同。
  • detail: 关于该错误的人类可读的详细描述。
  • instance: 发生错误的URI。例如，如果错误发生在GET /user/info，则/user/info将是其值。
  • extensions: 以JSON Object形式构成，用于描述错误的辅助元素。
    • 例如，当是BadRequest时，可能包含用户的输入。
    • 或者当是TooManyRequest时，可能包含最近一次请求的时间点。

为了便于使用，我们在与HttpError相同的httperror包中创建一个新文件，并生成RFC7807Error结构体，并通过方法链模式进行创建。

 1func NewRFC7807Error(status int, title, detail string) *RFC7807Error {
 2	return &RFC7807Error{
 3		Type:   "about:blank", // Default type as per RFC7807
 4		Title:  title,
 5		Status: status,
 6		Detail: detail,
 7	}
 8}
 9
10func BadRequestProblem(detail string, title ...string) *RFC7807Error {
11	t := "Bad Request"
12	if len(title) > 0 && title[0] != "" {
13		t = title[0]
14	}
15	return NewRFC7807Error(http.StatusBadRequest, t, detail)
16}
17
18func (p *RFC7807Error) WithType(typeURI string) *RFC7807Error { /* 此处省略实现 */ }
19func (p *RFC7807Error) WithInstance(instance string) *RFC7807Error { /* 此处省略实现 */ }
20func (p *RFC7807Error) WithExtension(key string, value interface{}) *RFC7807Error { /* 此处省略实现 */ }

Type中的"about:blank"是默认值，表示不存在的页面。以下是关于不当请求的错误生成示例。

1problem := httperror.BadRequestProblem("invalid user id format", "Bad User Input")
2
3problem = problem.WithType("https://example.com/errors/validation")
4         .WithInstance("/api/users/abc")
5         .WithExtension("invalid_field", "user_id")
6         .WithExtension("expected_format", "numeric")

通过简单的方法链，可以生成结构化的用户错误消息。此外，为了利用前面编写的集中式路由器，可以支持以下方法。

1func (p *RFC7807Error) ToHttpError() *HttpError {
2	jsonBytes, err := json.Marshal(p)
3	if err != nil {
4		// If marshaling fails, fall back to just using the detail
5		return New(p.Status, p.Detail)
6	}
7	return New(p.Status, string(jsonBytes))
8}

如果直接使用此方法修改上述示例，将变为如下所示。

 1package main
 2
 3import (
 4	"bytes"
 5	"context"
 6	"errors"
 7	"io"
 8	"log"
 9	"net/http"
10
11	"github.com/gosuda/httpwrap/httperror"
12	"github.com/gosuda/httpwrap/wrapper/chiwrap"
13)
14
15func main() {
16    ctx, cancel := signal.NotifyContext(context.Background(), syscall.SIGINT, syscall.SIGTERM)
17    defer cancel()
18
19	r := chiwrap.NewRouter(func(err error) {
20		log.Printf("Router log test: Error occured: %v", err)
21	})
22	r.Get("/echo", func(writer http.ResponseWriter, request *http.Request) error {
23		name := request.URL.Query().Get("name")
24		if name == "" {
25			return httperror.BadRequestProblem("name is required", "Bad User Input").
26                WithType("https://example.com/errors/validation").
27                WithInstance("/api/echo").
28                WithExtension("invalid_field", "name").
29                WithExtension("expected_format", "string").
30                WithExtension("actual_value", name).
31                ToHttpError()
32		}
33
34		writer.Write([]byte("Hello " + name))
35		return nil
36	})
37
38	svr := http.Server{
39		Addr:    ":8080",
40		Handler: r,
41	}
42	go func() {
43		if err := svr.ListenAndServe(); err != nil && !errors.Is(err, http.ErrServerClosed) {
44			log.Fatalf("Failed to start server: %v", err)
45		}
46	}()
47
48    <-ctx.Done()
49    svr.Shutdown(context.Background())
50}

结论

通过使用这种集中式路由器处理错误，可以减轻每次检查错误代码和编写适当错误消息的负担。此外，利用RFC7807提供结构化的错误消息，有助于客户端理解和处理错误。通过这些方法，可以使Go语言编写的HTTP API的错误处理更加简便和一致。

本文中的代码可在gosuda/httpwrap仓库中查看。