SpringBoot实现通用的接口参数校验，注解实战
source link: http://mp.weixin.qq.com/s?__biz=MzA3MTUzOTcxOQ%3D%3D&%3Bmid=2452969325&%3Bidx=1&%3Bsn=8f7e5d74918467ff4449b277a9efaa81
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
回复“ 1024 ”或 “ 面试题 ” 获取 4T架构师 资料
本文介绍基于 SpringBoot 和 JDK8 编写一个结合自定义注解实现通用的接口参数校验。
缘由
目前参数校验常用的方法是在实体类上添加注解，但对于不同的方法，所应用的校验规则也是不一样的，例如有一个 AccountVO 实体：
假设存在这样一个业务：用户注册时需要填写姓名和年龄，用户登陆时只需要填写姓名就可以了。那么把校验规则加在实体类上显然就不合适了。
所以一直想实现一种方法级别的参数校验，对于同一个实体参数，不同的方法可以应用不同的校验规则，由此便诞生了这个工具，而且在日常工作中使用了很久。
介绍
先来看看使用的方式：
其中方法上的 @Check 注解指明了参数 AccountVO 中的 name 、 age 属性不能为空。除了非空校验外，还支持大小判断、是否等于等校验：
默认的错误信息会返回字段，错误原因和调用的方法，例如：
也支持自定义错误返回信息：
只需要在校验规则后加上 : ，后面写上自定义信息，就会替换默认的错误信息。
PS：核心原理是通过反射获取参数实体中的字段的值，然后根据规则进行校验， 所以目前只支持含有一个参数的方法，并且参数不能是基础类型。
使用
spring-boot 中如何使用 AOP 这里不再赘述，主要介绍 AOP 中的核心代码。
Maven 依赖
除了 spring-boot 依赖之外，需要的第三方依赖，不是核心的依赖，可以根据个人习惯取舍：
自定义注解
核心代码
通过切面拦截加上了 @Check 注解的接口方法，在方法执行前，执行参数校验，如果存在错误信息，则直接返回：
核心的校验方法在 doCheck 方法中，主要原理是获取注解上指定的字段名称和校验规则，通过反射获取参数实体中对应的字段的值，再进行校验：
可以看到主要的逻辑是：
解析字段 -> 获取字段的值 -> 执行校验规则
内部维护一个枚举类，相关的校验操作都在里面指定：
由于篇幅原因，这里就不一一展开所有的代码，有兴趣的朋友可以到以下地址获取所有的源码：
https://github.com/ciphermagic/java-learn/tree/master/sandbox/src/main/java/com/cipher/checker
TODO
以Spring Boot Starter的方式封装成独立组件
支持正则表达式验证
作者：cipher
juejin.im/post/5af3c25b5188253064651c76
近期技术热文
1、 SpringBoot整合Activiti工作流（附源码）
2、 搞定 SpringBoot 整合 Spring Kafka深入探秘
4、 动图+源码+总结：演示 JDK8 中的数据结构(珍藏版)
5、 优雅停止SpringBoot服务，拒绝kill -9暴力停止！
Recommend
About Joyk
Aggregate valuable and interesting links.
Joyk means Joy of geeK