数据校验 JSR303校验

已于 2023-03-28 11:10:36 修改
阅读量1.2k 收藏 7
点赞数 2
分类专栏： Java大数据 文章标签： java
于 2022-05-27 10:51:08 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_48568302/article/details/124997741
版权

目录

1. 校验需求 

2. 校验方法

2.1 拼接式校验

2.1.1 定义

2.1.2 举例

2.1.3 缺点

2.2 声明式校验 JSR303

2.2.1 定义

2.2.2 相关注解

2.2.3 Hibernate Validator 扩展注解

2.2.4 基本使用

2.2.5 分组校验（多场景的复杂校验）和自定义校验

1. 校验需求 

        对前端传来入参做数据合法性检查。

2. 校验方法

2.1 拼接式校验

2.1.1 定义

        在业务成对request中的参数一个个做非空判断。

2.1.2 举例

        Stu.java

@Data
@EqualsAndHashCode(callSuper = false)
public class Stu implements Serializable {
    private static final long serialVersionUID = 1L;

    @TableId(value = "id",type = IdType.AUTO)
    private int id;
    private String name;
    private int age;
    private String gender;
    private String address;
    private Date birth;
}

        StuServiceImpl.java

@Service
public class StuServiceImpl extends ServiceImpl<StuMapper, Stu> implements StuServiceI {
    @Override
    public Result add(Stu stu) {
        if(stu.getName()==null){
            return Result.fail("学生名不能为空");
        }
        if(stu.getAddress()==null){
            return Result.fail("学生地址不能为空");
        }
        this.save(stu);
        return Result.success();
    }
}

2.1.3 缺点

        如果实体类字段很多，不易维护，给业务层增加负担。

2.2 声明式校验 JSR303

2.2.1 定义

        声明式校验，也称JSR303校验。

        JRS303是Java为Bean数据合法性校验提供的标准框架，JSR303通过在Bean属性上标注类似于@NotNull、@NotBlank实现数据合法性校验。

2.2.2 相关注解

注解功能
@Null验证对象是否为 null
@NotNull验证对象是否不为 null
@AssertTrue验证 Boolean 对象是否为 true
@AssertTrue验证 Boolean 对象是否为 false
@Max(value)验证 Number 和 String 对象是否小于等于指定值
@Min(value)验证 Number 和 String 对象是否大于等于指定值
@DecimalMax(value)验证注解的元素值小于等于 @DecimalMax 指定的 value 值
@DecimalMin(value)验证注解的元素值大于等于 @DecimalMin 指定的 value 值
@Digits(integer,fraction)验证字符串是否符合指定格式的数字，integer 指定整数精度，fraction 指定小数精度
@Size(min,max)验证对象长度是否在给定的范围内
@Past验证 Date 和 Calendar 对象是否在当前时间之前
@Future验证 Date 和 Calendar 对象是否在当前时间之后
@Pattern验证 String 对象是否符合正则表达式的规则
@NotBlank检查字符串是不是 Null，被 Trim 的长度是否大于0，只对字符串，且会去掉前后空格
@URL验证是否是合法的 url
@CreditCardNumber验证是否是合法的信用卡号

2.2.3 Hibernate Validator 扩展注解

注解功能
@Email验证是否是合法的邮箱
@Length(min,max)验证字符串的长度必须在指定范围内
@NotEmpty检查元素是否为 Null 或 Empty
@Range(min,max,message)验证属性值必须在合适的范围内

2.2.4 基本使用

2.2.4.1 pom.xml

  <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-validation</artifactId>
  </dependency>

注意：validation 启动依赖里 包含jakarta:el:3.0.4.jar 和hibernate-validator:6.1.7.Final.jar

2.2.4.2 实体类Stu.java

@Data
@EqualsAndHashCode(callSuper = false)
public class Stu implements Serializable {
    private static final long serialVersionUID = 1L;

    @TableId(value = "id",type = IdType.AUTO)
    private int id;
    @NotBlank(message = "姓名不能为空")
    @Length(max = 20, message = "用户名称的长度不能超过20")
    private String name;
    private int age;
    private String gender;
    @NotBlank(message = "性别不能为空")
    private String address;
    private Date birth;
}

2.2.4.3 控制层StuController.java

        使用@Valid注解。

        如果想进行分组校验可使用@Validated注解，这里不做演示。

@RestController
@RequestMapping("/stu")
public class StuController {
    @Resource
    private StuServiceI stuService;

    @PostMapping
    public Result add(@Valid @RequestBody Stu stu){
        stuService.save(stu);
        return Result.success("新增成功");
    }
}

2.2.4.4 全局异常处理ExceptionCatch.java

        数据合法校验的异常是MethodArgumentNotValidException，多个数据合法校验异常，只提示用户第一个。

@RestControllerAdvice
public class ExceptionCatch {

    private static ImmutableMap.Builder<Class<? extends Exception>,ExceptionResult> builder = ImmutableMap.builder();
    /**
     * 自定义异常处理
     * @param e
     * @return
     */
    @ExceptionHandler(CustomException.class)
    public ResponseResult handlerRuntimeException(CustomException e){
        ExceptionResult result = e.getExceptionResult();
        return ResponseResult.fail(result.retCode(),result.retMsg());
    }

    @ExceptionHandler(value= MethodArgumentNotValidException.class)
    public ResponseResult validateException(MethodArgumentNotValidException e){
        BindingResult bindingResult=e.getBindingResult();
        Map<String,Object> map=new HashMap<>();
        List<FieldError> fieldErrors = bindingResult.getFieldErrors();
        FieldError fieldError = fieldErrors.get(0);
        map.put("field",fieldError.getField());
        map.put("msg",fieldError.getDefaultMessage());
        return ResponseResult.fail("数据校验异常",map);

    }
    /**
     * 其他异常处理
     *          除运行时异常以外的异常
     * @param e
     * @return
     */
    @ExceptionHandler(Exception.class)
    public ResponseResult handlerException(Exception e){
        ExceptionResult result = builder.build().get(e.getClass());
        if(ObjectUtil.isNotNull(result)){
            return ResponseResult.fail(result.retCode(),result.retMsg());
        }
        return ResponseResult.fail(e.getMessage());
    }
}

2.2.4.5 测试

2.2.5 分组校验（多场景的复杂校验）和自定义校验

项目中一般使用分组校验或自定义校验，这里更换实体类和优化统一异常处理。

1. 分组校验（多场景的复杂校验）

        新增、修改等接口想要校验的入参不同，可以通过分组进行校验。

（1）引入相关依赖 pom.xml

<!-- 数据校验 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

（2）返回前端数据的相关类

/**
 * 返回数据
 *
 * @author wen
 */
public class R extends HashMap<String, Object> {
	private static final long serialVersionUID = 1L;
	
	public R() {
		put("code", 0);
		put("msg", "success");
	}
	
	public static R error() {
		return error(HttpStatus.SC_INTERNAL_SERVER_ERROR, "未知异常，请联系管理员");
	}
	
	public static R error(String msg) {
		return error(HttpStatus.SC_INTERNAL_SERVER_ERROR, msg);
	}
	
	public static R error(int code, String msg) {
		R r = new R();
		r.put("code", code);
		r.put("msg", msg);
		return r;
	}

	public static R ok(String msg) {
		R r = new R();
		r.put("msg", msg);
		return r;
	}
	
	public static R ok(Map<String, Object> map) {
		R r = new R();
		r.putAll(map);
		return r;
	}
	
	public static R ok() {
		return new R();
	}

	@Override
	public R put(String key, Object value) {
		super.put(key, value);
		return this;
	}
}

（3） 统一处理的全局异常、异常消息枚举类

@Slf4j
@RestControllerAdvice(basePackages = "com.wen.product.controller")
public class ExceptionControllerAdvice {


    @ExceptionHandler(MethodArgumentNotValidException.class)
    public R handlerValidException(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.VAILD_EXCEPTION.getCode(), BizCodeEnum.VAILD_EXCEPTION.getMsg()).put("data",errorMap);
    }

    @ExceptionHandler(Throwable.class)
    public R handlerException(Throwable throwable){
        return R.error(BizCodeEnum.UNKNOW_EXCEPTION.getCode(), BizCodeEnum.UNKNOW_EXCEPTION.getMsg());
    }
}
public enum BizCodeEnum {
    UNKNOW_EXCEPTION(10000,"系统未知异常"),
    VAILD_EXCEPTION(10001,"参数格式校验异常");
    private int code;
    private String msg;

    BizCodeEnum(int code, String msg){
        this.code = code;
        this.msg = msg;
    }

    public int getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }
}

（4） 定义分组接口

        这边定义新增校验分组接口AddGroup、修改校验分组接口UpdateGroup、修改状态分组接口UpdateStatusGroup。

/**
 * 新增数据 Group
 *
 * @author wen
 */
public interface AddGroup {
}
/**
 * 更新数据 Group
 *
 * @author wen
 */

public interface UpdateGroup {

}
/**
 * @author wen
 * @createDate 2023/3/24 15:04
 * @description 修改状态 Group
 */
public interface UpdateStatusGroup {
}

（5）实体类 BrandEntity

观察JSR303校验注解的groups属性的值就是不同分组想要校验的实体变量。 

@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, UpdateStatusGroup.class})
	@TableId
	private Long brandId;
	/**
	 * 品牌名
	 */
	@NotBlank(message = "品牌名不能为空",groups = {AddGroup.class,UpdateGroup.class})
	private String name;
	/**
	 * 品牌logo地址
	 */
	@NotBlank(message = "品牌logo地址不能为空",groups = {AddGroup.class})
	@URL(message = "品牌logo地址必须是一个合法的URL",groups = {AddGroup.class,UpdateGroup.class})
	private String logo;
	/**
	 * 介绍
	 */
	private String descript;
	/**
	 * 显示状态[0-不显示；1-显示]
	 */
	@NotNull(message = "显示状态不能为空", groups = {AddGroup.class, UpdateStatusGroup.class})
	private Integer showStatus;
	/**
	 * 检索首字母
	 */
	@NotEmpty(message = "检索首字母不能为空",groups = {AddGroup.class})
	@Pattern(regexp = "^[a-zA-Z]$", message = "检索首字母必须是一个字母",groups = {AddGroup.class,UpdateGroup.class})
	private String firstLetter;
	/**
	 * 排序
	 */
	@NotNull(message = "排序不能为空",groups = {AddGroup.class})
	@Min(value = 0, message = "排序必须大于等于0的整数",groups = {AddGroup.class,UpdateGroup.class})
	private Integer sort;

}

（6）控制层使用@Validated注解开启分组校验

@RestController
@RequestMapping("product/brand")
public class BrandController {
    @Autowired
    private BrandService brandService;

    /**
     * 保存
     */
    @RequestMapping("/save")

    public R save(@Validated({AddGroup.class}) @RequestBody BrandEntity brand){
		brandService.save(brand);

        return R.ok();
    }

    /**
     * 修改
     */
    @RequestMapping("/update")

    public R update(@Validated(UpdateGroup.class) @RequestBody BrandEntity brand){
		brandService.updateDetail(brand);
        return R.ok();
    }
    /**
     * 修改状态
     */
    @RequestMapping("/update/status")

    public R updateStatus(@Validated(UpdateStatusGroup.class) @RequestBody BrandEntity brand){
        brandService.updateById(brand);
        //brandService.updateBrand(brand);
        return R.ok();
    }

（7）测试

 2. 自定义校验

（1）引入依赖 pom.xml

        在基础校验和分组校验的基础上添加validation-api依赖，该依赖中包含自定义校验所需的校验器等。

<!-- 数据校验 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

<!--   自定义JSR303校验     -->
<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>2.0.1.Final</version>
</dependency>

（2）和（3）同分组校验的（2）和（3）

（4）自定义校验注解（默认消息提示）、自定义校验器

 1）编写一个自定义的校验注解
        默认message定义在src/main/resources/ValidationMessages.properties文件中
 2）编写一个自定义的校验器
 3）关联自定义的校验注解和自定义的校验器，使用@Constraint注解

注意：一个自定义注解可以指定多个不同的校验器，适配不同的校验。

/**
 * @author wen
 * @createDate 2023/3/24 14:17
 * @description 自定义校验注解
 */
@Documented
@Constraint(
        validatedBy = {ListValueConstraintValidator.class}
) // 指定校验器
@Target({ElementType.METHOD, ElementType.FIELD, ElementType.ANNOTATION_TYPE, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ListValue {
    String message() default "{com.wen.common.validator.anno.ListValue.message}";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};

    int[] vals() default {};
}

ValidationMessages.properties

com.wen.common.validator.anno.ListValue.message=必须提交指定的值
/**
 * @author WangWenwen
 * @createDate 2023/3/24 14:20
 * @description 自定义ListValue校验器
 * ConstraintValidator<A,T>:A-指定注解；T-指定什么类型的数据
 *
 */
public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {

    private Set<Integer> set = new HashSet<>();

    @Override
    public void initialize(ListValue constraintAnnotation) {
        int[] vals = constraintAnnotation.vals();
        if(vals!=null && vals.length>0){
            for (int val : vals) {
                set.add(val);
            }
        }
    }

    /**
     *
     * @param integer 需要校验的值
     * @param constraintValidatorContext
     * @return
     */
    @Override
    public boolean isValid(Integer integer, ConstraintValidatorContext constraintValidatorContext) {
        return set.contains(integer);
    }
}

（5）实体类 BrandEntity

        实体类中的showStatus变量使用@ListValue注解。

@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, UpdateStatusGroup.class})
	@TableId
	private Long brandId;
	/**
	 * 品牌名
	 */
	@NotBlank(message = "品牌名不能为空",groups = {AddGroup.class,UpdateGroup.class})
	private String name;
	/**
	 * 品牌logo地址
	 */
	@NotBlank(message = "品牌logo地址不能为空",groups = {AddGroup.class})
	@URL(message = "品牌logo地址必须是一个合法的URL",groups = {AddGroup.class,UpdateGroup.class})
	private String logo;
	/**
	 * 介绍
	 */
	private String descript;
	/**
	 * 显示状态[0-不显示；1-显示]
	 */
	@NotNull(message = "显示状态不能为空", groups = {AddGroup.class, UpdateStatusGroup.class})
	@ListValue(vals = {0,1}, groups = {AddGroup.class})
	private Integer showStatus;
	/**
	 * 检索首字母
	 */
	@NotEmpty(message = "检索首字母不能为空",groups = {AddGroup.class})
	@Pattern(regexp = "^[a-zA-Z]$", message = "检索首字母必须是一个字母",groups = {AddGroup.class,UpdateGroup.class})
	private String firstLetter;
	/**
	 * 排序
	 */
	@NotNull(message = "排序不能为空",groups = {AddGroup.class})
	@Min(value = 0, message = "排序必须大于等于0的整数",groups = {AddGroup.class,UpdateGroup.class})
	private Integer sort;

}

（6）控制层在分组的基础上

@ListValue指定的分组是新增。

@RestController
@RequestMapping("product/brand")
public class BrandController {
    @Autowired
    private BrandService brandService;

    /**
     * 保存
     */
    @RequestMapping("/save")

    public R save(@Validated({AddGroup.class}) @RequestBody BrandEntity brand){
		brandService.save(brand);

        return R.ok();
    }
}

（7）测试 

W@#
关注
  • 2
    点赞
  • 踩
  • 7
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Java如何使用JSR303校验数据与自定义校验注解
10-14
主要介绍了Java如何使用JSR303校验数据与自定义校验注解，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
JSR303JavaBean参数校验+统一处理异常
furenqiang的博客
07-19 1118
JSR303+统一处理异常一、JSR303介绍二、JSR303使用三、统一处理异常 一、JSR303介绍 JSR是Java Specification Requests的缩写，意思是Java 规范提案。是指向JCP(Java Community Process)提出新增一个标准化技术规范的正式请求。任何人都可以提交JSR，以向Java平台增添新的API和服务。JSR已成为Java界的一个重要标准。 二、JSR303使用 使用场景：当前端进行表单验证后，还是可以使用postman去恶意传参，所以JSR3
SpringBoot：yaml注入，JSR303数据校验
半山腰太挤了，你要去山顶看看
11-10 885
一、yaml YAML是"YAML Ain’t a Markup Language"（YAML不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（仍是一种标记语言），但为了强调这种语言以数据做为中心，而不是以标记语言为重点，而用反向缩略语重命名。 yaml语法采用多行缩进，对比XML格式，yaml精简、可读性高 yaml语法格式： 属性:空格 值 以缩进来控制层级关系，只要左对齐则是同一级 大小写十分敏感 二、yaml注入
JSR303数据校验
qiangqiang12138的博客
12-18 380
后端校验技术 JSR303技术，JSR-303 是JAVA EE 6 中的一项子规范，叫做Bean Validation，Hibernate Validator 是 Bean Validation 的参考实现 . Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现，除此之外还有一些附加的 constraint，在springboot中使用也比较简便。 1.给需要校验的字段添加校验注解 在javax.validation.constraints包下有许
8.Spring服务器端数据校验（JSR-303）
相互学习 共同进步
04-27 320
数据校验：①客户端校验、②服务器端校验 在Spring MVC 框架中有两种方法可以验证输入数据，一种是利用Spring自带的验证框架，另一种是利用JSR 303实现验证，推荐使用JSR 303验证。 1.前端校验要做，目的是为了提高用户体验 2.后端校验也要做，目的是为了数据安全
JSR303校验
Hola
09-12 3666
JSR是Java Specification Requests的缩写，意思是Java 规范提案 JSR-303 是JAVA EE 6 中的一项子规范，叫做Bean Validation即，JSR 303，Bean Validation规范 ，为Bean验证定义了元数据模型和API.。默认的元数据模型是通过Annotations来描述的，但是也可以使用XML来重载或者扩展。
使用JRS303校验对参数进行提前校验
金蒂
06-16 660
我们在开发过程中前段发过来的请求大部分会携带一些参数，而这些参数大部分不是固定写好的，是变化的、随机的，是我们和前端一起商量好的模版。这样就会带来一些无法避免的问题，比如参数个数不匹配，又或者最最常见的空指针问题​​​​。
JSR303 参数校验
Java 领域技术分享
04-14 984
什么是JSR303 参数校验？ JSR303 是一套 JavaBean 参数校验的标准，它定义了很多常用的校验注解，我们可以直接将这些注解加在我们 JavaBean 的属性上面，就是类里面的字段上面，就可以在需要校验的时候进行校验了。 怎么使用JSR303? 导入 validation 依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-st
JSR-303数据校验
junR_980218的博客
05-05 1621
JSR-303数据校验
jsr303校验.txt
01-27
jsr303校验.txt
JSR303+AOP数据校验
11-20
集成Swagger api管理 包含对象的一般校验和级联校验，可直接进入swagger-ui.html进行测试
SpringBoot结合JSR303对前端数据进行校验的示例代码
10-14
主要介绍了SpringBoot结合JSR303对前端数据进行校验的示例代码，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
JSR303定义的校验类型
10-20
根据类的注解，自动验证，不需要去没个属性单独验证
狂神说SpringBoot04：JSR303数据校验及多环境切换
狂神说
03-11 4340
狂神说SpringBoot系列连载课程，通俗易懂，基于SpringBoot2.2.5版本，欢迎各位狂粉转发关注学习。未经作者授权，禁止转载JSR303数据校验先看看如何使用Springb...
JSR303校验详解(基础校验,分组校验,自定义校验)结合 全局异常处理捕获校验异常
weixin_51751186的博客
05-13 1695
详解jsr303校验
【参数校验】JSR303实现自定义注解+自定义校验器实现参数的动态校验
最新发布
weixin_43431346的博客
02-02 350
Class<?Class<?
JSR-303 数据校验
小老弟的博客
08-25 500
一、JSR-303简介 JSR-303 是 JAVA EE 6 中的一项子规范，叫做 Bean Validation，官方参考实现是Hibernate Validator。 此实现与 Hibernate ORM 没有任何关系。 JSR 303 用于对 Java Bean 中的字段的值进行验证。  Spring MVC 3.x 之中也大力支持 JSR-303，可以在控制器中对表单提交的数据......
jsr303数据校验是什么
07-28
JSR303数据校验是一种用于对Java Bean中的字段的值进行验证的规范。它可以通过注解的方式对表单提交的数据进行方便地验证。在Spring MVC 3.x中也大力支持JSR-303，可以在控制器中进行数据校验。\[1\]数据校验的基本...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值