Validated 注解完成 Spring Boot 参数校验

1.  @Valid 和 @Validated

　　@Valid 注解，是 Bean Validation 所定义，可以添加在普通方法、构造方法、方法参数、方法返回、成员变量上，表示它们需要进行约束校验。

　　@Validated 注解，是 Spring Validation 所定义，可以添加在类、方法参数、普通方法上，表示它们需要进行约束校验。并且，@Validated 具有 value 属性，支持分组校验。

• 声明式校验

　　　　@Validated

• 分组检验

　　　　@Validated

• 嵌套校验

　　　　@Valid

2.  常用注解

3. 快速入门

• 创建Maven项目

• 修改pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.c3stones</groupId>
    <artifactId>spring-boot-validated-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring-boot-validated-demo</name>
    <description>Spring Boot Validated Demo</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.4.RELEASE</version>
    </parent>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
           <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

</project>

• 创建启动类

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

•  创建DTO

import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.Pattern;

import org.hibernate.validator.constraints.Length;

import lombok.Data;

/**
 * 用户保存DTO
 *
 */
@Data
public class UserSaveDto {

    /**
     * 用户名称
     */
    @NotEmpty(message = "用户名称不能为空")
    @Length(min = 6, max = 12, message = "账号长度为 6-12 位")
    @Pattern(regexp = "^[A-Za-z0-9]+$", message = "用户名称格式为数字或字母")
    private String username;

    /**
     * 密码
     */
    @NotEmpty(message = "密码不能为空")
    @Length(min = 6, max = 18, message = "密码长度为 6-18 位")
    private String password;
}

•  创建Controller

import javax.validation.Valid;
import javax.validation.constraints.Min;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import com.c3stones.dto.UserSaveDto;

@RestController
@RequestMapping("/user")
@Validated
public class UserController {

    private Logger logger = LoggerFactory.getLogger(getClass());

    @GetMapping("/get")
    public String get(@RequestParam("id") @Min(value = 1L, message = "id必须大于0") Integer id) {
        logger.info("获取用户信息，id：" + id);
        return "get success";
    }

    @PostMapping("/save")
    public String save(@Valid UserSaveDto saveDto) {
        logger.info("保存用户信息：", saveDto.toString());
        return "save success";
    }

}

• 启动项目
• 测试get方法

curl -X GET "http://localhost:8080/user/get?id=0"
#返回：
{
    "timestamp": "2020-05-20T03:27:23.667+0000",
    "status": 500,
    "error": "Internal Server Error",
    "message": "get.id: id必须大于0",
    "path": "/user/get"
}

curl -X GET "http://localhost:8080/user/get?id=1"
#返回：
get success

• 测试save方法

curl -X POST "http://localhost:8080/user/save?username=test&password=123"
#返回：
{
    "timestamp": "2020-05-20T03:29:46.684+0000",
    "status": 400,
    "error": "Bad Request",
    "errors": [
        {
            "codes": [
                "Length.userSaveDto.username",
                "Length.username",
                "Length.java.lang.String",
                "Length"
            ],
            "arguments": [
                {
                    "codes": [
                        "userSaveDto.username",
                        "username"
                    ],
                    "arguments": null,
                    "defaultMessage": "username",
                    "code": "username"
                },
                12,
                6
            ],
            "defaultMessage": "账号长度为 6-12 位",
            "objectName": "userSaveDto",
            "field": "username",
            "rejectedValue": "test",
            "bindingFailure": false,
            "code": "Length"
        },
        {
            "codes": [
                "Length.userSaveDto.password",
                "Length.password",
                "Length.java.lang.String",
                "Length"
            ],
            "arguments": [
                {
                    "codes": [
                        "userSaveDto.password",
                        "password"
                    ],
                    "arguments": null,
                    "defaultMessage": "password",
                    "code": "password"
                },
                18,
                6
            ],
            "defaultMessage": "密码长度为 6-18 位",
            "objectName": "userSaveDto",
            "field": "password",
            "rejectedValue": "123",
            "bindingFailure": false,
            "code": "Length"
        }
    ],
    "message": "Validation failed for object='userSaveDto'. Error count: 2",
    "path": "/user/save"
}

curl -X POST "http://localhost:8080/user/save?username=test001&password=123456"
#返回：
save success

4. 分组校验

• 编写实体类

import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * 用户
 * 
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {

    /**
     * 用户保存分组
     * 
     */
    public interface UserSaveGroup {
    }

    /**
     * 用户更新分组
     * 
     */
    public interface UserUpdateGroup {
    }

    /**
     * ID
     */
    @NotNull(message = "ID不能为空", groups = { UserUpdateGroup.class })
    private Integer id;

    /**
     * 用户名称
     */
    @NotEmpty(message = "用户名称不能为空", groups = { UserSaveGroup.class, UserUpdateGroup.class })
    private String username;

    /**
     * 密码
     */
    @NotEmpty(message = "密码不能为空", groups = { UserSaveGroup.class, UserUpdateGroup.class })
    private String password;
}

• Controller添加方法

@PostMapping("/saveUser")
public String saveUser(@Validated({ UserSaveGroup.class }) User user) {
    logger.info("保存用户信息：", user.toString());
    return "saveUser success";
}

@PutMapping("/updateUser")
public String updateUser(@Validated({ UserUpdateGroup.class }) User user) {
    logger.info("更新用户信息：", user.toString());
    return "updateUser success";
}

•  测试UserSaveGroup分组

curl -X POST "http://localhost:8080/user/saveUser"
#返回：
{
    "timestamp": "2020-05-20T03:45:15.357+0000",
    "status": 400,
    "error": "Bad Request",
    "errors": [
        {
            "codes": [
                "NotEmpty.user.password",
                "NotEmpty.password",
                "NotEmpty.java.lang.String",
                "NotEmpty"
            ],
            "arguments": [
                {
                    "codes": [
                        "user.password",
                        "password"
                    ],
                    "arguments": null,
                    "defaultMessage": "password",
                    "code": "password"
                }
            ],
            "defaultMessage": "密码不能为空",
            "objectName": "user",
            "field": "password",
            "rejectedValue": null,
            "bindingFailure": false,
            "code": "NotEmpty"
        },
        {
            "codes": [
                "NotEmpty.user.username",
                "NotEmpty.username",
                "NotEmpty.java.lang.String",
                "NotEmpty"
            ],
            "arguments": [
                {
                    "codes": [
                        "user.username",
                        "username"
                    ],
                    "arguments": null,
                    "defaultMessage": "username",
                    "code": "username"
                }
            ],
            "defaultMessage": "用户名称不能为空",
            "objectName": "user",
            "field": "username",
            "rejectedValue": null,
            "bindingFailure": false,
            "code": "NotEmpty"
        }
    ],
    "message": "Validation failed for object='user'. Error count: 2",
    "path": "/user/saveUser"
}

curl -X POST "http://localhost:8080/user/saveUser?username=zhangsan&password=123456"
#返回：
saveUser success

•  测试UserUpdateGroup分组

curl -X PUT "http://localhost:8080/user/updateUser"
#返回：
{
    "timestamp": "2020-05-20T03:52:01.350+0000",
    "status": 400,
    "error": "Bad Request",
    "errors": [
        {
            "codes": [
                "NotEmpty.user.username",
                "NotEmpty.username",
                "NotEmpty.java.lang.String",
                "NotEmpty"
            ],
            "arguments": [
                {
                    "codes": [
                        "user.username",
                        "username"
                    ],
                    "arguments": null,
                    "defaultMessage": "username",
                    "code": "username"
                }
            ],
            "defaultMessage": "用户名称不能为空",
            "objectName": "user",
            "field": "username",
            "rejectedValue": null,
            "bindingFailure": false,
            "code": "NotEmpty"
        },
        {
            "codes": [
                "NotNull.user.id",
                "NotNull.id",
                "NotNull.java.lang.Integer",
                "NotNull"
            ],
            "arguments": [
                {
                    "codes": [
                        "user.id",
                        "id"
                    ],
                    "arguments": null,
                    "defaultMessage": "id",
                    "code": "id"
                }
            ],
            "defaultMessage": "ID不能为空",
            "objectName": "user",
            "field": "id",
            "rejectedValue": null,
            "bindingFailure": false,
            "code": "NotNull"
        },
        {
            "codes": [
                "NotEmpty.user.password",
                "NotEmpty.password",
                "NotEmpty.java.lang.String",
                "NotEmpty"
            ],
            "arguments": [
                {
                    "codes": [
                        "user.password",
                        "password"
                    ],
                    "arguments": null,
                    "defaultMessage": "password",
                    "code": "password"
                }
            ],
            "defaultMessage": "密码不能为空",
            "objectName": "user",
            "field": "password",
            "rejectedValue": null,
            "bindingFailure": false,
            "code": "NotEmpty"
        }
    ],
    "message": "Validation failed for object='user'. Error count: 3",
    "path": "/user/updateUser"
}

curl -X PUT "http://localhost:8080/user/updateUser?id=1001&username=zhangsan&password=123123"
#返回：
updateUser success

5. 国际化配置

• 配置文件中添加

spring:
# i18 message 配置，对应 MessageSourceProperties 配置类
   messages:
      basename: i18n/messages # 文件路径基础名
      encoding: UTF-8 # 使用 UTF-8 编码

• 在项目resource目录下创建i18n文件夹
• 在i18n中添加国际化配置文件

messages.properties

Goods.id.NotNull=商品ID不能为空

messages_en.properties

Goods.id.NotNull=Goods id cannot be empty

messages_ja.properties

Goods.id.NotNull=商品IDは空にできません

• 创建实体

import javax.validation.constraints.NotNull;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * 商品
 * 
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Goods {

    /**
     * 商品ID
     */
    @NotNull(message = "{Goods.id.NotNull}")
    private Integer id;

    /**
     * 商品名称
     */
    private String name;
}

• 创建Controller

import javax.validation.Valid;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.c3stones.entity.Goods;

@RestController
@RequestMapping("/goods")
@Validated
public class GoodsController {

    private Logger logger = LoggerFactory.getLogger(getClass());

    @PostMapping("/save")
    public String save(@Valid Goods goods) {
        logger.info("保存商品信息：", goods.toString());
        return "save success";
    }

}

• 测试（通过头部指定 Accept-Language 参数）

#测试默认中文
curl -X POST "http://localhost:8080/goods/save"
#返回：
{
    "timestamp": "2020-05-20T04:15:59.417+0000",
    "status": 400,
    "error": "Bad Request",
    "errors": [
        {
            "codes": [
                "NotNull.goods.id",
                "NotNull.id",
                "NotNull.java.lang.Integer",
                "NotNull"
            ],
            "arguments": [
                {
                    "codes": [
                        "goods.id",
                        "id"
                    ],
                    "arguments": null,
                    "defaultMessage": "id",
                    "code": "id"
                }
            ],
            "defaultMessage": "商品ID不能为空",
            "objectName": "goods",
            "field": "id",
            "rejectedValue": null,
            "bindingFailure": false,
            "code": "NotNull"
        }
    ],
    "message": "Validation failed for object='goods'. Error count: 1",
    "path": "/goods/save"
}

#测试英文
curl -X POST -H "Accept-Language:en" "http://localhost:8080/goods/save"
#返回：
{
    "timestamp": "2020-05-20T04:16:15.078+0000",
    "status": 400,
    "error": "Bad Request",
    "errors": [
        {
            "codes": [
                "NotNull.goods.id",
                "NotNull.id",
                "NotNull.java.lang.Integer",
                "NotNull"
            ],
            "arguments": [
                {
                    "codes": [
                        "goods.id",
                        "id"
                    ],
                    "arguments": null,
                    "defaultMessage": "id",
                    "code": "id"
                }
            ],
            "defaultMessage": "Goods id cannot be empty",
            "objectName": "goods",
            "field": "id",
            "rejectedValue": null,
            "bindingFailure": false,
            "code": "NotNull"
        }
    ],
    "message": "Validation failed for object='goods'. Error count: 1",
    "path": "/goods/save"
}

#测试日文
curl -X POST -H "Accept-Language:ja" "http://localhost:8080/goods/save"
#返回：
{
    "timestamp": "2020-05-20T04:16:35.011+0000",
    "status": 400,
    "error": "Bad Request",
    "errors": [
        {
            "codes": [
                "NotNull.goods.id",
                "NotNull.id",
                "NotNull.java.lang.Integer",
                "NotNull"
            ],
            "arguments": [
                {
                    "codes": [
                        "goods.id",
                        "id"
                    ],
                    "arguments": null,
                    "defaultMessage": "id",
                    "code": "id"
                }
            ],
            "defaultMessage": "商品IDは空にできません",
            "objectName": "goods",
            "field": "id",
            "rejectedValue": null,
            "bindingFailure": false,
            "code": "NotNull"
        }
    ],
    "message": "Validation failed for object='goods'. Error count: 1",
    "path": "/goods/save"
}

6. 项目地址

　　https://github.com/C3Stones/blog