JSR303校验
1、JSR-303数据校验简介
JSR是Java Specification Requests的缩写，意思是Java 规范提案
JSR-303 是JAVA EE 6 中的一项子规范，叫做Bean Validation
即，JSR 303，Bean Validation规范 ，为Bean验证定义了元数据模型和API.。默认的元数据模型是通过Annotations来描述的，但是也可以使用XML来重载或者扩展。
2、SR303数据校验使用步骤
1.引入依赖
org.hibernate.validator
hibernate-validator
2.实体类上加校验注解
@NotBlank
@NotEmpty
@NotNull
@Pattern
@Url
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.NotEmpty;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Positive;
/**
* 品牌
*
* @author liucan
* @email [email protected]
* @date 2022-08-27 14:23:15
*/
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 品牌id
*/
@TableId
private Long brandId;
/**
* 品牌名
*/
@NotEmpty(message = "品牌名不能为空")
private String name;
/**
* 品牌logo地址
*/
@NotEmpty(message = "logo不能为空")
@URL(message = "logo必须是一个合法的url")
private String logo;
/**
* 介绍
*/
private String descript;
/**
* 显示状态[0-不显示；1-显示]
*/
private Integer showStatus;
/**
* 检索首字母
*/
@NotEmpty
@Pattern(regexp = "^[a-zA-Z]$",message = "检索首字母必须是一个字母")
private String firstLetter;
/**
* 排序
*/
@NotNull
@Positive(message = "排序必须为正整数")
private Integer sort;
}
3.在Controller中的方法形参前加上@Valid注解
/**
* 保存
*/
@RequestMapping("/save")
public R save(@RequestBody @Valid BrandEntity brand, BindingResult result){
HashMap map = new HashMap<>();
if(result.hasErrors()){
result.getFieldErrors().forEach((item)->{
String field = item.getField();
String message = item.getDefaultMessage();
map.put(field,message);
});
return R.error(400,"提交的数据不合法").put("data",map);
}else{
brandService.save(brand);
}
return R.ok();
} 在参数后接收BingingResult可获取到校验结果
4.测试
3、统一异常处理
1.在common中新建一个枚举用于存放我们异常类型
public enum BizCodeEnume {
UNKNOW_EXCEPTION(10000,"系统未知异常"),
VAILD_EXCEPTION(10001,"参数格式校验失败");
private int code;
private String msg;
BizCodeEnume(int code,String msg){
this.code = code;
this.msg = msg;
}
public int getCode() {
return code;
}
public String getMsg() {
return msg;
}
}
2.在exception下新建GulimallExceptionControllerAdvice用于集中处理异常
import com.liucan.common.exception.BizCodeEnume;
import com.liucan.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.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import java.util.HashMap;
/**
* 集中处理异常
*/
// 统一处理basePackages中的异常
@Slf4j
//@ResponseBody
//@ControllerAdvice(basePackages = "com.liucan.gulimall.product.controller")
@RestControllerAdvice(basePackages = "com.liucan.gulimall.product.controller")
public class GulimallExceptionControllerAdvice {
//标注方法可以处理的异常
@ExceptionHandler(value = MethodArgumentNotValidException.class)
public R handleVaildException(MethodArgumentNotValidException e){
log.info("数据校验出现异常:{},异常类型:{}",e.getMessage(),e.getClass());
BindingResult result = e.getBindingResult();
HashMap errMap = new HashMap<>();
result.getFieldErrors().forEach((item)->{
errMap.put(item.getField(),item.getDefaultMessage());
});
return R.error(BizCodeEnume.VAILD_EXCEPTION.getCode(),BizCodeEnume.VAILD_EXCEPTION.getMsg()).put("data",errMap);
}
@ExceptionHandler(value = Throwable.class)
public R hanleException(Throwable throwable){
return R.error(BizCodeEnume.UNKNOW_EXCEPTION.getCode(),BizCodeEnume.UNKNOW_EXCEPTION.getMsg());
}
}
3.测试
4.分组校验
1.在校验注解中有个groups属性，里面存放一个接口数组，例如：
@NotNull(message = “修改时品牌id不能为空”,groups = {UpdateGroup.class，AddGroup.class})
package com.liucan.gulimall.product.entity;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import java.io.Serializable;
import com.liucan.common.valid.AddGroup;
import com.liucan.common.valid.UpdateGroup;
import lombok.Data;
import org.apache.ibatis.annotations.Update;
import org.hibernate.validator.constraints.URL;
import javax.validation.constraints.*;
/**
* 品牌
*
* @author liucan
* @email [email protected]
* @date 2022-08-27 14:23:15
*/
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
private static final long serialVersionUID = 1L;
/**
* 品牌id
*/
@Null(message = "新增品牌时品牌id必须为空",groups = {AddGroup.class})
@NotNull(message = "新增品牌时品牌id能为空",groups = {UpdateGroup.class})
@TableId
private Long brandId;
/**
* 品牌名
*/
@NotNull(message = "品牌不能为空",groups = {UpdateGroup.class,AddGroup.class})
@NotEmpty(message = "品牌名不能为空")
private String name;
/**
* 品牌logo地址
*/
@NotEmpty(message = "logo不能为空",groups = {AddGroup.class})
@URL(message = "logo必须是一个合法的url",groups = {UpdateGroup.class,AddGroup.class})
private String logo;
/**
* 介绍
*/
private String descript;
/**
* 显示状态[0-不显示；1-显示]
*/
private Integer showStatus;
/**
* 检索首字母
*/
@NotEmpty(groups = {AddGroup.class})
@Pattern(regexp = "^[a-zA-Z]$",message = "检索首字母必须是一个字母",groups = {UpdateGroup.class,AddGroup.class})
private String firstLetter;
/**
* 排序
*/
@NotNull(groups = {AddGroup.class})
@Positive(message = "排序必须为正整数",groups = {UpdateGroup.class,AddGroup.class})
private Integer sort;
}
其中的AddGroup与UpdateGroup是我们自定义的接口，无需实现，只作为分组
public interface AddGroup {
}
public interface UpdateGroup {
}2.在控制器Bean前添加注解@Validated({UpdateGroup.class})，用于指定我们要使用的分组
/**
* 保存
*/
@RequestMapping("/save")
public R save(@RequestBody @Validated({AddGroup.class}) BrandEntity brand/*, BindingResult result*/){
brandService.save(brand);
return R.ok();
}
/**
* 修改
*/
@RequestMapping("/update")
public R update(@RequestBody @Validated({UpdateGroup.class}) BrandEntity brand){
brandService.updateById(brand);
return R.ok();
}3.效果:
五.自定义校验器
例如我们校验某个字段是不是我们指定的值：
/**
* 显示状态[0-不显示；1-显示]
*/
@ListValue(vals = {0,1}) // 只希望接收0或1
private Integer showStatus;
/**1、编写自定义校验注解
-
新建自定义校验注解ListVaue
@Documented
@Constraint(validatedBy = { })
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {
// 此类的全限定类名
String message() default "{com.XXX.common.valid.ListValue.message}";
Class[] groups() default { };
Class[] payload() default { };
int[] vals() default { };
}
2、编写自定义校验器
-
新建自定义校验器ListValuaConstraintValidator，并实现ConstraintValidator
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.HashSet;
import java.util.Set;
public class ListValuaConstraintValidator implements ConstraintValidator{
private Set set = new HashSet<>();
//初始化方法
@Override
public void initialize(ListValue constraintAnnotation) {
int[] vals = constraintAnnotation.vals();
if(vals.length != 0){
for (int val : vals) {
set.add(val);
}
}
}
/**
* 判断是否校验成功
* @param value 需要校验的值
* @param constraintValidatorContext
* @return
*/
@Override
public boolean isValid(Integer value, ConstraintValidatorContext constraintValidatorContext) {
return set.contains(value);
}
}
- 新建配置文件ValidationMessages.properties，定义我们自定义校验注解校验失败后的返回信息
com.xxx.common.valid.ListValue.message = 必须提交指定参数3、关联自定义校验器和自定义校验注解
- 在刚刚编写好的自定义注解@ListVaue中关联我们自定义的检验器
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.ElementType.TYPE_USE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;
@Documented
@Constraint(validatedBy = {ListValuaConstraintValidator.class /* 【可以指定多个不同的校验器，适配不同类型的校验】 */})
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {
// 此类的全限定类名
String message() default "{com.xxx.common.valid.ListValue.message}";
Class[] groups() default { };
Class[] payload() default { };
int[] vals() default { };
}
4.测试
