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

相关文章

使用Python实现矢量路径的压缩、解压与可视化

《使用Python实现矢量路径的压缩、解压与可视化》在图形设计和Web开发中,矢量路径数据的高效存储与传输至关重要,本文将通过一个Python示例,展示如何将复杂的矢量路径命令序列压缩为JSON格式,... 目录引言核心功能概述1. 路径命令解析2. 路径数据压缩3. 路径数据解压4. 可视化代码实现详解1

PyQt6/PySide6中QTableView类的实现

《PyQt6/PySide6中QTableView类的实现》本文主要介绍了PyQt6/PySide6中QTableView类的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学... 目录1. 基本概念2. 创建 QTableView 实例3. QTableView 的常用属性和方法

PyQt6/PySide6中QTreeView类的实现

《PyQt6/PySide6中QTreeView类的实现》QTreeView是PyQt6或PySide6库中用于显示分层数据的控件,本文主要介绍了PyQt6/PySide6中QTreeView类的实现... 目录1. 基本概念2. 创建 QTreeView 实例3. QTreeView 的常用属性和方法属性

Android使用ImageView.ScaleType实现图片的缩放与裁剪功能

《Android使用ImageView.ScaleType实现图片的缩放与裁剪功能》ImageView是最常用的控件之一,它用于展示各种类型的图片,为了能够根据需求调整图片的显示效果,Android提... 目录什么是 ImageView.ScaleType?FIT_XYFIT_STARTFIT_CENTE

pandas中位数填充空值的实现示例

《pandas中位数填充空值的实现示例》中位数填充是一种简单而有效的方法,用于填充数据集中缺失的值,本文就来介绍一下pandas中位数填充空值的实现,具有一定的参考价值,感兴趣的可以了解一下... 目录什么是中位数填充?为什么选择中位数填充?示例数据结果分析完整代码总结在数据分析和机器学习过程中,处理缺失数

Golang HashMap实现原理解析

《GolangHashMap实现原理解析》HashMap是一种基于哈希表实现的键值对存储结构,它通过哈希函数将键映射到数组的索引位置,支持高效的插入、查找和删除操作,:本文主要介绍GolangH... 目录HashMap是一种基于哈希表实现的键值对存储结构,它通过哈希函数将键映射到数组的索引位置,支持

Pandas使用AdaBoost进行分类的实现

《Pandas使用AdaBoost进行分类的实现》Pandas和AdaBoost分类算法,可以高效地进行数据预处理和分类任务,本文主要介绍了Pandas使用AdaBoost进行分类的实现,具有一定的参... 目录什么是 AdaBoost?使用 AdaBoost 的步骤安装必要的库步骤一:数据准备步骤二:模型

使用Pandas进行均值填充的实现

《使用Pandas进行均值填充的实现》缺失数据(NaN值)是一个常见的问题,我们可以通过多种方法来处理缺失数据,其中一种常用的方法是均值填充,本文主要介绍了使用Pandas进行均值填充的实现,感兴趣的... 目录什么是均值填充?为什么选择均值填充?均值填充的步骤实际代码示例总结在数据分析和处理过程中,缺失数

Java对象转换的实现方式汇总

《Java对象转换的实现方式汇总》:本文主要介绍Java对象转换的多种实现方式,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录Java对象转换的多种实现方式1. 手动映射(Manual Mapping)2. Builder模式3. 工具类辅助映

Go语言开发实现查询IP信息的MCP服务器

《Go语言开发实现查询IP信息的MCP服务器》随着MCP的快速普及和广泛应用,MCP服务器也层出不穷,本文将详细介绍如何在Go语言中使用go-mcp库来开发一个查询IP信息的MCP... 目录前言mcp-ip-geo 服务器目录结构说明查询 IP 信息功能实现工具实现工具管理查询单个 IP 信息工具的实现服