Spring Web 参数验证常见错误

1.对象参数校验失效

import lombok.Data;
import javax.validation.constraints.Size;
@Data
public class Student {
    @Size(max = 10)
    private String name;
    private short age;
}

@RestController
@Slf4j
@Validated
public class StudentController {
    @RequestMapping(path = "students", method = RequestMethod.POST)
    public void addStudent(@RequestBody Student student){
        log.info("add new student: {}", student.toString());
        //省略业务代码
    };
}

以上校验不会被校验
源码：AbstractMessageConverterMethodArgumentResolver#validateIfApplicable
必须匹配的两个条件

• 标记了 org.springframework.validation.annotation.Validated 注解
• 标记了其他类型的注解，且注解名称以 Valid 关键字开头

对于 RequestBody 接受的对象参数而言，要启动 Validation，必须将对象参数标记上 @Validated 或者其他以 @Valid 关键字开头的注解

// 修正代码
public void addStudent(@Validated @RequestBody Student student)

public void addStudent(@Valid @RequestBody Student student)

2.嵌套校验失效

public class Student {
    @Size(max = 10)
    private String name;
    private short age;   
    private Phone phone;
}
@Data
class Phone {
    @Size(max = 10)
    private String number;
}


POST http://localhost:8080/students
Content-Type: application/json
{
  "name": "xiaoming",
  "age": 10,
  "phone": {"number":"12306123061230612306"}
}

以上代码约束不生效

修正：

@Validprivate Phone phone;

3.误解校验执行

@Size(min = 1, max = 10)
private String name;

// 此json可以通过上面的校验
{
  "age": 10,
  "phone": {"number":"12306"}
}

// 修正
@NotEmpty
@Size(min = 1, max = 10)
private String name;