数据校验 JSR303校验

2023-10-29 10:10
文章标签 数据 校验 jsr303

本文主要是介绍数据校验 JSR303校验，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

目录

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 {@Overridepublic 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 {@Resourceprivate StuServiceI stuService;@PostMappingpublic 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();}@Overridepublic 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})@TableIdprivate 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 {@Autowiredprivate 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<>();@Overridepublic 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*/@Overridepublic 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})@TableIdprivate 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 {@Autowiredprivate BrandService brandService;/*** 保存*/@RequestMapping("/save")public R save(@Validated({AddGroup.class}) @RequestBody BrandEntity brand){brandService.save(brand);return R.ok();}
}

（7）测试 

这篇关于数据校验 JSR303校验的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/299931。

相关文章

Python获取中国节假日数据记录入JSON文件

Python获取中国节假日数据记录入JSON文件

《Python获取中国节假日数据记录入JSON文件》项目系统内置的日历应用为了提升用户体验,特别设置了在调休日期显示“休”的UI图标功能,那么问题是这些调休数据从哪里来呢？我尝试一种更为智能的方法：P... 目录节假日数据获取存入jsON文件节假日数据读取封装完整代码项目系统内置的日历应用为了提升用户体验，
阅读更多...
Java进行文件格式校验的方案详解

Java进行文件格式校验的方案详解

《Java进行文件格式校验的方案详解》这篇文章主要为大家详细介绍了Java中进行文件格式校验的相关方案,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录一、背景异常现象原因排查用户的无心之过二、解决方案Magandroidic Number判断主流检测库对比Tika的使用区分zip
阅读更多...
Java利用JSONPath操作JSON数据的技术指南

Java利用JSONPath操作JSON数据的技术指南

《Java利用JSONPath操作JSON数据的技术指南》JSONPath是一种强大的工具,用于查询和操作JSON数据,类似于SQL的语法,它为处理复杂的JSON数据结构提供了简单且高效... 目录1、简述2、什么是 jsONPath？3、Java 示例3.1 基本查询3.2 过滤查询3.3 递归搜索3.4
阅读更多...
MySQL大表数据的分区与分库分表的实现

MySQL大表数据的分区与分库分表的实现

《MySQL大表数据的分区与分库分表的实现》数据库的分区和分库分表是两种常用的技术方案,本文主要介绍了MySQL大表数据的分区与分库分表的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有... 目录1. mysql大表数据的分区1.1 什么是分区？1.2 分区的类型1.3 分区的优点1.4 分
阅读更多...
Mysql删除几亿条数据表中的部分数据的方法实现

Mysql删除几亿条数据表中的部分数据的方法实现

《Mysql删除几亿条数据表中的部分数据的方法实现》在MySQL中删除一个大表中的数据时,需要特别注意操作的性能和对系统的影响,本文主要介绍了Mysql删除几亿条数据表中的部分数据的方法实现,具有一定... 目录1、需求2、方案1. 使用 DELETE 语句分批删除2. 使用 INPLACE ALTER T
阅读更多...
Python Dash框架在数据可视化仪表板中的应用与实践记录

Python Dash框架在数据可视化仪表板中的应用与实践记录

《PythonDash框架在数据可视化仪表板中的应用与实践记录》Python的PlotlyDash库提供了一种简便且强大的方式来构建和展示互动式数据仪表板,本篇文章将深入探讨如何使用Dash设计一... 目录python Dash框架在数据可视化仪表板中的应用与实践1. 什么是Plotly Dash？1.1
阅读更多...
Redis 中的热点键和数据倾斜示例详解

Redis 中的热点键和数据倾斜示例详解

《Redis中的热点键和数据倾斜示例详解》热点键是指在Redis中被频繁访问的特定键,这些键由于其高访问频率,可能导致Redis服务器的性能问题,尤其是在高并发场景下,本文给大家介绍Redis中的热... 目录Redis 中的热点键和数据倾斜热点键（Hot Key）定义特点应对策略示例数据倾斜（Data S
阅读更多...
Python实现将MySQL中所有表的数据都导出为CSV文件并压缩

Python实现将MySQL中所有表的数据都导出为CSV文件并压缩

《Python实现将MySQL中所有表的数据都导出为CSV文件并压缩》这篇文章主要为大家详细介绍了如何使用Python将MySQL数据库中所有表的数据都导出为CSV文件到一个目录,并压缩为zip文件到... python将mysql数据库中所有表的数据都导出为CSV文件到一个目录，并压缩为zip文件到另一个
阅读更多...
SpringBoot整合jasypt实现重要数据加密

SpringBoot整合jasypt实现重要数据加密

《SpringBoot整合jasypt实现重要数据加密》Jasypt是一个专注于简化Java加密操作的开源工具,：本文主要介绍详细介绍了如何使用jasypt实现重要数据加密,感兴趣的小伙伴可... 目录jasypt简介 jasypt的优点SpringBoot使用jasypt创建mapper接口配置文件加密
阅读更多...
使用Python高效获取网络数据的操作指南

使用Python高效获取网络数据的操作指南

《使用Python高效获取网络数据的操作指南》网络爬虫是一种自动化程序,用于访问和提取网站上的数据,Python是进行网络爬虫开发的理想语言,拥有丰富的库和工具,使得编写和维护爬虫变得简单高效,本文将... 目录网络爬虫的基本概念常用库介绍安装库Requests和BeautifulSoup爬虫开发发送请求解
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2