最小のWebサーバ
Ginで最小のWebサーバを立ち上げるまでの流れを確認します。
1. プロジェクトの準備
任意の場所に hello-gin フォルダを作成し、Visual Studio Codeの「ファイル」→「フォルダーを開く」から、作成した hello-gin フォルダを開きます。以降の操作は、Visual Studio Codeのターミナルから行います。
hello-gin/ ← このフォルダを作成
以下のコマンドで、Go がインストールされていることを確認します。
go version
以下のように Go のバージョンが表示されれば、インストールは確認できています。
go version go1.x.x darwin/arm64
バージョンが表示されない場合は、Goのインストール を先に実施してください。
インストールが確認できたら、モジュールを初期化するために、go mod init コマンドを実行します。
go mod init hello-gin
以下のような実行結果が表示されます。
go: creating new go.mod: module hello-gin
続いて、Gin本体を go get コマンドで取得します。
go get github.com/gin-gonic/gin
以下のような実行結果が表示されます(バージョンは環境により変わります)。
go: added github.com/gin-gonic/gin v1.10.0
go.mod に依存関係が追記され、go.sum が生成されていれば準備完了です。
2. main.go の作成
Ginでは、gin.Engine 型のインスタンスを作成し、HTTPメソッドとパスに対応するハンドラを登録します。書き方は以下のとおりです。
r := gin.Default() // ロガー・リカバリ入りの Engine を作成
r.GET("パス", func(c *gin.Context) {
c.JSON(ステータスコード, gin.H{"キー": "値"}) // JSONレスポンスを返す
})
r.Run(":ポート") // 指定ポートでサーバを起動
gin.Default() はロガーとパニックリカバリ用のミドルウェアが組み込まれた gin.Engine を返します。ハンドラは *gin.Context を受け取り、c.JSON などの短いAPIでレスポンスを返します。
Visual Studio Codeのエクスプローラーで hello-gin フォルダを右クリックし、「新しいファイル」を選択して main.go を作成します。作成したファイルに以下の内容を記述して保存します。これは、ポート 8080 で待ち受け、ルートパス(/)へのGETリクエストに {"message": "Hello, Gin!"} を返す最小のWebサーバです。
package main
import (
"net/http"
"github.com/gin-gonic/gin"
)
func main() {
r := gin.Default()
r.GET("/", func(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{"message": "Hello, Gin!"})
})
r.Run(":8080")
}
以下のコマンドでサーバを起動します。
go run main.go
以下のような実行結果が表示されます。
[GIN-debug] Listening and serving HTTP on :8080
Gin独自のデバッグログとともに、ポート 8080 でサーバがリクエスト待ちの状態になりました。
別のターミナルから curl でアクセスします。
curl http://localhost:8080/
以下のような実行結果が表示されます。
{"message":"Hello, Gin!"}
登録したハンドラが返した gin.H{"message": "Hello, Gin!"} が、そのままJSONレスポンスとして curl の出力に現れました。数行のコードで、JSONを返すWebサーバが立ち上がっていることが確認できます。
コードを解説します。
r := gin.Default()
gin.Default() はロガーとパニックリカバリ用のミドルウェアが組み込まれた gin.Engine を返します。以降のルート登録はすべてこの r に対して行います。
r.GET("/", func(c *gin.Context) {
c.JSON(http.StatusOK, gin.H{"message": "Hello, Gin!"})
})
r.GET("パス", ハンドラ) で「このパスへのGETリクエストを、このハンドラで処理する」と登録します。ハンドラは *gin.Context の1引数のみを受け取ります。net/http の (w, r) の2引数を1つに束ねたのが gin.Context で、レスポンス書き出しとリクエスト参照の両方をこのオブジェクト経由で行います。
c.JSON(http.StatusOK, gin.H{"message": "Hello, Gin!"})
c.JSON はステータスコードと任意のGoの値を渡すと、Content-Type: application/json の設定・ステータスコードの書き込み・JSONエンコードをまとめて行います。gin.H は map[string]any の別名で、JSONオブジェクトを短く書くためのショートカットです。
r.Run(":8080")
r.Run は指定ポートでサーバを起動する関数で、内部では http.ListenAndServe(":8080", r) 相当の処理を行います。
| 📝 gin.Default と gin.New の違い |
|---|
gin.Default() はロガーとパニックリカバリ用のミドルウェアが最初から組み込まれた gin.Engine を返します。何のミドルウェアも持たない空の gin.Engine がほしい場合は gin.New() を使い、必要なミドルウェアを自分で Use する形になります。学習・開発時は gin.Default() を使うのが扱いやすいです。 |