文章目录
Spring boot 参数校验
上一节 Spring boot crud 和 swagger使用
源码
springboot web模板已经自动集成了 hibernate-validator; 所以我们引入 spring-boot-starter-web 即可使用;
简介
java 参数校验;是遵循JSR-303 规范,对这种规范实现支持最好的就是 Hibernate Validator; spring 底层也是使用的hibernate validator。简化了 我们在硬编码对参数和bean的校验。
基本数据类型参数校验(包括string,以及基本数据类型的包装类)
请求只接受一个基本类型参数的时候(包括string)不是一个bean;
我们需要在类上加@Validated 然后在方法参数上加上对应的校验注解
我们以String 类型参数为例
使用@Length对string 长度的校验
// 类上加注解 @Validated
@Validated
public class ProductController {
// 参数中使用校JSR303 bean校验注解
@GetMapping("product")
public Product getProduct(@Length(max = 32, min = 32) @RequestParam String id) throws Exception {
...
}
}
通过swagger 调用; 上面我们限制了 id的长度为32, 我们输入一个错误的长度
我们输入长度为1 的id; 校验生效 提示 长度需要在32到32之间;这是框架自动给我们返回的
当然我们也可以指定message来设置消息;例如:
@Length(max = 32, min = 32, message = “id长度必须为32位”),其他的基本类型使用基本一样;
例如 int , long 值可以使用 @Max @Min 等注解修饰;具体参考常用注解, 不同类型使用不同的校验方式。
实体参数校验
对参数bean进行校验。我们在实体类上使用注解
例如 :
- @NotBlank 不能为null以及空白字符
- @Max 最大值
- @Min 最小值
public class Product {
@ApiModelProperty(required = true, value = "商品名称")
@NotBlank
@Length(min = 1, max = 500)
private String name;
@ApiModelProperty(required = true, value = "商品id")
@NotBlank
@Length(max = 32, min = 32)
private String id;
@ApiModelProperty(required = true, value = "商品价格,以分为单位", dataType = "java.lang.Long", example = "1000")
@Max(Integer.MAX_VALUE)
@Min(0)
private Long price;
上面对实体类Product 进行了name的长度和不能为空白的校验以及id长度限制,price最大值最小值
请求方法添加@Validated 开启校验
@ApiOperation(value = "添加商品信息", httpMethod = "