|
| 1 | +--- |
| 2 | +title: Binding |
| 3 | +description: Analiza datos de request en structs Go tipados desde path, query, header y body. |
| 4 | +sidebar: |
| 5 | + order: 5 |
| 6 | +--- |
| 7 | + |
| 8 | +Analizar datos de request es una parte crucial de una aplicación web. En Echo esto se llama |
| 9 | +_binding_, y puede leer desde cuatro partes de un request HTTP: |
| 10 | + |
| 11 | +- Parámetros de path de URL |
| 12 | +- Parámetros de query de URL |
| 13 | +- Headers |
| 14 | +- Body del request |
| 15 | + |
| 16 | +## Binding con tags de struct |
| 17 | + |
| 18 | +Define un struct con tags que especifican el origen de datos y la clave, y luego llama a `c.Bind()` |
| 19 | +con un puntero a él. Aquí el parámetro de query `id` se vincula al campo `ID`: |
| 20 | + |
| 21 | +```go |
| 22 | +type User struct { |
| 23 | + ID string `query:"id"` |
| 24 | +} |
| 25 | + |
| 26 | +// handler for /users?id=<userID> |
| 27 | +var user User |
| 28 | +if err := c.Bind(&user); err != nil { |
| 29 | + return c.String(http.StatusBadRequest, "bad request") |
| 30 | +} |
| 31 | +``` |
| 32 | + |
| 33 | +### Orígenes de datos |
| 34 | + |
| 35 | +| Tag | Origen | |
| 36 | +| -------- | ------ | |
| 37 | +| `query` | Parámetro de query | |
| 38 | +| `param` | Parámetro de path | |
| 39 | +| `header` | Valor de header | |
| 40 | +| `form` | Datos de formulario (query + body) | |
| 41 | +| `json` | Body del request (`encoding/json`) | |
| 42 | +| `xml` | Body del request (`encoding/xml`) | |
| 43 | + |
| 44 | +Los campos de path, query, header y form requieren un **tag explícito**. JSON y XML usan |
| 45 | +el nombre del campo del struct cuando se omite el tag, igual que la biblioteca estándar. |
| 46 | + |
| 47 | +### Content types del body |
| 48 | + |
| 49 | +Al decodificar el body del request, el header `Content-Type` selecciona el decoder: |
| 50 | + |
| 51 | +- `application/json` |
| 52 | +- `application/xml` |
| 53 | +- `application/x-www-form-urlencoded` |
| 54 | + |
| 55 | +### Múltiples orígenes y precedencia |
| 56 | + |
| 57 | +Un campo puede declarar varios orígenes. Los datos se vinculan en este orden, y cada paso |
| 58 | +sobrescribe el anterior: |
| 59 | + |
| 60 | +1. Parámetros de path |
| 61 | +2. Parámetros de query (solo GET / DELETE) |
| 62 | +3. Body del request |
| 63 | + |
| 64 | +```go |
| 65 | +type User struct { |
| 66 | + ID string `param:"id" query:"id" form:"id" json:"id" xml:"id"` |
| 67 | +} |
| 68 | +``` |
| 69 | + |
| 70 | +### Binding directo desde un origen |
| 71 | + |
| 72 | +```go |
| 73 | +echo.BindBody(c, &payload) // request body |
| 74 | +echo.BindQueryParams(c, &payload) // query parameters |
| 75 | +echo.BindPathValues(c, &payload) // path parameters |
| 76 | +echo.BindHeaders(c, &payload) // headers |
| 77 | +``` |
| 78 | + |
| 79 | +:::note |
| 80 | +Los headers **no** están incluidos por `c.Bind()`. Vincúlalos directamente con `echo.BindHeaders`. |
| 81 | +::: |
| 82 | + |
| 83 | +:::caution[Seguridad] |
| 84 | +No vincules directamente a structs de negocio. Si un struct vinculado expone un campo `IsAdmin bool`, |
| 85 | +un body de request `{"IsAdmin": true}` lo establecería. Usa un DTO dedicado y mapéalo explícitamente: |
| 86 | +::: |
| 87 | + |
| 88 | +```go |
| 89 | +type UserDTO struct { |
| 90 | + Name string `json:"name" form:"name" query:"name"` |
| 91 | + Email string `json:"email" form:"email" query:"email"` |
| 92 | +} |
| 93 | + |
| 94 | +e.POST("/users", func(c *echo.Context) error { |
| 95 | + var dto UserDTO |
| 96 | + if err := c.Bind(&dto); err != nil { |
| 97 | + return c.String(http.StatusBadRequest, "bad request") |
| 98 | + } |
| 99 | + user := User{Name: dto.Name, Email: dto.Email, IsAdmin: false} |
| 100 | + executeSomeBusinessLogic(user) |
| 101 | + return c.JSON(http.StatusOK, user) |
| 102 | +}) |
| 103 | +``` |
| 104 | + |
| 105 | +## Binding fluido |
| 106 | + |
| 107 | +Para binding explícito y type-safe desde un único origen, usa los binders fluidos. Encadenan |
| 108 | +la configuración y la ejecutan, recopilando errores: |
| 109 | + |
| 110 | +```go |
| 111 | +// /api/search?active=true&id=1&id=2&id=3&length=25 |
| 112 | +var opts struct { |
| 113 | + IDs []int64 |
| 114 | + Active bool |
| 115 | +} |
| 116 | +length := int64(50) |
| 117 | + |
| 118 | +err := echo.QueryParamsBinder(c). |
| 119 | + Int64("length", &length). |
| 120 | + Int64s("id", &opts.IDs). |
| 121 | + Bool("active", &opts.Active). |
| 122 | + BindError() // first error, if any |
| 123 | +``` |
| 124 | + |
| 125 | +Binders disponibles: `echo.QueryParamsBinder(c)`, `echo.PathValuesBinder(c)`, |
| 126 | +`echo.FormFieldBinder(c)`. Termina una cadena con `BindError()` (primer error) o |
| 127 | +`BindErrors()` (todos los errores). `FailFast(false)` ejecuta toda la cadena; está activado por defecto. |
| 128 | + |
| 129 | +Cada tipo soportado ofrece métodos `Type(...)`, `MustType(...)`, `Types(...)` (slices) y |
| 130 | +`MustTypes(...)`, por ejemplo `Int64`, `MustInt64`, `Int64s`. Usa |
| 131 | +`BindWithDelimiter("id", &dest, ",")` para separar valores unidos por comas. |
| 132 | + |
| 133 | +## Binder personalizado |
| 134 | + |
| 135 | +Registra un binder personalizado mediante `Echo#Binder`: |
| 136 | + |
| 137 | +```go |
| 138 | +type CustomBinder struct{} |
| 139 | + |
| 140 | +func (cb *CustomBinder) Bind(c *echo.Context, i any) error { |
| 141 | + db := new(echo.DefaultBinder) |
| 142 | + if err := db.Bind(c, i); err != echo.ErrUnsupportedMediaType { |
| 143 | + return err |
| 144 | + } |
| 145 | + // custom logic here |
| 146 | + return nil |
| 147 | +} |
| 148 | + |
| 149 | +e.Binder = &CustomBinder{} |
| 150 | +``` |
0 commit comments