1、后端进行数据校验
1)给Bean添加校验注解:
可以给实体类上根据业务需求自己添加相应的注解,注解在javax.validation.constraints包下,
实例如下:
@Data
@TableName("pms_brand")
public class JSR303Test implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 品牌id
*/
@NotNull
@TableId
private Long brandId;
/**
* 品牌名
*/
@NotBlank
private String name;
/**
* 品牌logo地址
*/
@NotBlank
@URL
private String logo;
/**
* 介绍
*/
private String descript;
/**
* 显示状态[0-不显示;1-显示]
*/
@NotNull
@ListValue
private Integer showStatus;
/**
* 检索首字母
*/
@NotEmpty
@Pattern(regexp = "^[a-zA-Z]$")
private String firstLetter;
/**
* 排序
*/
@NotNull
@Min(value = 0)
private Integer sort;
}
校验默认提示信息会默认去ValidationMessages.properties文件下去寻找下面default中的信息
String message() default "{javax.validation.constraints.NotNull.message}";
message消息可以在注解中自定义,如果没有自定义就采用上面ValidationMessages.properties中默认的提示信息。
如:
@NotNull
@Min(value = 0,message = "排序必须大于等于0")
private Integer sort;
2)开启校验功能使用注解 @Valid
效果:校验错误以后会有默认的响应;
@RequestMapping("/save")
public R save(@Valid @RequestBody BrandEntity brand){
brandService.save(brand);
return R.ok();
}
3)给校验的bean后紧跟一个BindingResult,就可以获取到校验的结果
@RequestMapping("/save")
public R save(@Valid @RequestBody BrandEntity brand , BindingResult bindingResult){
if (bindingResult.hasErrors()){
Map<String,String> map = new HashMap<>();
// 获取校验的错误结果
bindingResult.getFieldErrors().forEach((item)->{
// FieldError 获取到错误提示
String message = item.getDefaultMessage();
// 获取错误的属性名字
String field = item.getField();
map.put(field,message);
});
R.error(400,"提交的数据不合法").put("data",map);
}else {
brandService.save(brand);
}
return R.ok();
}
4)分组校验(多场景的复杂校验)
1.给校验注解标注什么情况下需要进行校验:
@NotEmpty(groups = {AddGroup.class})
@Pattern(regexp = "^[a-zA-Z]$",message = "检索首字母必须是一个字母",groups = {AddGroup.class,UpdateGroup.class})
private String firstLetter;
这里的AddGroup.class和UpdateGroup.class均为空的接口。
2.使用@Validated(xxxgroup.class)进行开启校验
@RequestMapping("/save")
public R save(@Validated({AddGroup.class}) @RequestBody BrandEntity brand , BindingResult bindingResult){
if (bindingResult.hasErrors()){
Map<String,String> map = new HashMap<>();
// 获取校验的错误结果
bindingResult.getFieldErrors().forEach((item)->{
// FieldError 获取到错误提示
String message = item.getDefaultMessage();
// 获取错误的属性名字
String field = item.getField();
map.put(field,message);
});
R.error(400,"提交的数据不合法").put("data",map);
}else {
brandService.save(brand);
}
return R.ok();
}
意味着当我们进行保存操作时,首字母必定会进行校验(规则为前方的正则表达式)
当一个实体类中默认没有指定分组的校验注解,在分组校验情况下不会生效
5)自定义校验
1、编写一个自定义的校验注解(例如只能传入0或者1,其他数字均非法)
1.1创建一个注解,点进原生注解类我们可以发现上面有几个注解,我们需要将上面的几个注解加入到我们自定义的注解类上
1.2自定义注解类
@Documented
@Constraint(validatedBy = { ListValueConstraintValidator.class})//可以指定多个不同的校验器,适配不同类型的校验
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {
String message() default "{com.atguigu.common.valid.ListValue.message}";
Class<?>[] groups() default { };
Class<? extends Payload>[] payload() default { };
int[] vals() default { };
}
1.3其中ListValueConstraintValidator.class是自定义的一个校验器,可以指定多个不同的校验器,适配不同类型的校验**(关联自定义校验器和自定义校验注解)**
String message() default “{com.atguigu.common.valid.ListValue.message}”;这里我们使用了自已定义的message,如果不想使用默认的可以在resources下创建ValidationMessages.properties文件,并自定义message
2、编写一个自定义的校验器
2.1、自定义校验器需要实现ConstraintValidator接口中的方法并传入校验注解以及校验类型(这里指定的是Integer类型)
public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {
private Set<Integer> set = new HashSet<>();
// 初始化方法
@Override
public void initialize(ListValue constraintAnnotation) {
//@ListValue(vals = {0,1},groups = {AddGroup.class})
int[] vals = constraintAnnotation.vals();
for (int val:vals
) {
set.add(val);
}
}
/**
*
* @param value 需要校验的值
* @param context
* @return 判断是否校验成功
*/
@Override
public boolean isValid(Integer value, ConstraintValidatorContext context) {
return set.contains(value);//value为外界所传入需要进行校验的值,合法则返回true
}
}
实体类上使用自定义校验注解:
@NotNull(groups = {AddGroup.class, UpdateStatusGroup.class})
@ListValue(vals = {0,1},groups = {AddGroup.class, UpdateStatusGroup.class})
private Integer showStatus;
这里传入的vals={0,1}会被自定义的校验器通过int[] vals = constraintAnnotation.vals();获得
3、测试: