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"}) 2 public @ResponseBody Object getUserById(@PathVariable Integer uid) { 3     return userService.getUserById(uid); 4 }

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  2 @EnableWebMvc  3 public class GlobalExceptionHandler {  4     // 單參數校驗
    @ExceptionHandler(ValidParamException.class)  6     public @ResponseBody Map<Object, String> validParamException(HttpServletRequest req, ValidParamException vpe) {  7         return vpe.getErrorMap();  8  }  9 
    // 對象類型參數校驗
    @ExceptionHandler(MethodArgumentNotValidException.class) 12     public @ResponseBody Map<Object, String> methodArgumentNotValidException(MethodArgumentNotValidException ex) { 13         String parameterName = ex.getParameter().getParameterName(); 14         Map<Object, String> map = new HashMap<Object, String>(6); 15  map.put(parameterName, ex.getLocalizedMessage()); 16         return map; 17  } 18 
    // pathvariable不傳遞參數時拋出的異常
    @ExceptionHandler(ServletRequestBindingException.class) 21     public @ResponseBody Map<Object, String> servletRequestBindingException(ServletRequestBindingException ex) { 22         Map<Object, String> map = new HashMap<Object, String>(6); 23         map.put("error", ex.getLocalizedMessage()); 24         return map; 25  } 26 }

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})  2 @Min(value = 1,message = "uid不合法")  3 private Integer uid;  4 
@NotBlank(message = "姓名不能為空")  6 @Size(max = 20,message = "姓名最大長度為50個字符")  7 private String userName;  8 
@NotBlank(message = "性別不能為空") 10 @Size(max = 20,message = "性別最大長度位20個字符") 11 private String sex; 12 
@NotNull 14 @Max(value = 70,message = "最大年齡為70歲") 15 private Integer age; 16 
@NotNull 18 private Integer departmentId; 19 
@Value(value = "1") 21 private Integer state;

分組只是個標記，用接口定義就好

public interface Query { 2 
}

2.在參數前添加@Valited注解，該注解支持分組，@Valid不支持,如果你選擇的校驗位置與上面定義的aop攔截的位置相同，那就會出問題了，

你的代碼會走aop的邏輯然后去用你校驗單個參數的校驗器去進行校驗，這樣無法校驗出問題，因此推薦放在controller層

@RequestMapping("/insertUser") 2 public @ResponseBody String insertUser(@Validated @RequestBody User user) { 3     Integer count = userService.insertUser(user); 4     return count ==1 ? "成功增加1條記錄" : "增加" + user + "失敗"; 5 }

校驗指定分組

 

3.拋出的異常會走上面貼出的全局異常處理器的代碼

4.測試

1）正常情況，注意沒有id

 2)丟失userName