Go-Playground Validator 使用教程

Go-Playground Validator 使用教程

validator:100:Go Struct and Field validation, including Cross Field, Cross Struct, Map, Slice and Array diving项目地址:https://gitcode.com/gh_mirrors/va/validator

项目介绍

Go-Playground Validator 是一个用于 Go 语言的数据验证库。它提供了丰富的验证功能，支持结构体标签（struct tags）定义验证规则，使得数据验证变得简单而直观。该库广泛应用于 Go 项目的表单验证、配置验证等场景。

项目快速启动

安装

首先，你需要安装 Go-Playground Validator 库。你可以通过以下命令进行安装：

go get github.com/go-playground/validator/v10

基本使用

以下是一个简单的示例，展示了如何使用 Go-Playground Validator 进行数据验证：

package main

import (
	"fmt"
	"github.com/go-playground/validator/v10"
)

type User struct {
	Name  string `validate:"required"`
	Email string `validate:"required,email"`
	Age   int    `validate:"gte=0,lte=130"`
}

func main() {
	validate := validator.New()

	user := &User{
		Name:  "John Doe",
		Email: "john.doe@example.com",
		Age:   30,
	}

	err := validate.Struct(user)
	if err != nil {
		fmt.Println("Validation failed:", err)
	} else {
		fmt.Println("Validation passed")
	}
}

应用案例和最佳实践

表单验证

在 Web 开发中，表单验证是一个常见的需求。Go-Playground Validator 可以很好地满足这一需求。以下是一个简单的表单验证示例：

type RegisterForm struct {
	Username string `validate:"required,min=3,max=32"`
	Password string `validate:"required,min=6"`
	Email    string `validate:"required,email"`
}

func validateForm(form RegisterForm) error {
	validate := validator.New()
	return validate.Struct(form)
}

配置验证

在应用程序中，配置文件的验证同样重要。以下是一个配置验证的示例：

type AppConfig struct {
	Port     int    `validate:"required,gte=1,lte=65535"`
	LogLevel string `validate:"required,oneof=debug info warning error"`
}

func validateConfig(config AppConfig) error {
	validate := validator.New()
	return validate.Struct(config)
}

典型生态项目

Go-Playground Validator 可以与其他 Go 生态项目结合使用，以实现更复杂的功能。以下是一些典型的生态项目：

Gin 框架

Gin 是一个高性能的 Web 框架，可以与 Go-Playground Validator 结合使用，实现强大的表单验证功能：

func main() {
	r := gin.Default()
	r.POST("/register", func(c *gin.Context) {
		var form RegisterForm
		if err := c.ShouldBindJSON(&form); err != nil {
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
			return
		}

		if err := validateForm(form); err != nil {
			c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
			return
		}

		c.JSON(http.StatusOK, gin.H{"message": "Registration successful"})
	})
	r.Run()
}

Echo 框架

Echo 是另一个流行的 Go Web 框架，同样可以与 Go-Playground Validator 结合使用：

func main() {
	e := echo.New()
	e.POST("/register", func(c echo.Context) error {
		var form RegisterForm
		if err := c.Bind(&form); err != nil {
			return c.JSON(http.StatusBadRequest, map[string]string{"error": err.Error()})
		}

		if err := validateForm(form); err != nil {
			return c.JSON(http.StatusBadRequest, map[string]string{"error": err.Error()})
		}

		return c.JSON(http.StatusOK, map[string]string{"message": "Registration successful"})
	})
	e.Start(":8

validator:100:Go Struct and Field validation, including Cross Field, Cross Struct, Map, Slice and Array diving项目地址:https://gitcode.com/gh_mirrors/va/validator