JSR303 统一校验实现

2024-06-12 21:12
文章标签 实现 校验 统一 jsr303

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

1.简介

JSR 303 是 Java Specification Request 303 的简称,它定义了一套 Java Bean Validation API,用于对 Java 应用中的 Bean(通常是指 POJOs,即 Plain Old Java Objects)进行声明式校验。JSR 303 为 Java 开发者提供了一套标准的校验注解,使得开发者可以非常方便地在 Bean 属性上声明校验规则,而不需要编写大量的校验代码。

JSR 303 的主要特点和组件包括:

  1. 校验注解:JSR 303 定义了一系列的校验注解,如 @NotNull@Size@Min@Max@Pattern 等,这些注解可以直接应用于 Java Bean 的属性上,以声明校验规则。

  2. 约束Violation:当校验失败时,JSR 303 会生成一系列的 ConstraintViolation 对象,每个对象包含有关违反约束的详细信息,如属性路径、违规值、错误消息等。

  3. 校验器(Validator):JSR 303 提供了一个 Validator 接口,用于执行实际的校验操作。开发者可以通过 Validator 对象对 Bean 进行校验,并获取校验结果。

  4. 校验组(Validation Groups):JSR 303 支持校验组的概念,允许开发者将校验规则分组,以便在不同的场景下应用不同的校验规则。

  5. 自定义约束:除了使用标准的校验注解外,JSR 303 还允许开发者定义自己的校验注解和约束。

2实战

2.1 引入依赖

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

2.2 创建exception类

2.2.1 CommonError通用异常处理类

package com.etc.shop.exception;public enum CommonError {UNKOWN_ERROR("执行过程异常,请重试。"),PARAMS_ERROR("非法参数"),OBJECT_NULL("对象为空"),QUERY_NULL("查询结果为空"),REQUEST_NULL("请求参数为空");private String errMessage;public String getErrMessage(){return errMessage;}CommonError(String errMessage) {this.errMessage = errMessage;}
}

2.2.2 该系统的异常类ShopSystem

package com.etc.shop.exception;public class ShopSystemException extends RuntimeException{private String errMessage;public ShopSystemException(){super();}public ShopSystemException(String errMessage){super(errMessage);this.errMessage = errMessage;}public String getErrMessage(){return errMessage;}public static void cast(CommonError commonError){throw new ShopSystemException(commonError.getErrMessage());}public static void cast(String errMessage){throw new ShopSystemException(errMessage);}}

2.2.3  响应请求的错误类

package com.etc.shop.exception;import java.io.Serializable;public class RestErrorResponse implements Serializable {private String errMessage;public RestErrorResponse(String errMessage){this.errMessage = errMessage;}public String getErrMessage(){return errMessage;}public void setErrMessage(String errMessage){this.errMessage = errMessage;}
}

2.2.4 GlobalException全局异常处理类

package com.etc.shop.exception;import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.*;@Slf4j
@ControllerAdvice
public class GlobalExceptionHandler {@ResponseBody@ExceptionHandler(ShopSystemException.class)@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)public RestErrorResponse customException(ShopSystemException e){log.error("系统异常:{}",e.getErrMessage(),e);String errMessage = e.getErrMessage();RestErrorResponse restErrorResponse = new RestErrorResponse(errMessage);return restErrorResponse;}@ResponseBody@ExceptionHandler(Exception.class)@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)public RestErrorResponse exception(Exception e){log.error("系统异常:{}",e.getMessage(),e);RestErrorResponse restErrorResponse = new RestErrorResponse(CommonError.UNKOWN_ERROR.getErrMessage());return restErrorResponse;}
}

2.2.5 设置异常分组类

public class ValidationGroups {public interface Insert{};public interface Update{};public interface Delete{};}

2.3 对实体添加异常处理注解示例,以及分组示例

@Data
public class OrderDTO {@NotEmpty(message = "订单上的商品不能为空")private List<OrderItem> orderItems;@NotEmpty(message = "订单上的总金额不能为空")private BigDecimal totalAmount;@NotEmpty(message = "接收人的姓名不能为空",groups = {ValidationGroups.Insert.class})@NotEmpty(message = "更改后的接收人的姓名不能为空",groups = {ValidationGroups.Update.class})private String receiverName;@NotEmpty(message = "接收地址不能为空",groups = {ValidationGroups.Insert.class})@NotEmpty(message = "更改后的接收地址不能为空",groups = {ValidationGroups.Update.class})private String receiverAddress;@NotEmpty(message = "接收人的手机号不能为空",groups = {ValidationGroups.Insert.class})@NotEmpty(message = "更改后的接收人的手机号不能为空",groups = {ValidationGroups.Update.class})private String receiverPhone;}

2.4 在controller中对请求的接口添加@Validated注解,可以设置groups分组

这篇关于JSR303 统一校验实现的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1055353

相关文章

使用Sentinel自定义返回和实现区分来源方式

《使用Sentinel自定义返回和实现区分来源方式》:本文主要介绍使用Sentinel自定义返回和实现区分来源方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Sentinel自定义返回和实现区分来源1. 自定义错误返回2. 实现区分来源总结Sentinel自定

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

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

Java实现时间与字符串互相转换详解

《Java实现时间与字符串互相转换详解》这篇文章主要为大家详细介绍了Java中实现时间与字符串互相转换的相关方法,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录一、日期格式化为字符串(一)使用预定义格式(二)自定义格式二、字符串解析为日期(一)解析ISO格式字符串(二)解析自定义

opencv图像处理之指纹验证的实现

《opencv图像处理之指纹验证的实现》本文主要介绍了opencv图像处理之指纹验证的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学... 目录一、简介二、具体案例实现1. 图像显示函数2. 指纹验证函数3. 主函数4、运行结果三、总结一、

Springboot处理跨域的实现方式(附Demo)

《Springboot处理跨域的实现方式(附Demo)》:本文主要介绍Springboot处理跨域的实现方式(附Demo),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不... 目录Springboot处理跨域的方式1. 基本知识2. @CrossOrigin3. 全局跨域设置4.

Spring Boot 3.4.3 基于 Spring WebFlux 实现 SSE 功能(代码示例)

《SpringBoot3.4.3基于SpringWebFlux实现SSE功能(代码示例)》SpringBoot3.4.3结合SpringWebFlux实现SSE功能,为实时数据推送提供... 目录1. SSE 简介1.1 什么是 SSE?1.2 SSE 的优点1.3 适用场景2. Spring WebFlu

基于SpringBoot实现文件秒传功能

《基于SpringBoot实现文件秒传功能》在开发Web应用时,文件上传是一个常见需求,然而,当用户需要上传大文件或相同文件多次时,会造成带宽浪费和服务器存储冗余,此时可以使用文件秒传技术通过识别重复... 目录前言文件秒传原理代码实现1. 创建项目基础结构2. 创建上传存储代码3. 创建Result类4.

SpringBoot日志配置SLF4J和Logback的方法实现

《SpringBoot日志配置SLF4J和Logback的方法实现》日志记录是不可或缺的一部分,本文主要介绍了SpringBoot日志配置SLF4J和Logback的方法实现,文中通过示例代码介绍的非... 目录一、前言二、案例一:初识日志三、案例二:使用Lombok输出日志四、案例三:配置Logback一

Python如何使用__slots__实现节省内存和性能优化

《Python如何使用__slots__实现节省内存和性能优化》你有想过,一个小小的__slots__能让你的Python类内存消耗直接减半吗,没错,今天咱们要聊的就是这个让人眼前一亮的技巧,感兴趣的... 目录背景:内存吃得满满的类__slots__:你的内存管理小助手举个大概的例子:看看效果如何?1.

Python+PyQt5实现多屏幕协同播放功能

《Python+PyQt5实现多屏幕协同播放功能》在现代会议展示、数字广告、展览展示等场景中,多屏幕协同播放已成为刚需,下面我们就来看看如何利用Python和PyQt5开发一套功能强大的跨屏播控系统吧... 目录一、项目概述:突破传统播放限制二、核心技术解析2.1 多屏管理机制2.2 播放引擎设计2.3 专