问题描述
Controller层query方法QueryRequest对象参数校验失效 。
Controller代码如下:
public interface IQueryResource {
/**
*
* @param 请求数据
* @return 返回查询结果
*/
@GetMapping
DeferredResult<HttpEntity<ResponseObject<QueryResponse>>> query(QueryRequest request);
}
QueryReques对象如下:
@Data
public class QueryRequest {
private String userId;
@NotEmpty(message = "地区不能为空")
private Long area;
}
原因分析:
1、Controller层query方法参数前没加注解@Validated或者@Valid,所以对象内部@NotEmpty不起作用;
2、其次@NotEmpty适用于 String、Collection集合、Map、数组等,加了@NotEmpty 的参数不能为 Null 或者长度为 0;
@NotBlank适用于 String 类型的数据上,加了@NotBlank 注解的参数不能为 Null 且 trim() 之后 size > 0;
@NotNull适用于基本数据类型(Integer,Long,Double等等),当 @NotNull 注解被使用在 String 类型的数据上,则表示该数据不能为 Null(但是可以为 Empty);因此这里应该使用@NotNull更好;
解决方案:
1、Controller层query方法参数前没加注解@Validated;
2、@NotEmpty注解改为@NotNull。
修改后代码如下:
Controller代码如下:
public interface IQueryResource {
/**
*
* @param 请求数据
* @return 返回查询结果
*/
@GetMapping
DeferredResult<HttpEntity<ResponseObject<QueryResponse>>> query(@Validated QueryRequest request);
}
QueryReques对象如下:
@Data
public class QueryRequest {
private String userId;
@NotNull(message = "地区不能为空")
private Long area;
}
扩展@Valid与@Validated的使用与区别
相同点:
@Valid、@Validated 注解可以实现数据的验证,你可以定义实体,在实体的属性上添加校验规则
校验规则如上@NotEmpty,@NotBlank,@NotNull等等的注解就是,不加上就不会生效!
不同点:
1、分组上:
@Valid 不支持分组, @Validated则支持分组验证。
2、使用位置:
@Valid:可以用在方法、构造函数、方法参数和成员属性(字段)上
@Validated:可以用在类型、方法和方法参数上。但是不能用在成员属性(字段)上
3、包位置
@Valid 包位置:javax.validation;
@Validated 包位置 org.springframework.validation.annotation是@Valid 的一次封装,是Spring提供的校验机制使用。
4、非Controller使用(极少)
@Validated可以用到非Controller层,被Spring容器管理的类上。
一定一定不要忘记在类上加上 @Validated 注解了,这个参数可以告诉 Spring 去校验方法参数。