入參校驗，你還在寫 If-Else？Out了！快來看看這個吧
作者：java永無bug
當服務端接口一拿到前臺的入參，你是不是上去就開始堆積if-else，十多行代碼下去，發現全判斷校驗參數了，還沒進入正常的業務邏輯。想要優雅一點嗎？那就一起隨小編一起來學習吧！
背景
當服務端接口一拿到前臺的入參，你是不是上去就開始堆積if-else，十多行代碼下去，發現全判斷校驗參數了，還沒進入正常的業務邏輯。雖然功能沒啥毛病，但看起來太冗長，被后來者看到，那是免不了一頓吐槽的!想要優雅一點嗎?那就一起隨小編一起來學習使用
spring-boot-starter-validation進行參數校驗!
優點
- controller層的代碼看起來干凈整潔
- spring-boot-starter-validation本身內置了一些注解可以直接使用，比如@NotNull，@NotBlank，@Size等
- 支持自定義注解，靈活方便
搭建
pom引入依賴包
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
常用注解
@NotNull
@NotBlank
@NotEmpty
@Size
自定義注解
/**
* 時間屬性格式校驗
* @author:liyajie
* @createTime:2022/1/20 10:38
* @version:1.0
*/
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.PARAMETER,ElementType.FIELD})
@Constraint(validatedBy = DateValidator.Validator.class)
public @interface DateValidator {
// 校驗未通過時的返回信息
String message() default "日期格式不正確";
// 以下兩行為固定模板
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
/**
* 預期日期格式
*/
String expectValue();
@Slf4j
class Validator implements ConstraintValidator<DateValidator, String> {
private String expectValue;
@Override
public void initialize(DateValidator dateValidator) {
expectValue = dateValidator.expectValue();
}
@Override
public boolean isValid(String value, ConstraintValidatorContext context) {
boolean flag = false;
/**
* 為空直接通過，只做格式驗證
*/
if(Strings.isNullOrEmpty(value)){
return true;
}
try {
Date date = DateUtil.formatStr2Date(value, expectValue);
flag = true;
}catch (RuntimeException e){
log.warn("DateValidator 日期格式不正確");
e.printStackTrace();
}
return flag;
}
}
}
測試
注意點
校驗不通過時，會直接拋出異常，程序將停止執行下面的邏輯，這樣是不合理的，所以我們要捕獲異常，并進行處理，方案如下： 全局捕獲異常，并統一返回：
/**
* 全局異常處理
* @author: zhanglei
* @version: 1.0
* @date: 2021/5/18 20:27
*/
@ControllerAdvice
@Slf4j
public class GlobalExceptionHandler {
/**
* 校驗異常
* @author: liyajie
* @date: 2022/1/20 13:07
* @param e
* @return com.lyj.validates.common.R
* @exception:
* @update:
* @updatePerson:
**/
@ExceptionHandler(MethodArgumentNotValidException.class)
@ResponseBody
public R exceptionHandler(MethodArgumentNotValidException e) {
log.error("exceptionHandler info:", e);
BindingResult bindingResult = e.getBindingResult();
StringBuilder builder = new StringBuilder();
for (FieldError fieldError : bindingResult.getFieldErrors()) {
builder.append(fieldError.getDefaultMessage()).append("!");
}
log.error("message : {}",builder.toString());
return new R("500",builder.toString());
}
}
責任編輯：武曉燕
來源：
今日頭條
