文档：https://pkg.go.dev/github.com/xeipuuv/gojsonschema

type JSONLoader

  1. type JSONLoader interface {
  2.     JsonSource() interface{}
  3.     LoadJSON() (interface{}, error)
  4.     JsonReference() (gojsonreference.JsonReference, error)
  5.     LoaderFactory() JSONLoaderFactory
  6. }
  8. func NewBytesLoader(source []byte) JSONLoader
  9. func NewStringLoader(source string) JSONLoader

type Schema

  1. type Schema struct {}
  3. func NewSchema(l JSONLoader) (*Schema, error)
  4. func (d *Schema) SetRootSchemaName(name string)
  5. func (v *Schema) Validate(l JSONLoader) (*Result, error)

type Result

  1. type Result struct {}
  3. func Validate(ls JSONLoader, ld JSONLoader) (*Result, error)
  4. func (v *Result) Errors() []ResultError
  5. func (v *Result) Valid() bool  // 是否没发现错误

type ResultError

  1. type ResultError interface {
  2.     // Field returns the field name without the root context
  3.     // i.e. firstName or person.firstName instead of (root).firstName or (root).person.firstName
  4.     Field() string
  5.     // SetType sets the error-type
  6.     SetType(string)
  7.     // Type returns the error-type
  8.     Type() string
  9.     // SetContext sets the JSON-context for the error
  10.     SetContext(*JsonContext)
  11.     // Context returns the JSON-context of the error
  12.     Context() *JsonContext
  13.     // SetDescription sets a description for the error
  14.     SetDescription(string)
  15.     // Description returns the description of the error
  16.     Description() string
  17.     // SetDescriptionFormat sets the format for the description in the default text/template format
  18.     SetDescriptionFormat(string)
  19.     // DescriptionFormat returns the format for the description in the default text/template format
  20.     DescriptionFormat() string
  21.     // SetValue sets the value related to the error
  22.     SetValue(interface{})
  23.     // Value returns the value related to the error
  24.     Value() interface{}
  25.     // SetDetails sets the details specific to the error
  26.     SetDetails(ErrorDetails)
  27.     // Details returns details about the error
  28.     Details() ErrorDetails
  29.     // String returns a string representation of the error
  30.     String() string
  31. }

Demo

  1. package main
  3. import (
  4.     "fmt"
  5.     "github.com/tidwall/gjson"
  6.     "github.com/xeipuuv/gojsonschema"
  7. )
  9. var schemaString = `
  10. {
  11.     "customize": {
  12.         "system_config": {
  13.             "properties": {
  14.                 "config_name": {
  15.                     "maxLength":100,
  16.                     "minLength":1,
  17.                     "pattern":"^[a-zA-Z0-9_]+$",
  18.                     "type":"string"
  19.                 },
  20.                 "desc": {
  21.                     "maxLength":256,
  22.                     "type":"string"
  23.                 },
  24.                 "payload": {
  25.                     "type":"object",
  26.                     "minProperties":1
  27.                 },
  28.                 "create_time": {
  29.                     "type":"integer"
  30.                 },
  31.                 "update_time": {
  32.                     "type":"integer"
  33.                 }
  34.             },
  35.             "required": [
  36.                 "config_name",
  37.                 "payload"
  38.             ],
  39.             "type":"object"
  40.         }
  41.    }
  42. }
  43. `
  45. type SystemConfig struct {
  46.     ConfigName string                 `json:"config_name"`
  47.     Desc       string                 `json:"desc,omitempty"`
  48.     Payload    map[string]interface{} `json:"payload,omitempty"`
  49. }
  51. func main() {
  52.     objString := gjson.Get(schemaString, "customize.system_config").String()
  53.     schemaLoader := gojsonschema.NewStringLoader(objString)
  54.     schema, err := gojsonschema.NewSchema(schemaLoader)
  55.     if err != nil {
  56.         panic(err)
  57.     }
  59.     var sc = SystemConfig{
  60.         ConfigName: "",
  61.         Payload:    nil,
  62.     }
  64.     goLoader := gojsonschema.NewGoLoader(sc)
  66.     // gojsonschema.Validate 每次 new 一个 schema, 效率低下
  67.     // result, err := gojsonschema.Validate(schemaLoader, goLoader)
  68.     result, err := schema.Validate(goLoader)
  69.     if err != nil {
  70.         panic(err.Error())
  71.     }
  73.     if result.Valid() {
  74.         fmt.Printf("The document is valid\n")
  75.     } else {
  76.         fmt.Printf("The document is not valid. see errors :\n")
  77.         for _, desc := range result.Errors() {
  78.             fmt.Printf("- %s\n", desc)
  79.         }
  80.     }
  81. }
  83. -----------------------------------------------------------------------------
  84. The document is not valid. see errors :
  85. - (root): payload is required
  86. - config_name: String length must be greater than or equal to 1
  87. - config_name: Does not match pattern '^[a-zA-Z0-9_]+$'