springboot中@Validated注解

本文介绍了SpringBoot中使用@Validated和@ConfigurationProperties进行数据校验和YAML配置信息绑定。当使用@Email等注解时,需要引入validation启动器。通过示例展示了Person实体类的配置及yaml内容,当邮箱格式错误时,系统会抛出异常。同时列举了常见的数据校验注解,如@Null、@NotBlank等。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

一般@Validated注解用于数据校验

注意:使用@Email等注解爆红,原因是新版本需要引入validation启动器

<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

例如以下实体类Person

@Data
@AllArgsConstructor
@NoArgsConstructor
@Component
@ConfigurationProperties(prefix = "person") //yaml配置信息绑定javabean
@Validated //数据校验
public class Person {
    @Email("邮箱格式错误") //校验是否是邮箱格式
    private String email;
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birthday;
    private Map<String, Object> map;
    private List<Object> list;
    private Dog dog;
}

yaml配置内容如下

person:
  email: 123456789@gmail.com
  name: xiaozhuang${random.uuid}
  age: 26
  happy: false
  birthday: 2021/07/02
  map: {k1: v1,k2: v2}
  list:
    - code
    - music
    - girl
  dog:
    name: 旺财
    age: 3

创建测试类,输出Person类的内容

@SpringBootTest
class Springboot05ConfigApplicationTests {

    @Autowired
    private Person person;

    @Test
    void contextLoads() {
        System.out.println(person);
    }
}

输出内容正常
在这里插入图片描述
修改yaml配置文件中的email,改成一个错误格式,如下所示

person:
  email: 123456789 #@gmail.com
  name: xiaozhuang${random.uuid}
  age: 26
  happy: false
  birthday: 2021/07/02
  map: {k1: v1,k2: v2}
  list:
    - code
    - music
    - girl
  dog:
    name: 旺财
    age: 3

启动测试类,错误描述如下:
在这里插入图片描述
常用注解如下:

空检查
@Null       验证对象是否为null
@NotNull    验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank   检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
@NotEmpty   检查约束元素是否为NULL或者是EMPTY.
    
Booelan检查
@AssertTrue     验证 Boolean 对象是否为 true  
@AssertFalse    验证 Boolean 对象是否为 false  
    
长度检查
@Size(min=, max=) 验证对象(Array,Collection,Map,String)长度是否在给定的范围之内  
@Length(min=, max=) string is between min and max included.

日期检查
@Past       验证 Date 和 Calendar 对象是否在当前时间之前  
@Future     验证 Date 和 Calendar 对象是否在当前时间之后  
@Pattern    验证 String 对象是否符合正则表达式的规则

`@Validated`注解Spring框架提供的一种参数校验注解。它可以用来替代Java标准库中的`@Valid`注解,并且支持分组校验等功能。 `@Validated`注解可以用在类、方法、构造函数、方法参数以及方法返回值上。它的作用是启用方法参数校验。当方法被调用时,如果参数上标注了`@Validated`注解,则会对该参数进行校验。如果校验失败,则会抛出`MethodArgumentNotValidException`异常。 除了支持Java标准库中的参数校验注解之外,`@Validated`注解还支持分组校验功能。即可以根据不同的校验场景,对同一个类中的不同属性进行不同的校验。例如: ```java public interface Update { } public interface Create { } public class User { @NotNull(groups = Update.class) private Long id; @NotBlank(groups = {Create.class, Update.class}) private String name; @Min(value = 18, message = "年龄不能小于18岁", groups = {Create.class, Update.class}) private Integer age; // 省略getter和setter方法 } ``` 在上面的代码中,定义了两个分组`Create`和`Update`,并在`User`类中使用了分组校验注解。其中,`id`属性只在更新用户信息时进行校验,`name`和`age`属性在创建和更新用户信息时都需要进行校验。当进行校验时,需要指定对应的分组,例如: ```java @RestController @RequestMapping("/user") @Validated public class UserController { @PostMapping("/create") public ResponseEntity createUser(@RequestBody @Validated(Create.class) User user) { // ... } @PostMapping("/update") public ResponseEntity updateUser(@RequestBody @Validated(Update.class) User user) { // ... } } ``` 在上面的代码中,`@Validated(Create.class)`注解表示对`User`对象中标注了`Create`分组的属性进行校验,`@Validated(Update.class)`注解表示对`User`对象中标注了`Update`分组的属性进行校验。 综上所述,`@Validated`注解可以用来替代Java标准库中的`@Valid`注解,并且支持分组校验等功能。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值