GoSuda

Egyszerűbb HTTP-hibakezelés + RFC7807

By snowmerak views ...

Áttekintés

Go nyelven HTTP API-t készítve a legbosszantóbb a hibakezelés. Tipikus példa az alábbi kód.

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}

Ha az API-k száma kevés, ilyen módon írva sem lesz különösebb kellemetlenség. Ahogy azonban az API-k száma nő és a belső logika bonyolultabbá válik, három dolog kezd zavarni:

  1. Megfelelő hibakód visszaadása
  2. Túl sok naplóbejegyzés írása
  3. Egyértelmű hibaüzenet küldése

Főrész

Megfelelő hibakód visszaadása

Természetesen az 1. pont, vagyis a megfelelő hibakód visszaadása, a saját személyes panaszom. A tapasztalt fejlesztők minden alkalommal megtalálják és helyesen beírják a megfelelő kódot, de én is, és a kezdő fejlesztők is nehezen tudják következetesen használni a megfelelő hibakódokat, ahogy a logika bonyolultabbá válik és az esetek száma nő. Erre többféle megoldás létezik, a legelterjedtebb az, hogy előre megtervezzük az API logikai folyamatát, majd úgy írjuk meg a kódot, hogy a megfelelő hibát adja vissza. Tegyék ezt meg

Ez azonban nem tűnik optimális megoldásnak olyan emberi fejlesztő számára, aki az IDE-(vagy Language Server-)től kap segítséget. Továbbá, mivel maga a REST API a hibakódokban rejlő jelentést igyekszik a lehető legjobban kihasználni, egy másik módszert is javasolhatunk. Létrehozunk egy új, error interfészt megvalósító HttpError típust, amely tárolja a StatusCode-ot és a Message-et. Ezután az alábbihoz hasonló segédfüggvényeket biztosítunk.

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

A BadRequest segédfüggvény olyan HttpError-t ad vissza, amelynek StatusCode értéke 400, Message értéke pedig az átadott argumentum. Ezen kívül természetesen létrehozhatunk olyan segédfüggvényeket is, mint a NotImplement, ServiceUnavailable, Unauthorized, PaymentRequired, amelyeket automatikus kiegészítéssel kereshetünk és vehetünk fel. Ez gyorsabb, mint minden alkalommal az előre elkészített tervdokumentációt ellenőrizni, és megbízhatóbb, mint a hibakódot minden alkalommal számként beírni. Azt mondják, hogy minden benne van a http.StatusCode konstansokban? Pszt

Túl sok naplóbejegyzés írása

Hiba esetén természetesen naplózni kell. Ha az API meghívásakor és a kérés sikerességének vagy sikertelenségének naplózásakor a kezdetektől fogva minden várható befejezési pontra naplóbejegyzést írunk, az sok kódot eredményez. Ezt úgy oldhatjuk meg, hogy magát a handlert egy burkolóval vesszük körül, így a naplózás központilag kezelhetővé válik.

Az alábbi példa a chi router becsomagolását mutatja.

 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}

A router struct belsejében egy chi.Router található, így a chi.Router funkciói változatlanul használhatók. A Get metódusban látható, hogy ellenőrzi, hogy a fentebb javasolt segédfüggvény által visszaadott HttpError struct érkezett-e, és ennek megfelelően válaszol. Minden más error esetén egységesen az error callback függvénynek adja át. Ezt a callbacket a konstruktor kapja meg paraméterként.

Az alábbi kód a csomag felhasználásával készült.

 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}

Nos, mit gondolnak? Ha csak a HttpError-t készítjük el segédfüggvényként és adjuk vissza, a felsőbb szinten megfelelő hibakóddal és üzenettel válaszolhatunk, miközben a regisztrált callbacken keresztül minden szolgáltatás számára megfelelő naplózást biztosíthatunk. Szükség esetén bővíthetjük is, például a RequestID használatával részletes naplózás valósítható meg.

Egyértelmű hibaüzenet küldése

Erre a célra az RFC7807 szolgál. Az RFC7807 főként az alábbi elemeket határozza meg:

  • type: a hibatípust azonosító URI. Főként a hibát leíró dokumentum.
  • title: rövid, egysoros leírás arról, hogy milyen hibáról van szó.
  • status: megegyezik a HTTP állapotkóddal.
  • detail: az adott hibáról emberek számára olvasható, részletes leírás.
  • instance: az URI, ahol a hiba történt. Például ha a hiba a GET /user/info kérésnél történt, ennek értéke /user/info lesz.
  • extensions: JSON objektum formájában megadott, a hibát magyarázó kiegészítő elem.
    • Például BadRequest esetén tartalmazhatja a felhasználó bemenetét.
    • Vagy TooManyRequest esetén tartalmazhatja a legutóbbi kérés időpontját is.

Ennek egyszerű használatához a HttpError-rel azonos helyen, a httperror csomagban létrehozunk egy új fájlt, definiáljuk benne az RFC7807Error struct-ot, és metódusláncolási mintával tesszük lehetővé a létrehozását.

 1func NewRFC7807Error(status int, title, detail string) *RFC7807Error {
 2	return &RFC7807Error{
 3		Type:   "about:blank", // Alapértelmezett típus az RFC7807 szerint
 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 { ... }

A Type "about:blank" értéke az alapértelmezett érték. Egy nem létező oldalt jelöl. Az alábbiakban egy hibás kérésre vonatkozó hibagenerálási példa látható.

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

Egyszerű metódusláncolással a felhasználó számára strukturált hibaüzenet hozható létre. Ezen kívül, hogy a korábban bemutatott központosított routert használhassuk, a következő metódust támogathatjuk:

1func (p *RFC7807Error) ToHttpError() *HttpError {
2	jsonBytes, err := json.Marshal(p)
3	if err != nil {
4		// Ha a szerializálás sikertelen, csak a detail mezőt használjuk
5		return New(p.Status, p.Detail)
6	}
7	return New(p.Status, string(jsonBytes))
8}

Ezt közvetlenül használva a fenti példa így módosítható:

 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}

Következtetés

A központosított router segítségével történő hibakezelés révén csökkenthető az a teher, hogy minden alkalommal ellenőriznünk kell a hibakódot és meg kell fogalmaznunk a megfelelő hibaüzenetet. Az RFC7807 alkalmazásával strukturált hibaüzenetek küldhetők, ami segíti a klienst a hiba megértésében és kezelésében. Ezekkel a módszerekkel a Go nyelven írt HTTP API-k hibakezelése egyszerűbbé és egységesebbé tehető.

A cikk kódja a gosuda/httpwrap repozitóriumban érhető el.