filter

golang 的数据过滤包，由 数据输入、格式化、校验、输出 几个部份组成。

• 每个步骤都可以自定义错误消息
• 过滤结果可以自动赋值到变量
• 支持批量操作，合并错误处理代码
• 可将多条过滤规则封装成函数，便于复用

github.com/dxvgef/filter/v3

请参考单元测试代码获得使用帮助，其它问题请在 Issues 里提出。

---

目录

• 字符串过滤
• 字符串切片过滤
• 整数过滤
• 整数切片过滤
• 浮点过滤
• 浮点切片过滤
• 布尔过滤
• 布尔切片过滤

字符串过滤

输入函数

• FromString() 输入string类型的数据

格式化函数

• ToUpper 字母转为大写
• ToLower 字母转为小写
• Trim 删除左右的指定字符
• TrimSpace 删除左右的空格
• TrimLeft 删除左边的指定字符串
• TrimRight 删除右边的指定字符串
• TrimPrefix 删除指定的前缀字符串
• TrimSuffix 删除指定的后缀字符串
• Replace 替换指定的字符串，可指定替换次数
• ReplaceAll 替换指定的字符串，替换所有
• RemoveSpace 删除字符串中所有出现的空格
• Base64StdEncode Base64 std 编码
• Base64StdDecode Base64 std 解码
• Base64RawStdEncode Base64 raw std 编码
• Base64RawStdDecode Base64 raw std 解码
• Base64URLEncode Base64 URL 编码
• Base64URLDecode Base64 URL 解码
• Base64RawURLEncode Base64 raw URL 编码
• Base64RawURLDecode Base64 raw URL 解码
• HTMLEscape 编码成HTML中显示的字符
• HTMLUnescape HTMLEscape的解码函数
• URLPathEscape 编码成能作为URL路径传输的字符
• URLPathUnescape URLPathEscape的解码函数
• URLQueryEscape 编码成能作为URL查询参数传输的字符
• URLQueryUnescape URLQueryEscape的解码函数

校验函数

• Require 参数不能为零值
• Length 字符串的长度必须为指定的值
• UTF8Length 按UTF8编码检查字符串的长度必须等于指定的值
• MinLength 字符串的长度不能小于指定的值
• UTF8MinLength 按UTF8编码检查字符串的长度不能小于指定的值
• MaxLength 字符串的长度不能大于指定的值
• UTF8MaxLength 按UTF8编码检查字符串的长度不能大于指定的值
• IsLower 必须是小写字母
• IsUpper 必须是大写字母
• IsLetter 必须是字母
• IsLowerOrNumber 必须是小写字母或数字
• IsUpperOrNumber 必须是大写字母或数字
• IsLetterOrNumber 必须是字母或数字
• IsChinese 必须是汉字
• IsMail 必须是电邮地址
• IsIP 必须是IPv4/v6地址
• IsTCPAddr 必须是IP or Host:Port格式
• IsMAC 必须是MAC地址
• IsJSON 必须是有效的JSON格式
• IsChineseIDcard 必须是中国大陆地区身份证号码
• IsSQLObject 必须是有效的SQL对象名(库、表、字段)
• IsUUID 必须是UUID格式
• IsULID 必须是ULID格式
• IsURL 必须是URL格式
• HasLetter 必须有字母
• HasLower 必须有小写字母
• HasUpper 必须有大写字母
• HasNumber 必须有数字
• HasSymbol 必须有符号
• HasPrefix 必须有指定的前缀字符串
• HasSuffix 必须有指定的后缀字符串
• Contains 必须包含指定的多个字符串
• AllowedChars 只允许存在指定的字符
• AllowedSymbols 只允许存在指定的符号（只校验符号）
• AllowedStrings 只允许存在指定的字符串（枚举）
• DeniedCharts 禁止存在指定的字符
• DeniedSymbols 禁止存在指定的符号（只校验符号）
• DeniedStrings 禁止存在指定的多个字符串

自定义处理函数

• Custom 自定义字符串处理函数，详见 CustomStringFunc

类型转换函数

• ToStringSlice 根据指定分隔符转为[]string类型的对象
• ToInteger 转为int64类型的对象
• ToIntegerSlice 根据指定分隔符转为[]int64类型的对象
• ToBoolean 转为bool类型的对象
• ToBooleanSlice 根据指定分隔符转为[]bool类型的对象
• ToFloat 转为float类型的对象
• ToFloatSlice 根据指定分隔符转为[]float类型的对象

输出函数

• Error 返回过滤中出现的错误（error类型）
• Value 返回当前值(string类型)
• DefaultValue 如果过滤失败则返回默认值，否则返回过滤后的值
• Result 返回 Value(), Error()
• Set 通过反射将处理结果值赋值到字符串类型的变量

---

字符串切片过滤

输入函数

• FromStringSlice 输入[]string类型的数据

格式化函数

• Trim 删除每个元素左右的指定字符
• TrimSpace 删除每个元素左右的空格
• TrimLeft 删除每个元素左边的指定字符串
• TrimRight 删除每个元素右边的指定字符串
• TrimPrefix 删除每个元素指定的前缀字符串
• TrimSuffix 删除每个元素指定的后缀字符串
• RemoveSpace 删除每个元素中所有出现的空格
• DeleteEmpty 删除空字符串的元素
• Base64StdEncode 对每个元素进行Base64 std 编码
• Base64StdDecode 对每个元素进行Base64 std 解码
• Base64RawStdEncode 对每个元素进行Base64 raw std 编码
• Base64RawStdDecode 对每个元素进行Base64 raw std 解码
• Base64URLEncode 对每个元素进行Base64 URL 编码
• Base64URLDecode 对每个元素进行Base64 URL 解码
• Base64RawURLEncode 对每个元素进行Base64 raw URL 编码
• Base64RawURLDecode 对每个元素进行Base64 raw URL 解码
• HTMLEscape 编码成HTML中显示的字符
• HTMLUnescape HTMLEscape的解码函数
• URLPathEscape 编码成能作为URL路径传输的字符
• URLPathUnescape URLPathEscape的解码函数
• URLQueryEscape 编码成能作为URL查询参数传输的字符
• URLQueryUnescape URLQueryEscape的解码函数

校验函数

• Require 切片元的素数量不能为零，且不能所有元素都为零值
• MinCount 切片元素的数量不能小于指定值
• MaxCount 切片元素的数量不能大于指定值
• EqualCount 切片元素的数量必须是指定值
• NotEqualCount 切片元素的数量不能是指定值
• Length 每个字符串元素的长度必须等于指定值
• UTF8Length 按UTF8编码检查每个字符串元素的长度必须等于指定值
• MinLength 每个字符串元素的长度不能小于指定值
• UTF8MinLength 按UTF8编码检查每个字符串元素的长度不能小于的指定值
• MaxLength 每个字符串元素的长度不能大于的指定值
• UTF8MaxLength 按UTF8编码检查每个字符串元素的长度不能大于的指定值
• IsLower 每个元素都必须是小写字母
• IsUpper 每个元素都必须是大写字母
• IsLetter 每个元素都必须是字母
• IsLowerOrNumber 每个元素都必须是小写字母或数字
• IsUpperOrNumber 每个元素都必须是大写字母或数字
• IsLetterOrNumber 每个元素都必须是字母或数字
• IsChinese 每个元素都必须是汉字
• IsMail 每个元素都必须是电邮地址
• IsIP 每个元素都必须是IPv4/v6地址
• IsTCPAddr 每个元素都必须是IP or Host:Port格式
• IsMAC 每个元素都必须是MAC地址
• IsSQLObject 每个元素都必须是有效的SQL对象名(库、表、字段)
• IsUUID 每个元素都必须是UUID格式
• IsULID 每个元素都必须是ULID格式
• Contains 每个元素都必须包含指定的字符串
• HasPrefix 每个元素都必须有指定的前缀字符串
• HasSuffix 每个元素都必须有指定的后缀字符串
• HasLetter 每个元素都必须包含字母
• HasLower 每个元素都必须包含小写字母
• HasUpper 每个元素都必须包含大写字母
• HasNumber 每个元素都必须包含数字
• HasSymbol 每个元素都必须包含符号
• AllowedChars 每个元素都只允许存在指定的字符
• AllowedSymbols 每个元素都只允许存在指定的符号（只校验符号）
• AllowedStrings 每个元素都只允许存在指定的字符串（枚举）
• DeniedCharts 每个元素都禁止存在指定的字符
• DeniedSymbols 每个元素都禁止存在指定的符号（只校验符号）
• DeniedStrings 每个元素都禁止存在指定的多个字符串

自定义处理函数

• Custom 自定义字符串处理函数，详见 CustomStringSliceFunc

输出函数

• Error 返回过滤中出现的错误（error类型）
• Value 返回当前值([]string类型)
• DefaultValue 如果过滤失败则返回默认值，否则返回过滤后的值
• Result 返回 Value(), Error()
• Set 通过反射将处理结果值赋值到字符串切片类型的变量

---

整数过滤

输入函数

• FromInteger 输入int64类型的数据

格式化函数

• Replace 替换指定的值

校验函数

• Require 不能为零值
• MinValue 不能小于指定值
• MaxValue 不能大于指定值
• AllowedValues 只允许是指定的多个值
• DeniedValues 禁止是指定的多个值

自定义处理函数

• Custom 自定义整数值处理函数，详见 CustomIntegerFunc

输出函数

• Error 返回过滤中出现的错误（error类型）
• Result 返回 int64, error
• Value 返回当前值(int64类型)
• Set 通过反射将处理结果值赋值到整数或无符号整数类型的变量
• Int 返回uint类型的数值
• DefaultInt 返回int类型的数值，如果失败则返回指定的默认值
• Int8 返回int8类型的数值
• DefaultInt8 返回int8类型的数值，如果失败则返回指定的默认值
• Int16 返回int16类型的数值
• DefaultInt16 返回int16类型的数值，如果失败则返回指定的默认值
• Int32 返回int32类型的数值
• DefaultInt32 返回int32类型的数值，如果失败则返回指定的默认值
• Int64 返回int64类型的数值
• DefaultInt64 返回int64类型的数值，如果失败则返回指定的默认值
• Uint 返回uint类型的数值
• DefaultUint 返回uint类型的数值，如果失败则返回指定的默认值
• Uint8 返回uint8类型的数值
• DefaultUint8 返回uint8类型的数值，如果失败则返回指定的默认值
• Uint16 返回uint16类型的数值
• DefaultUint16 返回uint16类型的数值，如果失败则返回指定的默认值
• Uint32 返回uint32类型的数值
• DefaultUint32 返回uint32类型的数值，如果失败则返回指定的默认值
• Uint64 返回uint64类型的数值
• DefaultUint64 返回uint64类型的数值，如果失败则返回指定的默认值

---

整数切片过滤

输入函数

• FromIntegerSlice 输入[]int64类型的数据

校验函数

• Require 切片元素的数量不能为零，且不能所有元素都为零值
• MinCount 切片元素的数量不能小于指定值
• MaxCount 切片元素的数量不能大于指定值
• EqualCount 切片元素的数量必须等于指定值
• NotEqualCount 切片元素的数量不能等于指定值
• MinValue 切片中不能存在值小于指定值的元素
• MaxValue 切片中不能存在值大于指定值的元素
• AllowedValues 只允许是指定的多个值
• DeniedValues 禁止是指定的多个值

自定义处理函数

• Custom 自定义整数值处理函数，详见 CustomIntegerSliceFunc

输出函数

• Error 返回过滤中出现的错误（error类型）
• Result 返回 int64, error
• Value 返回当前值([]int64类型)
• Set 通过反射将处理结果值赋值到整数切片或无符号整数切片类型的变量
• Int 返回uint类型的数值
• DefaultInt 返回int类型的数值，如果失败则返回指定的默认值
• Int8 返回int8类型的数值
• DefaultInt8 返回int8类型的数值，如果失败则返回指定的默认值
• Int16 返回int16类型的数值
• DefaultInt16 返回int16类型的数值，如果失败则返回指定的默认值
• Int32 返回int32类型的数值
• DefaultInt32 返回int32类型的数值，如果失败则返回指定的默认值
• Int64 返回int64类型的数值
• DefaultInt64 返回int64类型的数值，如果失败则返回指定的默认值
• Uint 返回uint类型的数值
• DefaultUint 返回uint类型的数值，如果失败则返回指定的默认值
• Uint8 返回uint8类型的数值
• DefaultUint8 返回uint8类型的数值，如果失败则返回指定的默认值
• Uint16 返回uint16类型的数值
• DefaultUint16 返回uint16类型的数值，如果失败则返回指定的默认值
• Uint32 返回uint32类型的数值
• DefaultUint32 返回uint32类型的数值，如果失败则返回指定的默认值
• Uint64 返回uint64类型的数值
• DefaultUint64 返回uint64类型的数值，如果失败则返回指定的默认值

---

浮点值过滤

输入函数

• FromFloat 输入float64类型的数据

校验函数

• Require 不能为零值
• MinValue 不能小于指定值
• MaxValue 不能大于指定值
• AllowedValues 只允许是指定的值
• DeniedValues 禁止是指定的值

自定义处理函数

• Custom 自定义整数值处理函数，详见 CustomFloatFunc

输出函数

• Error 返回过滤中出现的错误（error类型）
• Result 返回 int64, error
• Value 返回当前值(float64类型)
• Set 通过反射将处理结果值赋值到浮点类型的变量
• Float32 返回float32类型的数值
• DefaultFloat32 返回float32类型的数值，如果失败则返回指定的默认值
• Float64 返回float64类型的数值
• DefaultFloat64 返回float64类型的数值，如果失败则返回指定的默认值

---

浮点切片过滤

输入函数

• FromFloatSlice 输入[]float64类型的数据

校验函数

• Require 切片元素的数量不能为零，且不能所有元素都为零值
• MinCount 切片元素的数量不能小于指定值
• MaxCount 切片元素的数量不能大于指定值
• EqualCount 切片元素的数量必须等于指定的值
• NotEqualCount 切片元素的数量不能等于指定的值
• MinValue 切片中不能存在小于指定值的元素
• MaxValue 切片中不能存在大于指定值的元素
• AllowedValues 只允许是指定的多个值
• DeniedValues 禁止是指定的多个值

自定义处理函数

• Custom 自定义整数值处理函数，详见 CustomFloatSliceFunc

输出函数

• Error 返回过滤中出现的错误（error类型）
• Result 返回 int64, error
• Value 返回当前值([]float64类型)
• Set 通过反射将处理结果值赋值到浮点切片类型的变量
• Float32 返回float32类型的数值
• DefaultFloat32 返回float32类型的数值，如果失败则返回指定的默认值
• Float64 返回float64类型的数值
• DefaultFloat64 返回float64类型的数值，如果失败则返回指定的默认值

---

布尔值过滤

输入函数

• FromBoolean 输入bool类型的数据

校验函数

• Equal 必须等于指定值
• NotEqual 不能等于指定值

自定义处理函数

• Custom 自定义整数值处理函数，详见 CustomBooleanFunc

输出函数

• Error 返回过滤中出现的错误（error类型）
• Result 返回 int64, error
• Value 返回当前值(bool类型)
• DefaultValue 返回bool类型的数值，如果失败则返回指定的默认值
• Set 通过反射将处理结果值赋值到布尔类型的变量

---

布尔切片过滤

输入函数

• FromBooleanSlice 输入[]bool类型的数据

校验函数

• Has 至少有一个元素必须包含指定值
• Count 元素的数量必须等于指定值
• MinCount 元素的数量不能小于指定值
• MaxCount 元素的数量不能大于指定值

自定义处理函数

• Custom 自定义整数值处理函数，详见 CustomBooleanSliceFunc

输出函数

• Error 返回过滤中出现的错误（error类型）
• Result 返回 []bool, error
• Value 返回当前值([]bool类型)
• DefaultValue 返回[]bool类型的数值，如果失败则返回指定的默认值
• Set 通过反射将处理结果值赋值到布尔切片类型的变量