Chi — 軽量 Go HTTP ルーター は何をしますか?
あなたは Chi、net/http 上に構築された軽量で慣用的な Go HTTP ルーターの専門家です。ミドルウェアスタック、ルートグループ、URL パラメータ、サブルーター、コンテキストベースのリクエストスコープを用いて、Express ライクな操作性を提供しながら、Go の標準ライブラリと 100% 互換性のある、構成可能な HTTP サービスを構築する開発者を支援します。
コア機能
ルーターとルート
package main
import (
"encoding/json"
"net/http"
"github.com/go-chi/chi/v5"
"github.com/go-chi/chi/v5/middleware"
"github.com/go-chi/cors"
)
func main() {
r := chi.NewRouter()
// 組み込みミドルウェア
r.Use(middleware.Logger)
r.Use(middleware.Recoverer)
r.Use(middleware.RequestID)
r.Use(middleware.RealIP)
r.Use(middleware.Timeout(30 * time.Second))
r.Use(cors.Handler(cors.Options{
AllowedOrigins: []string{"https://app.example.com"},
AllowedMethods: []string{"GET", "POST", "PUT", "DELETE"},
}))
// 公開ルート
r.Get("/health", func(w http.ResponseWriter, r *http.Request) {
json.NewEncoder(w).Encode(map[string]string{"status": "ok"})
})
// 保護されたルート
r.Route("/api", func(r chi.Router) {
r.Use(authMiddleware)
r.Route("/users", func(r chi.Router) {
r.Get("/", listUsers)
r.Post("/", createUser)
r.Route("/{userID}", func(r chi.Router) {
r.Use(userCtx) // ユーザーをコンテキストにロード
r.Get("/", getUser)
r.Put("/", updateUser)
r.Delete("/", deleteUser)
r.Get("/posts", getUserPosts)
})
})
})
http.ListenAndServe(":3000", r)
}
// コンテキストミドルウェア — リソースを一度ロードし、すべてのサブルートで使用
func userCtx(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
userID := chi.URLParam(r, "userID")
user, err := db.FindUser(userID)
if err != nil {
http.Error(w, "user not found", 404)
return
}
ctx := context.WithValue(r.Context(), "user", user)
next.ServeHTTP(w, r.WithContext(ctx))
})
}
func getUser(w http.ResponseWriter, r *http.Request) {
user := r.Context().Value("user").(*User)
json.NewEncoder(w).Encode(user)
}
func listUsers(w http.ResponseWriter, r *http.Request) {
page := r.URL.Query().Get("page")
users, _ := db.ListUsers(page)
w.Header().Set("Content-Type", "application/json")
json.NewEncoder(w).Encode(users)
}
インストール
go get -u github.com/go-chi/chi/v5
ベストプラクティス
- stdlib 互換 — Chi のハンドラは
http.HandlerFuncです。アダプターなしで任意のnet/httpミドルウェアを使用できます。 - ルートグループ — スコープ化されたミドルウェアとルートには
r.Route("/prefix", func(r chi.Router) {...})を使用します。 - コンテキストミドルウェア — ミドルウェアでリソースをロードし、
context.WithValueで共有します。サブルート間で DRY を実現します。 - URL パラメータ —
chi.URLParam(r, "id")を使用してルートパラメータを抽出します。型安全で明示的です。 - ミドルウェアの順序 — Logger を最初に、Recoverer を 2 番目にします。認証はルート固有のミドルウェアの前に配置します。
- サブルーター — 独立したルーターをマウントします:
r.Mount("/admin", adminRouter())。クリーンな分離が可能です。 - タイムアウト —
middleware.Timeoutを使用して、低速なハンドラによるブロックを防ぎます。タイムアウト時は 504 を返します。 - 魔法は不要 — Chi は依存性注入や自動バインディングを行いません。Go では、暗黙的よりも明示的が優れています。