文档章节

Spring MVC 通过切面,实现超灵活的注解式数据校验

DiamondFsd
 DiamondFsd
发布于 2017/02/17 09:41
字数 2306
阅读 5522
收藏 437

这篇文在主要是介绍,如何在 Controller 的方法里面,让校验注解 ( @NotNull @Email @Size...等),对基本类型的数据生效(基本类型 Integer,String,Long等)。

Spring MVC 有什么校验方式?

大家都知道,Spring MVC 默认依赖了 hibernate-validator 校验框架。使用这个,我们可以在可以在model的字段上,加相应的校验注解来轻松的实现数据校验。 例如:

// 实体类
public class User {
  @NotNull
  private String username;
  
  @NotBlank
  @Length(min = 6, max = 32)
  private String password;

}

// Controller 请求
@RequestMapping("save-user")
 // 使用 @Valid 注解,告诉 Spring MVC 要校验 user 对象的数据
public User save(@Valid User user){
.....
}

相信大家都有接触过,使用这种方法来实现整体对象的校验,而且还可以根据不同场景,加上不同的 @Group 注解,来实现不同请求对数据的校验规则。

我们想实现什么?

但是有些时候,我们的请求参数并不多,可能只是一些零碎的基本类型的参数 例如 String Integer Long 等等。就像下面这个请求:

@RequestMapping("update-user-status")
public User update(String userId, Integer status){
....
}

这种情况相信大家经常遇到,大部分情况下,我们都需要对接收过来的数据做校验。 如果接收过来的是基本类型,我们一般都是包装一些工具类,然后通过编码的方式来实现校验。如果这个时候,我们想用 @NotNull, @Email,@Size 等校验注解,直接加在参数上,是做不到的。
例如这样,spring mvc 是不支持的。

@RequestMapping("update-user-status")
public User update( 
              @NotNull String userId, 
              @NotNull @Range(min = 0, max = 5) Integer status){
....
}

那么这篇文章主要就是讲解,如何让加在基本类型上的校验注解生效,最终实现上代码所呈现的效果,在基本类型参数上校验注解,执行校验逻辑。

Hibernate-Validator 方法参数校验说明

因为Spring MVC 默认使用的是 Hibernate-Validator 来进行数据校验,那么我首先瞄准的目标也就是看看 Hibernate-Validator 有没有什么方法可以直接对方法的参数进行校验。
最终我在官方文档里找到,ExecutableValidator这个接口里有一个 validateParameters,实现我们想要的功能,该方法声明如下:

interface ExecutableValidator{
//...
 <T> Set<ConstraintViolation<T>> validateParameters(
                              T object, // 需要校验的方法所属对象
                              Method method,  // 需要校验的方法
                              Object[] parameterValues, // 需要交验的方法对应的参数
                              Class<?>... groups);  // 校验组(这里我们暂时用不到)
//...
}

如何使用呢? 我写了一个测试类来测试这个方法具体返回的内容。

package diamond.cms.server.mvc.valid;

import java.lang.reflect.Method;
import java.util.Set;

import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.ValidatorFactory;
import javax.validation.constraints.NotNull;
import javax.validation.executable.ExecutableValidator;

import org.hibernate.validator.constraints.NotBlank;
import org.hibernate.validator.constraints.Range;
import org.junit.Test;

public class ExecutableValidatorTest {

    @Test
    public void hibernateVaildTest() throws NoSuchMethodException, SecurityException {
        // 需要校验的方法实例
        ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
        ExecutableValidator validator = factory.getValidator().forExecutables();

        Method method = this.getClass().getMethod("vaildMethod",  Integer.class, String.class, String.class);
        // 校验参数,应该是有两个非法的参数
        Object [] params = new Object[]{100, "", "test"};

        // 获得校验结果 Set 集合,有多少个字段校验错误 Set 的大小就是多少
        Set<ConstraintViolation<ExecutableValidatorTest>> constraintViolationSet =
                validator.validateParameters(this, method, params);

        System.out.println("非法参数校验结果条数: " + constraintViolationSet.size());
        constraintViolationSet.forEach(cons -> {
            System.out.println("非法消息: " + cons.getMessage());
        });

        params = new Object[]{10, "build-test", "test"};
        constraintViolationSet =
                validator.validateParameters(this, method, params);

        System.out.println("合法参数校验结果条数: " + constraintViolationSet.size());
    }

    // 校验示范方法
    public void vaildMethod(@NotNull @Range(min = 0, max = 18)Integer age,@NotBlank String build, String test){}
}

上面的方法最终输出:

非法参数校验结果条数: 2
非法消息: 需要在0和18之间
非法消息: 不能为空
合法参数校验结果条数: 0

获得校验所需参数,统一处理进行数据校验

如何去使用我们上面提到的数据校验方法呢?首先我们要想,如何去获得我们需要的参数。我们需要以下参数:

  1. 请求执行的目标对象
  2. 请求执行的方法
  3. 请求的参数

有两种方式来获得:

1. 通过实现 HandlerInterceptor 拦截器来实现

因为通过拦截器实现,有很多坑要填,这里不推荐使用。主要讲第二个方法,通过AOP来实现校验数据获取。

2. 通过 AOP(切面)来实现校验数据获取

首先说,推荐使用这种方式,上面的那个方式在这篇文章里只是说说而已。我们来讲一讲,如何实现这样一个切面,来获取我们校验数据所需的参数。

首先定义一个切面,切入点是所有 controllers 包下所有类的所有方法。 最后我们定义一个方法,在切入点方法之前执行。

当执行到Controller这一层的时候,所有的数据已经被Spring MVC处理好了,包括数据类型的转换,自定义的WebDataBinder等。所以我们可以直接通过切面获得所需的校验参数,做最终校验。

@Component
@Aspect
public class RequestParamValidAspect{

    Logger log = LoggerFactory.getLogger(getClass());

    @Pointcut("execution(* diamond.cms.server.mvc.controllers.*.*(..))")
    public void controllerBefore(){};

    ParameterNameDiscoverer parameterNameDiscoverer = new LocalVariableTableParameterNameDiscoverer();

    @Before("controllerBefore()")
    public void before(JoinPoint point) throws NoSuchMethodException, SecurityException, ParamValidException{
        //  获得切入目标对象
        Object target = point.getThis();
        // 获得切入方法参数
        Object [] args = point.getArgs(); 
        // 获得切入的方法
        Method method = ((MethodSignature)point.getSignature()).getMethod(); 
          
        // 执行校验,获得校验结果
        Set<ConstraintViolation<Object>> validResult = validMethodParams(target, method, args);

        if (!validResult.isEmpty()) {
            String [] parameterNames = parameterNameDiscoverer.getParameterNames(method); // 获得方法的参数名称
            List<FieldError> errors = validResult.stream().map(constraintViolation -> {
                PathImpl pathImpl = (PathImpl) constraintViolation.getPropertyPath();  // 获得校验的参数路径信息
                int paramIndex = pathImpl.getLeafNode().getParameterIndex(); // 获得校验的参数位置
                String paramName = parameterNames[paramIndex];  // 获得校验的参数名称
                FieldError error = new FieldError();  // 将需要的信息包装成简单的对象,方便后面处理
                error.setName(paramName);  // 参数名称(校验错误的参数名称)
                error.setMessage(constraintViolation.getMessage()); // 校验的错误信息
                return error;
            }).collect(Collectors.toList());
            throw new ParamValidException(errors);  // 我个人的处理方式,抛出异常,交给上层处理
        }
    }

    private final ValidatorFactory factory = Validation.buildDefaultValidatorFactory();
    private final ExecutableValidator validator = factory.getValidator().forExecutables();

    private <T> Set<ConstraintViolation<T>> validMethodParams(T obj, Method method, Object [] params){
        return validator.validateParameters(obj, method, params);
    }
}

FieldError.java

class FieldError implements Serializable{
    private String name;
    private String message;
    // getter / setter...
}

ParamValidException.java

public class ParamValidException extends Exception{
    private List<FieldError>;
    public ParamValidException(List<FieldError> errors) {
        this.fieldErrors = errors;
    }
}

通过这样的方式,我们请求这个方法:

@RequestMapping(value = "token")
public Result token(@NotBlank String username, @NotBlank String password){
    String token = userService.login(username, PwdUtils.pwd(password));
    Result result = new Result(token);
    return result;
}
  1. 模拟请求不传参数 http://localhsot/token
{
  "success": false,
  "msg": "invalid params: [`password` 不能为空, `username` 不能为空]",
  "code": 10012,
  "data": [
    {
      "name": "password",
      "message": "不能为空"
    },
    {
      "name": "username",
      "message": "不能为空"
    }
  ]
}
  1. 模拟请求,只传username参数 http://localhost/token?username=testusername
{
  "success": false,
  "msg": "invalid params: [`password` 不能为空]",
  "code": 10012,
  "data": [
    {
      "name": "password",
      "message": "不能为空"
    }
  ]
}
  1. 模拟请求,传正确参数 http://localhost/token?username=testusername&password=testpassword
{
  "success": true,
  "code": 0,
  "data": "token-data"
}

以上请求结果,都是获取基本错误信息封装得来的,根据实际情况可能不同,主要是为了讲解在方法上添加 校验注解 的效果。

FAQ (常见问题解答)

为什么我抛出异常后捕获不到?

切面内抛出的异常都会被 UndeclaredThrowableException包装,需要先捕获这个异常,获得这个异常后,调用这个他的 getUndeclaredThrowable() 方法,就可以获得实际的异常了, 例如:

 @ExceptionHandler(UndeclaredThrowableException.class)
 public Result undeclaredThrowableException(UndeclaredThrowableException ex, HttpServletResponse response){
        Throwable throwable = ex.getUndeclaredThrowable(); // 获得实际异常
        if (throwable instanceof ParamValidException) { // 如果是我们自定义异常就调用自定义异常的处理方法
            return paramValidExceptionHandler((ParamValidException)throwable, response);
        }
        return exception(ex, response);
    }

为什么不实现 HandlerInterceptor 拦截器来处理?

实现拦截器后,拦截器提供 preHandle 方法,在请求处理之前执行。

preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)

这个方法传过来的最后一个参数 Object handler 实际上是一个 HandlerMethod 对象。
可以通过强制转换获得 HandlerMethod methodHandler = (HandlerMethod) handler;

通过这个对象,我们可以获取到处理本次请求的处理对象 HandlerMethod.getBean(),本次请求的处理方法 MethodHandler.getMethod()。 至此,我们校验需要的前两个参数都有了。
问题就在这最后一个参数上,最后一个参数我们需要获得前端传过来的数据,在这里,我们只能从 HttpServletRequest request 里面获取。 从 request 获取的参数,都只是原始的 String[] 没有经过处理和转换。
如果要实际使用,还需要转换成 方法 对应的数据类型,并考虑自定义的 WebDataBinder 或其复杂类型的数据转换。 相当于要把 Spring MVC 处理参数的逻辑重新实现一遍。虽然也是可以完成的,但是太过于复杂,所以不推荐使用这种方式。

代码中的 LocalVariableTableParameterNameDiscoverer 是个什么东西

我们需要知道被校验的参数的名称,以便告诉前端,具体是哪个参数有问题。 通过 LocalVariableTableParameterNameDiscoverer.getParameterNames(Method method) 方法,获取到一个字符串数组,里面就是包含的方法的参数名称。例如如下这个方法。

@RequestMapping(value = "token")
public Result token(@NotBlank String username, @NotBlank String password){
    String token = userService.login(username, PwdUtils.pwd(password));
    Result result = new Result(token);
    return result;
}

// 演示代码
LocalVariableTableParameterNameDiscoverer discoverer = new LocalVariableTableParameterNameDiscoverer();
Method method = demo.getMethod("token", String.class, String.class);
String [] paramNames = discoverer.getParameterNames(method);
// 最终获得  
paramNames: ["username", "password"]

项目源码

博客系统后台源码: Github-cms-admin-end
文章内容的代码片段: Github-cms-admin-end-valid
个人博客: https://diamondfsd.com

文章到此就结束了,希望对大家有所帮助,有什么问题也可以在下方进行讨论。

© 著作权归作者所有

共有 人打赏支持
DiamondFsd
粉丝 87
博文 15
码字总数 16372
作品 0
深圳
程序员
私信 提问
加载中

评论(29)

lzxianren
lzxianren

引用来自“marinesky”的评论

引用来自“DiamondFsd”的评论

引用来自“marinesky”的评论

楼主,如果不依赖hibernate有啥方法可以在controller上注解实现参数验证
hibernate 和 hibernate-validator 是不同的东西哦, hibernate-validator 只是一套验证组件,实现了 javax.validation 下的验证注解而已。 都是 `hibernate.org` 出品的,但是实际上和那个 orm 框架没什么关系。
而且spring-mvc 是默认就依赖了 `hibernate-validator`


如果你是不想用 `hibernate-validator` ,并且想实现注解参数验证。那么你就得自己实现一套注解验证框架了

@DiamondFsd 我知道是hibernate-validator,其实我很不喜欢用这个,特别是不喜欢说要把这些验证注解在实体类上,我想自己实现一个注解在controller方法上,支持扩展的,目前用aop现实了一些,想问问有没有更好的方法或思路,手机码字不方便,图片也上不了
spring 也有一套valid 可以验证传入参数。但你如果用bean来接收参数,注解还是只能加到bean上。在spring 看来,你应该用model(或者vo)来接收,不是实体类(po),你偷懒了。。。
MGL_ONE
MGL_ONE
token(UserModel user, @NotBlank String password) 带这种实体类的怎么验证 ? 你这个不适用 感觉!
Jamson丶
Jamson丶
已经完美实现,感谢分享
12叔
12叔

加一个方法 处理器不就可以了。。 不用自己写吧
<bean class="org.springframework.validation.beanvalidation.MethodValidationPostProcessor"/>
Usiboy
Usiboy
这个是基于Spring多少版本来做的?
开不了囧
开不了囧
aop可以实现但效率一般,springmvc本身是有提供扩展的,继承AbstractNamedValueMethodArgumentResolver,只处理基本类型
j
justkuai

引用来自“justkuai”的评论

lz, spring官方文档<34. Validation>这里就说的是你这个

引用来自“DiamondFsd”的评论

-😳 这就很尴尬了, 怪我,没好好看文档
结合这段代码就搞定了, 统一异常处理类中添加一个 此类异常的处理

@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
@ExceptionHandler(ConstraintViolationException.class)
public JsonResult handleValidException(ConstraintViolationException e) {
StringBuilder msg = new StringBuilder();
e.getConstraintViolations().forEach((cv -> {
msg.append(cv.getMessage() + ",");
}));
JsonResult jsonResult = JsonResult.build(ErrCode.ParamValidError);
jsonResult.setMsg(msg.toString());

return jsonResult;
}
DiamondFsd
DiamondFsd

引用来自“justkuai”的评论

lz, spring官方文档<34. Validation>这里就说的是你这个
-😳 这就很尴尬了, 怪我,没好好看文档
j
justkuai
lz, spring官方文档<34. Validation>这里就说的是你这个
每周精粹
每周精粹
效率问题。aop效率低。
[转载]69道Spring面试题和答案

原文地址 http://ifeve.com/spring-interview-questions-and-answers/ 目录 Spring 概述 依赖注入 Spring beans Spring注解 Spring数据访问 Spring面向切面编程(AOP) Spring MVC Spring 概......

王木东
2017/03/27
0
0
细说不懂Spring底层原理带来的伤与痛

什么是spring? Spring 是个Java企业级应用的开源开发框架。Spring主要用来开发Java应用,但是有些扩展是针对构建J2EE平台的web应用。Spring 框架目标是简化Java企业级应用开发,并通过POJO为...

老道士
09/04
0
0
springmvc中aop对controller切面编程(转)

概述: 最近在开发一个基础应用服务系统,利用加密的token标识来校验访问者的身份。几乎每一个接口都需要校验token。故打算采用aop面向切面编程,一次性对所有接口进行身份认证; 遇见的问题...

mifans
2016/11/07
36
0
在Spring-Boot中实现通用Auth认证的几种方式

前言 最近一直被无尽的业务需求淹没,没时间喘息,终于接到一个能让我突破代码舒适区的活儿,解决它的过程非常曲折,一度让我怀疑人生,不过收获也很大,代码方面不明显,但感觉自己抹掉了 ...

枕边书
07/17
0
0
spring mvc 注解详解

1. 声明Bean的注解: 1.1 @Component : 组件,没有明确的角色 1.2 @Service : 在业务逻辑层(service层)使用 1.3 @Repository : 在数据访问层(dao层)使用 1.4 @Controller : 在展现层(MVC--Spr...

坚持30天
2017/10/19
0
0

没有更多内容

加载失败,请刷新页面

加载更多

Yearning基于Inception的开源SQL审核平台

基础环境: python3 nodejs vuejs mysql python-ldap pymysql mysql 新建数据库 create database Yearning DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci; Navicat导入初始化数据 : ......

以谁为师
18分钟前
0
0
flutter Expanded用法

使用的地方:一个分类,类似京东的,左右两边都可以滑动 Widget build(BuildContext context) { return Row(children: [ Column( children: <Widget>[ Ex......

大灰狼wow
23分钟前
2
0
Java8 Map中新增的方法使用总结

前言 得益于 Java 8 的 default 方法特性,Java 8 对 Map 增加了不少实用的默认方法,像 getOrDefault, forEach, replace, replaceAll, putIfAbsent, remove(key, value), computeIfPresent,......

kaixin_code
33分钟前
2
0
@TransactionConfiguration

@TransactionConfiguration过时与替代写法 @TransactionConfiguration 替代写法

miaojiangmin
35分钟前
0
0
浅谈Vue响应式(数组变异方法)

很多初使用Vue的同学会发现,在改变数组的值的时候,值确实是改变了,但是视图却无动于衷,果然是因为数组太高冷了吗? 查看官方文档才发现,不是女神太高冷,而是你没用对方法。 看来想让女...

开元中国2015
36分钟前
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部