|
| 1 | +--- |
| 2 | +title: Binding |
| 3 | +description: Analise dados de request em structs Go tipadas a partir de path, query, header e body. |
| 4 | +sidebar: |
| 5 | + order: 5 |
| 6 | +--- |
| 7 | + |
| 8 | +Analisar dados de request é uma parte crucial de uma aplicação web. No Echo isso se chama |
| 9 | +_binding_, e ele pode ler de quatro partes de um request HTTP: |
| 10 | + |
| 11 | +- Parâmetros de caminho da URL |
| 12 | +- Parâmetros de query da URL |
| 13 | +- Headers |
| 14 | +- Body do request |
| 15 | + |
| 16 | +## Binding com tags de struct |
| 17 | + |
| 18 | +Defina uma struct com tags que especificam a fonte e a chave dos dados, então chame `c.Bind()` |
| 19 | +com um ponteiro para ela. Aqui o parâmetro de query `id` faz binding para o 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 | +### Fontes de dados |
| 34 | + |
| 35 | +| Tag | Fonte | |
| 36 | +| -------- | ----- | |
| 37 | +| `query` | Parâmetro de query | |
| 38 | +| `param` | Parâmetro de caminho | |
| 39 | +| `header` | Valor de header | |
| 40 | +| `form` | Dados de formulário (query + body) | |
| 41 | +| `json` | Body do request (`encoding/json`) | |
| 42 | +| `xml` | Body do request (`encoding/xml`) | |
| 43 | + |
| 44 | +Campos de path, query, header e form exigem uma **tag explícita**. JSON e XML usam |
| 45 | +o nome do campo da struct quando a tag é omitida, igual à biblioteca padrão. |
| 46 | + |
| 47 | +### Tipos de conteúdo do body |
| 48 | + |
| 49 | +Ao decodificar o body do request, o header `Content-Type` seleciona o decoder: |
| 50 | + |
| 51 | +- `application/json` |
| 52 | +- `application/xml` |
| 53 | +- `application/x-www-form-urlencoded` |
| 54 | + |
| 55 | +### Múltiplas fontes e precedência |
| 56 | + |
| 57 | +Um campo pode declarar várias fontes. Os dados fazem binding nesta ordem, cada etapa |
| 58 | +sobrescrevendo a anterior: |
| 59 | + |
| 60 | +1. Parâmetros de caminho |
| 61 | +2. Parâmetros de query (somente GET / DELETE) |
| 62 | +3. Body do 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 direto de uma fonte |
| 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 | +Headers **não** são incluídos por `c.Bind()`. Faça binding deles diretamente com `echo.BindHeaders`. |
| 81 | +::: |
| 82 | + |
| 83 | +:::caution[Segurança] |
| 84 | +Não faça binding diretamente em structs de negócio. Se uma struct vinculada expuser um campo `IsAdmin bool`, |
| 85 | +um body de request `{"IsAdmin": true}` o definiria. Use um DTO dedicado e faça o mapeamento |
| 86 | +explicitamente: |
| 87 | +::: |
| 88 | + |
| 89 | +```go |
| 90 | +type UserDTO struct { |
| 91 | + Name string `json:"name" form:"name" query:"name"` |
| 92 | + Email string `json:"email" form:"email" query:"email"` |
| 93 | +} |
| 94 | + |
| 95 | +e.POST("/users", func(c *echo.Context) error { |
| 96 | + var dto UserDTO |
| 97 | + if err := c.Bind(&dto); err != nil { |
| 98 | + return c.String(http.StatusBadRequest, "bad request") |
| 99 | + } |
| 100 | + user := User{Name: dto.Name, Email: dto.Email, IsAdmin: false} |
| 101 | + executeSomeBusinessLogic(user) |
| 102 | + return c.JSON(http.StatusOK, user) |
| 103 | +}) |
| 104 | +``` |
| 105 | + |
| 106 | +## Binding fluente |
| 107 | + |
| 108 | +Para binding explícito e type-safe de uma única fonte, use os binders fluentes. Eles |
| 109 | +encadeiam configuração e execução, coletando erros: |
| 110 | + |
| 111 | +```go |
| 112 | +// /api/search?active=true&id=1&id=2&id=3&length=25 |
| 113 | +var opts struct { |
| 114 | + IDs []int64 |
| 115 | + Active bool |
| 116 | +} |
| 117 | +length := int64(50) |
| 118 | + |
| 119 | +err := echo.QueryParamsBinder(c). |
| 120 | + Int64("length", &length). |
| 121 | + Int64s("id", &opts.IDs). |
| 122 | + Bool("active", &opts.Active). |
| 123 | + BindError() // first error, if any |
| 124 | +``` |
| 125 | + |
| 126 | +Binders disponíveis: `echo.QueryParamsBinder(c)`, `echo.PathValuesBinder(c)`, |
| 127 | +`echo.FormFieldBinder(c)`. Termine uma cadeia com `BindError()` (primeiro erro) ou |
| 128 | +`BindErrors()` (todos os erros). `FailFast(false)` executa a cadeia inteira; ele vem ativado por padrão. |
| 129 | + |
| 130 | +Cada tipo suportado oferece métodos `Type(...)`, `MustType(...)`, `Types(...)` (slices) e |
| 131 | +`MustTypes(...)` — por exemplo, `Int64`, `MustInt64`, `Int64s`. Use |
| 132 | +`BindWithDelimiter("id", &dest, ",")` para separar valores unidos por vírgula. |
| 133 | + |
| 134 | +## Binder customizado |
| 135 | + |
| 136 | +Registre um binder customizado via `Echo#Binder`: |
| 137 | + |
| 138 | +```go |
| 139 | +type CustomBinder struct{} |
| 140 | + |
| 141 | +func (cb *CustomBinder) Bind(c *echo.Context, i any) error { |
| 142 | + db := new(echo.DefaultBinder) |
| 143 | + if err := db.Bind(c, i); err != echo.ErrUnsupportedMediaType { |
| 144 | + return err |
| 145 | + } |
| 146 | + // custom logic here |
| 147 | + return nil |
| 148 | +} |
| 149 | + |
| 150 | +e.Binder = &CustomBinder{} |
| 151 | +``` |
0 commit comments