博客

Sprint Boot @Size使用方法详解

  • Post category:Java

在Spring Boot中，我们可以使用注解来实现参数校验。其中，@Size注解可以用于校验实体类中的字符串属性的长度是否符合要求。本文将介绍@Size注解的作用和方法以及两个示例说明。

1. @Size注解的作用

@Size注解用于校验实体类中的字符串属性的长度是否符合要求。如果长度不符合要求，则会抛出ConstraintViolationException异常。

2. @Size注解的使用方法

使用@Size注解需要遵循以下步骤：

  1. 在pom.xml文件中添加依赖
<dependency>
    <groupId>org.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>
  1. 在实体类属性上使用@Size注解进行校验。
public class MyEntity {
   @Size(min = 2, max = 10)
    private String name;

    // getter and setter
}

在上面的示例中，我们在实体类属性上使用了@Size注解，表示该属性的长度必须在2到10之间。如果长度不符合要求，则会抛ConstraintViolationException。

  1. 在Controller方法中使用@Validated注解进行校验。
@PostMapping("/user")
public User createUser(@Validated @RequestBody User user) {
    // ...
}

在上面的示例中，我们在Controller方法的参数上使用了@Validated注解，表示需要对该参数进行校验。参数不符合要求，则会抛ConstraintViolationException异常。

3. 示例1：使用@Size注解校验请求参数

假设我们有一个Controller，其中有一个方法用于接收一个请求参数。我们可以使用@Size注解来校验该参数的长度是否符合要求。

@RestController
@Validated
public class MyController {
    @PostMapping("/user")
    public User createUser(@Size(min = 2, max = 10) @RequestBody String name) {
        // ...
    }
}

在上面的示例中，我们在Controller方法的参数上使用了@Size注解，表示需要对该参数进行校验。如果参数的长度不在2到10之间，则会抛出ConstraintViolationException异常。

4. 示例2：使用@Size注解校验实体类属性

假设我们有一个实体类，其中有多个字符串属性需要校验长度是否符合要求。我们可以使用@Size注解来校验这些属性的长度是否符合要求。

public class User {
    @Size(min = 2, max = 10)
    private String name;

    // getter and setter
}

在上面的示例中，我们在实体类属性上使用了@Size注解，表示该属性的长度必须在2到10之间。如果长度不符合要求，则会抛出ConstraintViolationException异常。

5. 总结

@Size注解用于校验实体类中的字符串属性的长度是否符合要求。使用@Size注解需要在pom.xml文件中添加依赖，实体类属性上使用注解进行校验，在Controller方法的参数上使用@Validated注解进行校验。在实际开发中，可以根据需要使用@Size注解来校实体类属性的长度是否符合要求。

Tags: ,