Table of Contents

Class ConfigValidationBuilder

Namespace
Apq.Cfg.Validation
Assembly
Apq.Cfg.dll

配置验证构建器,提供流式 API 构建验证规则

public sealed class ConfigValidationBuilder
Inheritance
ConfigValidationBuilder
Inherited Members

Methods

AddRule(IValidationRule)

添加自定义验证规则

public ConfigValidationBuilder AddRule(IValidationRule rule)

Parameters

rule IValidationRule

验证规则

Returns

ConfigValidationBuilder

构建器实例,支持链式调用

AddRules(IEnumerable<IValidationRule>)

添加多个自定义验证规则

public ConfigValidationBuilder AddRules(IEnumerable<IValidationRule> rules)

Parameters

rules IEnumerable<IValidationRule>

验证规则列表

Returns

ConfigValidationBuilder

构建器实例,支持链式调用

Build()

构建配置验证器

public IConfigValidator Build()

Returns

IConfigValidator

配置验证器

Custom(string, Func<string?, bool>, string, string?)

添加自定义验证规则

public ConfigValidationBuilder Custom(string key, Func<string?, bool> validator, string errorMessage, string? ruleName = null)

Parameters

key string

配置键

validator Func<string, bool>

验证函数,返回 true 表示验证通过

errorMessage string

错误消息

ruleName string

规则名称

Returns

ConfigValidationBuilder

构建器实例,支持链式调用

DependsOn(string, string, string?)

添加依赖验证规则

public ConfigValidationBuilder DependsOn(string key, string dependencyKey, string? errorMessage = null)

Parameters

key string

配置键

dependencyKey string

依赖的配置键

errorMessage string

自定义错误消息

Returns

ConfigValidationBuilder

构建器实例,支持链式调用

Length(string, int?, int?, string?)

添加字符串长度验证规则

public ConfigValidationBuilder Length(string key, int? minLength = null, int? maxLength = null, string? errorMessage = null)

Parameters

key string

配置键

minLength int?

最小长度(null 表示不限制)

maxLength int?

最大长度(null 表示不限制)

errorMessage string

自定义错误消息

Returns

ConfigValidationBuilder

构建器实例,支持链式调用

MaxLength(string, int, string?)

添加最大长度验证规则

public ConfigValidationBuilder MaxLength(string key, int maxLength, string? errorMessage = null)

Parameters

key string

配置键

maxLength int

最大长度

errorMessage string

自定义错误消息

Returns

ConfigValidationBuilder

构建器实例,支持链式调用

MinLength(string, int, string?)

添加最小长度验证规则

public ConfigValidationBuilder MinLength(string key, int minLength, string? errorMessage = null)

Parameters

key string

配置键

minLength int

最小长度

errorMessage string

自定义错误消息

Returns

ConfigValidationBuilder

构建器实例,支持链式调用

OneOf(string, IEnumerable<string>, bool, string?)

添加枚举值验证规则

public ConfigValidationBuilder OneOf(string key, IEnumerable<string> allowedValues, bool ignoreCase = false, string? errorMessage = null)

Parameters

key string

配置键

allowedValues IEnumerable<string>

允许的值列表

ignoreCase bool

是否忽略大小写

errorMessage string

自定义错误消息

Returns

ConfigValidationBuilder

构建器实例,支持链式调用

OneOf(string, params string[])

添加枚举值验证规则

public ConfigValidationBuilder OneOf(string key, params string[] allowedValues)

Parameters

key string

配置键

allowedValues string[]

允许的值列表

Returns

ConfigValidationBuilder

构建器实例,支持链式调用

Range(string, DateTime, DateTime, string?)

添加日期时间范围验证规则

public ConfigValidationBuilder Range(string key, DateTime min, DateTime max, string? errorMessage = null)

Parameters

key string

配置键

min DateTime

最小值

max DateTime

最大值

errorMessage string

自定义错误消息

Returns

ConfigValidationBuilder

构建器实例,支持链式调用

Range(string, decimal, decimal, string?)

添加十进制数范围验证规则

public ConfigValidationBuilder Range(string key, decimal min, decimal max, string? errorMessage = null)

Parameters

key string

配置键

min decimal

最小值

max decimal

最大值

errorMessage string

自定义错误消息

Returns

ConfigValidationBuilder

构建器实例,支持链式调用

Range(string, double, double, string?)

添加双精度浮点数范围验证规则

public ConfigValidationBuilder Range(string key, double min, double max, string? errorMessage = null)

Parameters

key string

配置键

min double

最小值

max double

最大值

errorMessage string

自定义错误消息

Returns

ConfigValidationBuilder

构建器实例,支持链式调用

Range(string, int, int, string?)

添加整数范围验证规则

public ConfigValidationBuilder Range(string key, int min, int max, string? errorMessage = null)

Parameters

key string

配置键

min int

最小值

max int

最大值

errorMessage string

自定义错误消息

Returns

ConfigValidationBuilder

构建器实例,支持链式调用

Range(string, long, long, string?)

添加长整数范围验证规则

public ConfigValidationBuilder Range(string key, long min, long max, string? errorMessage = null)

Parameters

key string

配置键

min long

最小值

max long

最大值

errorMessage string

自定义错误消息

Returns

ConfigValidationBuilder

构建器实例,支持链式调用

Regex(string, string, string?, RegexOptions)

添加正则表达式验证规则

public ConfigValidationBuilder Regex(string key, string pattern, string? errorMessage = null, RegexOptions options = RegexOptions.None)

Parameters

key string

配置键

pattern string

正则表达式模式

errorMessage string

自定义错误消息

options RegexOptions

正则表达式选项

Returns

ConfigValidationBuilder

构建器实例,支持链式调用

Required(string, string?)

添加必填验证规则

public ConfigValidationBuilder Required(string key, string? errorMessage = null)

Parameters

key string

配置键

errorMessage string

自定义错误消息

Returns

ConfigValidationBuilder

构建器实例,支持链式调用

Required(params string[])

添加多个必填验证规则

public ConfigValidationBuilder Required(params string[] keys)

Parameters

keys string[]

配置键列表

Returns

ConfigValidationBuilder

构建器实例,支持链式调用