关于spring-mvc:从零搭建-Spring-MVC-项目-Validation

疾速开始

1. 引入 Validation 依赖

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

2. 编写校验代码

@Data 为 lombok 的注解，在此不做具体阐明。

@Data
public class UserRequest {

    @NotBlank
    private String name;

    @Min(0)
    @Max(200)
    private Integer age;

}

3. 申明校验参数

@RestController
public class UserController {@PostMapping("/api/users")
    public UserRequest createUser(@RequestBody @Validated UserRequest userRequest) {return userRequest;}

}

4. 捕获全局异样

这一步不是必须的，目标是为了能不便查看校验后果。

@ControllerAdvice
public class GlobalExceptionHandler {@ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<Map<String, Object>> handleMethodArgumentNotValidException(MethodArgumentNotValidException exception) {List<String> errorMessages = exception.getFieldErrors()
                .stream()
                .map(fieldError -> String.format("%s %s", fieldError.getField(), 
                        fieldError.getDefaultMessage()))
                .sorted()
                .collect(Collectors.toList());

        Map<String, Object> errorMessageMap = CollectionUtils.newLinkedHashMap(2);
        errorMessageMap.put("code", HttpStatus.BAD_REQUEST.value());
        errorMessageMap.put("message", errorMessages);

        return ResponseEntity.badRequest().body(errorMessageMap);
    }

}

5. 查看校验成果

应用 curl 拜访接口：

curl --location --request POST 'http://localhost:8080/api/users' \
--header 'Content-Type: application/json' \
--data-raw '{"name":"",
    "age": -1
}'

最终的校验后果如下：

{
    "code": 400,
    "message": [
        "age 最小不能小于 0",
        "name 不能为空"
    ]
}

罕用注解

@NotNull、@NotEmpty 与 @NotBlank

示例代码：

@Data
public class NotAnnotationRequest {

    @NotNull
    private Object notNullObject;

    @NotEmpty
    private String notEmptyString;

    @NotEmpty
    private Collection<Integer> notEmptyCollection;

    @NotEmpty
    private Map<String, String> notEmptyMap;

    @NotEmpty
    private int[] notEmptyArray;

    @NotBlank
    private String notBlankString;

}

@Size 与 @Min、@Max

示例代码：

@Data
public class RangeAnnotationRequest {@Size(min = 1, max = 5)
    private String limitedString;

    @Size(min = 1, max = 5)
    private Collection<Integer> limitedCollection;

    @Size(min = 1, max = 5)
    private Map<String, String> limitedMap;

    @Size(min = 1, max = 5)
    private int[] limitedArray;

    @Min(1)
    @Max(2)
    private Integer limitedNumber;

}

@Pattern

示例代码：

@Data
public class PatternAnnotationRequest {@Pattern(regexp = "^1[3456789]\\d{9}$", message = "手机号码格局不正确")
    private String mobile;

}

@Valid 与 @Validated

@Valid 和 @Validated 都能够用来申明校验参数，但它们并不齐全一样，它们的区别次要蕴含以下几个方面：

• @Valid 是定义在 javax 包下的规范注解，@Validated 是 Spring 官网定义的注解。
• @Valid 能够作用于办法、字段、构造函数、参数和运行时应用的类型，@Validated 可作用于类型、办法和参数。
• @Valid 能够用来定义嵌套校验，@Validated 无奈独自实现嵌套校验的定义。
• @Validated 反对分组校验，@Valid 不反对分组校验。

应用 @Valid 申明校验参数

@RestController
public class UserController {@PostMapping("/api/users")
    public UserRequest createUser(@RequestBody @Valid UserRequest userRequest) {return userRequest;}

}

嵌套校验

编写校验代码：

@Data
public class CompanyRequest {

    @NotBlank
    private String name;

    @Valid
    @NotNull
    private AddressRequest address;

}

@Data
public class AddressRequest {

    @NotBlank
    private String country;

    @NotBlank
    private String province;

    @NotBlank
    private String city;

}

申明校验参数：

@RestController
public class NestValidController {@PostMapping("/api/companies")
    public CompanyRequest createCompany(@RequestBody @Validated CompanyRequest companyRequest) {return companyRequest;}

}

分组校验

定义分组：

public interface CreateGroup extends Default {}

public interface UpdateGroup extends Default {}

编写校验代码：

@Data
public class OrganizationRequest {@NotBlank(groups = CreateGroup.class)
    @Null(groups = UpdateGroup.class)
    private String orgCode;

    @NotBlank
    private String orgName;

}

申明校验参数：

@RestController
public class GroupValidController {@PostMapping("/api/organizations")
    public OrganizationRequest createOrganization(@RequestBody @Validated(CreateGroup.class) OrganizationRequest organizationRequest) {return organizationRequest;}

    @PutMapping("/api/organizations")
    public OrganizationRequest updateOrganization(@RequestBody @Validated(UpdateGroup.class) OrganizationRequest organizationRequest) {return organizationRequest;}

}

其余注解

@Null

示例代码：

@Data
public class NullAnnotationRequest {

    @Null
    private Object nullObject;

}

@Email

示例代码：

@Data
public class EmailAnnotationRequest {

    @Email
    private String email;

}

布尔类型注解

示例代码：

@Data
public class BooleanAnnotationRequest {

    @AssertTrue
    private Boolean trueParam;

    @AssertFalse
    private boolean falseParam;

}

数字类型注解

示例代码：

@Data
public class NumberAnnotationRequest {@DecimalMin("1.5")
    @DecimalMax("2.5")
    private BigDecimal limitedBigDecimal;

    @Digits(integer = 1, fraction = 2)
    private BigDecimal digits;

    @Negative
    private short negative;

    @NegativeOrZero
    private int negativeOrZero;

    @Positive
    private long positive;

    @PositiveOrZero
    private BigDecimal positiveOrZero;

}

工夫类型注解

示例代码：

@Data
public class TimeAnnotationRequest {

    @Past
    private Date past;

    @PastOrPresent
    private Date pastOrPresent;

    @Future
    private Date future;

    @FutureOrPresent
    private Date futureOrPresent;

}

获取源码