如何使用JSR 303 进行后台数据校验?

news2024/11/26 1:43:23

文章目录

  • 一、JSR 303
    • 1、什么是 JSR 303?
    • 2、为什么使用 JSR 303?
    • 3、JSR 303 常见操作?
    • 二、使用 JSR 303 相关注解处理逻辑
    • 1、JSR 303 注解处理逻辑
      • 1.1 使用步骤
      • 1.2 实际应用
    • 2 、JSR 303 分组校验
      • 2.1 为什么使用 分组校验?
      • 2.2 使用步骤
      • 2.3 实际应用
    • 3、JSR 303 自定义校验注解
      • 3.1 为什么使用自定义校验注解?
      • 3.2 使用步骤
      • 3.3 实际应用

三连哦

一、JSR 303

1、什么是 JSR 303?

  • JSR 是 Java Specification Requests 的缩写,即 Java 规范提案。
  • 存在各种各样的 JSR,简单的理解为 JSR 是一种 Java 标准。
  • JSR 303 就是数据检验的一个标准(Bean Validation (JSR 303))。
参考:https://www.jianshu.com/p/554533f88370

2、为什么使用 JSR 303?

  • 处理一段业务逻辑,首先要确保数据输入的正确性,所以需要先对数据进行检查,保证数据在语义上的正确性,再根据数据进行下一步的处理。
  • 前端可以通过 js 程序校验数据是否合法,后端同样也需要进行校验。而后端最简单的实现就是直接在业务方法中对数据进行处理,但是不同的业务方法可能会出现同样的校验操作,这样就出现了数据的冗余。为了解决这个情况,JSR 303 出现了。
  • JSR 303 使用 Bean Validation,即在 Bean 上添加相应的注解,去实现数据校验。这样在执行业务方法前,都会根据注解对数据进行校验,从而减少自定义的校验逻辑,减少代码冗余。

3、JSR 303 常见操作?

(1)可以通过简单的注解校验 Bean 属性,比如 @NotNull、@Null 等。
(2)可以通过 Group 分组自定义需要执行校验的属性。
(3)可以自定义注解并指定校验规则。
(4)支持基于 JSR 303 的实现,比如 Hibernate Validator(额外添加一些注解)。

二、使用 JSR 303 相关注解处理逻辑

1、JSR 303 注解处理逻辑

1.1 使用步骤

  • 1、在相关的 Bean 上标注需要处理的注解,并指定需要提示的信息(若不指定,会从默认配置文件中读取默认的信息)。

  • 2、在相关的方法上,使用 @Valid 注解(或者 @Validated 指定组名)标记需要被校验的数据,否则会不生效。

注意:检测到数据异常后,系统会向外抛出异常,如果做了统一异常处理,可以根据 postman 测试的结果,找到控制台打印出的相应的异常,并处理。

  • 3、处理异常。使用 BindingResult 可以获取到检测结果,然后进行处理。也可以使用 全局统一异常 处理(@RestControllerAdvice@ExceptionHandler),处理检测结果

1.2 实际应用

1、给Bean添加校验注解:javax.validation.constraints,并定义自己的message提示


import javax.validation.constraints.*;

/**
 * 品牌
 * 
 * @author zhengyuzhu
 * @email 2977429967@qq.com
 * @date 2023-02-25 23:11:31
 */
@Data
@TableName("pms_brand")
public class BrandEntity implements Serializable {
	private static final long serialVersionUID = 1L;

	/**
	 * 品牌id
	 */
	@NotNull(message = "修改必须指定品牌id")
	@TableId
	private Long brandId;
	/**
	 * 品牌名
	 */
	@NotBlank(message = "品牌名必须提交")
	private String name;


}

2、修改 Controller 方法,使用 @Valid 注解标记需要检测的数据、比如在常见的增加和修改方法上,这个时候需要将前台传来的数据插入数据库


@RestController
@RequestMapping("product/brand")
public class BrandController {
    @Autowired
    private BrandService brandService;

    /**
     * 保存新添加品牌
     */
    @RequestMapping("/save")
    public R save(@Validated @RequestBody BrandEntity brand){
		brandService.save(brand);
        return R.ok();
    }

    /**
     * 修改
     */
    @RequestMapping("/update")
    public R update(@Validated @RequestBody BrandEntity brand){
        brandService.updateDetail(brand);
        return R.ok();
    }


}

提示:这个时候如果插入的数据不符合规范,就会抛出异常、为了避免代码冗余。可以使用全局异常来进行处理

3、集中处理异常

可以使用 BindingResult 去处理捕获到的数据并进行相关处理

/**
 * 集中处理所有异常
 */
@Slf4j

@RestControllerAdvice(basePackages = "com.zyz.gulimall.product.controller")
public class GulimallExceptionControllerAdvice {

    @ExceptionHandler(value= MethodArgumentNotValidException.class)
    public R 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 R.error(BizCodeEnume.VAILD_EXCEPTION.getCode(),BizCodeEnume.VAILD_EXCEPTION.getMsg()).put("data",errorMap);
    }

    @ExceptionHandler(value = Throwable.class)
    public R handleException(Throwable throwable){
        log.error("错误:",throwable);
        return R.error(BizCodeEnume.UNKNOW_EXCEPTION.getCode(),BizCodeEnume.UNKNOW_EXCEPTION.getMsg());
    }


}

2 、JSR 303 分组校验

2.1 为什么使用 分组校验?

如果出现多个方法,都需要校验 Bean,且校验规则不同的时候,怎么办呢?

就比如下方,修改品牌ID的时候,提交为空的时候,提示用户的应该是修改ID不能为空。新增的时候,应该是提示用户,新增ID不能为空。但是你也可以直接写ID不能为空,但总感觉缺少点啥。

分组校验就可以去解决该问题,每个分组指定不同的校验规则,不同的方法执行不同的分组,就可以得到不同的校验结果。 也就是说,定义好分组后,在校验的时候,就可以去找对应的分组进行相关的信息提示。

	/**
	 * 品牌id
	 */
	@NotNull(message = "修改必须指定品牌id",groups = {UpdateGroup.class})
	@Null(message = "新增不能指定id",groups = {AddGroup.class})
	@TableId
	private Long brandId;

2.2 使用步骤

  • 1、定义一个空接口,用于指定分组,内部不需要任何实现。

  • 2、指定 注解时,通过 groups 指定分组。用于指定在某个分组条件下,才去执行校验规则。

  • 3、在相关的业务方法上,通过 @Validated 注解指定分组,去指定校验。

注:使用分组校验后,Bean 注解上若不指定分组,则不会执行校验规则。

2.3 实际应用

1 创建两个新增和修改接口

public interface AddGroup {
}

public interface UpdateGroup {
}

2 指定 注解时,通过 groups 指定分组

比如,这里的品牌id定义两个分组,一个是增加时候的校验,一个是修改时候的校验,对应不同的校验规则。也可以将通用的校验规则,以分组的时候同时管理多个。

	/**
	 * 品牌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;

3、在相关的业务方法上,通过 @Validated 注解指定分组,去指定校验。

    /**
     * 保存新添加品牌
     */
    @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();
    }

在这里插入图片描述

3、JSR 303 自定义校验注解

3.1 为什么使用自定义校验注解?

当上面的注解满足不了业务需求时,可以自定义校验注解,自定义校验规则。

3.2 使用步骤

  • 1、需要自定义一个校验注解。可以创建一个 ValidationMessages.properties 用于保存默认的 message 信息。

  • 2、需要自定义一个校验器,即自定义校验规则。实现 ConstraintValidator 接口,并重写相关方法。

注:initialize 方法用于初始化,可以获取 自定义的属性的值。isValid
方法用于校验,可以获取到实际的值,然后与自定义的属性值进行比较。

  • 3、将校验注解 与 校验器 关联起来。@Constraint(validatedBy = {TestValidConstraintValidator.class})

3.3 实际应用

如下例,自定义一个校验规则,判断数据是否是 0,1。当传来的数据不是这两种之一,校验不通过。

  • 1、自定义一个校验注解
/**
 * @author zyz
 */
@Documented
@Constraint(validatedBy = { ListValueConstraintValidator.class })
@Target({ METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER, TYPE_USE })
@Retention(RUNTIME)
public @interface ListValue {

    /**
     * 添加校验
     * @return
     */
    String message() default "{com.zyz.common.valid.ListValue.message}";

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

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

    int[] vals() default { };
}

创建一个文件ValidationMessages.properties。当不符合自定义规则校验的时候,message可以获取到对应的信息

配置文件内容:com.zyz.common.valid.ListValue.message=必须提交指定的值啊

在这里插入图片描述

  • 2 自定义一个校验器TestValidConstraintValidator, 用于检测值是否合法。
/**
 * @author zyz
 */
 /**
 * 实现 ConstraintValidator 接口,
 * 其中 ConstraintValidator 的泛型,一个需要指定自定义的注解,一个需要指定需要获取的值的类型。
 * 比如:
 *  ConstraintValidator<ListValue , String> 中
 *      ListValue   表示自定义注解
 *      String      表示获取的值的类型
 * 即定义规则,判断一个 String 的值的长度是否满足条件
 */
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 val : vals) {
            set.add(val);
        }

    }

    //判断是否校验成功
    /**
     *
     * @param value 需要校验的值
     * @param context
     * @return
     */
    @Override
    public boolean isValid(Integer value, ConstraintValidatorContext context) {
        return set.contains(value);
    }
}
  • 3、使用注解

使用自定义注解,这里的@ListValue 就是使用的自定义注解,当前端传来状态的值不是对应数据。就会走自定义校验判断、提示对应的信息。这里也使用了分组的形式。

	/**
	 * 显示状态[0-不显示;1-显示]
	 */
	@NotNull(groups = {AddGroup.class, UpdateStatusGroup.class})
	@ListValue(vals={0,1},groups = {AddGroup.class, UpdateStatusGroup.class})
	private Integer showStatus;

方法中使用

这里使用了分组,就会自动校验

    /**
     * 保存新添加品牌
     */
    @RequestMapping("/save")
    public R save(@Validated({AddGroup.class}) @RequestBody BrandEntity brand){
		brandService.save(brand);
        return R.ok();
    }

资料参考:JSR 303

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/393631.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

软件设计师教程(八)计算机系统知识-软件工程基础知识

软件设计师教程 软件设计师教程&#xff08;一&#xff09;计算机系统知识-计算机系统基础知识 软件设计师教程&#xff08;二&#xff09;计算机系统知识-计算机体系结构 软件设计师教程&#xff08;三&#xff09;计算机系统知识-计算机体系结构 软件设计师教程&#xff08;…

【C++】list迭代器的深度剖析及模拟实现(感受类封装,类和对象的思想)

早点睡兄弟&#xff0c;别一天到晚就熬夜。 文章目录一、通过list迭代器来感受类和对象以及类封装的思想1.迭代器的特征和本质是什么&#xff1f;&#xff08;两大特征&#xff1a;类的内嵌类型&#xff0c;行为像指针。本质&#xff1a;内置类型定义的变量或自定义类型实例化…

Linux命令·less

less 工具也是对文件或其它输出进行分页显示的工具&#xff0c;应该说是linux正统查看文件内容的工具&#xff0c;功能极其强大。less 的用法比起 more 更加的有弹性。在 more 的时候&#xff0c;我们并没有办法向前面翻&#xff0c; 只能往后面看&#xff0c;但若使用了 less …

Java Stream 如何提高遍历集合效率?

目录什么是 Stream&#xff1f;Stream 如何优化遍历&#xff1f;Stream 源码实现内部实现Stream 并行处理什么是 Stream&#xff1f; Stream 的聚合操作与数据库 SQL 的聚合操作 sorted、filter、map 等类似。我们在应用层就可以高效地实现类似数据库 SQL 的聚合操作了&#x…

Spring MVC 详解(连接、获取参数、返回数据)

在之前我们先简单那谈谈Spring、SpringBoot以及Spring MVC框架之间有什么关系&#xff1f;首先Spring是一个框架&#xff0c;SpringBoot脚手架是为了快速开发Spring框架而创造的技术。可以理解为SpringBoot又在Spring上面包了一层壳子&#xff0c;是基于Spring的&#xff0c;是…

xxl-job调度中心、执行器源码详解

文章目录简介调度中心一.程序启动初始化1.初始化入口类2.初始化I18n3.初始化快慢调度线程池4.初始化处理执行器注册或移除线程池更新执行器最新在线的守护线程5.初始化监控任务调度失败或执行失败的守护线程6.初始化处理执行器回调线程池监控任务执行结果丢失的守护线程7.初始化…

创建虚拟机、添加镜像以及配置虚拟机

一、创建虚拟机 1、点击 “创建新的虚拟机” 2.选择“自定义配置” 到后面可以选择硬件的类型 3.默认值就行 4.选择 “稍后安装操作系统” 5.操作系统选择 “Linux”&#xff0c;版本结合镜像自行选择 6. 虚拟机的名称自行定义&#xff0c; 就是上述显示出来的名称。 虚拟机…

Mybatis使用手册

Myabtis 官网文档 官网网站&#xff1a;https://mybatis.org/mybatis-3/zh/index.html 搭建环境 项目结构 引入依赖 创建Maven项目&#xff0c;pom依赖文件中加入mybatis和jdbc驱动依赖。 <dependency><groupId>org.mybatis</groupId><artifactId>…

CSS渐进增强方案

首先需要明确一点&#xff0c;以往浏览器对css的支持是不同的&#xff0c;不同浏览器的样式可能会存在差异&#xff0c;对待这种差异问题&#xff0c;需要写几套不同的css来兼容&#xff08;边框、圆角、颜色等&#xff09;&#xff0c;这样是非常麻烦的&#xff0c;浏览器css显…

Go项目(订单微服务)

文章目录简介handlerUTweb支付服务Notify小结简介 这部分开始梳理订单微服务的关键点这里仿京东&#xff0c;订单结算在购物车进行&#xff0c;所以用户的操作是加入商品到购物车&#xff0c;进入购物车付款从页面分析需求 点击添加到购物车&#xff0c;删除车中商品&#xff…

JAVA环境配置多环境(全,细,简单)

下载java包&#xff1a;https://www.oracle.com/java/technologies/downloads &#xff08;8版本稳定&#xff09; 直接无脑安装java程序 &#xff08;包括jdk-开发与jre-运行&#xff09; 接下来是java环境配置&#xff1a; 创建系统变量 &#xff08;用户变量也可以&#…

近红外吸收荧光染料IR-808,IR-808 NH2,IR-808 amine,发射808nm 性质分享

中文名称&#xff1a;IR-808 氨基英文名称&#xff1a;IR-808 NH2&#xff0c;IR-808 amine&#xff0c;IR-808-NH2规格标准&#xff1a;10mg&#xff0c;25mg&#xff0c;50mgCAS&#xff1a;N/A产品描述&#xff1a;IR-808&#xff0c;发射808nm&#xff0c;酯溶性染料修饰氨…

[NOIP2003 提高组] 侦探推理(C++,字符串)

题目描述 明明同学最近迷上了侦探漫画《柯南》并沉醉于推理游戏之中&#xff0c;于是他召集了一群同学玩推理游戏。游戏的内容是这样的&#xff0c;明明的同学们先商量好由其中的一个人充当罪犯&#xff08;在明明不知情的情况下&#xff09;&#xff0c;明明的任务就是找出这…

关于Ping命令的七种用法

今天我们来详细看下ping命令详细使用&#xff1a; 一、ping基本使用详解 在网络中ping是一个十分强大的TCP/IP工具。它的作用主要为&#xff1a; 1、用来检测网络的连通情况和分析网络速度 2、根据域名得到服务器IP 3、根据ping返回的TTL值来判断对方所使用的操作系统及数据…

前端——2.HTML基本结构标签

这篇文章我们从0来介绍一下HTML的相关标签内容 目录 1.HTML语法规范 1.1基本语法概述 1.2标签关系 2.HTML的基本结构标签 2.1第一个HTML网页 2.2基本结构标签总结 1.HTML语法规范 下面&#xff0c;我们来看一下HTML的语法规范的内容 1.1基本语法概述 首先&#xff0c…

基于粒子群优化支持向量机SVM发电功率回归分析,eemd-pso-svm

目录 支持向量机SVM的详细原理 SVM的定义 SVM理论 SVM应用实例,基于eemd分解+粒子群改进SVM的回归分析 代码 结果分析 展望 支持向量机SVM的详细原理 SVM的定义 支持向量机(support vector machines, SVM)是一种二分类模型,它的基本模型是定义在特征空间上的间隔最大的…

挖到宝了,这2款浏览器工具多看小说自由,没踩雷

浏览器除了可以用来搜索和工作&#xff0c;还有很多有趣的娱乐功能。例如&#xff0c;喜欢看片的朋友可以通过浏览器追剧看电影&#xff0c;小说爱好者可以通过浏览器看小说。那么&#xff0c;有没有哪些浏览器可以免费阅读小说呢&#xff1f;我挖到宝了&#xff0c;原来这2款浏…

分布式之CAP原则

文章目录一、知识储备1.1 一致性&#xff08;Consistency&#xff09;1.2 可用性&#xff08;Availability&#xff09;1.3 分区容错性&#xff08;Partition tolerance&#xff09;二、CAP原则2.1 证明三、常见分布式系统采用的原则3.1 CP原则3.2 AP原则3.3 CA原则3.4 动态调节…

可视化爬虫框架spiderflow入门及实战

官网: 点击直达官网 文档: 点击查看官网文档 以下内容部分来自官网或官网文档。文章比较长&#xff0c;请准备好瓜子和小板凳~~~ TIP&#xff1a; 文中用到的网站地址仅为了说明功能&#xff0c;如有侵犯&#xff0c;请告知&#xff0c;会及时删除或者修改本文仅供学习参考&am…

合作伙伴管理软件VS CRM,企业应该选择哪一个?

当涉及到管理你公司的伙伴关系和与客户的关系时&#xff0c;有两个主要选择&#xff1a;合作伙伴管理软件和CRM&#xff08;客户关系管理&#xff09;软件。虽然这两种工具都可以帮助你跟踪商业关系的重要信息&#xff0c;但它们都有各自的优势和不足。 合作伙伴管理软件是专门…