请求参数验证
发布者:admin 发表于:417天前 阅读数:551 评论:0

对Web进行验证是一个难题。本节将探讨使用闭包来支持验证函数,并允许在初始化控制器结构时执行验证类型以增强灵活性。

我们将在结构上执行验证,但不会讨论如何填充结构。我们可以假设通过解析JSON,从表单输入或其他方法显式填充数据。

实践

建立 controller.go:

package validation

// Controller 保存了验证方法
type Controller struct {
    ValidatePayload func(p *Payload) error
}

// New 使用我们的本地验证初始化controller 它可以被覆盖
func New() *Controller {
    return &Controller{
        ValidatePayload: ValidatePayload,
    }
}

建立 validate.go:

package validation

import "errors"

// Verror是在验证期间发生的错误,我们可以将其返回给用户
type Verror struct {
    error
}

// Payload 是我们处理的内容
type Payload struct {
    Name string `json:"name"`
    Age  int    `json:"age"`
}

// ValidatePayload是我们控制器中闭包的1个实现
func ValidatePayload(p *Payload) error {
    if p.Name == "" {
        return Verror{errors.New("name is required")}
    }

    if p.Age <= 0 || p.Age >= 120 {
        return Verror{errors.New("age is required and must be a value greater than 0 and less than 120")}
    }
    return nil
}

建立 process.go:

package validation

import (
    "encoding/json"
    "fmt"
    "net/http"
)

// Process是一个验证post传入的数据
func (c *Controller) Process(w http.ResponseWriter, r *http.Request) {
    if r.Method != http.MethodPost {
        w.WriteHeader(http.StatusMethodNotAllowed)
        return
    }

    decoder := json.NewDecoder(r.Body)
    defer r.Body.Close()
    var p Payload

    if err := decoder.Decode(&p); err != nil {
        fmt.Println(err)
        w.WriteHeader(http.StatusBadRequest)
        return
    }

    if err := c.ValidatePayload(&p); err != nil {
        switch err.(type) {
        case Verror:
            w.WriteHeader(http.StatusBadRequest)
            // pass the Verror along
            w.Write([]byte(err.Error()))
            return
        default:
            w.WriteHeader(http.StatusInternalServerError)
            return
        }
    }
}

建立 main.go:

package main

import (
    "fmt"
    "net/http"

    "github.com/agtorre/go-cookbook/chapter7/validation"
)

func main() {
    c := validation.New()
    http.HandleFunc("/", c.Process)
    fmt.Println("Listening on port :3333")
    err := http.ListenAndServe(":3333", nil)
    panic(err)
}

运行:

go run main.go

这会输出

Listening on port :3333

进行请求测试:

$curl "http://localhost:3333/-X POST -d '{}'
name is required
$curl "http://localhost:3333/-X POST -d '{"name":"test"}'
age is required and must be a value greater than 0 and
less than 120
$curl "http://localhost:3333/-X POST -d '{"name":"test",
"age": 5}' -v

说明

我们通过将闭包传递给控制器结构来处理验证。这种方法的优点是我们可以在运行时模拟和替换验证函数,因此测试变得更加简单。 另外,我们没有绑定到单个函数签名,因此可以将诸如数据库连接之类的东西传递给验证函数。

另外需要关注的是返回了一个名为Verror的类型错误。此类型包含用于向用户显示的验证错误消息。这种方法的一个缺点是它不能同时处理多个验证消息。这可以通过修改Verror类型以允许更多状态(例如,通过包含映射)来实现,以便在从ValidatePayload函数返回之前容纳更多验证错误。说明

我们通过将闭包传递给控制器结构来处理验证。这种方法的优点是我们可以在运行时模拟和替换验证函数,因此测试变得更加简单。 另外,我们没有绑定到单个函数签名,因此可以将诸如数据库连接之类的东西传递给验证函数。