• 欢迎访问搞代码网站,推荐使用最新版火狐浏览器和Chrome浏览器访问本网站!
  • 如果您觉得本站非常有看点,那么赶紧使用Ctrl+D 收藏搞代码吧

Java如何使用JSR303校验数据与自定义校验注解

java 搞代码 4年前 (2022-01-05) 29次浏览 已收录 0个评论

这篇文章主要介绍了Java如何使用JSR303校验数据与自定义校验注解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

一、自带校验注解实现数据校验

1、web项目导入依赖

 <!-- 该依赖默认导入了 hibernate-validator 所以不需要再单独导入 -->        org.springframework.boot     spring-boot-starter-web   

下图可以看到spring-boot-starter-web依赖自动引入了hibernate-validator;

如果感兴趣的话还可以进入hibernate-validator查看引入了什么相关依赖

2、默认注解的使用

在需要校验的字段添加不同校验类型的注解

 /** * 品牌id */ @NotNull(message = "必须提交品牌id") @TableId private Long brandId; /** * 品牌名 */ @NotBlank(message = "品牌名不<a style="color:transparent">来源gao($daima.com搞@代@#码(网</a>可为空") private String name; /** * 品牌logo地址 */ @NotBlank(message = "logo必须提交") @URL(message = "logo地址格式错误") private String logo; /** * 介绍 */ private String descript; /** * 显示状态[0-不显示;1-显示] */private Integer showStatus; /** * 检索首字母 - 正则校验实现 */ @NotNull(message = "首字母必须提交") @Pattern(message = "首字母必须是一个字母,且a-z或A-Z", regexp = "/^[a-zA-Z]$/") private String firstLetter;

下图是自带的所有校验注解,可以进入查看源码的注释查看如何使用

3、设置谁需要进行数据校验!!!

在接口参数需要校验的对象前标注注解**@Valid** – 标明前台提交数据时该对象的字段需要进行数据校验

 /** * 修改 */ @RequestMapping("/update") public R update(@Valid @RequestBody AttrGroupEntity attrGroup){ attrGroupService.updateById(attrGroup); return R.ok(); }

二、如何使用分组校验?

由于不同功能的接口接收的对象数据可能需要校验的字段不同,并不是每一个接口接收的对象的所有字段都需要校验的,所以则需要使用”分组校验”来区分不同的业务需要校验不同的字段,在这里我使用新增业务和修改业务为例。

根据上图可以看到,默认的注解源码不仅可以设置message(消息)还有一个可以设置group(分组)

1、创建分组接口

 /** * 新增业务分组校验 - 不需要实现任何业务,只是用来标识身份 */ public interface AddGroup { } 
 /** * 修改业务分组校验 - 不需要实现任何业务,只是用来标识身份 */ public interface UpdateGroup { } 

2、如何使用分组校验?

2.1、修改Bean每个字段上校验注解,设置group值

 /** * 品牌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(message = "logo必须提交", groups = {AddGroup.class}) @URL(message = "logo地址格式错误", groups = {AddGroup.class, UpdateGroup.class}) private String logo; /** * 介绍 */ private String descript; /** * 显示状态[0-不显示;1-显示] */ private Integer showStatus; /** * 检索首字母 */ @NotNull(message = "首字母必须提交", groups = {AddGroup.class}) @Pattern(message = "首字母必须是一个字母,且a-z或A-Z", regexp = "/^[a-zA-Z]$/", groups = {AddGroup.class, UpdateGroup.class}) private String firstLetter; /** * 排序 */ @Min(value = 0, groups = {AddGroup.class, UpdateGroup.class}) private Integer sort; 

2.2、设置什么业务需要使用什么分组进行校验

 /** * 保存 - 使用添加分组校验接口参数对象的字段 */ @RequestMapping("/save") public R save(@Validated(value = {AddGroup.class}) @RequestBody BrandEntity brand){ brandService.save(brand); return R.ok(); } 
 /** * 修改 - 使用修改分组校验接口参数对象的字段 */ @RequestMapping("/update") public R update(@Validated(value = UpdateGroup.class) @RequestBody BrandEntity brand){ brandService.updateById(brand); return R.ok(); } 

此时,不同业务就会校验不同的字段!!!

三、自定义校验注解

1、导入依赖的jar包

  javax.validationvalidation-api2.0.1.Final

2、编写自定义校验注解

 /** * 自定义校验注解 * @author mashanghaoyun * @date 2020/8/3115:01 */ @Target({METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE}) @Retention(RUNTIME) @Documented @Constraint(validatedBy = {}) public @interface ListValue { String message() default "{com.mashanghaoyun.common.valid.ListValue.message}"; Class[] groups() default {}; Class[] payload() default {}; int[] vals() default { }; } 

3、编写自定义校验器

 /** * 自定义校验器 * @author mashanghaoyun * @date 2020/8/3115:15 */ public class ListValueConstraintValidator implements ConstraintValidator { private Set set = new HashSet(); /** * @Description 初始化方法 * @Author mashanghaoyun * @Date 15:17 2020/8/31 * @Param [constraintAnnotation] * @return void **/ @Override public void initialize(ListValue constraintAnnotation) { int[] vals = constraintAnnotation.vals(); if (vals.length > 0) { for (int val : vals) { set.add(val); } } } /** * @Description 判断是否校验成功 * @Author mashanghaoyun * @Date 15:18 2020/8/31 * @Param [value(当前提交校验的值), context] * @return boolean **/ @Override public boolean isValid(Integer value, ConstraintValidatorContext context) { if (set.size() > 0) { if (set.contains(value)) { return true; } } return false; } } 

3、关联自定义注解与校验器

4、使用自定义注解

以上就是Java如何使用JSR303校验数据与自定义校验注解的详细内容,更多请关注gaodaima搞代码网其它相关文章!


搞代码网(gaodaima.com)提供的所有资源部分来自互联网,如果有侵犯您的版权或其他权益,请说明详细缘由并提供版权或权益证明然后发送到邮箱[email protected],我们会在看到邮件的第一时间内为您处理,或直接联系QQ:872152909。本网站采用BY-NC-SA协议进行授权
转载请注明原文链接:Java如何使用JSR303校验数据与自定义校验注解

喜欢 (0)
[搞代码]
分享 (0)
发表我的评论
取消评论

表情 贴图 加粗 删除线 居中 斜体 签到

Hi,您需要填写昵称和邮箱!

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址