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

// 实体类

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){

.....

}

@RequestMapping("update-user-status")

public User update(String userId, Integer status){

....

}

@RequestMapping("update-user-status")

public User update( 

              @NotNull String userId, 

              @NotNull @Range(min = 0, max = 5) Integer status){

....

}

interface ExecutableValidator{

//...

  Set> 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> 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.请求的参数

当执行到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> validResult = validMethodParams(target, method, args);

        if (!validResult.isEmpty()) {

            String [] parameterNames = parameterNameDiscoverer.getParameterNames(method); // 获得方法的参数名称

            List 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 Set> validMethodParams(T obj, Method method, Object [] params){

        return validator.validateParameters(obj, method, params);

    }

}

FieldError.java

ParamValidException.java

@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

2.模拟请求，只传username参数 http://localhost/token?username=testusername

3.模拟请求，传正确参数 http://localhost/token?username=testusername&password=testpassword

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

@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);

    }

preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)

@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"]