在项目开发过程中controller层方法入参检验中存在一个问题,就是会对参数进行校验,于是有的人就开始各种if esle,并且会产生大量的的if else
。
@PostMapping("/filingBankAccountOpen/applyApprove")
public DataResult applyRecordApproval(@RequestBody OpenApprovalUpdateReqDTO openApprovalUpdateReqDTO) {
if(openApprovalUpdateReqDTO==null){
return ...
}
if(openApprovalUpdateReqDTO.getApprOpinio()==null){
return ....
}
.....
return recordWorkService.applyRecordApproval(openApprovalUpdateReqDTO);
}
最后看看这代码你会觉得很恶心,因为我们可以使用巧办法搞定的。那就是本文的内容:
1.先在你需要校验的实体类上面加上所需要的注解
为了测试,我自己就简单写了。@NotNull 和 @NotBlank 不能为空
public class OpenApprovalUpdateReqDTO {
/**
* 审批人
*/
@ApiModelProperty(value = "审批人id")
@NotNull(message = "approvorId为空")
private Integer approvorId;
/**
* 审批意见
*/
@ApiModelProperty(value = "apprOpinio审批意见为空")
private String apprOpinio;
/**
* 审批标志 ,1:通过,2:驳回
*/
@ApiModelProperty(value = "审批标志")
@NotNull(message = "approvalStatus为空")
private Integer approvalStatus;
/**
* 申请单id
*/
@ApiModelProperty(value = "申请单id")
@NotNull(message = "applyId不能为空")
private Integer applyId;
/**
* 流程实例id
*/
@ApiModelProperty(value = "流程实例id")
@NotNull(message = "流程实例id为空")
private Integer processInstId;
//set get
}
2,增加一个全局处理
@RestControllerAdvice
@ExceptionHandler(写你想要拦截的异常类型)
这两个注解必须要
第一个方法是校验异常的统一处理
第二个是防止参数类型不一致的处理
当然你也可以在里面处理其他异常。
@RestControllerAdvice
public class TreasurerExceptionHandler {
private static Logger LOGGER = LoggerFactory.getLogger(TreasurerExceptionHandler.class);
public TreasurerExceptionHandler() {
}
/**
* 校验错误拦截处理
* 处理{@link Valid} & {@link NotNull}
*
* @param exception 错误信息集合
* @return 错误信息
*/
@ExceptionHandler(MethodArgumentNotValidException.class)
public DataResult validationBodyException(MethodArgumentNotValidException exception) {
BindingResult result = exception.getBindingResult();
if (result.hasErrors()) {
List<ObjectError> errors = result.getAllErrors();
errors.forEach(p -> {
FieldError fieldError = (FieldError) p;
LOGGER.warn("Data check failure : object={}, field={}, errorMessage={}", fieldError.getObjectName(), fieldError.getField(), fieldError.getDefaultMessage());
});
return DataResult.faild(TreasurerErrorCode.PARAM_MISSING.getErrorCode(),
result.getFieldError() == null ? "请求参数有误" : result.getFieldError().getDefaultMessage());
}
//其他错误
return DataResult.faild(TreasurerErrorCode.OTHER_ERROR.getErrorCode(), TreasurerErrorCode.OTHER_ERROR.getErrorReason());
}
/**
* 参数类型转换错误 {@link HttpMessageConversionException}
*
* @param exception 错误
* @return 错误信息
*/
@ExceptionHandler(HttpMessageConversionException.class)
public DataResult parameterTypeException(HttpMessageConversionException exception) {
LOGGER.warn("parameterTypeException {}", exception.getCause().getLocalizedMessage());
return DataResult.faild(TreasurerErrorCode.PARAM_MISSING.getErrorCode(), "请求参数类型有误");
}
}
然后把上面的controller改造一下加一个@Valid
然后测试
下面是我从别的博客收集的所有参数校验注解的使用规则方法
空检查
@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=) Checks whether the annotated value lies between (inclusive) the specified minimum and maximum. @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=)