变更日志

特性

创作目的

hibernate-validator 无法满足的场景

validation-api 过于复杂

自定义缺乏灵活性

过程式编程 vs 注解式编程

快速开始

准备工作

maven 引入

<dependency>    <groupId>com.github.houbb</groupId>    <artifactId>validator-core</artifactId>    <version>0.7.0</version></dependency>

快速入门

定义对象

publicclassUser {/**     * 名称     */@HasNotNull({"nickName"})privateStringname;/**     * 昵称     */privateStringnickName;/**     * 原始密码     */@AllEquals("password2")privateStringpassword;/**     * 新密码     */privateStringpassword2;/**     * 性别     */@Ranges({"boy","girl"})privateStringsex;/**     * 失败类型枚举     */@EnumRanges(FailTypeEnum.class)privateStringfailType;//getter & setter}

ValidHelper 工具方法

// 对象定义Useruser =newUser();user.sex("what").password("old").password2("new");// 调用方法IResultresult =ValidHelper.failFast(user);

DefaultResult{pass=false, notPassList=[DefaultConstraintResult{pass=false, message='name: 值 <null> 不是预期值', value=null, constraint='HasNotNullConstraint', expectValue='', fieldName='name'}], allList=null}

publicinterfaceIResult {/**     * 是否全部通过验证     * @return 是否     * @since 0.1.0     */booleanpass();/**     * 未通过的列表信息     * @return 验证结果     * @since 0.1.0     */List<IConstraintResult>notPassList();/**     * 所有的验证结果列表     * @return 所有的验证结果     * @since 0.1.0     */List<IConstraintResult>allList();/**     * 输出信息到控台     * （1）主要是为了方便调整     * （2）该功能其实可以做增强，比如输出到文件/数据库等等。     * @return this     * @since 0.0.6     */IResultprint();/**     * 对于未通过的信息，     * （1）未通过的界定。     *  {@link IConstraintResult#pass()} 为 false     *     * （2）内容信息     * 抛出运行时异常 {@link com.github.houbb.validator.api.exception.ValidRuntimeException}，异常信息为 {@link IConstraintResult#message()} 消息     * （3）内容限定     *  为了避免异常内容过多，只抛出第一条即可。     *  （4）改方法的增强空间     *  4.1 可以指定什么情况下抛出异常     *  4.2 抛出异常的信息和类别     *     * @return this     * @since 0.0.6     */IResultthrowsEx();}

注解说明

内置约束注解

JSR-303 / jakarta bean validation 约束注解支持

hibernate-validator 约束注解支持

条件注解

说明

内置注解

使用

publicclassConditionUser {/**     * 操作类型     */@Ranges({"create","edit"})privateStringoperType;/**     * 新建时，name 必填     */@EqualsCondition(value ="create",fieldName ="operType")@Size(min =3)@NotNullprivateStringname;/**     * 不是新建时, id 字段必填     */@NotEqualsCondition(value ="create",fieldName ="operType")@Size(min =16)privateStringid;//getter & setter}

过程式接口

说明

ValidHelper 方法

使用例子

IResultresult =ValidHelper.failFast("",Constraints.notEmpty());

IConstraint 对应关系

JSR-303 / jakarta bean validation 约束注解支持

## hibernate-validator 约束注解支持

条件注解

注解自定义

说明

约束注解 @Constraint

定义注解

@Target(ElementType.FIELD)@Retention(RetentionPolicy.RUNTIME)@Constraint(AtAllEqualsConstraint.class)public @interfaceAllEquals {/**     * 当前字段及其指定的字段 全部相等     * 1. 字段类型及其他字段相同     * @return 指定的字段列表     */String[]value();/**     * 提示消息     * @return 错误提示     */Stringmessage()default"";/**     * 分组信息     * @return 分组类     * @since 0.1.2     */Class[]group()default {};}

实现逻辑

publicclassAtAllEqualsConstraintextendsAbstractAnnotationConstraint<AllEquals> {@OverrideprotectedIConstraintbuildConstraint(AllEqualsannotation) {returnConstraints.allEquals(annotation.value());    }}

条件注解 @Condition

定义注解

@Target(ElementType.FIELD)@Retention(RetentionPolicy.RUNTIME)@Condition(AtAlwaysTrueCondition.class)public @interfaceAlwaysTrueCondition {}

实现逻辑

publicclassAtAlwaysTrueConditionextendsAbstractAnnotationCondition<AlwaysTrueCondition> {@OverrideprotectedIConditionbuildCondition(AlwaysTrueConditionannotation) {returnConditions.alwaysTrue();    }}

开源地址

ROAD-MAP