Java利用自定义注解实现数据校验
作者：扫地和尚 发布时间：2022-12-03 09:56:49
JSR303介绍
在Java中提供了一系列的校验方式
这些校验方式在javax.validation.constraints包中
引入依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
常用注解
@Null 验证对象是否为null
@NotNull 验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty 检查约束元素是否为NULL或者是EMPTY.
Booelan检查
@AssertTrue 验证 Boolean 对象是否为 true
@AssertFalse 验证 Boolean 对象是否为 false
长度检查
@Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
@Length(min=, max=) Validates that the annotated string is between min and max included.
日期检查
@Past 验证 Date 和 Calendar 对象是否在当前时间之前，验证成立的话被注释的元素一定是一个过去的日期
@Future 验证 Date 和 Calendar 对象是否在当前时间之后 ，验证成立的话被注释的元素一定是一个将来的日期
@Pattern 验证 String 对象是否符合正则表达式的规则，被注释的元素符合制定的正则表达式，regexp:正则表达式 flags: 指定 Pattern.Flag 的数组，表示正则表达式的相关选项。
数值检查
建议使用在Stirng,Integer类型，不建议使用在int类型上，因为表单值为“”时无法转换为int，但可以转换为Stirng为”“,Integer为null
@Min 验证 Number 和 String 对象是否大等于指定的值
@Max 验证 Number 和 String 对象是否小等于指定的值
@DecimalMax 被标注的值必须不大于约束中指定的最大值. 这个约束的参数是一个通过BigDecimal定义的最大值的字符串表示.小数存在精度
@DecimalMin 被标注的值必须不小于约束中指定的最小值. 这个约束的参数是一个通过BigDecimal定义的最小值的字符串表示.小数存在精度
@Digits 验证 Number 和 String 的构成是否合法
@Digits(integer=,fraction=) 验证字符串是否是符合指定格式的数字，interger指定整数精度，fraction指定小数精度。
@Range(min=, max=) 被指定的元素必须在合适的范围内
@Range(min=10000,max=50000,message=”range.bean.wage”)
@Valid 递归的对关联对象进行校验, 如果关联对象是个集合或者数组,那么对其中的元素进行递归校验,如果是一个map,则对其中的值部分进行校验.(是否进行递归验证)
@CreditCardNumber信用卡验证
@Email 验证是否是邮件地址，如果为null,不进行验证，算通过验证。
@ScriptAssert(lang= ,script=, alias=)
@URL(protocol=,host=, port=,regexp=, flags=)
开启校验
controller中加校验注解@Valid，开启校验
数据校验测试
步骤1：实体类字段上使用校验注解 @NotNull @NotEmpty @NotBlank @Pattern
步骤2：controller中加校验注解@Valid，开启校验
步骤3：给校验的Bean后，紧跟一个BindingResult，就可以获取到校验的结果
public R save(@Valid @RequestBody User user, BindingResult result){}
实体中添加注解
@Data
public class Student {
@NotEmpty(message ="姓名不能为空")
private String name;
}
controller层中保存方法添加：@Valid
@PostMapping("/jsr")
public AjaxResult testJrs(@Valid @RequestBody User user, BindingResult result) {
String name = user.getName();
HashMap<String, Object> map = new HashMap<>();
map.put("name", name);
map.put("errors", result.getFieldErrors());
return AjaxResult.success("数据校验", map);
}
数据校验测试：测试：http://localhost:8080/test/jsr
@Data
public class User {
@NotEmpty(message = "姓名不能为空")
@ApiModelProperty("姓名")
private String name;
@ApiModelProperty("学号")
private String id;
@ApiModelProperty("年龄")
private String age;
}
返回信息
{
"msg": "数据校验",
"code": 200,
"data": {
"name": "",
"errors": [
{
"codes": [
"NotEmpty.user.name",
"NotEmpty.name",
"NotEmpty.java.lang.String",
"NotEmpty"
],
"arguments": [
{
"codes": [
"user.name",
"name"
],
"defaultMessage": "name",
"code": "name"
}
],
"defaultMessage": "姓名不能为空",
"objectName": "user",
"field": "name",
"rejectedValue": "",
"bindingFailure": false,
"code": "NotEmpty"
}
]
}
}
自定义的封装错误信息
@PostMapping("/package")
public AjaxResult testPackage(@Valid @RequestBody User user, BindingResult result) {
String name = user.getName();
Map<String, String> map = new HashMap<>();
map.put("name", name);
if (result.hasErrors()) {
//1.获取错误的校验结果
result.getFieldErrors().forEach((item) -> {
//2.获取发生错误时的message
String message = item.getDefaultMessage();
//3.获取发生错误的字段
String field = item.getField();
map.put(field, message);
});
return AjaxResult.error("数据校验", map);
} else {
return AjaxResult.success(map);
}
}
自定义的封装错误信息：测试：http://localhost:80/test/package
{
"name": "",
"id": "demoData",
"age": "demoData"
}
错误信息
{
"msg": "数据校验",
"code": 500,
"data": {
"name": "姓名不能为空"
}
}
统一异常处理
@Slf4j
@RestControllerAdvice(basePackages = "com.michale.jrs303.controllers")
public class FireflyMallExceptionControllerAdvice {
/**
* 处理数据校验问题
* @param e
* @return
*/
@ExceptionHandler(value = MethodArgumentNotValidException.class)
public Result handleVaildException(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 Result.fail(errorMap, "数据校验出现问题");
}
/**
* 处理其他异常
* @param throwable
* @return
*/
@ExceptionHandler(value = Throwable.class)
public Result handleException(Throwable throwable) {
return Result.fail();
}
}
@RequestMapping("/testException")
public Result testException(@Valid @RequestBody Student student) {
String name = student.getName();
Map<String, String> map = new HashMap<>();
map.put("name", name);
return Result.ok(map);
}
测试统一异常处理：测试：http://localhost:8080/testException
{
"msg": "数据校验出现问题",
"path": "/test/testException",
"code": 414,
"errors": {
"name": "姓名不能为空"
}
}
错误信息
{
"code": 500,
"msg": "数据校验出现问题",
"data": {
"name": "姓名不能为空"
}
}
分组校验
创建分组校验接口
/**
* @Author 天才小狐狸
* @Data 2022/8/11 2:03
* @Description 姓名校验分组
*/
public interface NameGroup {
}
/**
* @Author 天才小狐狸
* @Data 2022/8/11 2:04
* @Description 年龄校验分组
*/
public interface AgeGroup {
}
添加校验注解
@Data
public class Student {
@NotEmpty(message ="姓名不能为空",groups = NameGroup.class)
private String name;
@NotEmpty(message ="绰号不能为空",groups = NameGroup.class)
private String nickName;
@Min(value = 18,message = "年龄下限不能低于18岁" ,groups = AgeGroup.class)
private String age;
@Max(value = 60,message = "年龄上限不能超过60岁" ,groups = AgeGroup.class)
private String retireAge;
}
开启分组校验
@Validated(NameGroup.class)指定校验分组
@RequestMapping("/testGroup")
public Result testGroup(@Validated(NameGroup.class) @RequestBody Student student) {
String name = student.getName();
String nickName = student.getNickName();
String age = student.getAge();
String retireAge = student.getRetireAge();
Map<String, String> map = new HashMap<>();
map.put("name", name);
map.put("nickname", nickName);
map.put("age", age);
map.put("retireAge", retireAge);
return Result.ok(map);
}
测试分组校验：http://localhost:8080/testGroup
{
"name":"",
"nickName":"",
"age":"17",
"retireAge":"66"
}
错误信息
{
"code": 500,
"msg": "数据校验出现问题",
"data": {
"nickName": "绰号不能为空",
"name": "姓名不能为空"
}
}
@Validated(AgeGroup.class)指定校验分组
@RequestMapping("/testGroup")
public Result testGroup(@Validated(AgeGroup.class) @RequestBody Student student) {
String name = student.getName();
String nickName = student.getNickName();
String age = student.getAge();
String retireAge = student.getRetireAge();
Map<String, String> map = new HashMap<>();
map.put("name", name);
map.put("nickname", nickName);
map.put("age", age);
map.put("retireAge", retireAge);
return Result.ok(map);
}
测试分组校验：http://localhost:8080/testGroup
{
"name":"",
"nickName":"",
"age":"17",
"retireAge":66
}
错误信息
{
"code": 500,
"msg": "数据校验出现问题",
"data": {
"retireAge": "年龄上限不能超过60岁",
"age": "年龄下限不能低于18岁"
}
}
自定义校验
编写自定义的校验注解
比如要创建一个：@ListValue 注解，被标注的字段值只能是：0或1
@Documented
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {
// 使用该属性去Validation.properties中取
String message() default "{com.atguigu.common.valid.ListValue.message}";
Class<?>[] groups() default { };
Class<? extends Payload>[] payload() default { };
int[] value() default {};
}
设置错误信息：创建文件ValidationMessages.properties
com.firefly.common.valid.ListValue.message=必须提交指定的值 [0,1]
编写自定义的校验器
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.HashSet;
import java.util.Set;
/**
* @author Michale @EMail：firefly@163.com
* @Date: 2022/1/8 19:23
* @Name ListValueConstraintValidator
* @Description:
*/
public class ListValueConstraintValidator implements ConstraintValidator<ListValue, Integer> {
private Set<Integer> set = new HashSet<>();
@Override
public void initialize(ListValue constraintAnnotation) {
//获取注解允许的值
int[] value = constraintAnnotation.value();
for (int i : value) {
set.add(i);
}
}
@Override
public boolean isValid(Integer value, ConstraintValidatorContext context) {
//判断传入的值是否在满足允许的值
boolean b = set.contains(value);
return b;
}
}
关联校验器和校验注解
在@ListValue注解关联校验器
@Constraint(validatedBy = { ListValueConstraintValidator.class})
一个校验注解可以匹配多个校验器
添加自定义的校验注解
@ListValue(value = {0,1},groups = {AgeGroup.class,MyJRS303Group.class})
private Integer gender;
测试自定义校验器：http://localhost:8080/testGroup
{
"gender":"3"
}
{
"code": 500,
"msg": "数据校验出现问题",
"data": {
"gender": "必须提交指定的值 [0,1]"
}
}
来源：https://juejin.cn/post/7138373378070560782
0
投稿猜你喜欢
在C#中DateTime是一个包含日期、时间的类型，此类型通过ToString()转换为字符串时，可根据传入给Tostring()的参数转换- 最早开始的时候做过一些数据Excel导出的功能，但是到后期每一次导出都需要写一些差不多类似的代码，稍微研究了一下写了个公共的导出方法。这里用
- 不少朋友自己下载了一个Android SDK，怎样在Android studio中默认的Android SDK路径呢？打开Android s
- 你好，今天我要和大家分享一些东西，举例来说这个在JavaScript中用的很多。我要讲讲回调（callbacks）。你知道什么时候用，怎么用
- 1、使用Adobe PDF Reader控件。从COM组件库中找到Adobe PDF Reader控件，添加到工具箱中。从工具箱中拖入PDF
- Android 是一款基于 Linux 内核，面向移动终端的操作系统。为适应其作为移动平台操作系统的特殊需要，谷歌对其做了特别的设计与优化，
- 前言随着使用 Spring 进行开发的个人和企业越来越多，Spring 也慢慢从一个单一简洁的小框架变成一个大而全的开源软件，Spring
- 意义：由于每个应用进程都有自己的独立进程空间，在android平台上，一个进程通常不能访问另一个进程的内存空间，而我们经常需要夸进程传递对象
- 前言工作中是否遇到这样的场景？1、需要异步线程执行，而且需要获取到线程执行返回的结果。2、如果执行过程异常，可以按照自定义方式消费异常信息。
- 本文实例讲述了spring AOP的Around增强实现方法。分享给大家供大家参考，具体如下：一 配置<?xml version=&q
- 目录场景介绍自动填充处理器Mybatis-Plus配置类配置实体类中相关字段的自动填充策略在阿里开发手册的建表规约中有说明，数据库表中应该都
- 基于SSM+Mysql+Maven+HTML实现的员工绩效管理系统。该系统只有后台页面，后台前端框架使用的是layui官网推荐后台界面。角色
- 目录1、对于A、B两种排队方式，说法正确的是2、Inter-process communication (IPC) is the trans
- 本文实例讲述了C#实现对二维数组排序的方法。分享给大家供大家参考。具体实现方法如下：/// <summary>/// A gen
- 1.服务配置中心1.1 服务配置中心介绍首先我们来看一下,微服务架构下关于配置文件的一些问题:1.配置文件相对分散。在一个微服务架构下，配置
- 项目描述：这是一个基于SpringBoot+Vue框架开发的仿小米电子产品售卖商城系统。首先，这是一个前后端分离的项目，代码简洁规范，注释说
- ClassLoader概念我们知道，Java源文件（.java）经过编译器编译之后，会转换成Java字节码(.class)，然而程序是如何加
- 内部类的介绍定义在另外一个类中的类，叫内部类成员内部类1..new 创建成员内部类必须先创建外部类的实例，然后通过.new 创建内部类的对象
- 本文为大家分享一个非常简单但又很常用的控件，跑马灯状态的TextView。当要显示的文本长度太长，又不想换行时用它来显示文本，一来可以完全的
- 写在前面的废话 下载文件，几乎是所有APP都会用到的功能！算了，还是不废话了，直接开写吧。。。 简单使用 完成
