JSR303校验异常处理及统一结果封装

JSR303校验参数是否符合规范

空检查
@Null	验证对象是否为null
@NotNull	验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank	检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty	检查约束元素是否为NULL或者是EMPTY.

Booelan检查
@AssertTrue	验证 Boolean 对象是否为 true
@AssertFalse	验证 Boolean 对象是否为 false

长度检查
@Size(min=, max=)	验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
@Length(min=, max=)	Validates that the annotated string is between min and max included.

日期检查
@Past	验证 Date 和 Calendar 对象是否在当前时间之前
@Future	验证 Date 和 Calendar 对象是否在当前时间之后
@Pattern	验证 String 对象是否符合正则表达式的规则

数值检查	建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为"",Integer为null
@Min	验证 Number 和 String 对象是否大等于指定的值
@Max	验证 Number 和 String 对象是否小等于指定的值
@DecimalMax	被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin	被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits	验证 Number 和 String 的构成是否合法
@Digits(integer=,fraction=)	验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。

@Range(min=, max=)	检查数字是否介于min和max之间.
@Range(min=10000,max=50000,message=“range.bean.wage”)	private BigDecimal wage;

@Valid	递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
@CreditCardNumber	信用卡验证
@Email	验证是否是邮件地址，如果为null,不进行验证，算通过验证。
@ScriptAssert(lang= ,script=, alias=)
@URL(protocol=,host=, port=,regexp=, flags=)

1、pom.xml导入validation依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

2、在javaBean中需要校验的参数上添加注解

@Data
@AllArgsConstructor
@NoArgsConstructor
@Accessors(chain = true)
public class User {

    @Min(value = 0, message = "id不能为空")
    @TableId(type = IdType.ASSIGN_ID)
    private long id;

    @NotNull(message = "用户名不能为空")
    private String username;

    @NotNull(message = "密码不能为空")
    private String password;

    private String salt;
}

3、校验方法

@RestController
@Slf4j
//Swagger-ui注解
@Api(value = "UserController文档")
public class UserController {

    @RequestMapping(value = "/user", method = RequestMethod.POST)
    @ApiOperation("JSR303校验测试")
    public User user(@Validated @RequestBody User user) throws ApplicationException {
        return user;
    }
    
}

给前端返回约定的JSON数据，同时避免重复new ResultVo，对返回结果进行统一处理

1、新建StatusCode接口

public interface StatusCode {
    Boolean getSuccess();
    Integer getCode();
    String getMsg();
}

2、新建枚举类ResultCode并实现StatusCode

@Getter
public enum ResultCode implements StatusCode {

    SUCCESS(true, 200, "请求成功"),
    FAILED(false, 400, "请求失败"),
    VALIDATE_ERROR(false, 1002, "参数校验失败"),
    RESPONSE_PACK_ERROR(false, 1003, "response返回包装失败");

    private Boolean success;
    private Integer code;
    private String msg;

    ResultCode(Boolean success, Integer code, String msg) {
        this.success = success;
        this.code = code;
        this.msg = msg;
    }
}

3、新建ResultVo并重载所需要的方法

@Data
public class ResultVo {

    private Boolean success;
    private Integer code;
    private String msg;
    private Object data;

    public ResultVo(Boolean success, int code, String msg, Object data) {
        this.success = success;
        this.code = code;
        this.msg = msg;
        this.data = data;
    }

    public ResultVo(Object data) {
        this.success = ResultCode.SUCCESS.getSuccess();
        this.code = ResultCode.SUCCESS.getCode();
        this.msg = ResultCode.SUCCESS.getMsg();
        this.data = data;
    }

    public ResultVo(StatusCode statusCode, Object data) {
        this.success = statusCode.getSuccess();
        this.code = statusCode.getCode();
        this.msg = statusCode.getMsg();
        this.data = data;
    }

    public ResultVo(StatusCode statusCode) {
        this.success = statusCode.getSuccess();
        this.code = statusCode.getCode();
        this.msg = statusCode.getMsg();
        this.data = null;
    }
}

4、新建ControllerResponseAdvice类对返回结果进行处理

@Component
@RestControllerAdvice(basePackages = {"com.xxx.controller"})
public class ControllerResponseAdvice implements ResponseBodyAdvice<Object> {

    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        // response是ResultVo类型，或者注释了NotControllerResponseAdvice都不进行包装
        return !(methodParameter.getParameterType().isAssignableFrom(ResultVo.class));
    }

    @Override
    public Object beforeBodyWrite(Object data, MethodParameter returnType, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest request, ServerHttpResponse response) {
        if (returnType.getGenericParameterType().equals(String.class)) {
            ObjectMapper objectMapper = new ObjectMapper();
            try {
                // 将数据包装在ResultVo里后转换为json串进行返回
                return objectMapper.writeValueAsString(new ResultVo(data));
            } catch (JsonProcessingException e) {
                throw new APIException(ResultCode.RESPONSE_PACK_ERROR, e.getMessage());
            }
        }
        return new ResultVo(data);
    }
}

5、异常枚举类AppCode并实现StatusCode

@Getter
public enum AppCode implements StatusCode {

    APP_ERROR(false, 2000, "业务异常");

    Boolean success;
    private Integer code;
    private String msg;

    AppCode(Boolean success, Integer code, String msg) {
        this.success = success;
        this.code = code;
        this.msg = msg;
    }
}

6、新建APIException异常类

@Getter
public class APIException extends RuntimeException {

    private Boolean success;
    private Integer code;
    private String msg;

    //手动设置异常
    public APIException(StatusCode statusCode, String message) {
        // message用于用户设置抛出错误详情
        super(message);
        // 返回
        this.success = statusCode.getSuccess();
        // 状态码
        this.code = statusCode.getCode();
        // 状态码配套的msg
        this.msg = statusCode.getMsg();
    }

    // 默认异常使用APP_ERROR状态码
    public APIException(String message) {
        super(message);
        this.success = AppCode.APP_ERROR.getSuccess();
        this.code = AppCode.APP_ERROR.getCode();
        this.msg = AppCode.APP_ERROR.getMsg();
    }
}

7、新建ControllerExceptionAdvice异常处理类对异常进行封装并返回统一结果

@RestControllerAdvice
@Slf4j
public class ControllerExceptionAdvice {

    @ExceptionHandler({BindException.class})
    public ResultVo MethodArgumentNotValidExceptionHandler(BindException e) {
        ObjectError objectError = e.getBindingResult().getAllErrors().get(0);
        return new ResultVo(ResultCode.VALIDATE_ERROR, objectError.getDefaultMessage());
    }

    @ExceptionHandler(APIException.class)
    public ResultVo APIExceptionHandler(APIException e) {
        log.error(e.getMessage(), e);
        return new ResultVo(e.getSuccess(), e.getCode(), e.getMsg(), e.getMessage());
    }
}

8、避免某些不需要返回统一结果集的地方被处理，添加自定义注解@NotControllerResponseAdvice

@Target({
    ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface NotControllerResponseAdvice {
}

在ControllerResponseAdvice中修改supports方法为

@Override
public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
    // response是ResultVo类型，或者注释了NotControllerResponseAdvice都不进行包装
    return !(methodParameter.getParameterType().isAssignableFrom(ResultVo.class) ||
             methodParameter.hasMethodAnnotation(NotControllerResponseAdvice.class));
}