【Java】在实体类中常用的注解校验

news2024/12/26 23:26:53

1、常用注解:

注解说明
@Null只能为null
@NotNull(message = “id不能为空”)必须不为null,可以为空字符串
@Min(value)必须为一个不小于指定值的数字
@Max(value)必须为一个不大于指定值的数字
@NotBlank(message = “姓名不能为空”)验证注解的元素值不为空(不为null、去除首位空格后长度为0),不同于@NotEmpty,@NotBlank只应用于字符串且在比较时会去除字符串的空格
@NotEmpty验证注解的元素值不为null且不为空(字符串长度不为0、集合大小不为0)
@AssertFalse必须为false
@AssertTrue必须为true
@DecimalMax(value)必须为一个不大于指定值的数字
@DecimalMin(value)必须为一个不小于指定值的数字
@Digits(integer,fraction)必须为一个小数,且整数部分的位数不能超过integer,小数部分的位数不能超过fraction
@Future必须是一个将来的日期
@Past必须是一个过去的日期
@Pattern(regexp = “^(正则表达式)$”, message = “身份证格式错误”)必须符合指定的正则表达式
@Size(max,min,message = “list大小不可为0”)字符长度必须在min到max之间
@Length(min = 1,max = 4, message = “用户名不能超过4个字符”)被限制的字符串的大小必须在指定的范围内,一般用在 String 类型上可对字段数值进行最大长度限制的控制。
@Email验证注解的元素值是Email,也可以通过正则表达式和flag指定自定义的email格式
@Range(min = 60,max = 80,message = “年龄必须要60到80之间,60=<年龄=<80”)被注释的元素必须在合适的范围内,一般用在 Integer 类型上可对字段数值进行大小范围的控制。

@NotEmpty、@NotBlank 以及 @NotNull 注解的使用:

@NotEmpty 用在集合或数组上面,一般用来校验List类型(不能注释枚举),而且长度必须大于0
@NotBlank 用在String上面,一般用来校验String类型不能为空,而且调用trim()后,长度必须大于0。
@NotNull 用在所有类型上面,一般用来校验Integer类型不能为空,但可以为empty。
需要搭配@Valid使用,在检验Controller的入参是否符合规范时

@JsonFormat注解:

可以约束时间的接收格式和响应格式 (接收和响应的都是JSON字符串),将日期类型数据在JSON格式和java.util.Date对象之间转换 (前端传参是json字符串格式,后端返参也是json字符串格式,JsonFormat注解会自动转化成data格式进行处理)。与传输方向没有关系(前端到后端or后端到前端都可以使用)

使用 @JsonFormat 注解时,查到的时间可能会比数据库中的时间少八个小时,这是由于时区差引起的,JsonFormat 默认的时区是 Greenwich Time, 默认的是格林威治时间,而我们是在东八区上,所以时间会比实际我们想得到的时间少八个小时。需要在后面加上一个时区,如下示例:

@JsonFormat(pattern="yyyy-MM-dd",timezone="GMT+8")
private Date date;

常用注解属性:

名称作用
pattern约定时间格式:pattern=“yyyy-MM-dd HH:mm:ss”
timezone指定具体时区: timezone = “GMT+8” or timezone = “Asia/Shanghai”

@DateTimeFormat注解:

可对java.util.Date、java.uitl.calendar、java.long.Long及Joda时间类型的属性进行标注,主要处理前端时间类型与后端pojo对象中的成员变量进行数据绑定,所约束的时间格式并不会影响后端返回前端的时间类型数据格式(前端传参是json字符串格式,后端返参也是json字符串格式,DateTimeFormat注解会自动转化成data格式进行处理)

注意:前端入参数据的时间格式必须与注解中定义的时间格式相同,不然会报错,如:@DateTimeFormat(pattern = “yyyy-MM-dd HH:mm”) 则入参的格式必须为"2020-6-4 10:43";

常用注解属性:

名称作用
iso类型为DateTimeFormat.ISO,常用值:DateTimeFormat.ISO.DATE:格式为yyyy-MM-ddDateTimeFormat.ISO.DATE_TIME:格式为yyyy-MM-dd hh:mm:ss.SSSZDateTimeFormat.ISO.TIME:格式为hh:mm:ss.SSSZDateTimeFormat.ISO.NONE:表示不使用ISO格式的时间(默认值)
pattern类型为String,使用自定义时间格式化字符串,如"yyyy-MM-dd hh:mm:ss"
style类型为String,通过样式指定日期时间的格式,由两位字符组成,第一位表示日期的样式,第二位表示时间的格式,以下是几个常用的可选值:S:短日期/时间的样式M:中日期/时间的样式L:短日期/时间的样式F:完整日期/时间的样子-:忽略日期或时间的样式默认值 style=“SS”

@JsonFormat 和 @DateTimeFormat 区别

@JsonFormat既可以约束前端传入的时间类型参数格式,也可以约束后端响应前端的时间类型格式;

@DateTimeFormat :

  • 只能约束前端入参时间类型的格式,并不会修改原有的日期对象的格式,如果想要获得期望的日期格式,是需要自己手动转换的;
  • 如果单独使用@DateTimeFormat 时,响应给前端的时间会比实际时间晚8个小时(时区原因)

参考链接:https://blog.csdn.net/zhuzicc/article/details/106529485

@ApiModelProperty()注解:用于方法,字段; 表示对属性的说明或者数据操作更改

value–字段说明
name–重写属性名字 ,
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏

@ApiModel(value="user对象",description="用户对象user")
public class User implements Serializable{
    private static final long serialVersionUID = 1L;
     @ApiModelProperty(value="用户名",name="username",example="xingguo")
     private String username;
     @ApiModelProperty(value="状态",name="state",required=true)
      private Integer state;
      private String password;
      private String nickName;
      private Integer isDeleted;

      @ApiModelProperty(value="id数组",hidden=true)
      private String[] ids;
      private List<String> idList;
     //省略get/set
}

一些校验注解的使用:

在这里插入图片描述

2、使用案例(@Valid注解的使用):

@valid注解主要用于数据校验,可定义在两种地方。

  1. 定义实体类中的属性上,添加不同的注解来完成不同的校验规则。

  2. 定义在接口类中,在接收参数前添加@Valid注解,开启实体类的校验功能。

1、在实体类中添加注解校验:

public class OrderSync {
        private static final long serialVersionUID = 1L;
        /**
         * 用户Id
         */
        @ApiModelProperty(value = "用户id") //@ApiModelProperty是swagger的注解,它的作用是添加和操作属性模块的数据
        @NotEmpty(message = "用户id不能为空")
        private String userId;
        /**
         * 购买数量
         */
        @NotNull(message = "购买数量不能为空")
        private Integer quantity;
        /**
         * 支付时间
         */
        @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
        @DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss")
        @NotEmpty(message = "支付时间不能为空")
        private LocalDateTime paymentTime;
    
        /**
         * 订单状态1、待发货 2、待收货 3、确认收货/已完成 5、已关闭
         */
        @Excel(name = "订单状态", readConverterExp = "1=待发货,2=待收货,3=确认收货/已完成 ,5=已关闭")
        @NotEmpty(message = "订单状态不能为空")
        private String orderStatus;

}

2、在接口中添加@valid注解

在controller类中添加接口,POST方法中接收设置了@Valid相关注解的实体对象,然后再参数中添加@Valid注解来开启效验功能,需要注意的是,@Valid对Get请求中接收的平面参数请求无效。

@RestController
public class TestController {
    @PostMapping("/sync")
    public String addUserInfo(@Valid @RequestBody OrderSync sync){
        return "调用成功";
    }
}

嵌套校验:

为了能够进行嵌套验证,必须手动在Person实体的son字段上明确指出这个字段里面的实体也要进行验证。

class Person {
    @NotNull
    private Integer id;

    @NotNull
    /**
     * @Validated不允许使用在成员属性上,所以只能用@Valid
     * 如果不加  @Valid 就不会对 Son类进行校验,只会判断 @NotNull,List<Son>是否为空,并不会Son类里面的成员属性
     */
    @Valid //嵌套验证
    private List<Son> son;
}

class Son {
    @NotNull
    private Integer sid;

    @NotBlank(message = "姓名不能为空")
    private String name;

}

class MemberController {

    @ApiOperation(value = "会员注册")
    @PostMapping("register")
                              //使用@Validated或者@Valid都可以,这样就完成了嵌套验证
    public JSONResult register(@Validated @RequestBody Person person, BindingResult bindingResult){

        if (bindingResult.hasErrors()) {
            System.out.println(bindingResult.getFieldError().getDefaultMessage());
            return JSONResult.error().message(bindingResult.getFieldError().getDefaultMessage());
        }
        return JSONResult.ok();
    }

}

3、@Valid 与 @Validated注解的区别:

@Valid、@Validated 注解可以实现数据的验证,你可以定义实体,在实体的属性上添加校验注解,如@NotEmpty,@NotBlank,@NotNull等等的注解就是,不加上就不会生效!
@Valid 包位置:javax.validation
@Validated 包位置 org.springframework.validation.annotation,是@Valid 的一次封装,是Spring提供的校验机制使用。

不同点:

1、使用位置:

  • @Validated:用在类型、方法和方法参数上。但不能用于成员属性(field)
  • @Valid:可以用在方法、构造函数、方法参数和成员属性(field)上
    在这里插入图片描述在这里插入图片描述

如果@Validated注解在成员属性上,则会报 ‘@Validdated’ not applicable to field 错误:
在这里插入图片描述

2、分组上:@Valid 不支持分组, @Validated则支持分组验证。

定义分组接口:

public interface IGroupA {
}
 
public interface IGroupB {
}

定义需要检验的参数bean:

public class StudentBean implements Serializable{
    @NotBlank(message = "用户名不能为空")
    private String name;
    //只在分组为IGroupB的情况下进行验证
    @Min(value = 18, message = "年龄不能小于18岁", groups = {IGroupB.class})
    private Integer age;
    @Pattern(regexp = "^((13[0-9])|(14[5,7,9])|(15([0-3]|[5-9]))|(166)|(17[0,1,3,5,6,7,8])|(18[0-9])|(19[8|9]))\\d{8}$", message = "手机号格式错误")
    private String phoneNum;
    @Email(message = "邮箱格式错误")
    private String email;
    @MyConstraint
    private String className;
}

测试代码:检验分组为IGroupA的情况,这里对分组IGroupB的就没检验了

@RestController
public class CheckController {
    @PostMapping("stu")
    public String addStu(@Validated({IGroupA.class}) @RequestBody StudentBean studentBean){
        return "add student success";
    }
}

如果把测试代码改成下面这样,就会检验B了

@RestController
public class CheckController {
    @PostMapping("stu")
    public String addStu(@Validated({IGroupA.class, IGroupB.class}) @RequestBody StudentBean studentBean){
        return "add student success";
    }
}

说明:
1、不分 配groups,默认每次都要进行验证
2、对一个参数需要多种验证方式时,也可通过分配不同的组达到目的。

相同点:

在检验Controller的入参是否符合规范时,使用@Validated或者@Valid都可以实现,并且需要传入BindingResult对象,用于获取校验失败情况下的反馈信息,如下代码:

  @PostMapping("register")
                             //@Valid这两个用哪个效果都一样
    public JSONResult register(@Validated @RequestBody RegisterVo registerVo, BindingResult bindingResult){

     //会把校验失败情况下的反馈信息
        if (bindingResult.hasErrors()) {
            System.out.println(bindingResult.getFieldError().getDefaultMessage());
            return JSONResult.error().message(bindingResult.getFieldError().getDefaultMessage());
        }
        memberService.register(registerVo);
        return JSONResult.ok();
    }

总结:

1.常用校验注解@NotEmpty,@NotBlank,@NotNull,需要搭配@Valid或@Validated使用

2.@Valid或@Validated 中有 BindingResult,可以获取校验失败情况下的反馈信息,如果不添加,默认情况下会抛出对应的异常。

3.@Validated无法单独提供嵌套验证功能。不能用在成员属性上,能配合嵌套验证注解@Valid进行嵌套验证。

4.@Valid无法单独提供嵌套验证功能。能够用在成员属性上,能配合嵌套验证注解@Valid进行嵌套验证。

参考链接:https://blog.csdn.net/weixin_46015018/article/details/122637042

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

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

相关文章

2000-2021年全国各省资本存量测算数据(含原始数据+测算过程+计算结果)

2000-2021年全国各省资本存量测算数据&#xff08;含原始数据测算过程计算结果&#xff09; 1、时间&#xff1a;2000-2021年&#xff08;以2000年为基期&#xff09; 2、范围&#xff1a;30个省市&#xff08;不含西藏&#xff09; 3、指标&#xff1a;固定资产形成总额、固…

python poetry的教程

Poetry Python世界中&#xff0c;Poetry是一个近年来备受瞩目的工具&#xff0c;它为开发者提供了一个灵活且强大的依赖管理解决方案。Poetry可以帮助开发者管理项目的依赖关系&#xff0c;同时提供了一系列的工具和功能&#xff0c;使开发者能够更轻松地创建和管理复杂的项目。…

申克SCHENCK动平衡机显示器维修CAB700系统控制面板

适用电枢转子的卧式平衡机&#xff0c;高测量率&#xff0c;自动测量循环&#xff0c;自动定标完整的切槽计数可选项&#xff0c;CAB700动平衡测量系统两种皮带驱动方式(上置式或下置式)适用于站立或坐姿操作的人性化工作台设计。 动平衡机申克控制器面板维修型号&#xff1a;V…

关于VUE启动内存溢出

安装node v10.14.2 后 启动公司的VUE项目 使用命令npm run dev 命令 报错&#xff1a; <--- Last few GCs --->[20940:00000244699848E0] 215872 ms: Scavenge 1690.2 (1836.4) -> 1679.6 (1836.4) MB, 5.4 / 0.7 ms (average mu 0.266, current mu 0.253) a…

【编程语言发展史】SQL的发展历史

目录 目录 SQL概述 SQL发展历史 SQL特点 SQL基本语句 SQL是结构化查询语言(Structure Query Language)的缩写&#xff0c;它是使用关系模型的数据库应用语言&#xff0c;由IBM在70年代开发出来&#xff0c;作为IBM关系数据库原型System R的原型关系语言&#xff0c;实现了…

【广州华锐互动】VR虚拟仿真技术为航测实践教学提供了哪些帮助?

在过去的几十年里&#xff0c;航空测量技术发展迅速&#xff0c;为我们提供了前所未有的地理信息获取手段。然而&#xff0c;这个领域的发展并未停止&#xff0c;最新的技术进步——虚拟现实(VR)——正在为航测实践教学开启新的篇章。 VR虚拟现实技术能够创建和体验三维虚拟环境…

Next.js 项目——从入门到入门(Eslint+Prettier)

Next.js官方文档地址 什么是 Next.js 这是一个用于生产环境的 React 框架。 Next.js 为您提供生产环境所需的所有功能以及最佳的开发体验&#xff1a;包括静态及服务器端融合渲染、 支持 TypeScript、智能化打包、 路由预取等功能&#xff0c;无需任何配置。 功能&#xff…

如何下载PDF版本的专利

问题描述&#xff1a;有时下载的专利是CAJ格式&#xff0c;需要用CAJViewer软件才能观看&#xff0c;那么如何下载pdf版本的呢&#xff1f; 问题解决&#xff1a; 方法一&#xff1a; 使用CAJViewer软件进行转换。&#xff08;注意&#xff1a;这种方法转换的PDF其实就是一个…

重磅发布 OpenAI 推出用户自定义版 ChatGPT

文章目录 重磅发布 OpenAI 推出用户自定义版 ChatGPT个人简介 重磅发布 OpenAI 推出用户自定义版 ChatGPT OpenAI 首届开发者大会 (OpenAI DevDay) 于北京时间 11 月 7 日凌晨 02:00 开始&#xff0c;大会上宣布了一系列平台更新。其中一个重要更新是用户可以创建他们自己的自定…

Python 批量修改文件中的时间属性

目录 前言&#xff1a; 探索&#xff1a; 读取文件的属性时间 更改文件属性时间 使用 win32file 修改时间属性 all code: 前言&#xff1a; 有时候需要修改文件的“修改时间” 、 “访问时间”&#xff0c;“创建时间” 使用 Python 写出来简单好用。 探索&#xff1a; …

Power Apps-获取用户信息

插入一个文本组件&#xff0c;点击该组件&#xff0c;点击右侧边栏中的文本&#xff0c;在上方函数中写入如下内容就可以获取到用户信息了 "Hello!"&User().FullName//字符串拼接

中文编程软件视频推荐,自学编程电脑推荐,中文编程开发语言工具下载

中文编程软件视频推荐&#xff0c;自学编程电脑推荐&#xff0c;中文编程开发语言工具下载 给大家分享一款中文编程工具&#xff0c;零基础轻松学编程&#xff0c;不需英语基础&#xff0c;编程工具可下载。 这款工具不但可以连接部分硬件&#xff0c;而且可以开发大型的软件…

IPv6详解

目录: 第一部分 IPv6的诞生背景和引起的主要变化 第二部分 IPv6数据报的基本首部和扩展首部 第三部分 IPv6地址 第四部分 IPv4向IPv6过渡 第一部分 IPv6的诞生背景和引起的主要变化 一.IPv6的诞生背景 IPv4存在设计缺陷: IPv4的设计者最初并没有想到该协议会在全球范围内广…

leetcode做题笔记226. 翻转二叉树

给你一棵二叉树的根节点 root &#xff0c;翻转这棵二叉树&#xff0c;并返回其根节点。 示例 1&#xff1a; 输入&#xff1a;root [4,2,7,1,3,6,9] 输出&#xff1a;[4,7,2,9,6,3,1]示例 2&#xff1a; 输入&#xff1a;root [2,1,3] 输出&#xff1a;[2,3,1]示例 3&#x…

8086读取键盘-磁盘输入

文章目录 前言1.从键盘读数据2.磁盘读数据 前言 想过一个问题没有&#xff0c; 8086是如何从键盘中接受输入的&#xff1f; 8086如何将字符在显示器上显示的&#xff1f; 8086如何从磁盘中读取数据的&#xff1f; 上面的问题都是没有操作系统的时候&#xff0c;比如bios的那段…

VSCode使用插件Github Copilot进行AI编程

演示示例 函数封装 根据上下文 根据注释 详情请看GitHub Copilot 安装插件 在VS Code中安装插件 GitHub Copilot 登录账号 点击VS code左下角账户图标&#xff0c;点击【Sign in】&#xff0c;会自动在浏览器打开Github登录页&#xff0c;登录具有 Github Copilot 服务的…

Wireshark分析tcp交互过程

三次握手 客户端发起请求 Tcp段长度为575字节&#xff0c;seq1&#xff0c;ack1&#xff0c;next_seq576 服务器响应&#xff1a; Tcp段长度为175字节&#xff0c;seq1&#xff0c;ack576&#xff0c;next_seq176 客户端响应&#xff1a; Tcp段长度523字节&#xff0c;seq576&…

OpenGL_Learn08(坐标系统)

目录 1. 概述 2. 局部空间 3. 世界空间 4. 观察空间 5. 剪裁空间 6. 初入3D 7. 3D旋转 1. 概述 OpenGL希望在每次顶点着色器运行后&#xff0c;我们可见的所有顶点都为标准化设备坐标(Normalized Device Coordinate, NDC)。也就是说&#xff0c;每个顶点的x&#xff0c;…

2023.11.7 Spring 依赖注入的三大方式

目录 前言 属性注入&#xff08;Autowired&#xff09; Setter 注入 构造方法注入 Resource Autowired 和 Resource 的区别 Autowired 和 Resource 查找 Bean 对象的区别 前言 配置文件 ​ <?xml version"1.0" encoding"UTF-8"?> <beans …

Park和UnPark底层原理

文章目录 1. 简介2. 底层原理3. 总结 1. 简介 park和unpark也是一个线程暂停技术&#xff08;让线程进入wait状态&#xff09;&#xff0c;与wait/notify不同的是&#xff0c;前者是LockSupport类中的方法&#xff0c;后者是Object类中的方法。其次&#xff0c;wait与notify和…