validator/define/rule.go

69 lines
3.1 KiB
Go
Raw Normal View History

2024-04-29 12:17:18 +08:00
// Package define ...
//
// Description : define ...
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 2024-04-29 10:51
package define
// FieldRule 字段验证规则
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 10:52 2024/4/29
type FieldRule struct {
Path string `json:"path"` // 字段路径
Type string `json:"type"` // 数据类型, 具体枚举值参见 git.zhangdeman.cn/zhangdeman/consts
2024-04-29 17:29:46 +08:00
DisableRewrite bool `json:"disable_rewrite"` // 验证完相关数据类型之后, 不要重新给字段赋值
2024-04-29 12:17:18 +08:00
DefaultValue string `json:"default_value"` // 默认值, 统一以字符串传入, 会转为最终设置的类型
IsRequired bool `json:"is_required"` // 是否必传
2024-04-29 14:08:50 +08:00
AllowEmpty bool `json:"allow_empty"` // 必传时空字符串是否合法
AllowZero bool `json:"allow_zero"` // 必传数字, 0 是否合法
AllowNil bool `json:"allow_nil"` // 必传时, nil值是否合法
2024-04-29 12:17:18 +08:00
RequiredConditionGroup [][]RequiredCondition `json:"required_condition_group"` // 满足何种条件,字段必传,不配置则为无差别必传, 组之间是或条件, 满足一组即命中, 组之内为与条件
ValueLimit *ValueLimit `json:"value_limit"` // 数据值的限制
}
// RequiredCondition 定义必传条件
//
// Author : zhangdeman001@ke.com<张德满>
//
// Date : 10:58 2024/4/29
type RequiredCondition struct {
2024-04-29 17:29:46 +08:00
DependOnField string `json:"depend_on_field"` // 依赖数据园中的那一个字段
DependOnFieldStatus []string `json:"depend_on_field_status"` // 依赖数据状态 : NOT_FOUND / IS_NIL / IS_ZERO / IS_EMPTY / IS_FALSE
2024-04-29 12:17:18 +08:00
}
// ValueLimit 取值的限制
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 11:15 2024/4/29
type ValueLimit struct {
2024-04-29 17:29:46 +08:00
EnumList []string `json:"enum_list"` // 枚举值列表, 仅对 int / float / string 生效
Min *float64 `json:"min"` // 最小值(包含), 对于 int/float, 此值为最小取值, 对于int/map/slice辞职问最小长度
Max *float64 `json:"max"` // 最大值(不包含), 对于 int/float, 此值为最大取值, 对于int/map/slice辞职问最大长度
String *StringValueLimit `json:"string"` // 字符串值的限制
Map *MapValueLimit `json:"map"` // map验证
2024-04-29 12:17:18 +08:00
}
// StringValueLimit 字符串类型值的限制
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 11:16 2024/4/29
type StringValueLimit struct {
AutoTrimSpace bool `json:"auto_trim_space"` // 自动去除前后空格
IncludeSubStrList []string `json:"include_sub_str_list"` // 必须包含指定的子串
}
// MapValueLimit map数据的限制
//
// Author : go_developer@163.com<白茶清欢>
//
// Date : 11:23 2024/4/29
type MapValueLimit struct {
IncludeFieldList []string `json:"include_field_list"` // 必须存在的字段列表
}