Предыдущие разделы представили метод прямого считывания параметров запроса. Если слишком громоздко считывать каждый параметр индивидуально, фреймворк Iris также предоставляет механизм привязки параметров, который может привязывать параметры запроса к структуре и поддерживает механизм валидации параметров формы.
Привязка моделей и валидация
Для привязки тела запроса к типу используйте привязку модели. В настоящее время мы поддерживаем привязку типов, таких как JSON, JSONProtobuf, Protobuf, MsgPack, XML, YAML и стандартные значения формы (foo=bar&boo=baz).
// Ниже приведены определения функций для привязки параметров запроса различных форматов к структуре
ReadJSON(outPtr interface{}) error
ReadJSONProtobuf(ptr proto.Message, opts ...ProtoUnmarshalOptions) error
ReadProtobuf(ptr proto.Message) error
ReadMsgPack(ptr interface{}) error
ReadXML(outPtr interface{}) error
ReadYAML(outPtr interface{}) error
ReadForm(formObject interface{}) error
ReadQuery(ptr interface{}) error
При использовании ReadBody Iris будет выводить привязку на основе заголовка Content-Type. Если вы уверены в содержимом, которое хотите привязать, вы можете использовать конкретные методы ReadXXX, такие как ReadJSON или ReadProtobuf.
ReadBody(ptr interface{}) error
Iris поставляется с интеллектуальной встроенной валидацией данных. Однако вы можете присоединить валидатор, который будет автоматически вызываться на методах, таких как ReadJSON, ReadXML и т. д. В этом примере мы узнаем, как использовать go-playground/validator/v10 для валидации тела запроса.
Обратите внимание, что необходимо установить соответствующие теги привязки на всех полях, которые будут привязаны. Например, при привязке из JSON установите json:"fieldname".
Вы также можете указать определенные поля как обязательные. Если поле имеет декорацию binding:"required", и при привязке не указано значение, будет возвращена ошибка.
package main
import (
"fmt"
"github.com/kataras/iris/v12"
"github.com/go-playground/validator/v10"
)
func main() {
app := iris.New()
app.Validator = validator.New()
userRouter := app.Party("/user")
{
userRouter.Get("/validation-errors", resolveErrorsDocumentation)
userRouter.Post("/", postUser)
}
app.Listen(":8080")
}
// Пользователь содержит информацию о пользователе.
type User struct {
FirstName string `json:"fname" validate:"required"` // Имя, обязательно
LastName string `json:"lname" validate:"required"` // Фамилия, обязательно
Age uint8 `json:"age" validate:"gte=0,lte=130"` // Возраст, диапазон от 0 до 130
Email string `json:"email" validate:"required,email"` // Электронная почта, обязательно
FavouriteColor string `json:"favColor" validate:"hexcolor|rgb|rgba"` // Любимый цвет, должен быть допустимым шестнадцатеричным, RGB или RGBA значением цвета
Addresses []*Address `json:"addresses" validate:"required,dive,required"` // Список адресов, не должен быть пустым и каждый элемент адреса обязателен
}
// Адрес хранит информацию об адресе пользователя.
type Address struct {
Street string `json:"street" validate:"required"` // Улица, обязательно
City string `json:"city" validate:"required"` // Город, обязательно
Planet string `json:"planet" validate:"required"` // Планета, обязательно
Phone string `json:"phone" validate:"required"` // Телефон, обязательно
}
type validationError struct {
ActualTag string `json:"tag"` // Фактический тег
Namespace string `json:"namespace"` // Пространство имён
Kind string `json:"kind"` // Вид
Type string `json:"type"` // Тип
Value string `json:"value"` // Значение
Param string `json:"param"` // Параметр
}
func wrapValidationErrors(errs validator.ValidationErrors) []validationError {
validationErrors := make([]validationError, 0, len(errs))
for _, validationErr := range errs {
validationErrors = append(validationErrors, validationError{
ActualTag: validationErr.ActualTag(),
Namespace: validationErr.Namespace(),
Kind: validationErr.Kind().String(),
Type: validationErr.Type().String(),
Value: fmt.Sprintf("%v", validationErr.Value()),
Param: validationErr.Param(),
})
}
return validationErrors
}
func postUser(ctx iris.Context) {
var user User
err := ctx.ReadJSON(&user)
if err != nil {
// Обработка ошибок, ниже приведен правильный способ...
if errs, ok := err.(validator.ValidationErrors); ok {
// Упаковка ошибок в формат JSON, базовая библиотека возвращает ошибки типа интерфейса.
validationErrors := wrapValidationErrors(errs)
// Возвращение ответа в формате application/json+problem и остановка выполнения последующих обработчиков
ctx.StopWithProblem(iris.StatusBadRequest, iris.NewProblem().
Title("Ошибки валидации").
Detail("Один или несколько полей не прошли валидацию").
Type("/user/validation-errors").
Key("errors", validationErrors))
return
}
// Может быть внутренняя ошибка JSON, здесь не предоставляется дополнительная информация.
ctx.StopWithStatus(iris.StatusInternalServerError)
return
}
ctx.JSON(iris.Map{"message": "OK"})
}
func resolveErrorsDocumentation(ctx iris.Context) {
ctx.WriteString("Эта страница используется для объяснения способов устранения ошибок валидации веб-разработчикам или пользователям API")
}
Пример запроса
{
"fname": "",
"lname": "",
"age": 45,
"email": "[email protected]",
"favColor": "#000",
"addresses": [{
"street": "Eavesdown Docks",
"planet": "Persphone",
"phone": "none",
"city": "Unknown"
}]
}
Пример ответа
{
"title": "Ошибка валидации",
"detail": "Один или несколько полей не прошли валидацию",
"type": "http://localhost:8080/user/validation-errors",
"status": 400,
"fields": [
{
"tag": "required",
"namespace": "User.FirstName",
"kind": "string",
"type": "string",
"value": "",
"param": ""
},
{
"tag": "required",
"namespace": "User.LastName",
"kind": "string",
"type": "string",
"value": "",
"param": ""
}
]
}
Привязка параметров запроса URL
Метод ReadQuery привязывает только параметры запроса, а не данные тела запроса. Используйте ReadForm для привязки данных тела запроса.
package main
import "github.com/kataras/iris/v12"
type Person struct {
Name string `url:"name,required"`
Address string `url:"address"`
}
func main() {
app := iris.Default()
app.Any("/", index)
app.Listen(":8080")
}
func index(ctx iris.Context) {
var person Person
if err := ctx.ReadQuery(&person); err != nil {
ctx.StopWithError(iris.StatusBadRequest, err)
return
}
ctx.Application().Logger().Infof("Person: %#+v", person)
ctx.WriteString("Success")
}
Привязка произвольных данных
Привяжите тело запроса к "ptr" на основе типа содержимого данных, отправленных клиентом, таких как JSON, XML, YAML, MessagePack, Protobuf, Form и запрос URL.
package main
import (
"time"
"github.com/kataras/iris/v12"
)
type Person struct {
Name string `form:"name" json:"name" url:"name" msgpack:"name"`
Address string `form:"address" json:"address" url:"address" msgpack:"address"`
Birthday time.Time `form:"birthday" time_format:"2006-01-02" time_utc:"1" json:"birthday" url:"birthday" msgpack:"birthday"`
CreateTime time.Time `form:"createTime" time_format:"unixNano" json:"create_time" url:"create_time" msgpack:"createTime"`
UnixTime time.Time `form:"unixTime" time_format:"unix" json:"unix_time" url:"unix_time" msgpack:"unixTime"`
}
func main() {
app := iris.Default()
app.Any("/", index)
app.Listen(":8080")
}
func index(ctx iris.Context) {
var person Person
if err := ctx.ReadBody(&person); err != nil {
ctx.StopWithError(iris.StatusBadRequest, err)
return
}
ctx.Application().Logger().Infof("Person: %#+v", person)
ctx.WriteString("Success")
}
Проверить можно с помощью следующей команды:
$ curl -X GET "localhost:8085/testing?name=kataras&address=xyz&birthday=1992-03-15&createTime=1562400033000000123&unixTime=1562400033"
Привязка параметров пути URL
package main
import "github.com/kataras/iris/v12"
type myParams struct {
Name string `param:"name"`
Age int `param:"age"`
Tail []string `param:"tail"`
}
func main() {
app := iris.Default()
app.Get("/{name}/{age:int}/{tail:path}", func(ctx iris.Context) {
var p myParams
if err := ctx.ReadParams(&p); err != nil {
ctx.StopWithError(iris.StatusInternalServerError, err)
return
}
ctx.Writef("myParams: %#v", p)
})
app.Listen(":8088")
}
Запрос
$ curl -v http://localhost:8080/kataras/27/iris/web/framework
Привязка параметров заголовка запроса
package main
import "github.com/kataras/iris/v12"
type myHeaders struct {
RequestID string `header:"X-Request-Id,required"`
Authentication string `header:"Authentication,required"`
}
func main() {
app := iris.Default()
r.GET("/", func(ctx iris.Context) {
var hs myHeaders
if err := ctx.ReadHeaders(&hs); err != nil {
ctx.StopWithError(iris.StatusInternalServerError, err)
return
}
ctx.JSON(hs)
})
app.Listen(":8080")
}
Запрос
curl -H "x-request-id:373713f0-6b4b-42ea-ab9f-e2e04bc38e73" -H "authentication: Bearer my-token" \
http://localhost:8080
Ответ
{
"RequestID": "373713f0-6b4b-42ea-ab9f-e2e04bc38e73",
"Authentication": "Bearer my-token"
}