Form validation

The Form validation module is used for data validation and error collection.

Installing and testing

Installing:

  1. go get github.com/beego/beego/v2/core/validation

Testing:

  1. go test github.com/beego/beego/v2/core/validation

Localization

In order to localize validation error messages, one might use SetDefaultMessage function of the validation package.

Note that format markers (%d, %s) must be preserved in translated text to provide resulting messages with validation context values.

Default template messages are present in validation.MessageTmpls variable.

Simple message localization for Russian language:

  1. import "github.com/beego/beego/v2/core/validation"
  3. func init() {
  4.     validation.SetDefaultMessage(map[string]string{
  5.         "Required":     "Должно быть заполнено",
  6.         "Min":          "Минимально допустимое значение %d",
  7.         "Max":          "Максимально допустимое значение %d",
  8.         "Range":        "Должно быть в диапазоне от %d до %d",
  9.         "MinSize":      "Минимально допустимая длина %d",
  10.         "MaxSize":      "Максимально допустимая длина %d",
  11.         "Length":       "Длина должна быть равна %d",
  12.         "Alpha":        "Должно состоять из букв",
  13.         "Numeric":      "Должно состоять из цифр",
  14.         "AlphaNumeric": "Должно состоять из букв или цифр",
  15.         "Match":        "Должно совпадать с %s",
  16.         "NoMatch":      "Не должно совпадать с %s",
  17.         "AlphaDash":    "Должно состоять из букв, цифр или символов (-_)",
  18.         "Email":        "Должно быть в правильном формате email",
  19.         "IP":           "Должен быть правильный IP адрес",
  20.         "Base64":       "Должно быть представлено в правильном формате base64",
  21.         "Mobile":       "Должно быть правильным номером мобильного телефона",
  22.         "Tel":          "Должно быть правильным номером телефона",
  23.         "Phone":        "Должно быть правильным номером телефона или мобильного телефона",
  24.         "ZipCode":      "Должно быть правильным почтовым индексом",
  25.     })
  26. }

Examples:

Direct use:

  1. import (
  2.     "github.com/beego/beego/v2/core/validation"
  3.     "log"
  4. )
  6. type User struct {
  7.     Name string
  8.     Age int
  9. }
  11. func main() {
  12.     u := User{"man", 40}
  13.     valid := validation.Validation{}
  14.     valid.Required(u.Name, "name")
  15.     valid.MaxSize(u.Name, 15, "nameMax")
  16.     valid.Range(u.Age, 0, 18, "age")
  18.     if valid.HasErrors() {
  19.         // If there are error messages it means the validation didn't pass
  20.         // Print error message
  21.         for _, err := range valid.Errors {
  22.             log.Println(err.Key, err.Message)
  23.         }
  24.     }
  25.     // or use like this
  26.     if v := valid.Max(u.Age, 140, "age"); !v.Ok {
  27.         log.Println(v.Error.Key, v.Error.Message)
  28.     }
  29.     // Customize error messages
  30.     minAge := 18
  31.     valid.Min(u.Age, minAge, "age").Message("18+ only!!")
  32.     // Format error messages
  33.     valid.Min(u.Age, minAge, "age").Message("%d+", minAge)
  34. }

Use through StructTag

  1. import (
  2.     "log"
  3.     "strings"
  5.     "github.com/beego/beego/v2/core/validation"
  6. )
  8. // Set validation function in "valid" tag
  9. // Use ";" as the separator of multiple functions. Spaces accept after ";"
  10. // Wrap parameters with "()" and separate parameter with ",". Spaces accept after ","
  11. // Wrap regex match with "//"
  12. // 
  13. // 各个函数的结果的key值为字段名.验证函数名
  14. type user struct {
  15.     Id     int
  16.     Name   string `valid:"Required;Match(/^Bee.*/)"` // Name can't be empty or start with Bee
  17.     Age    int    `valid:"Range(1, 140)"` // 1 <= Age <= 140, only valid in this range
  18.     Email  string `valid:"Email; MaxSize(100)"` // Need to be a valid Email address and no more than 100 characters.
  19.     Mobile string `valid:"Mobile"` // Must be a valid mobile number
  20.     IP     string `valid:"IP"` // Must be a valid IPv4 address
  21. }
  23. // If your struct implemented interface `validation.ValidFormer`
  24. // When all tests in StructTag succeed, it will execute Valid function for custom validation
  25. func (u *user) Valid(v *validation.Validation) {
  26.     if strings.Index(u.Name, "admin") != -1 {
  27.         // Set error messages of Name by SetError and HasErrors will return true
  28.         v.SetError("Name", "Can't contain 'admin' in Name")
  29.     }
  30. }
  32. func main() {
  33.     valid := validation.Validation{}
  34.     u := user{Name: "Beego", Age: 2, Email: "dev@beego.vip"}
  35.     b, err := valid.Valid(&u)
  36.     if err != nil {
  37.         // handle error
  38.     }
  39.     if !b {
  40.         // validation does not pass
  41.         // blabla...
  42.         for _, err := range valid.Errors {
  43.             log.Println(err.Key, err.Message)
  44.         }
  45.     }
  46. }

Available validation functions in StrucTag:

  • Required not empty. :TODO 不为空，即各个类型要求不为其零值
  • Min(min int) minimum value. Valid type is int, all other types are invalid.
  • Max(max int) maximum value. Valid type is int, all other types are invalid.
  • Range(min, max int) Value range. Valid type is int, all other types are invalid.
  • MinSize(min int) minimum length. Valid type is string slice, all other types are invalid.
  • MaxSize(max int) maximum length. Valid type is string slice, all other types are invalid.
  • Length(length int) fixed length. Valid type is string slice, all other types are invalid.
  • Alpha alpha characters. Valid type is string, all other types are invalid.
  • Numeric numerics. Valid type is string, all other types are invalid.
  • AlphaNumeric alpha characters or numerics. Valid type is string, all other types are invalid.
  • Match(pattern string) regex matching. Valid type is string, all other types will be cast to string then match. (fmt.Sprintf(“%v”, obj).Match)
  • AlphaDash alpha characters or numerics or -_. Valid type is string, all other types are invalid.
  • Email Email address. Valid type is string, all other types are invalid.
  • IP IP address，Only support IPv4 address. Valid type is string, all other types are invalid.
  • Base64 base64 encoding. Valid type is string, all other types are invalid.
  • Mobile mobile number. Valid type is string, all other types are invalid.
  • Tel telephone number. Valid type is string, all other types are invalid.
  • Phone mobile number or telephone number. Valid type is string, all other types are invalid.
  • ZipCode zip code. Valid type is string, all other types are invalid.

API doc

Please see Go Walker