參數校驗
基於PathVariable的正則匹配
通過PathVariable，在{}包裹的字段后加冒號：，在加上正則。
如果不匹配正則，則前端會報出404.
/**
* 采用正則，在pathvarable中做參數校驗
* 如果不匹配正則，則返回404
*/
@RestController
@RequestMapping("pathVariable")
public class AppController {
@GetMapping("/id/{id:\\d+}")
public String getId(@PathVariable("id") Integer id) {
return String.valueOf(id);
}
@GetMapping("char/{char:[a-zA-Z0-9_]+}")
public String getChar(@PathVariable("char") String charVar) {
return charVar;
}
}
基於注解
添加maven依賴
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.0.Final</version>
</dependency>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>6.0.1.Final</version>
</dependency>
單個字段校驗
1、在Controller上注解@Validated
2、在字段前加入相應注解
/**
* 單個參數的校驗
* 在@Validated
*/
@RestController
@RequestMapping("valid1")
@Validated
public class App2Controller {
@GetMapping
public String get(@NotEmpty(message = "name不能為空") String name, @Min(value = 12) Integer age) {
return name + ":" + age;
}
}
javabean校驗
1、在實體類上加上注解校驗
@Data
public class User {
@NotEmpty(message = "實體類name不能為空")
private String name;
@Max(value = 100)
private Integer age;
}
2、在Controller出的方法入參處加上@Validated ，BindingResult可以收集錯誤
@RestController
@RequestMapping("user")
public class App3Controller {
@PostMapping
public String post(@Validated @RequestBody User user, BindingResult bindingResult) {
if (bindingResult.hasErrors()) {
for (ObjectError allError : bindingResult.getAllErrors()) {
System.out.println(allError.getDefaultMessage());
throw new RuntimeException(allError.getDefaultMessage());
}
}
return user.getName();
}
}
自定義注解校驗
1、定義一個注解
@Target({ElementType.ANNOTATION_TYPE, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = AppValidator.class)//指定注解邏輯實現類
public @interface AppValidAnno {
String message() default "";
Class<?>[] groups() default {};
Class<? extends Payload>[] payload() default {};
}
note
- message，groups，payload三個字段必須要
- 需要在注解上表明邏輯的實現類，這個是ConstraintValidator的實現類
2、實現ConstraintValidator類
/**
* 不需要@Component
* 實現了ConstraintValidator接口，spring會自動將其視為一個組件
*/
//@Component
public class AppValidator implements ConstraintValidator<AppValidAnno, String> {
//注入其他邏輯類
@Autowired
private AppComponent appComponent;
@Override
public void initialize(AppValidAnno constraintAnnotation) {
System.out.println("方法初始化");
}
@Override
public boolean isValid(String s, ConstraintValidatorContext constraintValidatorContext) {
return appComponent.validStr(s);
}
}
note
- 可以在這個類注入其他spring組件
- 不需要@Component，實現了ConstraintValidator接口，spring會自動將其視為一個組件
- ConstraintValidator<AppValidAnno, String>兩個范型，第一個是對應的注解，第二個是要處理的字段的類型
3、和其他校驗注解的使用方式相同
@Data
public class User {
@NotEmpty(message = "實體類name不能為空")
private String name;
@Max(value = 100)
private Integer age;
@AppValidAnno(message = "必須以app-開頭")
private String code;
}
更優雅的方式
采用validation的方式校驗參數的時候，當在參數前加上@valid注解，才會生效，但是在上文的方式中，我們還在代碼中加入了BindingResult這個類來接收錯誤參數。
public String post(@Validated @RequestBody User user, BindingResult bindingResult) {
所以此方法可以簡化這種使用方式，不用在每個方式中加入參數BindingResult。
我們可以采用RestControllerAdvice來統一處理和返回錯誤信息。
@PostMapping("/o")
public String post1(@Valid @RequestBody User user) {
return user.getName();
}
統一處理代碼
@RestControllerAdvice
public class ExceptionControllerAdvice {
@ExceptionHandler(MethodArgumentNotValidException.class)
public String MethodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) {
// 從異常對象中拿到ObjectError對象
ObjectError objectError = e.getBindingResult().getAllErrors().get(0);
// 然后提取錯誤提示信息進行返回
return objectError.getDefaultMessage();
}
}
參考
https://zhuanlan.zhihu.com/p/208298120