spring-boot-starter-validation校验框架

介绍

Spring Boot Starter Validation是一个Spring Boot模块,用于简化应用程序中的验证功能。它包含以下依赖:

  • Hibernate Validator:Hibernate Validator是JavaBean Validation(JSR 380)规范的参考实现,提供了一组用于验证Java对象的约束和注解。
  • javax.validation API:javax.validation API是JavaBean Validation的API,定义了可用于验证的约束和注解集。
  • Spring Validation:Spring Validation是一个模块,用于将JavaBean Validation与Spring Framework集成,包括对方法参数和返回值的验证支持。

注解全解

使用Spring Boot Starter Validation,您可以轻松地将验证功能添加到应用程序中。以下是一些常见的验证注解:

  • @Null:被注释的元素必须为null。
  • @NotNull:被注释的元素必须不为null。
  • @AssertTrue:被注释的元素必须为true。
  • @AssertFalse:被注释的元素必须为false。
  • @Min(value):被注释的元素必须是一个数字,其值必须大于或等于指定的最小值。
  • @Max(value):被注释的元素必须是一个数字,其值必须小于或等于指定的最大值。
  • @Size(min, max):被注释的元素必须是一个字符串、集合、数组或映射,其大小必须在指定的最小和最大值之间。
  • @Pattern(regexp):被注释的元素必须是一个字符串,并且必须与指定的正则表达式匹配。
  • @Valid:被注释的元素必须是一个有效的对象,其所有约束都必须通过验证。

以下是一个使用Spring Boot Starter Validation的示例:

首先,在Spring Boot应用程序中添加以下依赖:

xml 复制代码
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

接下来,创建一个包含验证注解的JavaBean:

java 复制代码
public class Person {
    @NotNull
    @Size(min = 2, max = 50)
    private String name;

    @Min(18)
    @Max(100)
    private int age;

    // getters and setters
}

然后,在控制器中使用@Valid注解来验证JavaBean:

java 复制代码
@RestController
public class PersonController {
    @PostMapping("/persons")
    public ResponseEntity createPerson(@Valid @RequestBody Person person) {
        // Do something with the person object
        return ResponseEntity.ok().build();
    }
}

最后,当调用createPerson方法时,Spring Boot将自动验证Person对象,如果验证失败,将返回一个400错误响应。

@Valid和@Pattern(regexp)是Spring Boot Starter Validation中两个常见的验证注解,用于验证Java对象和字符串。

@Valid


@Valid是一个用于在控制器方法参数上启用验证的注解。当在控制器方法参数上使用@Valid注解时,Spring Boot将自动验证该参数的所有约束,如果验证失败,则返回一个400错误响应。

例如,在下面的示例中,Person对象包含@NotNull和@Size注解,用于验证name属性。在PersonController中,使用@Valid注解来验证Person对象:

java 复制代码
public class Person {
    @NotNull
    @Size(min = 2, max = 50)
    private String name;

    // getters and setters
}

@RestController
public class PersonController {
    @PostMapping("/persons")
    public ResponseEntity createPerson(@Valid @RequestBody Person person) {
        // Do something with the person object
        return ResponseEntity.ok().build();
    }
}

当调用createPerson方法时,Spring Boot将自动验证Person对象的name属性,如果name为null或长度不在2到50之间,则返回一个400错误响应。

@Pattern(regexp)


@Pattern(regexp)是一个用于验证字符串是否匹配指定正则表达式的注解。在使用@Pattern(regexp)注解时,需要提供一个regexp属性,用于指定正则表达式。

例如,在下面的示例中,使用@Pattern(regexp)注解来验证email属性是否符合电子邮件地址的格式:

java 复制代码
public class Person {
    @Pattern(regexp = "^[\\w!#$%&'*+/=?`{|}~^-]+(?:\\.[\\w!#$%&'*+/=?`{|}~^-]+)*@(?:[a-zA-Z0-9-]+\\.)+[a-zA-Z]{2,6}$")
    private String email;

    // getters and setters
}

当验证Person对象时,Spring Boot将自动验证email属性是否符合指定的正则表达式。如果不符合,则返回一个400错误响应。

需要注意的是,在使用@Pattern(regexp)注解时,正则表达式可能会很复杂,因此需要仔细测试和验证。同时,也需要注意正则表达式的性能问题,避免使用过于复杂的正则表达式导致验证性能下降。

总之,@Valid和@Pattern(regexp)是Spring Boot Starter Validation中两个常见的验证注解,用于验证Java对象和字符串。它们可以帮助我们简化应用程序中的验证功能,提高代码的可读性和可维护性。

相关推荐
泰山小张只吃荷园6 分钟前
期末Python复习-输入输出
java·前端·spring boot·python·spring cloud·docker·容器
Mr_Xuhhh8 分钟前
程序地址空间
android·java·开发语言·数据库
YSRM14 分钟前
异或-java-leetcode
java·算法·leetcode
大明湖的狗凯.17 分钟前
MySQL 中的乐观锁与悲观锁
java·数据库·mysql
真上帝的左手17 分钟前
数据库-MySQL-MybatisPlus整合多数据源
数据库·mysql·mybatis
奈斯ing17 分钟前
【MySQL篇】持久化和非持久化统计信息的深度剖析(第一篇,总共六篇)
数据库·mysql
真上帝的左手18 分钟前
数据库-MySQL-Mybatis源码解析-设计模式角度
数据库·mysql·mybatis
z2023050822 分钟前
linux之调度管理(13)- wake affine 唤醒特性
java·开发语言
AI人H哥会Java23 分钟前
【JAVA】Java高级:Java网络编程——TCP/IP与UDP协议基础
java·开发语言
小白要加油哈36 分钟前
Lua--1.基础知识
开发语言·junit·lua