您现在的位置:首页 » 知识库 » 软件开发 » spring boot spring boot
Spring Boot实现通用的接口参数校验
发布日期:2018-05-15

缘由

目前参数校验常用的方法是在实体类上添加注解,但对于不同的方法,所应用的校验规则也是不一样的,例如有一个AccountVO实体:

假设存在这样一个业务:用户注册时需要填写姓名和年龄,用户登陆时只需要填写姓名就可以了。那么把校验规则加在实体类上显然就不合适了。

所以一直想实现一种方法级别的参数校验,对于同一个实体参数,不同的方法可以应用不同的校验规则,由此便诞生了这个工具,而且在日常工作中使用了很久。

介绍

先来看看使用的方式:

其中方法上的@Check注解指明了参数AccountVO中的name、age属性不能为空。除了非空校验外,还支持大小判断、是否等于等校验:

默认的错误信息会返回字段,错误原因和调用的方法,例如:

也支持自定义错误返回信息:

只需要在校验规则后加上:,后面写上自定义信息,就会替换默认的错误信息。

PS:

核心原理是通过反射获取参数实体中的字段的值,然后根据规则进行校验,

所以目前只支持含有一个参数的方法,并且参数不能是基础类型。

使用

spring-boot中如何使用AOP这里不再赘述,主要介绍AOP中的核心代码。

Maven 依赖

除了spring-boot依赖之外,需要的第三方依赖,不是核心的依赖,可以根据个人习惯取舍:

自定义注解

核心代码

通过切面拦截加上了@Check注解的接口方法,在方法执行前,执行参数校验,如果存在错误信息,则直接返回:

核心的校验方法在doCheck方法中,主要原理是获取注解上指定的字段名称和校验规则,通过反射获取参数实体中对应的字段的值,再进行校验:

可以看到主要的逻辑是:

解析字段 -> 获取字段的值 -> 执行校验规则

内部维护一个枚举类,相关的校验操作都在里面指定:

TODO

  • 以Spring Boot Starter的方式封装成独立组件

  • 支持正则表达式验证

  • 1.公司登记注册于2003年1月27日
    2.公司2006年起成为清远市政府定点协议供货商,电子采购供货商
    3.公司2007年被清远市相关政府部门评为安防行业状元
    4.公司2007年起成为长城电脑清远如意服务站(SP368)
    5.公司2007年承建清远市横河路口电子警察工程,开创清远电子警察先河。
  • 6.公司2007年起成为IBM合作伙伴、公司2010年底成为金蝶软件清远金牌代理(伙伴编号:30030013)
    7.公司组团队参加南方都市报组织的创富评选,获广东80强。公司申请多项软件著作权、专利权
    8.2016年起公司成为粤东西北地区为数不多的双软企业,确立“让软件驱动世界,让智能改变生活!"企业理想
  • 投资合作咨询热线电话:0763-3391888 3323588
  • 做一个负责任的百年企业! 天行健,君子以自强不息;地势坤,君子以厚德载物;
    为用户创造价值! 让软件驱动世界; 让智能改变生活; 超越顾客期望,帮助顾客成功;
    对客户负责,对员工负责,对企业命运负责!帮助支持公司的客户成功;帮助忠诚于公司的员工成功!
  • 联系电话:0763-3391888 3323588 3318977
    服务热线:18023314222 QQ:529623964
  • 工作QQ:2501204690 商务QQ: 602045550
    投资及业务投诉QQ: 529623964
    微信:小米哥 微信号:qysed3391888
    腾讯微博:桑达网络-基石与起点
  • E-MAIL:222#QYSED.CN ok3391888#163.com (请用@替换#)
  • 在线客服
  • 系统集成咨询
    点击这里给我发消息
  • 网站\微信\软件咨询
    点击这里给我发消息
  • 售后服务
    点击这里给我发消息
  • 投资合作
    点击这里给我发消息