springmvc 参数校验/aop失效/@PathVariable 参数为空

添加依赖

<!-- 参数校验 -->
<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.0.17.Final</version>
</dependency>

一.基本类型参数(String)校验

1.注解要写在接口中，实现类会自动继承，如果实现类的某个重写方法没有加上了注解，接口中却没有定义，运行时会产生redefine异常

接口：

User getUserById(@NotNull(message = "uid不能为null") @Min(value = 1,message = "uid不合法") Integer id);
实现类：

@Override
public User getUserById(@NotNull(message = "uid不能为null") @Min(value = 1,message = "uid不合法") Integer id) {
return userMapper.getUserById(id);
}

Controller(restful风格最容易出的问题就是参数为空，只要不传就是404，不要尝试：xxx/getUserById/null，这种写法是400，给url设置null没有意义，解决方式很简单，给Controller增加一个映射路径即可，空参数导致的bind异常可以用在全局异常处理器捕获即可，当然你在web.xml中统一处理404也可以)：

@RequestMapping(value = {"/getUserById/{uid}","/getUserById"})
public @ResponseBody Object getUserById(@PathVariable Integer uid) {
    return userService.getUserById(uid);
}

2.提供校验器，自定义异常（可选），全局异常处理器

校验器：

public class ParamsValidator {

    public static ExecutableValidator getValidator() {
        ValidatorFactory validatorFactory = Validation.buildDefaultValidatorFactory();
        return validatorFactory.getValidator().forExecutables();
    }
}

自定义异常（可选）：

public class ValidParamException extends RuntimeException {
    private static final long serialVersionUID = 1L;

    private Set<ConstraintViolation<Object>> validateResult;

    public ValidParamException() {
        super();
    }

    public ValidParamException(String message) {
        super(message);
    }

    public ValidParamException(Set<ConstraintViolation<Object>> validateResult) {
        this.validateResult = validateResult;
    }

    public Set<ConstraintViolation<Object>> getValidateResult() {
        return validateResult;
    }

    public void setValidateResult(Set<ConstraintViolation<Object>> validateResult) {
        this.validateResult = validateResult;
    }

    @Override
    public String getMessage() {
        return validateResult.iterator().next().getMessage();
    }

    public Map<Object, String> getErrorMap() {
        Map<Object, String> map = new HashMap<Object, String>(6);
        Iterator<ConstraintViolation<Object>> iterator = validateResult.iterator();
        while (iterator.hasNext()) {
            ConstraintViolation<Object> cons = iterator.next();
            Path propertyPath = cons.getPropertyPath();
            String message = cons.getMessage();
            map.put(propertyPath, message);
        }
        return map;
    }

}

全局异常处理器：

@ControllerAdvice
@EnableWebMvc
public class GlobalExceptionHandler {
    // 单参数校验
    @ExceptionHandler(ValidParamException.class)
    public @ResponseBody Map<Object, String> validParamException(HttpServletRequest req, ValidParamException vpe) {
        return vpe.getErrorMap();
    }

    // 对象类型参数校验
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public @ResponseBody Map<Object, String> methodArgumentNotValidException(MethodArgumentNotValidException ex) {
        String parameterName = ex.getParameter().getParameterName();
        Map<Object, String> map = new HashMap<Object, String>(6);
        map.put(parameterName, ex.getLocalizedMessage());
        return map;
    }

    // pathvariable不传递参数时抛出的异常
    @ExceptionHandler(ServletRequestBindingException.class)
    public @ResponseBody Map<Object, String> servletRequestBindingException(ServletRequestBindingException ex) {
        Map<Object, String> map = new HashMap<Object, String>(6);
        map.put("error", ex.getLocalizedMessage());
        return map;
    }
}

3.使用aop进行拦截

关于aop"失效"的问题有几点说明：

1）如果拦截controller，那么aop的配置要写在springmvc的配置文件中，拦截其他层(如service)写在spring的配置文件中

2）被拦截的类必须也被spring管理否则无法拦截成功

3）开启注解扫描时，springmvc只扫描@Controller类型的注解，其他的如@Service，@Repository注解由spring进行扫描

aop：

@Component
@Aspect
public class UserAspect {

    private ExecutableValidator validator = ParamsValidator.getValidator();

    @Pointcut("execution (* cn.tele.service.*.*(..))")
    private void pt() {
    }

    @Before("pt()")
    public void checkParams(JoinPoint jp) {

        Object target = jp.getTarget();
        Object[] params = jp.getArgs();
        MethodSignature methodSignature = (MethodSignature) jp.getSignature();

        String[] paramNames = methodSignature.getParameterNames();
        Method method = methodSignature.getMethod();

        Set<ConstraintViolation<Object>> validateResult = validator.validateParameters(target, method, params);
        if (!validateResult.isEmpty()) {
            throw new ValidParamException(validateResult);
        }
    }

}

4.测试结果：

1）传入-1

 2）不传

 

可以在aop中打印日志啥的

 

二.对象类型参数校验

1.在javaBean中添加注解，对一些特殊字段进行分组，如id,插入数据时，不需要校验可以为null,而查询，删除，更新等操作必须校验

@NotNull(message = "uid不能为null",groups = {Query.class,Update.class,Delete.class})
@Min(value = 1,message = "uid不合法")
private Integer uid;

@NotBlank(message = "姓名不能为空")
@Size(max = 20,message = "姓名最大长度为50个字符")
private String userName;

@NotBlank(message = "性别不能为空")
@Size(max = 20,message = "性别最大长度位20个字符")
private String sex;

@NotNull
@Max(value = 70,message = "最大年龄为70岁")
private Integer age;

@NotNull
private Integer departmentId;

@Value(value = "1")
private Integer state;

分组只是个标记，用接口定义就好

public interface Query {

}

2.在参数前添加@Valited注解，该注解支持分组，@Valid不支持,如果你选择的校验位置与上面定义的aop拦截的位置相同，那就会出问题了，

你的代码会走aop的逻辑然后去用你校验单个参数的校验器去进行校验，这样无法校验出问题，因此推荐放在controller层

@RequestMapping("/insertUser")
public @ResponseBody String insertUser(@Validated @RequestBody User user) {
    Integer count = userService.insertUser(user);
    return count ==1 ? "成功增加1条记录" : "增加" + user + "失败";
}

校验指定分组

 

3.抛出的异常会走上面贴出的全局异常处理器的代码

4.测试

1）正常情况，注意没有id

 2)丢失userName