validation 验证参数

validation 验证参数

一、引入POM依赖

添加spring-boot-starter-validation
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-validation</artifactId>
</dependency>
或添加hibernate-validator
<dependency><groupId>org.hibernate.validator</groupId><artifactId>hibernate-validator</artifactId>
</dependency>
或添加spring-boot-starter-web
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId>
</dependency>

二、校验注解

JSR提供的校验注解:
  1. @Null:被注释的元素值必须为null。
  2. @NotNull:被注释的元素值必须不为null。
  3. @Pattern(regex=):被注释的元素字符串必须符合指定的正则表达式。
  4. @Size(max=, min=):集合元素数量必须在min和max范围内。
  5. @AssertTrue:被注释的元素必须为true。
  6. @AssertFalse:被注释的元素必须为false。
  7. @Min(value):被注释的元素必须是一个数字,其值必须大于等于指定的最小值。
  8. @Max(value):被注释的元素必须是一个数字,其值必须小于等于指定的最大值。
  9. @Range(min,max):数字必须在min和max范围内。
  10. @DecimalMin(value):被注释的元素必须是一个数字,其值必须大于等于指定的最小值。
  11. @DecimalMax(value):被注释的元素必须是一个数字,其值必须小于等于指定的最大值。
  12. @Digits (integer, fraction):被注释的元素必须是一个数字,其值必须在可接受的范围内。
  13. @Past:被注释的元素必须是一个过去的日期。
  14. @Future:被注释的元素必须是一个将来的日期。
  15. @Email:字符串必须是Email地址。
  16. @SafeHtml:字符串必须是安全的html。
  17. @URL:字符串必须是合法的URL。
  18. @CreditCardNumber(ignoreNonDigitCharacters=):字符串必须是信用卡号,按照美国的标准验证。
  19. @Size(max,min):限制字符长度必须在min到max之间。
Hibernate Validator提供的校验注解:
  1. @NotBlank(message =):验证字符串非null,且trim后长度必须大于0。
  2. @Length(min=,max=):被注释的字符串的大小必须在指定的范围内。
  3. @NotEmpty:被注释的字符串的必须非空。
  4. @Range(min=,max=,message=):被注释的元素必须在合适的范围内。
  5. @AssertFalse:校验false。
  6. @AssertTrue:校验true。
  7. @DecimalMax(value=,inclusive=):小于等于value,inclusive=true是小于等于。
  8. @DecimalMin(value=,inclusive=):与上类似。
  9. @Max(value=):小于等于value。
  10. @Min(value=):大于等于value。
  11. @NotNull:检查Null。
  12. @Past:检查日期。
  13. @Pattern(regex=,flag=):正则。
  14. @Size(min=, max=):字符串,集合,map限制大小。
  15. @Valid:对po实体类进行校验。

三、常用注解的使用

Controller添加@Valid或者@Validated都可以
@RestController
@RequestMapping("/")
public class DemoController {@RequestMapping("test")public String test(@Valid @RequestBody request request) {}
}
@Pattern @NotBlank
//正则: 手机号格式是否正确
public static final String REGEX_PHONE = "(^$)|(^[1][3-9][0-9]{9}$)";@Pattern(regexp = Constants.REGEX_PHONE, message = "借款人手机号格式不正确")
@NotBlank(message = "借款人手机号不能为空")
@ApiModelProperty("借款人手机号")
private String borrowerPhone;
@Pattern(regexp = "[ABCD]", message = "权利取得方式不正确")
@ApiModelProperty("权利取得方式(原始:A,继承:B,承受:C,其他:D)")
@NotBlank(message = "权利取得方式不能为空")
private String acqMode;
@Pattern(regexp = "agree|disagree", message = "分发权利不正确")
@ApiModelProperty("分发权利(agree:同意分发,disagree:不同意分发)")
private String copyrightDispense;
@Past
@Past(message = "首次发表日期不正确")
@ApiModelProperty("首次发表日期")
@NotBlank(message = "首次发表日期不能为空")
private String publishDate;
@Size @Empty
@Empty(message = "字体文件数量不能为空")
@Size(max = 50, message = "字体文件数量过多")
@ApiModelProperty("字体文件")
private List<Long> fontFile;
@Length
@Length(max = 20, message = "企业法人名称过长")
@ApiModelProperty("企业法人名称")
private String legalName;
@Range
@Range(min=0,max=2,message="非法性别")
private String sex;
@Email
@Email(message="非法邮件地址")
private String email;
@Min @Max
@Min(value = 1, message = "作品是否涉及字体1-4以内整数")
@Max(value = 4, message = "作品是否涉及字体1-4以内整数")
@ApiModelProperty("作品是否涉及字体")
private Integer isHasFont;

四、分组校验

public class ValidationGroups {public interface ValidA {}public interface ValidB {}
}@ApiModelProperty("身份证背面id")
@NotNull(message = "身份证背面id不能为空", groups = {ValidationGroups.ValidA.class,ValidationGroups.ValidB.class})
private Long backAttachId;@ApiModelProperty("证件id")
@NotNull(message = "证件id不能为空", groups = ValidationGroups.ValidB.class)
private Long businessAttachId;//注解传参校验
public ResultVo<String> addOrUpdateOwnerTemplate(
@Validated(value = {ValidationGroups.ValidA.class,ValidationGroups.ValidB.class}) @NotNull OwnerTemplateReq ownerTemplateReq) throws Exception {return ownerTemplateService.addOrUpdateOwnerTemplate(ownerTemplateReq);
}//手写代码校验
if (条件) {beanValidate(ownerTemplateReq, ValidationGroups.ValidA.class);
} else {beanValidate(ownerTemplateReq, ValidationGroups.ValidB.class);
}//校验方法
private static <T> void beanValidate(T object, Class<?>... groups) throws ValidationException {Validator validator = Validation.buildDefaultValidatorFactory().getValidator();Set<ConstraintViolation<T>> validate1 = validator.validate(object);if (Objects.nonNull(validate1) && validate1.size() > 0) {String msg = validate1.stream().map(ConstraintViolation::getMessage).collect(Collectors.joining("|"));throw new ServiceException(msg);}Set<ConstraintViolation<T>> validate = validator.validate(object, groups);if (Objects.nonNull(validate) && validate.size() > 0) {String msg = validate.stream().map(ConstraintViolation::getMessage).collect(Collectors.joining("|"));throw new ServiceException(msg);}
}

五、@Validated @Valid

@Validated和@Valid都是Java中用于数据校验的注解,它们通常与Java Bean Validation(JSR 303)规范一起使用。在Spring框架中,可以使用这两个注解对方法参数进行校验。

  1. @Validated:这个注解用于类级别,表示该类中的所有方法都会进行数据校验。它主要用于分组校验,可以将不同的校验规则应用到不同的组上。
  2. @Valid:这个注解用于方法参数级别,表示对该参数进行数据校验。当请求中的参数不满足校验规则时,会抛出MethodArgumentNotValidException异常。例如:
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;@RestController
@Validated
public class UserController {@PostMapping("/user")public String createUser(@Valid @RequestBody User user) {// 保存用户信息return "success";}
}    

在这个例子中,createUser方法接收一个User对象作为参数,并使用@Valid注解对其进行校验。如果请求中的User对象不满足校验规则,会抛出MethodArgumentNotValidException异常。

六、全局异常处理ConstraintViolationException

import com.fa.notary.common.enums.base.ErrorCode;
import com.fa.notary.vo.ResultVo;
import io.netty.util.internal.ThrowableUtil;
import lombok.extern.log4j.Log4j2;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang3.StringUtils;
import org.springframework.dao.DuplicateKeyException;
import org.springframework.validation.BindException;
import org.springframework.validation.FieldError;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.text.MessageFormat;
import java.util.List;
import java.util.Set;@RestControllerAdvice
@Log4j2
public class GlobalExceptionHandler {/*** 处理所有不可知的异常*/@ExceptionHandler(Throwable.class)public ResultVo handleException(Throwable e){//DuplicateKeyException(唯一索引重复)if (e instanceof DuplicateKeyException) {return  ResultVo.error(ErrorCode.ERROR,"请勿重复添加");}//ServiceExceptionif(e instanceof ServiceException){return  ResultVo.error(ErrorCode.ERROR,((ServiceException) e).getMsg());}//ServiceExceptionif(e instanceof RetryException){return  ResultVo.error(ErrorCode.ERROR,((RetryException) e).getMsg());}//MissingServletRequestParameterExceptionif(e instanceof MissingServletRequestParameterException){String msg = MessageFormat.format("缺少参数{0}", ((MissingServletRequestParameterException) e).getParameterName());return  ResultVo.error(ErrorCode.ILLEGAL_PARAMETER,msg);}//ConstraintViolationExceptionif(e instanceof ConstraintViolationException){// 单个参数校验异常String msg="";Set<ConstraintViolation<?>> sets = ((ConstraintViolationException) e).getConstraintViolations();if(CollectionUtils.isNotEmpty(sets)){StringBuilder sb = new StringBuilder();sets.forEach(error -> {if (error instanceof FieldError) {sb.append(((FieldError)error).getField()).append(":");}sb.append(error.getMessage()).append(";");});msg = sb.toString();msg = StringUtils.substring(msg, 0, msg.length() -1);}return ResultVo.error(ErrorCode.ILLEGAL_PARAMETER,msg);}//BindExceptionif (e instanceof BindException){// get请求的对象参数校验异常String msg ="";List<ObjectError> errors = ((BindException) e).getBindingResult().getAllErrors();msg = getValidExceptionMsg(errors);return ResultVo.error(ErrorCode.ILLEGAL_PARAMETER,msg);}//MethodArgumentNotValidExceptionif (e instanceof MethodArgumentNotValidException){// post请求的对象参数校验异常String msg="";List<ObjectError> errors = ((MethodArgumentNotValidException) e).getBindingResult().getAllErrors();msg = getValidExceptionMsg(errors);return ResultVo.error(ErrorCode.ILLEGAL_PARAMETER,msg);}// 打印堆栈信息log.error(ThrowableUtil.stackTraceToString(e));return ResultVo.error(ErrorCode.ERROR,"网络繁忙,请稍后再试");}private String getValidExceptionMsg(List<ObjectError> errors) {if(CollectionUtils.isNotEmpty(errors)){StringBuilder sb = new StringBuilder();errors.forEach(error -> {if (error instanceof FieldError) {sb.append(((FieldError)error).getField()).append(":");}sb.append(error.getDefaultMessage()).append(";");});String msg = sb.toString();msg = StringUtils.substring(msg, 0, msg.length() -1);return msg;}return null;}
}

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

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

相关文章

基于java+springboot+vue实现的智慧生活商城系统(文末源码+Lw)244

摘 要 计算机网络发展到现在已经好几十年了&#xff0c;在理论上面已经有了很丰富的基础&#xff0c;并且在现实生活中也到处都在使用&#xff0c;可以说&#xff0c;经过几十年的发展&#xff0c;互联网技术已经把地域信息的隔阂给消除了&#xff0c;让整个世界都可以即时通…

platformio烧写STC8H1K08单片机程序失败:Serial port error: read timeout

问题 在使用platformio进行STC8H1K08单片机开发&#xff0c;在烧录编译好的程序时失败了&#xff0c;烧录过程日志如下&#xff1a; * 正在执行任务: C:\Users\23043036\.platformio\penv\Scripts\platformio.exe run --target upload Processing STC8H1K08 (platform: intel…

ionic7 从安装 到 项目启动最后打包成 apk

报错处理 在打包的时候遇到过几个问题&#xff0c;这里记录下来两个 Visual Studio Code运行ionic build出错显示ionic : 无法加载文件 ionic 项目通过 android studio 打开报错 capacitor.settings.gradle 文件不存在 说明 由于之前使用的是 ionic 3&#xff0c;当时打包的…

驾考小技巧:老北京布鞋!距离高考出分还剩3天,我却看到有些孩子已经拿了“满分”——早读(逆天打工人爬取热门微信文章解读)

我20年驾校4000多块钱&#xff0c;你呢&#xff1f; 引言Python 代码第一篇 洞见 距离高考出分还剩3天&#xff0c;我却看到有些孩子已经拿了“满分”第二篇 视频新闻结尾 引言 昨天的文章顺利发出 看来“梅西” 这两个字在我们这边 不是敏感词 只是很多个罗粉搞得有点过头了 …

Android设置页面Activity全屏(隐藏导航栏、状态栏)

3、代码中设置&#xff1a;在setContentView 之前调用 requestWindowFeature(Window.FEATURE_NO_TITLE); getWindow().setFlags(WindowManager.LayoutParams.FLAG_FULLSCREEN, WindowManager.LayoutParams.FLAG_FULLSCREEN); 注意&#xff1a; 当有全面屏手机可以显示虚拟…

2769. 找出最大的可达成数字

2769. 找出最大的可达成数字 题目链接&#xff1a;2769. 找出最大的可达成数字 代码如下&#xff1a; class Solution { public:int theMaximumAchievableX(int num, int t) {return num2*t; } };

公司名称含有关商标名称可能涉及侵权!

有个朋友找到普推商标知产老杨&#xff0c;说有个人给他打电话&#xff0c;说他的公司名称侵权另一家的商标名称&#xff0c;让他要改下公司名称&#xff0c;不改就要告侵权&#xff0c;此前看到过许多&#xff0c;在一些省市注册公司时&#xff0c;如果公司名称与已注册商标相…

聚类算法(1)---最大最小距离、C-均值算法

本篇文章是博主在人工智能等领域学习时&#xff0c;用于个人学习、研究或者欣赏使用&#xff0c;并基于博主对人工智能等领域的一些理解而记录的学习摘录和笔记&#xff0c;若有不当和侵权之处&#xff0c;指出后将会立即改正&#xff0c;还望谅解。文章分类在AI学习笔记&#…

区块链2024

项目名称&#xff1a;基于区块链的物资管理系统 技术栈:SpringBoot SpringSecurity MyBatis-Plus MySQL Redis CouchDB Hyperledger Fabric RabbitMQ Docker 项目描述&#xff1a;在自然灾害期间&#xff0c;物资管理常面临信息孤立和不透明等问题。为此&#xff0c;我…

象战----第十二届中山市邀请赛正赛

本次的题解一定让大家享受脑细胞碰撞与再生死亡的感受&#xff01;定然酣畅淋漓&#xff01;请耐心的读完 简称&#xff1a;让脑袋死机。。。 象战 老规矩先分析在打码&#xff1a; 注意到题目告诉我们&#xff1a;四个角落是不能放的 那么 我们设象在(i,j).(注意&#xff1a…

uniapp实现幻灯功能方法及代码

在 UniApp 中实现幻灯功能&#xff0c;通常可以使用 swiper 组件&#xff0c;该组件用于滑动视图容器&#xff0c;常用于制作轮播图效果。以下是一个简单的幻灯功能实现方法及代码示例&#xff1a; 步骤 1&#xff1a;在页面的模板部分添加 swiper 和 swiper-item 组件 <t…

解决双击bootstrap.bat没有生成b2.exe文件

双击bootstrap.bat但是并没有没有生成b2.exe文件&#xff0c;会报如下错误&#xff1a; "cl" 不是内部或外部命令&#xff0c;也不是可运行的程序 或批处理文件。D:\cppsoft\boost_1_85_0\tools\build\src\engine>dir *.exe 驱动器 D 中的卷是 Data 卷的序列号是…

eNSP学习——配置基于全局地址池的DHCP

目录 主要命令 原理概述 实验目的 实验场景 实验拓扑 实验编址 实验步骤 1、基本配置 2、配置基于全局地址池的 DHCP Server 3、配置DHCP Client 主要命令 [R1]dhcp enable //开启 DHCP功能//创建一个全局地址池&#xff0c;地址池名称为huawei1 [R1]ip pool h…

Linux系统开机自启动脚本(案例:Raspberry Pi 4B脚本)

前言&#xff1a;本篇博客为手把手教学的 Linux 系统开机自启动脚本教程&#xff0c;且额外包含有 Raspberry Pi 4B 的开机自启动案例。日常工程项目中往往需要 Linux 系统能够自启动一些代码程序&#xff0c;本篇博客利用虚拟机下的 Ubuntu 自启动脚本来进行教学&#xff0c;且…

力扣240.搜索二维矩阵II

力扣240.搜索二维矩阵II 因为原数组是从上到下从左到右增加的 在左下(和右上角)时有特性&#xff1a;i减小则a[i]减小&#xff0c;j增大则a[j]增大因此从左下角开始遍历 找到结果return即可 class Solution {public:bool searchMatrix(vector<vector<int>>&…

vue canvas学习

说明 在vue里试用一下canvas&#xff0c;记录一下 代码 <template><div><canvas ref"canvas1" height"500" width"500"></canvas><button click"draw">画图</button></div> </templa…

深入解析Transformer:大模型核心技术揭秘

在大模型发展历程中&#xff0c;有两个比较重要点&#xff1a;第一&#xff0c;Transformer 架构。它是模型的底座&#xff0c;但 Transformer 不等于大模型&#xff0c;但大模型的架构可以基于 Transformer&#xff1b;第二&#xff0c;GPT。严格意义上讲&#xff0c;GPT 可能…

【网络安全的神秘世界】docker启动失败?看我如何成功启动

&#x1f31d;博客主页&#xff1a;泥菩萨 &#x1f496;专栏&#xff1a;Linux探索之旅 | 网络安全的神秘世界 | 专接本 | 每天学会一个渗透测试工具 &#x1f64b;‍♂️问题描述 关闭docker后再启动就发现启动失败了 错误信息&#xff1a;Job for docker.service failed b…

2020C++等级考试二级真题题解

202012数组指定部分逆序重放c #include <iostream> using namespace std; int main() {int a[110];int n, k;cin >> n >> k;for (int i 0; i < n; i) {cin >> a[i];}for (int i 0; i < k / 2; i) {swap(a[i], a[k - 1 - i]);}for (int i 0…

Unity定时(延迟)管理器实现

前言 Unity中实现定时功能的方法有很多&#xff0c;比如协程、Update、Invoke、Async等&#xff0c;可以说是五花八门&#xff0c;对于这类实现方法多、需求频繁的功能还是需要一个管理器来统一处理。 功能 下面列出了该管理器支持的功能&#xff0c;可以根据根据所列功能判…