|
| 1 | +--- |
| 2 | +title: バインディング |
| 3 | +description: パス、クエリ、header、リクエストボディからリクエストデータを型付き Go struct に解析します。 |
| 4 | +sidebar: |
| 5 | + order: 5 |
| 6 | +--- |
| 7 | + |
| 8 | +リクエストデータの解析は、Web アプリケーションの重要な要素です。Echo ではこれを |
| 9 | +_バインディング_ と呼び、HTTP リクエストの 4 つの部分から読み取れます。 |
| 10 | + |
| 11 | +- URL パスパラメーター |
| 12 | +- URL クエリパラメーター |
| 13 | +- Header |
| 14 | +- リクエストボディ |
| 15 | + |
| 16 | +## Struct タグによるバインディング |
| 17 | + |
| 18 | +データソースとキーを指定するタグ付きの struct を定義し、そのポインターを |
| 19 | +`c.Bind()` に渡します。ここではクエリパラメーター `id` が `ID` フィールドに |
| 20 | +バインドされます。 |
| 21 | + |
| 22 | +```go |
| 23 | +type User struct { |
| 24 | + ID string `query:"id"` |
| 25 | +} |
| 26 | + |
| 27 | +// handler for /users?id=<userID> |
| 28 | +var user User |
| 29 | +if err := c.Bind(&user); err != nil { |
| 30 | + return c.String(http.StatusBadRequest, "bad request") |
| 31 | +} |
| 32 | +``` |
| 33 | + |
| 34 | +### データソース |
| 35 | + |
| 36 | +| タグ | ソース | |
| 37 | +| -------- | ------ | |
| 38 | +| `query` | クエリパラメーター | |
| 39 | +| `param` | パスパラメーター | |
| 40 | +| `header` | Header 値 | |
| 41 | +| `form` | フォームデータ(クエリ + ボディ) | |
| 42 | +| `json` | リクエストボディ(`encoding/json`) | |
| 43 | +| `xml` | リクエストボディ(`encoding/xml`) | |
| 44 | + |
| 45 | +パス、クエリ、header、フォームのフィールドには**明示的なタグ**が必要です。 |
| 46 | +JSON と XML はタグが省略された場合、標準ライブラリと同じように struct フィールド名へ |
| 47 | +フォールバックします。 |
| 48 | + |
| 49 | +### ボディのコンテンツタイプ |
| 50 | + |
| 51 | +リクエストボディをデコードするときは、`Content-Type` header によってデコーダーが選ばれます。 |
| 52 | + |
| 53 | +- `application/json` |
| 54 | +- `application/xml` |
| 55 | +- `application/x-www-form-urlencoded` |
| 56 | + |
| 57 | +### 複数ソースと優先順位 |
| 58 | + |
| 59 | +1 つのフィールドで複数のソースを宣言できます。データは次の順序でバインドされ、 |
| 60 | +各ステップが前の値を上書きします。 |
| 61 | + |
| 62 | +1. パスパラメーター |
| 63 | +2. クエリパラメーター(GET / DELETE のみ) |
| 64 | +3. リクエストボディ |
| 65 | + |
| 66 | +```go |
| 67 | +type User struct { |
| 68 | + ID string `param:"id" query:"id" form:"id" json:"id" xml:"id"` |
| 69 | +} |
| 70 | +``` |
| 71 | + |
| 72 | +### 1 つのソースから直接バインドする |
| 73 | + |
| 74 | +```go |
| 75 | +echo.BindBody(c, &payload) // request body |
| 76 | +echo.BindQueryParams(c, &payload) // query parameters |
| 77 | +echo.BindPathValues(c, &payload) // path parameters |
| 78 | +echo.BindHeaders(c, &payload) // headers |
| 79 | +``` |
| 80 | + |
| 81 | +:::note |
| 82 | +Header は `c.Bind()` に**含まれません**。`echo.BindHeaders` で直接バインドしてください。 |
| 83 | +::: |
| 84 | + |
| 85 | +:::caution[セキュリティ] |
| 86 | +ビジネス用の struct に直接バインドしないでください。バインド対象の struct が |
| 87 | +`IsAdmin bool` フィールドを公開している場合、`{"IsAdmin": true}` というリクエストボディで |
| 88 | +その値が設定されます。専用の DTO を使い、明示的にマッピングしてください。 |
| 89 | +::: |
| 90 | + |
| 91 | +```go |
| 92 | +type UserDTO struct { |
| 93 | + Name string `json:"name" form:"name" query:"name"` |
| 94 | + Email string `json:"email" form:"email" query:"email"` |
| 95 | +} |
| 96 | + |
| 97 | +e.POST("/users", func(c *echo.Context) error { |
| 98 | + var dto UserDTO |
| 99 | + if err := c.Bind(&dto); err != nil { |
| 100 | + return c.String(http.StatusBadRequest, "bad request") |
| 101 | + } |
| 102 | + user := User{Name: dto.Name, Email: dto.Email, IsAdmin: false} |
| 103 | + executeSomeBusinessLogic(user) |
| 104 | + return c.JSON(http.StatusOK, user) |
| 105 | +}) |
| 106 | +``` |
| 107 | + |
| 108 | +## フルーエントバインディング |
| 109 | + |
| 110 | +単一ソースから明示的かつ型安全にバインドするには、フルーエント binder を使います。 |
| 111 | +設定をチェーンし、実行時にエラーを収集します。 |
| 112 | + |
| 113 | +```go |
| 114 | +// /api/search?active=true&id=1&id=2&id=3&length=25 |
| 115 | +var opts struct { |
| 116 | + IDs []int64 |
| 117 | + Active bool |
| 118 | +} |
| 119 | +length := int64(50) |
| 120 | + |
| 121 | +err := echo.QueryParamsBinder(c). |
| 122 | + Int64("length", &length). |
| 123 | + Int64s("id", &opts.IDs). |
| 124 | + Bool("active", &opts.Active). |
| 125 | + BindError() // first error, if any |
| 126 | +``` |
| 127 | + |
| 128 | +利用できる binder は `echo.QueryParamsBinder(c)`、`echo.PathValuesBinder(c)`、 |
| 129 | +`echo.FormFieldBinder(c)` です。チェーンは `BindError()`(最初のエラー)または |
| 130 | +`BindErrors()`(すべてのエラー)で終了します。`FailFast(false)` はチェーン全体を実行します。 |
| 131 | +デフォルトでは早期終了が有効です。 |
| 132 | + |
| 133 | +各サポート型には `Type(...)`、`MustType(...)`、`Types(...)`(スライス)、 |
| 134 | +`MustTypes(...)` メソッドがあります。例:`Int64`、`MustInt64`、`Int64s`。 |
| 135 | +カンマ区切りの値を分割するには `BindWithDelimiter("id", &dest, ",")` を使います。 |
| 136 | + |
| 137 | +## カスタム binder |
| 138 | + |
| 139 | +`Echo#Binder` でカスタム binder を登録します。 |
| 140 | + |
| 141 | +```go |
| 142 | +type CustomBinder struct{} |
| 143 | + |
| 144 | +func (cb *CustomBinder) Bind(c *echo.Context, i any) error { |
| 145 | + db := new(echo.DefaultBinder) |
| 146 | + if err := db.Bind(c, i); err != echo.ErrUnsupportedMediaType { |
| 147 | + return err |
| 148 | + } |
| 149 | + // custom logic here |
| 150 | + return nil |
| 151 | +} |
| 152 | + |
| 153 | +e.Binder = &CustomBinder{} |
| 154 | +``` |
0 commit comments