Ginのcorsミドルウェアによる対応
CORSの仕組みが分かったところで、APIサーバにAccess-Control-Allow-Originヘッダを返す設定を組み込みます。Ginでは、gin-contrib/corsというミドルウェアが公式に提供されており、これをr.Useで登録することで実現できます。
1. ミドルウェアの導入
1.1 ミドルウェアの追加
APIサーバを開いたターミナルで、動作中のサーバをいったんCtrl + Cで停止します。停止したら、CORSヘッダの付与とプリフライト応答を任せるため、api-serverフォルダで以下のコマンドを実行し、gin-contrib/corsを導入します。
go get github.com/gin-contrib/cors
以下のような実行結果が表示されます(バージョンは環境により変わります)。
go: added github.com/gin-contrib/cors v1.7.2
api-server/main.goを以下のように書き換えて保存します。これは、http://localhost:5173からのアクセスを許可するCORSミドルウェアを組み込んだAPIサーバです。GET /notesとPUT /notes/:idのルートは変えずに、r.Use(cors.New(...)) の1行をr := gin.Default()の直後に追加した形になります。
package main
import (
"net/http"
"github.com/gin-contrib/cors"
"github.com/gin-gonic/gin"
)
type Note struct {
ID int `json:"id"`
Title string `json:"title"`
}
func main() {
r := gin.Default()
r.Use(cors.New(cors.Config{
AllowOrigins: []string{"http://localhost:5173"},
AllowMethods: []string{"GET", "POST", "PUT", "DELETE", "OPTIONS"},
AllowHeaders: []string{"Content-Type", "Authorization"},
}))
r.GET("/notes", func(c *gin.Context) {
notes := []Note{
{ID: 1, Title: "買い物"},
{ID: 2, Title: "打ち合わせ資料"},
}
c.JSON(http.StatusOK, notes)
})
r.PUT("/notes/:id", func(c *gin.Context) {
id := c.Param("id")
c.JSON(http.StatusOK, gin.H{"id": id, "status": "updated"})
})
r.Run(":8080")
}
1.2 動作確認
変更を反映するため、以下のコマンドでAPIサーバを再起動します。
go run main.go
以下のような実行結果が表示されます。
[GIN-debug] Listening and serving HTTP on :8080
ブラウザに戻って、http://localhost:5173/を再読み込みしてください。画面に以下のようにノート一覧が表示されれば、CORS対応は成功しています。
Notes
・ 1: 買い物
・ 2: 打ち合わせ資料
レスポンスヘッダにAccess-Control-Allow-Origin: http://localhost:5173が実際に付いていることは、別のターミナルから curl で確認できます。ブラウザからの呼び出しを再現するため、-H "Origin: http://localhost:5173" でリクエスト元のオリジンを付けて送り、-i オプションでレスポンスヘッダも表示します。
curl -i -H "Origin: http://localhost:5173" http://localhost:8080/notes
以下のような実行結果が表示されます。
HTTP/1.1 200 OK
Access-Control-Allow-Origin: http://localhost:5173
Content-Type: application/json; charset=utf-8
Vary: Origin
Date: XXX, XX XXX XXXX XX:XX:XX GMT
Content-Length: 71
[{"id":1,"title":"買い物"},{"id":2,"title":"打ち合わせ資料"}]
Access-Control-Allow-Origin: http://localhost:5173 の行があれば、CORSヘッダが正しく付与されています。逆に -H "Origin: ..." を付けずに叩くと、ブラウザ以外からの通常のリクエスト扱いになり、このヘッダは付きません(ミドルウェアがオリジン判定して付与するため)。
1.3 コードの解説
r.Use(cors.New(cors.Config{
AllowOrigins: []string{"http://localhost:5173"},
AllowMethods: []string{"GET", "POST", "PUT", "DELETE", "OPTIONS"},
AllowHeaders: []string{"Content-Type", "Authorization"},
}))
cors.Newはcors.Configを受け取って、gin.HandlerFunc型のミドルウェアを返します。r.Useで登録すると、以降に登録される全ルートに対してCORSヘッダの付与とプリフライト(OPTIONS)の応答を自動で行うようになります。
AllowOrigins: []string{"http://localhost:5173"}
CORSで許可するオリジンを列挙します。ここに含まれるオリジンからのリクエストに対してのみ、Access-Control-Allow-Originヘッダが付与されます。複数のオリジンをスライスで指定できます。
AllowMethods: []string{"GET", "POST", "PUT", "DELETE", "OPTIONS"}
プリフライトリクエストで許可するHTTPメソッドです。OPTIONSはプリフライト自身のメソッドで、通常は明示的に含めておきます。
AllowHeaders: []string{"Content-Type", "Authorization"}
リクエストで許可するヘッダを列挙します。Content-Type: application/jsonでJSONを送る場合や、Authorizationヘッダでトークンを送る場合はここに含めておく必要があります。
| ⚠️ 「Failed to fetch」がブラウザで解消しない場合 |
|---|
ブラウザは一度受け取ったレスポンス(CORS判定を含む)をキャッシュする場合があります。ミドルウェアを追加したのに画面上でエラーが続く場合は、ブラウザの再読み込みを「スーパーリロード」(ChromeではShift + F5またはCtrl + Shift + R/Cmd + Shift + R)で行い、開発者ツールを開いた状態で「Network」タブのDisable cacheにチェックを入れて再度確認してください。 |
2. プリフライトリクエストの確認
これまで確認してきたGET /notesは「単純リクエスト」に該当するため、ブラウザはOPTIONSを送らずにGETをそのまま投げていました。ここでは、単純リクエストの条件から外れるPUT /notes/:id(main.goに登録済み)に対して、プリフライト(OPTIONS)が実際に発生することをcurlで確認します。
2.1 プリフライトリクエストの再現
OPTIONSリクエストにプリフライト固有のヘッダを付けて送ります。書き方は以下のとおりです。
curl -X OPTIONS -i \
-H "Origin: 呼び出し元のオリジン" \
-H "Access-Control-Request-Method: 本来送るメソッド" \
-H "Access-Control-Request-Headers: 本来送るヘッダ" \
URL
上記の書式に沿って、本来送りたいメソッドPUTと、本来付けたいヘッダContent-Typeを伝えるプリフライトを、別のターミナルから送ります。
curl -X OPTIONS -i \
-H "Origin: http://localhost:5173" \
-H "Access-Control-Request-Method: PUT" \
-H "Access-Control-Request-Headers: Content-Type" \
http://localhost:8080/notes/1
以下のような実行結果が表示されます。
HTTP/1.1 204 No Content
Access-Control-Allow-Origin: http://localhost:5173
Access-Control-Allow-Methods: GET,POST,PUT,DELETE,OPTIONS
Access-Control-Allow-Headers: Content-Type,Authorization
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Access-Control-Allow-MethodsにPUTが、Access-Control-Allow-HeadersにContent-Typeが含まれています。ブラウザはこの応答を見て「PUTとContent-Typeヘッダは許可されている」と判断し、続けて本来のPUTリクエストを送ります。
コードを解説します。
-H "Origin: http://localhost:5173"
呼び出し元のオリジンをサーバに伝えるヘッダです。ブラウザはクロスオリジンリクエストの際に自動でこれを付けますが、curlでは明示的に指定します。
-H "Access-Control-Request-Method: PUT"
本来これから送るリクエストのHTTPメソッドを、プリフライトの段階でサーバに事前通知します。サーバはこれとAllowMethodsを突き合わせて許可可否を判定します。
-H "Access-Control-Request-Headers: Content-Type"
本来これから送るリクエストに含める非単純リクエスト用のヘッダを、プリフライトの段階でサーバに事前通知します。サーバはこれとAllowHeadersを突き合わせて許可可否を判定します。
HTTP/1.1 204 No Content
プリフライトへの応答は本文を持たない204 No Contentで返すのが一般的です。
Access-Control-Allow-Methods: GET,POST,PUT,DELETE,OPTIONS
Access-Control-Allow-Headers: Content-Type,Authorization
サーバが許可するメソッドとヘッダを列挙するレスポンスヘッダです。gin-contrib/corsがcors.ConfigのAllowMethods・AllowHeadersの値をもとに自動で組み立てます。
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
「同じURLでも、これらのリクエストヘッダの内容が変わるとレスポンスが変わる」ことをブラウザやプロキシに伝えるヘッダです。CORSレスポンスは呼び出し元のオリジンなどに応じて変わるため、Varyでキャッシュの取り違えを防ぎます。
2.2 本来のリクエストの送信
プリフライトが通ったあと、ブラウザは本来送りたいリクエストを続けて投げます。この段階もcurlで再現します。書き方は以下のとおりです。
curl -X メソッド -i \
-H "Origin: 呼び出し元のオリジン" \
-H "Content-Type: application/json" \
-d 'JSON文字列' \
URL
上記の書式に沿って、PUT /notes/1にJSONを送ります。
curl -X PUT -i \
-H "Origin: http://localhost:5173" \
-H "Content-Type: application/json" \
-d '{"title":"更新済み"}' \
http://localhost:8080/notes/1
以下のような実行結果が表示されます。
HTTP/1.1 200 OK
Access-Control-Allow-Origin: http://localhost:5173
Content-Type: application/json; charset=utf-8
Vary: Origin
Date: XXX, XX XXX XXXX XX:XX:XX GMT
Content-Length: 29
{"id":"1","status":"updated"}
ブラウザ経由の場合、OPTIONS → PUTの2ステップが自動的に行われます。プリフライトが失敗した場合(Access-Control-Allow-Methodsに対象メソッドが含まれない、など)は、本来のPUTリクエストは送信すらされずにブロックされる点が、単純リクエストとの違いです。gin-contrib/corsミドルウェアは、AllowMethods・AllowHeadersに含まれる範囲であれば、OPTIONSへの応答を自動で組み立てます。
AllowOrigins に * を使うことの是非
gin-contrib/corsでは、すべてのオリジンを許可するAllowAllOrigins: trueという設定も用意されていますが、以下の理由から利用には注意が必要です。
- 悪意のある第三者のサイトからも、そのAPIをブラウザ経由で呼び出せる状態になる
- Cookieによる認証(
AllowCredentials: true)と*は同時に使えず、ブラウザにブロックされる
原則としては、AllowOriginsに明示的なオリジンを列挙する運用が安全です。開発時に一時的に緩めたいだけであっても、AllowAllOrigins: trueはデフォルトの選択肢にはしません。
| 💡 ポイント |
|---|
本章では AllowOrigins にオリジンをハードコードしていますが、実際には開発環境・ステージング・本番環境で許可するオリジンが変わります。運用では環境変数や .env ファイル(Go標準ライブラリ 参照)からオリジンを読み込み、コードを書き換えずに切り替えられる形にするのが一般的です。 |
| 📝 CORSと認証の関係 |
|---|
CookieやAuthorizationヘッダを伴うクロスオリジンリクエストを許可するには、AllowCredentials: trueと、AllowOriginsに具体的なオリジンを指定する必要があります(AllowAllOrigins: trueは同時に使えない)。次章の GoでJWT認証を実装しよう でAuthorizationヘッダによる認証を扱う際、この組み合わせが前提となります。 |