利用spring mvc参数校验，统一做AOP检查参数

最近给手机app开发api接口时，经常会校验App传入的参数是否正确，这时候就要求我们在开发的时候在服务端也对App传入数据的有效性进行验证（如果我们将这些检验的逻辑全部与业务逻辑耦合在一起，那么我们的程序逻辑将会变得冗长而且不便于代码复用）所以想到利用springmvc validator验证统一处理参数

controller中声明@Valid 注解表示告诉spring需要验证UserParam类里参数

• 注意：必须在register方法最后声明BindingResult 否则spring直接就将异常抛出
• 使用@ExceptionHandler注解并定义一个InValidRuntimeException异常类收集错误数据通过@ResponseBody返回一个json字符串给app（实际项目开发中@ExceptionHandler声明在baseapi中）

@RestController
@RequestMapping("/user")  
public class UserApi {
    
    /**
     * 模拟用户注册
     * @param param
     * @return
     * @throws Exception 
     */
    @RequestMapping(value="register",method=RequestMethod.POST)
    public DataResponse register(@Valid @RequestBody UserParam param,BindingResult result) throws Exception {
        DataResponse response=new DataResponse();
        
        return response;
    }
    
    /**
     * 统一处理ValidRuntimeException异常
     * @param e
     * @param req
     * @return
     */
    @ExceptionHandler(InValidRuntimeException.class)
    @ResponseBody
    public DataResponse handleException(InValidRuntimeException e,HttpServletRequest req) {
        DataResponse response=new DataResponse();
        
        response.fillMsg(false,e.getMessage()); 
        
        return response;
    }
}

AOP拦截controller,通过JoinPoint 拦截到controller中的参数，并查看spring 是否有异常信息抛出，如果有则把所有的错误信息拼接，通过我们自定义的InValidRuntimeException类抛出，我们在controller中声明@ExceptionHandler(InValidRuntimeException.class)会捕获到错误信息并且返回到app端

/**
 * 拦截http请求  做参数校验
 * @author superxu
 */
@Aspect    
@Component 
public class ApiInterceptor {
     
    /**
     * 拦截controller中方法声明为RequestMapping
     * @param joinPoint
     * @throws Exception
     */
    @Before("execution(* com.superxu.sample.api..*(..)) and @annotation(org.springframework.web.bind.annotation.RequestMapping)")  
    public void before(JoinPoint joinPoint) throws Exception{ 
        /**
         * 获取参数
         * */
        Object[] args = joinPoint.getArgs();
        
        for (Object arg : args) { 
            /**
             *  如果参数中有 BindingResult 则说明需要校验参数
             * */
            if(arg.getClass()==BeanPropertyBindingResult.class) {
                /**
                 * 强制转换
                 * */
                BeanPropertyBindingResult result=(BeanPropertyBindingResult)arg;
                
                /**
                 * 获取所有的错误信息
                 * */
                List ls=result.getAllErrors(); 
                
                StringBuffer sb=new StringBuffer();
                
                for (int i = 0; i < ls.size(); i++) {
                    /**
                     * 获取出错的字段
                     * */
                    FieldError fieldError = (FieldError) ls.get(i);
                    
                    /**
                     * 拼接消息
                     * */
                    sb.append((i+1)+"."+fieldError.getField()+fieldError.getDefaultMessage()+" ");
                }
                
                /**
                 * 如果有错误消息，则抛出异常
                 * */
                if(ls.size()>0) {
                    throw new InValidRuntimeException(sb.toString());
                }
            }
        }
    }  
}

Hibernate Validator

@AssertTrue //用于boolean字段，该字段只能为true
@AssertFalse //该字段的值只能为false
@CreditCardNumber //对信用卡号进行一个大致的验证
@DecimalMax //只能小于或等于该值
@DecimalMin //只能大于或等于该值
@Digits (integer= 2 ,fraction= 20 ) //检查是否是一种数字的整数、分数,小数位数的数字。
@Email //检查是否是一个有效的email地址
@Future //检查该字段的日期是否是属于将来的日期
@Length (min=,max=) //检查所属的字段的长度是否在min和max之间,只能用于字符串
@Max //该字段的值只能小于或等于该值
@Min //该字段的值只能大于或等于该值
@NotNull //不能为null
@NotBlank //不能为空，检查时会将空格忽略
@NotEmpty //不能为空，这里的空是指空字符串
@Null //检查该字段为空
@Past //检查该字段的日期是在过去
@Size (min=, max=) //检查该字段的size是否在min和max之间，可以是字符串、数组、集合、Map等
@URL (protocol=,host,port) //检查是否是一个有效的URL，如果提供了protocol，host等，则该URL还需满足提供的条件
@Valid //该注解只要用于字段为一个包含其他对象的集合或map或数组的字段，或该字段直接为一个其他对象的引用，
//这样在检查当前对象的同时也会检查该字段所引用的对象

以下是分类
Bean Validation 中内置的 constraint

@Null 被注释的元素必须为 null
@NotNull 被注释的元素必须不为 null
@AssertTrue 被注释的元素必须为 true
@AssertFalse 被注释的元素必须为 false
@Min(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@Max(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@DecimalMin(value) 被注释的元素必须是一个数字，其值必须大于等于指定的最小值
@DecimalMax(value) 被注释的元素必须是一个数字，其值必须小于等于指定的最大值
@Size(max=, min=) 被注释的元素的大小必须在指定的范围内
@Digits (integer, fraction) 被注释的元素必须是一个数字，其值必须在可接受的范围内
@Past 被注释的元素必须是一个过去的日期
@Future 被注释的元素必须是一个将来的日期
@Pattern(regex=,flag=) 被注释的元素必须符合指定的正则表达式

Hibernate Validator 附加的 constraint
@NotBlank(message =) 验证字符串非null，且长度必须大于0
@Email 被注释的元素必须是电子邮箱地址
@Length(min=,max=) 被注释的字符串的大小必须在指定的范围内
@NotEmpty 被注释的字符串的必须非空
@Range(min=,max=,message=) 被注释的元素必须在合适的范围内

public class UserParam {
    
    @NotEmpty
    private String username;
    
    @NotEmpty
    private String password;
    
    @NotNull
    private Integer verificationCode;

    //get set 
}

Jar包依赖

    
        org.springframework.boot
        spring-boot-starter-web
    
        
    
        org.springframework.boot
        spring-boot-starter-aop
    

模拟http请求：

QQ截图20171223144311.png

源码下载https://gitee.com/beedasuper_admin/sample/tree/master/sample-param-check