一、初步使用
(1)给Bean添加校验注解 javax.validation.constraints.*,并定义自己的message提示
查看有哪些校验注解:
(2)控制层开启校验功能@Validated和添加BindingResult,校验错误以后会有自己的错误响应
(3)给校验的Bean后紧跟一个BindingResult result,就可以获取校验结果
(4)分组校验
@NotBlank(message = “品牌名必须提交”, groups = {AddGroup.class, UpdateGroup.class})
二、开发中使用
(2)定义集中处理异常类
import com.zsy.common.exception.BizCodeEnum;
import com.zsy.common.utils.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import java.util.HashMap;
import java.util.Map;
/**
* 集中处理所有异常
*/
@Slf4j
//@RestControllerAdvice 相当于 @ResponseBody 和 @ControllerAdvice(basePackages = "com.zsy.product.controller")结合
@RestControllerAdvice(basePackages = "com.zsy.product.controller")
public class MallExceptionControllerAdvice {
@ExceptionHandler(value = MethodArgumentNotValidException.class)//处理哪些异常
public R handleValidException(MethodArgumentNotValidException e) {
log.error("数据校验出现问题{},异常类型:{}", e.getMessage(), e.getClass());
BindingResult bindingResult = e.getBindingResult();
Map<String, String> errorMap = new HashMap<>();
bindingResult.getFieldErrors().forEach((fieldError) -> {
errorMap.put(fieldError.getField(), fieldError.getDefaultMessage());
});
return R.error(BizCodeEnum.VALID_EXCEPTION.getCode(), BizCodeEnum.VALID_EXCEPTION.getMsg()).put("data", errorMap);
}
@ExceptionHandler(value = Throwable.class)
public R handleException(Throwable throwable) {
log.error("错误:", throwable);
return R.error(BizCodeEnum.UNKNOWN_EXCEPTION.getCode(), BizCodeEnum.UNKNOWN_EXCEPTION.getMsg());
}
}
(3)在common模块com.zsy.common.valid包下新增两个空接口,如下:
package com.zsy.common.valid;
/**
* 新增校验分组
*/
public interface AddGroup {
}
package com.zsy.common.valid;
/**
* 更新校验分组
*/
public interface UpdateGroup {
}
(4)如果控制层有标注@Validated({AddGroup.class})指定是AddGroup,实体类相应字段要校验就要标注groups = {AddGroup.class},否则校验注解不会生效。如果控制层没有指定分组@Validated({AddGroup.class})指定是AddGroup,实体类中有标注类似groups = {AddGroup.class}的不会生效,只有没标注的才会生效
package com.zsy.product.entity;
import com.zsy.common.valid.AddGroup;
import com.zsy.common.valid.ListValue;
import com.zsy.common.valid.UpdateGroup;
import com.zsy.common.valid.UpdateStatusGroup;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import java.io.Serializable;
import lombok.Data;
import org.hibernate.validator.constraints.URL;
import javax.validation.constraints.*;
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 品牌id
*/
@NotNull(message = "修改必须指定品牌id", groups = {UpdateGroup.class})
@Null(message = "新增不能指定id", groups = {AddGroup.class})
@TableId
private Long brandId;
/**
* 品牌名
*/
@NotBlank(message = "品牌名必须提交", groups = {AddGroup.class, UpdateGroup.class})
private String name;
/**
* 品牌logo地址
*/
@NotBlank(groups = {AddGroup.class})
@URL(message = "logo必须是一个合法的url地址", groups = {AddGroup.class, UpdateGroup.class})
private String logo;
/**
* 介绍
*/
private String descript;
/**
* 显示状态[0-不显示;1-显示]
*/
// @Pattern()
@NotNull(groups = {AddGroup.class, UpdateStatusGroup.class})
@ListValue(values = {0, 1}, groups = {AddGroup.class, UpdateStatusGroup.class})
private Integer showStatus;
/**
* 检索首字母
*/
@NotEmpty(groups = {AddGroup.class})
@Pattern(regexp = "^[a-zA-Z]$", message = "检索首字母必须是一个字母", groups = {AddGroup.class, UpdateGroup.class})
private String firstLetter;
/**
* 排序
*/
@NotNull(groups = {AddGroup.class})
@Min(value = 0, message = "排序必须大于等于0", groups = {AddGroup.class, UpdateGroup.class})
private Integer sort;
}
(1)控制层添加@Validated({AddGroup.class}),AddGroup可自定义在common模块下的接口
/**
* 保存
*/
@RequestMapping("/save")
public R save(@Validated({AddGroup.class}) @RequestBody BrandEntity brand) {
brandService.save(brand);
return R.ok();
}
在这里插入代码片
三、自定义校验器
(1)添加自定义@ListValue注解,里面只有0和1两个值
@ListValue(values = {0, 1}, groups = {AddGroup.class, UpdateStatusGroup.class})
private Integer showStatus;
(2)在common模块引入依赖
<dependency>
<groupId>javax.validation</groupId>
<artifactId>validation-api</artifactId>
<version>2.0.1.Final</version>
</dependency>
快速按shift键两次,
(3)在common模块中的com.zsy.common.valid目录下添加下面代码
package com.zsy.common.valid;
import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
/**
* 自定义校验注解 声明可以取那些值
* @author ZSY
*/
@Documented
//1.使有哪个校验器进行校验,需自定义
@Constraint(validatedBy = {ListValueConstraintValidator.class})
//注解可标注位置:方法、属性、构造器...
@Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE})
//校验的时机:运行时获取到
@Retention(RUNTIME)
public @interface ListValue {
//2.校验出错错误信息到com.zsy.common.valid.ListValue.message里取
//其中com.zsy.common.valid.ListValue是当前的全类名
String message() default "{com.zsy.common.valid.ListValue.message}";
//开启分组功能
Class<?>[] groups() default {};
//自定义负载信息
Class<? extends Payload>[] payload() default {};
//3.int数组,对应实体类的值类型
int[] values() default {};
}
(3)在common模块resources目录下新建ValidationMessages.properties文件,里面内容如下
com.zsy.common.valid.ListValue.message=必须提交指定的值
package com.zsy.common.valid;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.HashSet;
import java.util.Set;
public class ListValueConstraintValidator implements
//1.ListValue对应实体类的@ListValue(values = {0, 1},Integer对应0,1类型
ConstraintValidator<ListValue, Integer> {
private final Set<Integer> set = new HashSet<>();
/**
* 2.初始化方法
* 参数:自定义注解的详细信息
* 即获取@ListValue(values = {0, 1}中的0和1
*/
@Override
public void initialize(ListValue constraintAnnotation) {
int[] values = constraintAnnotation.values();
for (int val : values) {//做判空判断
set.add(val);
}
}
/**
* 3.判断是否校验成功
*
* @param value 需要校验的值
* @param context
* @return
*/
@Override
public boolean isValid(Integer value, ConstraintValidatorContext context) {
//前端传入的值
return set.contains(value);
}
}