【JSR303 自定义校验的两种方式】

最新推荐文章于 2024-07-27 17:56:15 发布
最新推荐文章于 2024-07-27 17:56:15 发布
阅读量1k 收藏 3
点赞数
分类专栏： JAVA EE 文章标签： jsr java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/W664160450/article/details/123201152
版权

目录

1. 简介

最近在项目中遇到一个问题。简单来说就是对对象的属性进行有关联性的校验。
比如：登录接口

public ResponseResult login(@Validated(Groups.Query.class) @RequestBody LoginReqVO loginRepVO){
//do something
}

public class LoginReqVO {

    @NotNull(message = "userId 不能为空", groups = {Groups.Query.class, Groups.Search.class})
    @ApiModelProperty(required = true, value = "用户应用id", example = "123456")
    private String userId;

    @NotNull(message = "pwd 不能为空", groups = {Groups.Query.class, Groups.Search.class})
    @ApiModelProperty(required = true, value = "用户密码", example = "200")
    private String pwd;

    @NotNull(message = "appId 不能为空", groups = {Groups.Query.class, Groups.Search.class})
    @ApiModelProperty(required = true, value = "应用id", example = "1111")
    private String appId;

    @ApiModelProperty(value = "加密类型（0原始数据传输，1加密传输）默认0", example = "0")
    private Integer encryptType;

    @ApiModelProperty(value = "公钥加密过的秘钥（当encryptType为1是为必传字段）", example = "xxxx")
    private String key;

    @ApiModelProperty(value = "公钥版本号（当encryptType为1是为必传字段）", example = "1.0.0")
    private String version;
}

在上面的登录的请求对象中存在这样的一个需求：

当加密类型字段encryptType为1（数据加密传输）时，对应的key（密钥）和version（公钥版本号）不能为空。如果encryptType为0时，对应的key和version传不传都是可以的。

一开始最为简单，也是最先想到的方式便是和业务功能耦合在一起，在login方法内部进行对这三个参数进行校验。代码编写起来也是最为简单的。

但是这种方式的缺点就是功能性代码和业务代码耦合在了一起，而且之前所有的参数校验都是通过JSR303进行的，采用这种方式也打破了之前的代码习惯,可能有点小强迫症吧。hahaha

所以便有了一下两种自定义校验方式的探索：

2. @ScriptAssert注解

@ScriptAssert注解的作用：对于复杂业务逻辑可以通过脚本验证

先来了解一下@ScriptAssert注解

@Documented
@Constraint(
    validatedBy = {}
)
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(ScriptAssert.List.class)
public @interface ScriptAssert {
    String message() default "{org.hibernate.validator.constraints.ScriptAssert.message}";

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

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

    String lang();

    String script();

    String alias() default "_this";

    String reportOn() default "";

    @Target({ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    public @interface List {
        ScriptAssert[] value();
    }
}

首先我们看到@Target({ElementType.TYPE})表明整个注解适用于类或接口上的。

@Repeatable(ScriptAssert.List.class)这个注解作用：表明@ScriptAssert是可以多个一起使用的。如下面这样：

@ScriptAssert.List({
        @ScriptAssert(script = "com.RegisterUserDto.checkUserName(_this.userName)",lang = "javascript",message = "用户名不能包含! @ # $ % & * \\ / ? ？特殊符号"),
        @ScriptAssert(script = "_this.password.equals(_this.rePassword)",lang = "javascript",message = "确认密码与输入密码不一致")
})

下面三个属性是每一个JSR303注解中都存在的内容，大家经常使用JSR303的话，肯定也都不陌生。

   String message() default "{org.hibernate.validator.constraints.ScriptAssert.message}";

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

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

message()该注解判断为错误时的异常提示信息。
groups()分组。
payload()负载信息，比较少用。
上面三个属性也是自定义注解中必须存在的属性。

接下来我们在看看@ScriptAssert注解中特有的属性。

String lang();

String script();

String alias() default "_this";

String reportOn() default "";

lang()表示采用采用什么语言来执行脚本。lang = "javascript"表示通过Java语言来执行script中脚本。

script()指定特定的静态方法来检验复杂的业务逻辑。
这里的指定的方法必须是静态的方法，否则会抛出异常。

Caused by: jdk.nashorn.internal.runtime.ECMAException: TypeError: com.crossoverjie.cim.route.api.validated.ValidatedLoginParameter.checkVersion is not a function

alias()对象的别名，默认是_this。

reportOn()表明该验证是作用在那个方法上。这里起到作用就是在方法抛出异常的时候，可以具体到哪一个属性。因为@ScriptAssert是作用在整个对象上。所以整个属性还是非常有必要的。
在这里插入图片描述
以上便是所有的@ScriptAssert的属性介绍。
下面来看看如何使用：

  1. 首先自定义需要检验的方法
public class ValidatedLoginParameter {

    /**
     * 验证加密时，公钥加密过的秘钥不能为空
     *
     * @param encryptType
     * @param key
     * @return
     */
    public static Boolean checkKey(Integer encryptType, String key) {
        if (encryptType == 1) {
            if (key == null) {
                return false;
            }
        }
        return true;
    }

    /**
     * 验证加密时，公钥版本号不能为空
     *
     * @param encryptType
     * @param version
     * @return
     */
    public static Boolean checkVersion(Integer encryptType, String version) {
        if (encryptType == 1) {
            if (version == null) {
                return false;
            }
        }
        return true;
    }
}
  1. 在需要验证的类上添加注解
@Data
@ScriptAssert.List({
        @ScriptAssert(lang = "javascript",
                script = "com.crossoverjie.cim.route.api.validated.ValidatedLoginParameter.checkKey(_this.encryptType,_this.key)",
                message = "密钥不能为空",
                reportOn = "key",
                groups = {Groups.Query.class}
        ),
        @ScriptAssert(lang = "javascript",
                script = "com.crossoverjie.cim.route.api.validated.ValidatedLoginParameter.checkVersion(_this.encryptType,_this.version)",
                message = "公钥版本号不能为空",
                reportOn = "version",
                groups = {Groups.Query.class}
        )
})
public class LoginReqVO {

    @NotNull(message = "userId 不能为空", groups = {Groups.Query.class, Groups.Search.class})
    @ApiModelProperty(required = true, value = "用户应用id", example = "123456")
    private String userId;

    @NotNull(message = "pwd 不能为空", groups = {Groups.Query.class, Groups.Search.class})
    @ApiModelProperty(required = true, value = "用户密码", example = "200")
    private String pwd;

    @NotNull(message = "appId 不能为空", groups = {Groups.Query.class, Groups.Search.class})
    @ApiModelProperty(required = true, value = "应用id", example = "1111")
    private String appId;

    @ApiModelProperty(value = "加密类型（0原始数据传输，1加密传输）默认0", example = "0")
    private Integer encryptType;

    @ApiModelProperty(value = "公钥加密过的秘钥（当encryptType为1是为必传字段）", example = "xxxx")
    private String key;

    @ApiModelProperty(value = "公钥版本号（当encryptType为1是为必传字段）", example = "1.0.0")
    private String version;
}

这样就可以完成最开始所讲的需求了。当encryptType为1时验证key和version，当为0时，就不验证key和version。

3. 自定义注解

我们再来使用自定义注注解的方式来实现上述的功能：

  • 声明自定义注解
@Target({ElementType.TYPE})
@Retention(RUNTIME)
@Documented
// 1. Marks an annotation as being a Bean Validation constraint
// 2. validatedBy = 具体校验类
@Constraint(validatedBy = { AssociationValidator.class})
public @interface Association {
	//校验不通过的时候打印的信息
	String message() default "属性值不能为null";
	//校验组，用于分组校验
	Class<?>[] groups default{};
	//负载信息
	Class<? extends Payload> [] payload() default{};
}
  • 实现具体的校验类
public class AssociationValidator implements ConstraintValidator<Association, Object> {

    private Association association;

    @Override
    public void initialize(Association constraintAnnotation) {
        association = constraintAnnotation;
    }

    /**
     * @param value   被注解的对象
     * @param context
     * @return true 校验通过   false 校验失败
     */
    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {

        return association(value);
    }
    
    /**
     * 校验方法
     */
    private boolean association(Object value) {
   
		Field encryptType = value.class.getDeclaredField("encryptType"); 
		Field key = value.class.getDeclaredField("key"); 
		Field version = value.class.getDeclaredField("version"); 
        
        Integer type  = (Integer)encryptType .get(value);
        if(type == 1){
	        String keyStr  = (String)key.get(value);
	        String versionStr  = (String)version.get(value);
        	if(keyStr==null||versionStr==null){
        		return false;
        	}
        } 
        return true;
    }
}
  • 使用
@Data
@Association
public class LoginReqVO {

    @NotNull(message = "userId 不能为空", groups = {Groups.Query.class, Groups.Search.class})
    @ApiModelProperty(required = true, value = "用户应用id", example = "123456")
    private String userId;

    @NotNull(message = "pwd 不能为空", groups = {Groups.Query.class, Groups.Search.class})
    @ApiModelProperty(required = true, value = "用户密码", example = "200")
    private String pwd;

    @NotNull(message = "appId 不能为空", groups = {Groups.Query.class, Groups.Search.class})
    @ApiModelProperty(required = true, value = "应用id", example = "1111")
    private String appId;

    @ApiModelProperty(value = "加密类型（0原始数据传输，1加密传输）默认0", example = "0")
    private Integer encryptType;

    @ApiModelProperty(value = "公钥加密过的秘钥（当encryptType为1是为必传字段）", example = "xxxx")
    private String key;

    @ApiModelProperty(value = "公钥版本号（当encryptType为1是为必传字段）", example = "1.0.0")
    private String version;
}
蛋炒喜红柿
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
JSR303自定义参数校验-校验类型罗列
12-21
一、自定义参数校验 1、为什么要自定义？ 通过学习，了解到很多常用注解了，但是呢，总是有那么些需求… 2、案例分析(手机号格式) 2.1、需要验证的实体 Bean public class LoginVo { @NotNull @IsMobile //自定义的注解 private String mobile; @NotNull @Length(min=32) private String password; //省略 get set 方法 } 2.2、自定义 IsMobile 注解类 import static java.lang.a
JSR303校验注解和自定义校验注解的使用
10-14
总结起来，JSR303校验注解提供了一种声明式的方式来验证对象属性，而自定义校验注解则允许你扩展验证功能，以适应更复杂的业务场景。通过合理利用这些工具，可以有效提升应用的数据质量，减少因数据错误导致的问题。
Java如何使用JSR303校验数据与自定义校验注解
10-14
JSR303的一个具体实现是Hibernate Validator，它包含了丰富的内置校验注解以及自定义校验注解的能力。在Spring Boot项目中，我们通常通过集成Hibernate Validator来实现数据校验。 首先，为了在Spring Boot项目中...
SpringMVC使用JSR-303进行验证Bean.docx
12-02
SpringMVC框架结合JSR-303（也称为JSR-349，Java Bean Validation）规范提供了一种优雅的方式来处理数据验证。本篇文章将详细介绍如何在SpringMVC中使用JSR-303进行Bean验证。 首先，我们需要引入JSR-303的实现库。...
spring4采用JSR349标准校验数据
08-12
JSR 349是JavaBeans验证的规范，它定义了一种标准化的方式来验证对象的属性值，提供了在Java EE和Java SE应用程序中进行数据校验的标准API。 首先，我们来看JSR 349，全称为JavaTM specification request 349，即...
golang 接口
m0_70982551的博客
07-24 842
接口定义了一组方法，这些方法没有具体的实现。接口类型的变量可以存储任何实现了这些方法的类型的值。// 更多方法...在Go语言中，接口值是指存储了实现某个接口的具体类型值的变量。接口值由两部分组成：1.动态类型：这是接口值当前存储的实际类型。2.动态值：这是实际存储的值，该值必须实现了接口中定义的所有方法。
Swagger使用Map接受参数时，页面如何显示具体参数及说
a1058926697的博客
07-26 375
后端使用Map接受参数，要求在swagger页面上显示具体的参数名称、类型及说明。当Map接受参数数量少时，可以使用Swagger自带的注解。自定义注解 @ApiGlobalModel。编写处理注解对应的插件。
【Java算法专场】二分查找(下）
最新发布
zhyhgx的博客
07-27 469
本道题是要在一个从0~n-1的数组中找缺失的数，我们可以采用哈希表来解决，但此时时空复杂度达到了O(n),这是一个有序的数组，我们可以采用二分查找来解决，使时间复杂度达到O(logn).我们可以发现，每个数组的下标和其元素是相同的，那么我们可以通过判断下标和元素的大小，来确定缺失值的位置。3.mid=4+(5-4)/2=4,nums[mid]=5
springboot之自动装配
weixin_50153914的博客
07-23 525
Spring Boot 通过一系列注解和条件配置实现了自动装配机制，使得开发者无需手动配置大量的 XML 文件或 Java 配置类。自动配置机制利用文件中的自动配置类，并结合条件注解和组件扫描，实现了灵活且强大的自动装配功能。这样，开发者可以专注于业务逻辑的实现，而无需处理繁琐的配置细节。
Java的@DateTimeFormat注解与@JsonFormat注解的使用对比
訾博（ZiBo）的博客
07-27 455
在Spring和Jackson框架中，日期和时间格式化是一个常见需求。注解主要用于Spring的表单绑定，而注解则用于Jackson的JSON序列化和反序列化。了解这两个注解的使用场景和方法，可以帮助开发者更高效地处理日期和时间。和是处理日期和时间格式化的两个重要注解。主要用于Spring MVC的请求参数绑定，而主要用于Jackson的JSON序列化和反序列化。了解它们的使用场景和功能，可以帮助开发者更高效地处理日期和时间格式化需求。通过本文的介绍，希望读者能够更清晰地理解和。
Java代码基础算法练习-数的特性-2024.07.25
Sakurapaid的博客
07-25 338
小A喜欢两种性质都成立的数字，小B喜欢至少符合一种性质的数字，小C喜欢不符合这两种性质的 数字。给出一个数字，请输出三个人是否喜欢这个数字。如果喜欢输出1，否则输出0，用空格分隔。输入数字 num，先定义三个整型代表三个人的喜欢与否，先默认设为 0。之后判断num对于性质1、2的条件，分别用 boolen 类型标识。对于每个整型进行判断，是否改为 1 代表喜欢。性质2：大于4且不大于12;
Java修炼 2024.7.26 0:24
2301_80011650的博客
07-26 361
问题：编写一个方法，找出一个数组中的众数（出现次数超过数组长度一半的元素）。例如，输入 [2, 2, 1, 1, 2]，输出 2。编写一个方法，找出一个整数数组中的第二大元素。例如，输入 [3, 5, 1, 8, 7]，输出 7。例如，输入 5，输出 5。问题：编写一个方法，将给定的字符串逆转。问题：使用数组实现栈，并提供基本操作（push、pop、peek、isEmpty）。问题：实现一个单向链表，并提供基本的操作（添加、删除、查找元素）。问题：编写一个方法来查找一个给定字符串的所有子串。
学习笔记---java篇（0723）
m0_70630166的博客
07-23 821
java、数据类型、循环、选择等
4.Jmeter接口性能测试
weixin_43444329的博客
07-23 793
系统用户数：软件系统注册的用户总数（要注意初始化环境）在线用户数：某段视角内访问用户数，这些用户只是咋先，不一定同时做某一件事情。（初始化环境（warm up热机：让系统接近运行的系统，让系统运行更快 磁盘->内存））并发用户数：某一个时间同时向系统提交请求的用户数，场景不一定是同一个。：测试web系统的性能，支持多少并发？在确定并发用户数之前，必须先对用户的业务进行分解，分析出其中的典型业务场景（用户最常用、最关注的业务操作）然后基于场景获得其并发用户数。
SSM框架整合——常用方式整合SSM框架（三）Spring和MyBatis整合
PAP
07-26 145
SSM框架整合——常用方式整合SSM框架（三）Spring和MyBatis整合
19.jdk源码阅读之FutureTask
前端、移动端、后端源码级底层原理分享
07-25 850
FutureTask 是 Java 并发包中的一个重要类，它实现了 RunnableFuture 接口，结合了 Future 和 Runnable 的特性。FutureTask 通常用于异步任务的执行和结果的获取。
Jvm基础（一）
G81948577的博客
07-19 984
本地方法就是不使用java编写的，比如C++编写的程序，只是需要传递参数。
mysql表设计
wwwwwww31311的博客
07-23 167
status 状态 java代码中用一个枚举类，比如我的请假表还处于草稿状态，可以是新建态，提交后处于待审批状态，审批完成则是成功态，审批拒绝就是拒绝态。start_time 开始时间 dateTime类型。end_time 起始时间 dateTime类型。employee_id 外键，和员工信息表想管理。type 请假类型，对应一个枚举类，病假，事假。create_time 请假记录的创建时间。如果让你设计一个请假表，如何设计？approve_id 外键。
教务管理平台/高校教务管理系统的设计与实现/教务网站/学生成绩管理系统/学生课程管理系统
weixin_47958760的博客
07-27 418
本毕业设计的内容是设计并且实现一个基于JSP技术的教务管理平台。采用MYSQL为数据库开发平台，SSM框架，Tomcat网络信息服务作为应用服务器。教务管理平台的功能已基本实现，主要有学生、教师、课程信息、课程选择、教师课表、学生成绩、图书信息、考试等管理功能。 论文主要从系统的分析与设计 、数据库设计和系统的详细设计等几个方面来进行论述，系统分析与设计部分主要论述了系统的功能分析、系统的设计思路，数据库设计主要论述了数据库的设计，系统的详细设计部分主要论述了几个主要模块的详细设计过程。
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、付费专栏及课程。

余额充值