ミドルウェアとルータグループ
ログの出力や認証など、複数のハンドラで共通に行いたい処理は、ハンドラ本体に書くと重複が増えます。Ginではミドルウェアとして共通処理を切り出し、r.Use や Group で適用範囲を指定できます。
1. ミドルウェアの実装
ミドルウェアは gin.HandlerFunc を返す関数として書き、c.Next() を呼ぶことで次のハンドラに処理を渡します。書き方は以下のとおりです。
func ミドルウェア名() gin.HandlerFunc {
return func(c *gin.Context) {
// 前処理
c.Next() // 次のハンドラを呼ぶ
// 後処理
}
}
r.Use(ミドルウェア名()) // 全ルートに適用
c.Next() の前が「ハンドラ実行前に行いたい処理」、後が「ハンドラ実行後に行いたい処理」です。
main.go を以下の内容で置き換えて保存します。これは、リクエストの処理時間をログに出力する LoggerMiddleware を r.Use で全ルートに適用したうえで、動作確認用に /hello/:name エンドポイントを1つ登録するコードです。
package main
import (
"log"
"net/http"
"time"
"github.com/gin-gonic/gin"
)
func LoggerMiddleware() gin.HandlerFunc {
return func(c *gin.Context) {
start := time.Now()
c.Next()
log.Printf("%s %s (%s)", c.Request.Method, c.Request.URL.Path, time.Since(start))
}
}
func main() {
r := gin.Default()
r.Use(LoggerMiddleware())
r.GET("/hello/:name", func(c *gin.Context) {
name := c.Param("name")
c.JSON(http.StatusOK, gin.H{"message": "こんにちは、" + name + "さん!"})
})
r.Run(":8080")
}
既存のサーバが動いている場合は Ctrl+C で停止し、以下のコマンドで再起動します。
go run main.go
別のターミナルで以下のコマンドを実行します。
curl http://localhost:8080/hello/Taro
サーバを起動しているターミナル側に、以下のようなログが出力されます(gin.Default() の既定ログに続いて、自作のログが追記されます)。
2026/07/29 12:00:00 GET /hello/Taro (123.456µs)
LoggerMiddleware がメソッド(GET)・パス(/hello/Taro)・処理時間をまとめてログに書き出しています。
コードを解説します。
func LoggerMiddleware() gin.HandlerFunc {
return func(c *gin.Context) {
start := time.Now()
c.Next()
log.Printf("%s %s (%s)", c.Request.Method, c.Request.URL.Path, time.Since(start))
}
}
gin.HandlerFunc を返す関数として定義します。前処理として start := time.Now() で開始時刻を記録し、c.Next() で次のハンドラを呼び出し、戻ってきたところで time.Since(start) により所要時間を算出しています。
r.Use(LoggerMiddleware())
r.Use に渡したミドルウェアは、以降に登録される全ルートに適用されます。特定のルート群にだけ適用したい場合は、次に扱う Group に対して Use を呼びます。
2. ルータグループ
REST API を作っていると、/api/v1/users や /api/v1/products のように、複数のエンドポイントに同じURLプレフィックス(この場合 /api/v1)を持たせたい場面がよく出てきます。認証が必要な /admin/* 配下だけに共通のミドルウェアを適用したいケースも同様です。これを1つひとつのハンドラに書くと、同じプレフィックスやミドルウェアを何度も繰り返すことになります。
Ginでは、この問題を ルータグループ で解決できます。ルータグループは、複数のエンドポイントを1つにまとめて、共通のURLプレフィックスやミドルウェアを一括で適用できる仕組みです。書き方は以下のとおりです。
グループ変数 := r.Group("/共通プレフィックス")
{
グループ変数.GET("/パス", ハンドラ) // 実際のパスは "/共通プレフィックス/パス"
グループ変数.POST("/パス", ハンドラ)
}
r.Group("/共通プレフィックス") は、そのプレフィックスが自動で先頭に付く新しいルーティング先を返します。{ } は Go の構文上のブロックで、グループに属するルートを視覚的にまとめるための慣例的な書き方です(意味的にはなくても動作します)。
main.go を以下の内容で置き換えて保存します。これは、/api/v1 プレフィックスのルータグループを作り、その配下に /ping と /version の2つのエンドポイントを登録するコードです。
package main
import (
"net/http"
"github.com/gin-gonic/gin"
)
func main() {
r := gin.Default()
v1 := r.Group("/api/v1")
{
v1.GET("/ping", func(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{"message": "pong"})
})
v1.GET("/version", func(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{"version": "1.0.0"})
})
}
r.Run(":8080")
}
既存のサーバが動いている場合は Ctrl+C で停止し、以下のコマンドで再起動します。
go run main.go
別のターミナルで以下のコマンドを実行します。
curl http://localhost:8080/api/v1/ping
以下のような実行結果が表示されます。
{"message":"pong"}
v1.GET("/ping", ...) として登録したハンドラが、実際には /api/v1/ping で公開されていることが確認できます。
curl http://localhost:8080/api/v1/version
以下のような実行結果が表示されます。
{"version":"1.0.0"}
同じグループに属する /api/v1/version にも /api/v1 のプレフィックスが自動で付いていることが分かります。
コードを解説します。
v1 := r.Group("/api/v1")
r.Group("/api/v1") を呼ぶと、/api/v1 を先頭に付けたルーティング先が返ります。以降 v1.GET("/ping", ...) のように登録したパスは、実際には /api/v1/ping として公開されます。
{
v1.GET("/ping", ...)
v1.GET("/version", ...)
}
グループに属するルートを { } のブロックでくくるのは、Goの構文上のブロックであり慣例的な書き方です。処理上の意味はありませんが、グループの範囲が視覚的にまとまるため、REST APIのバージョン分割やモジュール分割で読みやすくなります。
| 💡 ポイント |
|---|
ルータグループは共通ミドルウェアの適用にも使えます。admin := r.Group("/admin", 認証ミドルウェア) のようにグループ作成時に渡すか、admin.Use(認証ミドルウェア) で後付けすることで、そのグループ配下のルートにだけミドルウェアが適用されます。認証が必要なエンドポイントと不要なエンドポイントを分けたい場面で使えます。 |