JSR303校验

最新推荐文章于 2024-06-26 21:37:09 发布
最新推荐文章于 2024-06-26 21:37:09 发布
阅读量189 收藏
点赞数
分类专栏： SpringBoot 文章标签： jsr java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/wangbeita/article/details/112754750
版权

JSR303校验

一、简介

JSR-303 是 JAVA EE 6 中的一项子规范，叫做 Bean Validation。

在任何时候，当你要处理一个应用程序的业务逻辑，数据校验是你必须要考虑和面对的事情。应用程序必须通过某种手段来确保输入进来的数据从语义上来讲是正确的。在通常的情况下，应用程序是分层的，不同的层由不同的开发人员来完成。很多时候同样的数据验证逻辑会出现在不同的层，这样就会导致代码冗余和一些管理的问题，比如说语义的一致性等。为了避免这样的情况发生，最好是将验证逻辑与相应的域模型进行绑定。

Bean Validation 为 JavaBean 验证定义了相应的元数据模型和 API。缺省的元数据是 Java Annotations，通过使用 XML 可以对原有的元数据信息进行覆盖和扩展。在应用程序中，通过使用 Bean Validation 或是你自己定义的 constraint，例如 @NotNull, @Max, @ZipCode， 就可以确保数据模型（JavaBean）的正确性。constraint 可以附加到字段，getter 方法，类或者接口上面。对于一些特定的需求，用户可以很容易的开发定制化的 constraint。Bean Validation 是一个运行时的数据验证框架，在验证之后验证的错误信息会被马上返回。

1.Bean Validation 规范内嵌的约束注解

在这里插入图片描述

二、实例

1. 基本应用

1.1 引入依赖

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

1.2 给实体类成员添加校验注解

1.2.1 我们可以直接给bean成员上添加校验注解

在这里插入图片描述

1.2.2 也可以修改bean成员上添加校验注解，修改默认提示

在这里插入图片描述

1.2.3 默认的错误提示规则

这些错误消息定义在“hibernate-validator”的“\org\hibernate\validator\ValidationMessages_zh_CN.properties”文件中。在该文件中定义了很多的错误规则：

javax.validation.constraints.AssertFalse.message     = 只能为false
javax.validation.constraints.AssertTrue.message      = 只能为true
javax.validation.constraints.DecimalMax.message      = 必须小于或等于{value}
javax.validation.constraints.DecimalMin.message      = 必须大于或等于{value}
javax.validation.constraints.Digits.message          = 数字的值超出了允许范围(只允许在{integer}位整数和{fraction}位小数范围内)
javax.validation.constraints.Email.message           = 不是一个合法的电子邮件地址
javax.validation.constraints.Future.message          = 需要是一个将来的时间
javax.validation.constraints.FutureOrPresent.message = 需要是一个将来或现在的时间
javax.validation.constraints.Max.message             = 最大不能超过{value}
javax.validation.constraints.Min.message             = 最小不能小于{value}
javax.validation.constraints.Negative.message        = 必须是负数
javax.validation.constraints.NegativeOrZero.message  = 必须是负数或零
javax.validation.constraints.NotBlank.message        = 不能为空
javax.validation.constraints.NotEmpty.message        = 不能为空
javax.validation.constraints.NotNull.message         = 不能为null
javax.validation.constraints.Null.message            = 必须为null
javax.validation.constraints.Past.message            = 需要是一个过去的时间
javax.validation.constraints.PastOrPresent.message   = 需要是一个过去或现在的时间
javax.validation.constraints.Pattern.message         = 需要匹配正则表达式"{regexp}"
javax.validation.constraints.Positive.message        = 必须是正数
javax.validation.constraints.PositiveOrZero.message  = 必须是正数或零
javax.validation.constraints.Size.message            = 个数必须在{min}和{max}之间

org.hibernate.validator.constraints.CreditCardNumber.message        = 不合法的信用卡号码
org.hibernate.validator.constraints.Currency.message                = 不合法的货币 (必须是{value}其中之一)
org.hibernate.validator.constraints.EAN.message                     = 不合法的{type}条形码
org.hibernate.validator.constraints.Email.message                   = 不是一个合法的电子邮件地址
org.hibernate.validator.constraints.Length.message                  = 长度需要在{min}和{max}之间
org.hibernate.validator.constraints.CodePointLength.message         = 长度需要在{min}和{max}之间
org.hibernate.validator.constraints.LuhnCheck.message               = ${validatedValue}的校验码不合法, Luhn模10校验和不匹配
org.hibernate.validator.constraints.Mod10Check.message              = ${validatedValue}的校验码不合法, 模10校验和不匹配
org.hibernate.validator.constraints.Mod11Check.message              = ${validatedValue}的校验码不合法, 模11校验和不匹配
org.hibernate.validator.constraints.ModCheck.message                = ${validatedValue}的校验码不合法, ${modType}校验和不匹配
org.hibernate.validator.constraints.NotBlank.message                = 不能为空
org.hibernate.validator.constraints.NotEmpty.message                = 不能为空
org.hibernate.validator.constraints.ParametersScriptAssert.message  = 执行脚本表达式"{script}"没有返回期望结果
org.hibernate.validator.constraints.Range.message                   = 需要在{min}和{max}之间
org.hibernate.validator.constraints.SafeHtml.message                = 可能有不安全的HTML内容
org.hibernate.validator.constraints.ScriptAssert.message            = 执行脚本表达式"{script}"没有返回期望结果
org.hibernate.validator.constraints.URL.message                     = 需要是一个合法的URL

org.hibernate.validator.constraints.time.DurationMax.message        = 必须小于${inclusive == true ? '或等于' : ''}${days == 0 ? '' : days += '天'}${hours == 0 ? '' : hours += '小时'}${minutes == 0 ? '' : minutes += '分钟'}${seconds == 0 ? '' : seconds += '秒'}${millis == 0 ? '' : millis += '毫秒'}${nanos == 0 ? '' : nanos += '纳秒'}
org.hibernate.validator.constraints.time.DurationMin.message        = 必须大于${inclusive == true ? '或等于' : ''}${days == 0 ? '' : days += '天'}${hours == 0 ? '' : hours += '小时'}${minutes == 0 ? '' : minutes += '分钟'}${seconds == 0 ? '' : seconds += '秒'}${millis == 0 ? '' : millis += '毫秒'}${nanos == 0 ? '' : nanos += '纳秒'}

1.3 在Controller上开启校验

Controller 中需要校验的参数Bean前添加 @Valid 开启校验功能，紧跟在校验的Bean后添加一个BindingResult，BindingResult封装了前面Bean的校验结果。
在这里插入图片描述

1.4 运行效果如下

在这里插入图片描述

2. 统一异常处理

参数校验不通过时，会抛出 BingBindException 异常，可以在统一异常处理中，做统一处理，这样就不用在每个需要参数校验的地方都用 BindingResult 获取校验结果了。

2.1 抽取一个异常处理类

可以使用SpringMvc所提供的@ControllerAdvice，通过“basePackages”能够说明处理哪些路径下的异常。

package com.bigdata.gulimall.product.exception;

import com.atguigu.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;
import java.util.Map;

/**
 * 集中处理所有异常
 */
@Slf4j
@RestControllerAdvice(basePackages = "com.atguigu.gulimall.product.controller")
public class GulimallExceptionAdvice {
    @ExceptionHandler(value = Exception.class)
    public R handleValidException(MethodArgumentNotValidException exception){
        Map<String,String> map=new HashMap<>();
        BindingResult bindingResult = exception.getBindingResult();
        bindingResult.getFieldErrors().forEach(fieldError -> {
            String message = fieldError.getDefaultMessage();
            String field = fieldError.getField();
            map.put(field,message);
        });

        log.error("数据校验出现问题{},异常类型{}",exception.getMessage(),exception.getClass());
        return R.error(400,"数据校验出现问题").put("data",map);
    }

}

2.2 测试结果如下

在这里插入图片描述

2.3 默认异常处理

2.3.1 添加默认异常处理
   @ExceptionHandler(value = Throwable.class)
    public R handleException(Throwable throwable){
        log.error("未知异常{},异常类型{}",throwable.getMessage(),throwable.getClass());
        return R.error(BizCodeEnum.UNKNOW_EXEPTION.getCode(),BizCodeEnum.UNKNOW_EXEPTION.getMsg());
    }
2.3.2 定义错误状态码

上面代码中，针对于错误状态码，是我们进行随意定义的，然而正规开发过程中，错误状态码有着严格的定义规则，如该在项目中我们的错误状态码定义
在这里插入图片描述

为了定义这些错误状态码，我们可以单独定义一个常量类，用来存储这些错误状态码。

package com.atguigu.common.exception;

/***
 * 错误码和错误信息定义类
 * 1. 错误码定义规则为5为数字
 * 2. 前两位表示业务场景，最后三位表示错误码。例如：100001。10:通用 001:系统未知异常
 * 3. 维护错误码后需要维护错误描述，将他们定义为枚举形式
 * 错误码列表：
 *  10: 通用
 *      001：参数格式校验
 *  11: 商品
 *  12: 订单
 *  13: 购物车
 *  14: 物流
 */
public enum BizCodeEnum {

    UNKNOW_EXEPTION(10000,"系统未知异常"),

    VALID_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;
    }
}
2.3.3 测试结果如下

在这里插入图片描述

3. 分组校验功能

新增和修改对于实体的校验规则是不同的，例如id是自增的时，新增时id要为空，修改则必须不为空；新增和修改，若用的恰好又是同一种实体，那就需要用到分组校验。

校验注解都有一个groups属性，可以将校验注解分组，我们看下@NotNull的源码：

@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
@Repeatable(List.class)
@Documented
@Constraint(validatedBy = { })
public @interface NotNull {

	String message() default "{javax.validation.constraints.NotNull.message}";

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

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

	@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
	@Retention(RUNTIME)
	@Documented
	@interface List {

		NotNull[] value();
	}
}

3.1 创建空接口

从源码可以看出 groups 是一个Class<?>类型的数组，我们可以创建两个接口用来区分添加和修改.
在这里插入图片描述

3.2 给参数对象的校验注解添加分组

在这里插入图片描述

3.3 业务方法参数上使用@Validated注解

Controller 中原先的@Valid不能指定分组 ，需要替换成@Validated，来标注使用的是添加分组的校验规则
在这里插入图片描述
注意：默认情况下，在分组校验情况下，没有指定指定分组的校验注解，将不会生效，它只会在不分组的情况下生效。

4. 自定义校验功能

虽然JSR303和springboot-validator 已经提供了很多校验注解，但是当面对复杂参数校验时，还是不能满足我们的要求，这时候我们就需要 自定义校验注解。
例如状态只有1和2两种，我们自定义一个校验注解@ListValue，指定取值只能1和2。

4.1 导入validation-api依赖

        <dependency>
            <groupId>javax.validation</groupId>
            <artifactId>validation-api</artifactId>
            <version>2.0.1.Final</version>
        </dependency>

4.2 创建约束规则(注解)

package com.atguigu.common.valid;

import com.atguigu.common.valid.ListValueConstraintValidator;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

@Documented
@Constraint(validatedBy = { ListValueConstraintValidator.class})
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {
    String message() default "{com.atguigu.common.valid.ListValue.message}";

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

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

    int [] vals() default { };
}

一个标注(annotation) 是通过@interface关键字来定义的. 这个标注中的属性是声明成类似方法
的样式的. 根据Bean Validation API 规范的要求：

  • message属性, 这个属性被用来定义默认得消息模版, 当这个约束条件被验证失败的时候,通过 此属性来输出错误信息。
  • groups属性, 用于指定这个约束条件属于哪(些)个校验组. 这个的默认值必须是Class<?>类型数组。
  • payload 属性, BeanValidation API 的使用者可以通过此属性来给约束条件指定严重级别. 这个属性并不被API自身所使用。

除了这三个强制性要求的属性(message, groups 和 payload) 之外, 我们还添 加了一个属性用来指定所要求的值.
此属性的名称vals在annotation的定义中比较特 殊, 如果只有这个属性被赋值了的话, 那么,
在使用此annotation到时候可以忽略此属性名称.

另外, 我们还给这个annotation标注了一些元标注( meta
annotatioins)：

  • @Target({ METHOD, FIELD, ANNOTATION_TYPE }): 表示此注解可以被用在方法, 字段或者
    annotation声明上。
  • @Retention(RUNTIME): 表示这个标注信息是在运行期通过反射被读取的.
  • @Constraint(validatedBy = ListValueConstraintValidator.class): 指明使用哪个校验器(类) 去校验使用了此标注的元素.
  • @Documented: 表示在对使用了该注解的类进行javadoc操作到时候, 这个标注会被添加到
    javadoc当中.

4.3 创建ValidationMessages.properties

com.atguigu.common.valid.ListValue.message=必须提交指定的值

必须要与指定包下的变量相同即可
在这里插入图片描述

4.3 创建约束校验器

package com.atguigu.common.valid;



import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.HashSet;
import java.util.Set;

public class ListValueConstraintValidator implements ConstraintValidator<ListValue,Integer> {

    private Set<Integer> set=new HashSet<>();
    @Override
    public void initialize(ListValue constraintAnnotation) {
        int[] vals = constraintAnnotation.vals();
        for (int i : vals) {
            set.add(i);
        }
    }

    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext constraintValidatorContext) {
        return  set.contains(value);
    }


}

ListValueConstraintValidator定义了两个泛型参数, 第一个是这个校验器所服务到标注类型(在我们的例子中即ListValue), 第二个这个校验器所支持到被校验元素的类型 (即Integer)。

如果一个约束标注支持多种类型的被校验元素的话, 那么需要为每个所支持的类型定义一个ConstraintValidator,并且注册到约束标注中。

这个验证器的实现就很平常了, initialize() 方法传进来一个所要验证的标注类型的实例, 在本
例中, 我们通过此实例来获取其vals属性的值,并将其保存为Set集合中供下一步使
用。

isValid()是实现真正的校验逻辑的地方, 判断一个给定的int对于@ListValue这个约束条件来说
是否是合法的。

在参数对象中使用@ListValue注解。

4.4 关联自定义的校验器和自定义的校验注解

在这里插入图片描述

wangbeita
关注
专栏目录
CRC校验（含源代码）
03-27
CRC校验， 含源代码， 简单易懂
CRC32校验原理及实现
liudewen3的专栏
01-06 2万+
CRC即循环冗余校验(Cyclic Redundancy Check)：是数据通信领域中最常用的一种差错校验码，其特征是信息字段和校验字段的长度可以任意选定。 CRC校验实用程序库：在数据存储和数据通讯领域，为了保证数据的正确性，就不得不采用检错的手段。 CRC码校验原理： 发送端：发送端根据信息字段与生成多项式生产呢个CRC码，CRC码作为数据发送给接收端，同时也会把计算出的校验字段的数据
JSR 303全解析：如何在Java项目中实施高效数据校验
最新发布
Hi_alan的博客
06-26 715
## 1.1 JSR 303的主要功能 - 注解驱动：通过注解直接在Java类上定义校验规则。 - 内置约束：如@NotNull、@Size、@Min、@Max等。 - 自定义约束：可以定义自定义的校验注解和逻辑。 - 分组校验：支持对不同场景（如创建和更新）进行分组校验。 ## 1.2 常用注解 - @NotNull：验证注解的元素值不是null。 - @Size：验证注解的元素的大小在指定范围内。 - @Min和@Max：验证注解的元素值在指定范围内。 - @NotNull：验证
循环冗余校验（CRC）算法入门引导
热门推荐
Ivan 的专栏
08-19 30万+
写给嵌入式程序员的循环冗余校验（CRC）算法入门引导 前言 CRC校验（循环冗余校验）是数据通讯中最常采用的校验方式。在嵌入式软件开发中，经常要用到CRC 算法对各种数据进行校验。因此，掌握基本的CRC算法应是嵌入式程序员的基本技能。可是，我认识的嵌入式程序员中能真正掌握CRC算法的人却很少，平常在项目中见到的CRC的代码多数都是那种效率非常低下的实现方式。 其实，在网上有一篇介绍CRC 算
CRC循环冗余校验码原理解析(附实例)
huoji555的博客
11-26 1万+
1.CRC简介 CRC循环冗余校验码是数据通信中的一种查错校验码。 2.CRC原理 CRC 算法的基本思想是将传输的数据[M(X)] 当做一个位数很长的数。将这个数除以另一个数[G(X)] ,得到的余数[R(X)] 作为校验数据附加到原数据后面,组成循环校验码。 M(X)代表待编码的有效信息 G(X)代表约定好的多项式 R(X)代表代表检验位 由于，CRC的结构 = 信息位(N位) + 校验位...
CRC校验
CHD_Apple的博客
09-27 4965
基本算法校验
jsr303校验.txt
01-27
### JSR 303 数据校验框架简介 JSR 303 是 Java 社区提出的一个用于验证 JavaBean 对象的标准规范，其主要目的是为了简化开发人员在进行对象属性值验证时的工作量，避免编写重复代码。该规范允许开发者在类或方法...
JSR303校验注解和自定义校验注解的使用
10-14
总结起来，JSR303校验注解提供了一种声明式的方式来验证对象属性，而自定义校验注解则允许你扩展验证功能，以适应更复杂的业务场景。通过合理利用这些工具，可以有效提升应用的数据质量，减少因数据错误导致的问题。
JSR303校验一些常用的规则
10-05
JSR303校验一些常用的规则
Java如何使用JSR303校验数据与自定义校验注解
10-14
Java中的JSR303（Java Bean Validation）标准是用来实现数据验证的一种机制，它提供了一套规范化的注解，使得开发者能够方便地在Bean的属性上添加校验规则。JSR303的一个具体实现是Hibernate Validator，它包含了...
JSR303+AOP数据校验
11-20
【JSR303+AOP数据校验】是Java Web开发中的一种常见实践，用于确保应用程序接收到的数据质量。JSR303（Java Bean Validation）是Java平台上的一个规范，它定义了一种标准的方式来验证对象属性，以满足业务规则。AOP...
CRC校验详解（附代码示例）
u013073067的博客
01-27 10万+
目录 1.CRC校验原理 2.生成多项式 3.以CRC-16校验为例讲解编程实现 3.3.1 完全按照CRC原理实现校验 3.3.2工程中常用CRC校验过程 3.3.3改进的CRC校验过程 4.以CRC-8校验为例讲解查表法 5.以CRC-16校验为例讲解查表法 5.1.生成表格 5.2.查表法实现 CRC校验即循环冗余校验（CyclicRedundancyCheck...
CRC校验原理及其使用
小菜鸡-言西子
04-19 6679
CRC校验学习记录
校验算法——CRC
雨中深巷的油纸伞
04-07 2954
CRC（Cyclic Redundancy Check）校验算法就是一种常用的数据校验方法，它通过对数据进行处理生成校验码，从而实现对数据的完整性和准确性进行验证。CRC-16算法适用于对数据进行中等程度的校验的场景，例如一些比较重要的通信数据、存储数据等。精度高：CRC算法能够提供较高的校验精度和安全性，能够在数据传输过程中及时发现错误，并对数据进行纠错，从而保证数据的可靠传输。校验码长度有限：不同版本的CRC算法的校验码长度有限，无法对所有可能的数据错误进行完美的检测和纠错。CRC算法的优点与缺点。
CRC校验码详解、常见算法实现及代码实例
huanxiajioabu的博客
06-21 2万+
在前面的文章中通过小例子的比喻，简单介绍过什么是CRC，这里再详细的讲解一次。CRC（Cyclic Redundancy Checksum）是一种纠错技术，代表循环冗余校验和。数据通信领域中最常用的一种差错校验码，其信息字段和校验字段长度可以任意指定，但要求通信双方定义的CRC标准一致。主要用来检测或校验数据传输或者保存后可能出现的错误。
通俗易懂的CRC校验
二进制模----细微行动改变影响世界
09-25 2139
CRC校验原理 CRC校验原理看起来比较复杂，好难懂，因为大多数书上基本上是以二进制的多项式形式来说明的。其实很简单的问题，其根本思想就是先在要发送的帧后面附加一个数（这个就是用来校验的校验码，但要注意，这里的数也是二进制序列的，下同），生成一个新帧发送给接收端。当然，这个附加的数不是随意的，它要使所生成的新帧能与发送端和接收端共同选定的某个特定数整除（注意，这里不是直接采用二进制除法，而...
CRC校验原理及步骤
qq_43842093的博客
08-20 9011
其根本思想就是先在要发送的帧后面附加一个数（这个就是用来校验的校验码，但要注意，这里的数也是二进制序列的，下同），生成一个新帧发送给接收端。当然，这个附加的数不是随意的，它要使所生成的新帧能与发送端和接收端共同选定的某个特定数整除（注意，这里不是直接采用二进制除法，而是采用一种称之为“模2除法”）。循环冗余检查（CRC）是一种数据传输检错功能，对数据进行多项式计算，并将得到的结果附在帧的后面，接收设备也执行类似的算法，以保证数据传输的正确性和完整性。接收方根据原始信息，按照同样的算法，计算CRC。
最通俗的CRC校验原理剖析
weixin_34327223的博客
11-19 2043
以下内容摘自笔者即将出版的最新著作《深入理解计算机网络》一书。本书将于12月底出版上市，敬请留意！！ 本书原始目录参见此文：http://winda.blog.51cto.com/55153/1063878 5.3.2 循环冗余校验检错方案 上节介绍的奇偶校验码（PCC）只能校验一位错误，本节所要介绍的循环冗余校验码（CRC）的检错能力更强，...
CRC校验原理与FPGA实现（含推导过程）
qq_42224089的博客
09-22 4854
本文介绍了CRC校验中的基本概念，包括CRC校验模型、生成多项式、校验码宽度、数据宽度、寄存器初始值等。同时推导了串行CRC校验与并行CRC校验的公式与相应的电路，包括长除法、线性移位寄存器法设计的串行CRC校验电路与由线性移位寄存器法校验电路推导得到的并行CRC校验电路，我们还给出了相应的电路对应的RTL代码，并进行功能验证，验证通过。
JSR303校验注解详解：从基础到自定义
"本文主要探讨JSR303校验注解和自定义校验注解的使用，通过实例代码详细解析，适用于学习和工作中进行数据验证的需求。首先需要引入相应的validation依赖，如Spring Boot的`spring-boot-starter-validation`模块。...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值