转载

SpringBoot 入门：08 - 接口参数校验

我们此时可能已经写了好多个接口了，大家有没有对每个接口的请求参数进行必要的校验呢？

作为一个系统，外来的数据尽可能去严格的校验它的 合法性 ，比如数字类型参数是否是有效数字、是否在最小值与最大值之间等等。

完全可以自己在每一个接口里执行业务逻辑前对每一个请求参数进行校验，但你会发现挺繁琐的，而且重复性比较高。所以我们引入 Spring Boot 的 spring-boot-starter-validation 依赖帮助我们做这件事情。在 pom.xml 配置里面加入：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-validation</artifactId>
</dependency>
复制代码

参数校验的步骤很简单：

第一步在 Controller 层加上 @Validation 注解；

第二步在请求参数前加上 @Valid 注解或是直接具体的校验注解：

@RequestBody @Valid AdminLoginParam param
// 或者
@RequestParam(name = "username") @NotBlank String username
复制代码

有哪些注解呢？可以查看 javax.validation.constraints 包或者去 Oracle 官网的 JavaEE 7 Specification APIs 文档里查阅。

下面列举一些常用的校验注解：

PS：通常我们接口参数的类型无非就那么几种，字符串、数字、数组、文件，而其中文件类型的现在基本都是交由 OSS 对象存储服务去完成。

==@NotBlank==

校验参数是否为空，只支持继承了 CharSequence 接口的类型。其中 null 和全空白字符串都是不合法的，null 好理解，全空白字符串的意思就是只由一个或多个 whitespace 字符组成的字符串，比如空格、Tab键、换行符等（可以通过 Character.isWhitespace() 方法判断是否是空白字符）。

@RequestParam(name = "username", required = false)
@NotBlank
String username
复制代码

==@Min / @Max==

校验参数的大小范围，支持数字类型，比如 byte、short、int、long 和他们的包装类。注意 double 和 float 是不能用这个注解来校验的。

和这两个注解类似的还有 @Negative / @NegativeOrZero / @Positive / @PositiveOrZero，看名称也能知道用来校验什么了。

==@Size==

校验参数的长度范围，支持的参数类型可以是继承了 CharSequence 接口的类型（比如字符串）、继承了 Collection 接口的类型、继承了 Map 接口的类型、Array 数组类型。

比如接口有一个 username 参数，限定它的长度在 6-10 之间，可以这么写：

@RequestParam(name = "username", required = false)
@Size(min = 6, max = 10)
String username
复制代码

这里我们 需要注意 null 值 ，这个注解对 null 值认为是合法的，所以如果接口调用方不传这个参数，而我们又将该参数设为非必传（required = false），那么在使用过程中需要小心。

==@Pattern==

校验是否符合给定的正则表达式，场景也很广泛，比如我们要校验手机号、IP地址、密码等基于各自业务场景包含特定规则的参数，就很适合用这个注解来做，避免去自定义校验注解。

比如接口有一个 phone 参数，可以这么写（偷懒的手机号正则表达式哈）：

@RequestParam(name = "phone")
@Pattern(regexp = "^1[0-9]{10}$")
String phone
复制代码

对于所有校验失败的情况，Validation 都会抛出一个 ConstraintViolationException 异常。所有的 Validation 注解都可以添加 message 参数，用于自定义错误提示，所以在全局捕获异常的时候，就可以用这个 message 来自定义错误信息，异常处理会在后面一篇文章中提到。

原文 https://juejin.im/post/5f12a437f265da2306247df7

正文到此结束