SpringBoot校验,DTO文件中常用的注解应用案例.

在观看本篇文章之前,可以先参考我之前写的一篇文章 " Spring5,Service层对DTO文件进行数据格式校验. " ,这篇文章是介绍在 Service层 对DTO文件的校验。 以下方的 CompanyDTO 文件为例,讲解不同的注解使用场景,以及适用于那些数据类型。

未完待续........

1、需要引入的Maven依赖

XML 复制代码
		<dependency>
			<groupId>org.projectlombok</groupId>
			<artifactId>lombok</artifactId>
			<version>1.18.20</version>
			<scope>compile</scope>
		</dependency>
		
		<dependency>
			<groupId>javax.validation</groupId>
			<artifactId>validation-api</artifactId>
			<version>2.0.1.Final</version>
		</dependency>

		<dependency>
			<groupId>org.hibernate.validator</groupId>
			<artifactId>hibernate-validator</artifactId>
			<version>6.2.5.Final</version>
		</dependency>

2、CompanyDTO 文件

java 复制代码
package com.moon.learning.dto;

import com.moon.learning.validation.ValidGroup;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;

import javax.validation.constraints.*;
import java.io.Serializable;


/**
 * 用于校验的DTO文件.
 *
 * @author moon
 * @version 1.0
 * @date 2022/11/22 11:45
 */
@ApiModel(value = "公司", description = "参数")
@Data
@AllArgsConstructor
@Builder
public class CompanyDTO implements Serializable {

    @ApiModelProperty(value = "ID主键")
    @NotNull(message = "ID主键不能为空!", groups = {ValidGroup.Update.class})
    private Long id;

    @ApiModelProperty(value = "公司名称")
    @NotBlank(message = "公司名称不能为空!", groups = {ValidGroup.Insert.class, ValidGroup.Update.class})
    @Size(min = 1, max = 20, message = "公司名称长度为 1-20 个字符", groups = {ValidGroup.Insert.class, ValidGroup.Update.class})
    private String companyName;

    @ApiModelProperty(value = "公司编号")
    @NotBlank(message = "公司编号不能为空!", groups = {ValidGroup.Insert.class, ValidGroup.Update.class})
    @Size(min = 1, max = 12, message = "公司编号长度为 1-12 个字符", groups = {ValidGroup.Insert.class, ValidGroup.Update.class})
    private String companyNo;

    /**
     * 在这里,纳税人识别号可以是:空字符串 或者 15位格式 或者 18位格式 或者 20位格式.
     */
    @ApiModelProperty(value = "纳税人识别号")
    @Pattern(regexp = "^$|^([0-9a-zA-Z]{15}|[0-9a-zA-Z]{18}|[0-9a-zA-Z]{20})$", message = "纳税人识别号格式不正确,请重新处理!", groups = {ValidGroup.Insert.class, ValidGroup.Update.class})
    private String taxNumber;

    @ApiModelProperty(value = "电子邮箱")
    @Email(message = "邮箱格式不正确", groups = {ValidGroup.Insert.class, ValidGroup.Update.class})
    @Size(max = 50, message = "邮箱长度不能超过 50 个字符", groups = {ValidGroup.Insert.class, ValidGroup.Update.class})
    private String email;


    /**
     * 在这里,账户可以是:11位手机号格式 或者 邮箱格式
     */
    @ApiModelProperty(value = "账号")
    @NotBlank(message = "账号不能为空!", groups = {ValidGroup.Insert.class, ValidGroup.Update.class})
    @Pattern(regexp = "^(1[3-9]\\d{9}|[\\w-]+(\\.[\\w-]+)*@[\\w-]+(\\.[\\w-]+)+)$", message = "账号格式不正确,请重新处理;", groups = {ValidGroup.Insert.class, ValidGroup.Update.class})
    private String account;


    /**
     * 在这里,数据来源可以是:新建、更新、导入。 非常适用于 "枚举值" 类型的字段.
     */
    @ApiModelProperty(value = "数据来源")
    @NotBlank(message = "数据来源不能为空!", groups = {ValidGroup.Insert.class, ValidGroup.Update.class})
    @Pattern(regexp = "^(新建|更新|导入)$", message = "账号格式不正确,请重新处理;", groups = {ValidGroup.Insert.class, ValidGroup.Update.class, ValidGroup.Import.class})
    private String dataSource;



    // ---------------- 非数据库表字段 ----------------



    // ---------------- 构造函数 ----------------

    /***
     * 无参构造函数
     *
     * @return
     * @author moon  2023/7/25 15:01
     */
    public CompanyDTO() {

    }
}
相关推荐
kTR2hD1qb3 小时前
Claude Code Skill的介绍与使用
java·前端·数据库·人工智能
狼爷4 小时前
百万QPS多场次秒杀系统架构全解:解耦设计、防超卖、流量防护体系
后端·架构
汤米粥4 小时前
python学习——核心语法三
java·python·学习
basketball6164 小时前
Kadane算法 C++实现
java·c++·算法
一 乐4 小时前
汽车租赁|基于SprinBoot+vue的汽车租赁管理系统(源码+数据库+文档)
数据库·vue.js·spring boot·汽车·论文·毕设·汽车租赁管理系统
better_liang4 小时前
每日Java面试场景题知识点之-如何设计分布式锁
java·redis·zookeeper·面试·分布式锁
战族狼魂4 小时前
集 “自动飞行、智能识别、实时预警、勤务联动” 于一体的高速公路应急车道无人机检测系统方案
java·人工智能·大模型·无人机
一只鹿鹿鹿4 小时前
信息化项目管理规范(参考Word文件)
java·大数据·运维·开发语言·数据库
Java小白笔记4 小时前
Linux 手动部署 Oracle JDK 17 完全指南
java·linux·oracle
夕除4 小时前
实战--2
java·spring boot·spring