Spring Boot实现通用的接口参数校验

本文介绍基于 spring boot 和 jdk8 编写一个 aop ，结合自定义注解实现通用的接口参数校验。

缘由

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

public class accountvo {

private string name; // 姓名

private integer age; // 年龄

}

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

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

介绍

先来看看使用的方式：

@service

public class testimpl implements itestservice {

@override

@check({"name", "age"})

public void testvalid(accountvo vo) {

// ...

}

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

1	`@check({"id>=8",` `"name!=aaa",` `"title<10"})`

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

updateuserid must not null while calling testvalid

id must >= 8 while calling testvalid

name must != aaa while calling testvalid

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

@check({"title<=8:标题字数不超过8个字，含标点符号"})

public void testvalid(testpo po) {

// ...

}

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

ps：核心原理是通过反射获取参数实体中的字段的值，然后根据规则进行校验，所以目前只支持含有一个参数的方法，并且参数不能是基础类型。

使用

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

maven 依赖

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