- spring boot
-
缘由
目前参数校验常用的方法是在实体类上添加注解,但对于不同的方法,所应用的校验规则也是不一样的,例如有一个AccountVO实体:
假设存在这样一个业务:用户注册时需要填写姓名和年龄,用户登陆时只需要填写姓名就可以了。那么把校验规则加在实体类上显然就不合适了。
所以一直想实现一种方法级别的参数校验,对于同一个实体参数,不同的方法可以应用不同的校验规则,由此便诞生了这个工具,而且在日常工作中使用了很久。
介绍
先来看看使用的方式:
其中方法上的@Check注解指明了参数AccountVO中的name、age属性不能为空。除了非空校验外,还支持大小判断、是否等于等校验:
默认的错误信息会返回字段,错误原因和调用的方法,例如:
也支持自定义错误返回信息:
只需要在校验规则后加上:,后面写上自定义信息,就会替换默认的错误信息。
PS:
核心原理是通过反射获取参数实体中的字段的值,然后根据规则进行校验,
所以目前只支持含有一个参数的方法,并且参数不能是基础类型。
使用
spring-boot中如何使用AOP这里不再赘述,主要介绍AOP中的核心代码。
Maven 依赖
除了spring-boot依赖之外,需要的第三方依赖,不是核心的依赖,可以根据个人习惯取舍:
自定义注解
核心代码
通过切面拦截加上了@Check注解的接口方法,在方法执行前,执行参数校验,如果存在错误信息,则直接返回:
核心的校验方法在doCheck方法中,主要原理是获取注解上指定的字段名称和校验规则,通过反射获取参数实体中对应的字段的值,再进行校验:
可以看到主要的逻辑是:
解析字段 -> 获取字段的值 -> 执行校验规则
内部维护一个枚举类,相关的校验操作都在里面指定:
TODO
-
以Spring Boot Starter的方式封装成独立组件
-
支持正则表达式验证
-