对于单个方法中字段检验
- 添加依赖
- 在参数前添加@vaild注解开启校验
- 为enitity的字段添加检验注解
<dependency>
<groupId>org.hibernate.validator</groupId>
<artifactId>hibernate-validator</artifactId>
</dependency>
自定义返回信息
- 在entity类的检验注解,自定义message属性
- 封装错误信息到R中
@RequestMapping("/save")
public R save(@Valid @RequestBody BrandEntity brand, BindingResult result) { //标注校验注解
if (result.hasErrors()) {
Map<String, String> map = new HashMap<>();
result.getFieldErrors().forEach((item) -> {
String message = item.getDefaultMessage(); // 错误信息
String field = item.getField(); // 错误字段
map.put(field , message);
});
return R.error(400, "字段格式错误").put("data", map);
} else {
brandService.save(brand);
return R.ok();
}
}
统一处理异常
如果每个方法都要这样写一个异常,太麻烦,写一个统一的异常处理类,当发生错误时,自动调用异常处理类的某一个方法
- 自定义异常处理类
- 类上添加注解
@RestControllerAdvice(basePackages = "com.chen.product.controller")
- 方法上添加注解@ExceptionHandler
- 类上添加注解
@Slf4j
@RestControllerAdvice(basePackages = "com.chen.product.controller") // 扫描包,返回json
public class ExceptionController {
@ExceptionHandler(MethodArgumentNotValidException.class) //接收括号里发生的异常
public R handleValidController(MethodArgumentNotValidException e){
BindingResult result = e.getBindingResult();
Map<String,String> map = new HashMap<>();
result.getFieldErrors().forEach((item)->{
String message = item.getDefaultMessage();
String field = item.getField();
map.put(field,message);
});
return R.error(400,"字段格式错误").put("data",map);
}
}
设置异常组
对于id来说,对于不同的情况会有不同的校验方式
- 添加时不需要id,因为id可能是自增
- 更新时需要id
- 新增对应接口,如果增加和修改的检验规则不同,新建add的接口,和update接口(这个接口是一个标识,不需要任何实现,或者任何内容)
- 为entity 添加groups字段,里面添加接口class
– 注意,如果此时一个字段的检验注释没声明groups,那么它将不会生效
自定义校验注解
- 标注一个自定义校验注解
- 编写自定义校验器
- 关联校验注解和校验器
@Retention(RUNTIME) // 生命周期
@Constraint(validatedBy = {ShowValueValidator.class}) // 指定校验器,创建校验器之后在这里关联即可
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE }) // 可以在哪使用
public @interface ShowValue { // 前三个必须
String message() default "{com.chen.gu-common.ShowValue.message}"; // 默认信息获取位置
Class<?>[] groups() default { }; // 支持组校验
Class<? extends Payload>[] payload() default { }; // 支持负载信息
int[] values() default {0,1};
}
public class ShowValueValidator implements ConstraintValidator<ShowValue, Integer> {
private final Set<Integer> set = new HashSet<>();
@Override
public void initialize(ShowValue constraintAnnotation) {
int[] value = constraintAnnotation.values();
for (int i : value) {
set.add(i);
}
}
@Override // value 为需要校验的值
public boolean isValid(Integer value, ConstraintValidatorContext context) {
return set.contains(value);
}
}