ServeMuxによるルーティングの整理

http.HandleFunc は内部で http.DefaultServeMux(グローバル変数)に登録します。テストや複数サーバを立てるときには、独立した ServeMux を作るほうが管理しやすくなります。Go 1.22 からは HTTP メソッドとパスパターンをまとめて指定できるようになり、実用性が大きく上がりました。

1. 独立したServeMuxによる複数ルートの実装

書き方は以下のとおりです。まず、http.NewServeMux() で独立した ServeMux を作ります。

mux := http.NewServeMux()

作った ServeMux に、HandleFunc でパスとハンドラを登録します。Go 1.22 からはHTTPメソッドとパスパターンをまとめて指定できます。

mux.HandleFunc("メソッド パス", ハンドラ関数)

最後に、この ServeMux を http.ListenAndServe の第2引数に渡して待ち受けを開始します(ListenAndServe の使い方は「最小のWebサーバ」で扱ったものと同じで、第2引数に nil の代わりに mux を渡す形になります)。

これは、独立した ServeMux に3つのルート(/health / /users / /users/{id})を登録するサーバの例です。

package main

import (
    "encoding/json"
    "fmt"
    "net/http"
)

type User struct {
    ID    int    `json:"id"`
    Name  string `json:"name"`
    Email string `json:"email"`
}

func main() {
    mux := http.NewServeMux()

    mux.HandleFunc("GET /health", func(w http.ResponseWriter, r *http.Request) {
        fmt.Fprintln(w, "ok")
    })

    mux.HandleFunc("GET /users", func(w http.ResponseWriter, r *http.Request) {
        users := []User{
            {ID: 1, Name: "Taro", Email: "taro@example.com"},
            {ID: 2, Name: "Jiro", Email: "jiro@example.com"},
        }
        w.Header().Set("Content-Type", "application/json")
        json.NewEncoder(w).Encode(users)
    })

    mux.HandleFunc("GET /users/{id}", func(w http.ResponseWriter, r *http.Request) {
        id := r.PathValue("id")
        w.Header().Set("Content-Type", "application/json")
        json.NewEncoder(w).Encode(map[string]string{"id": id})
    })

    fmt.Println("http://localhost:8080 で起動")
    http.ListenAndServe(":8080", mux)
}

main.go を上記の内容で置き換えて保存します。既存のサーバが動いている場合は Ctrl+C で停止し、以下のコマンドで再起動します。

go run main.go

別のターミナルで、以下のコマンドを1つずつ実行して動作を確認します。まず、/health にアクセスします。

curl http://localhost:8080/health

以下のような実行結果が表示されます。

ok

続いて、/users にアクセスします。

curl http://localhost:8080/users

以下のような実行結果が表示されます。

[{"id":1,"name":"Taro","email":"taro@example.com"},{"id":2,"name":"Jiro","email":"jiro@example.com"}]

続いて、/users/1 にアクセスします。

curl http://localhost:8080/users/1

以下のような実行結果が表示されます。

{"id":"1"}

/health は ok を、/users は User の一覧を JSON 配列として、/users/1 はパスパラメータ id=1 を JSON オブジェクトとして返しました。すべて想定通りのレスポンスが返っていれば、ルーティングとJSONエンコードが正しく動作しています。

コードを解説します。

mux := http.NewServeMux()

独立した ServeMux を作ります。以降はこの mux に登録し、ListenAndServe の第2引数に渡します。

mux.HandleFunc("GET /users/{id}", func(w http.ResponseWriter, r *http.Request) {
    id := r.PathValue("id")
    ...
})

Go 1.22 で導入された書き方で、HTTP メソッド(GET)とパスパターン(/users/{id})を一緒に指定できます。パスパラメータは r.PathValue("id") で取得します。

json.NewEncoder(w).Encode(users)

json.NewEncoder(w) は io.Writer(ここでは w)に対する JSON エンコーダを作ります。.Encode(users) で struct のスライスがそのまま JSON 配列としてレスポンスに書き出されます。