SpringBoot中优雅处理参数验证，到底发生了什么？

2020-02-20 19:14:31 Java高級架構師

一、为什么使用 @Valid 来验证参数

在平常通过 Spring 框架写代码时候，会经常写接口类，相信大家对该类的写法非常熟悉。在写接口时经常要写效验请求参数逻辑，这时候我们会常用做法是写大量的 if 与 ifelse 类似这样的代码来做判断，如下：

这样的代码如果按正常代码逻辑来说，是没有什么问题的，不过按优雅来说，简直糟糕透了。不仅不优雅，而且如果存在大量的验证逻辑，这会使代码看起来乱糟糟，大大降低代码可读性，那么有没有更好的方法能够简化这个过程呢？答案当然是有，推荐的是使用 @Valid注解来帮助我们简化验证逻辑。

二、@Valid 注解的作用

注解 @Valid 的主要作用是用于数据效验，可以在定义的实体中的属性上，添加不同的注解来完成不同的校验规则，而在接口类中的接收数据参数中添加 @valid 注解，这时你的实体将会开启一个校验的功能。

三、@Valid 的相关注解

下面是 @Valid 相关的注解，在实体类中不同的属性上添加不同的注解，就能实现不同数据的效验功能。

四、使用 @Valid 进行参数效验步骤

整个过程如下图所示，用户访问接口，然后进行参数效验，因为 @Valid 不支持平面的参数效验（直接写在参数中字段的效验）所以基于 GET 请求的参数还是按照原先方式进行效验，而 POST 则可以以实体对象为参数，可以使用 @Valid 方式进行效验。如果效验通过，则进入业务逻辑，否则抛出异常，交由全局异常处理器进行处理。

1、实体类中添加 @Valid 相关注解

使用 @Valid 相关注解非常简单，只需要在参数的实体类中属性上面添加如 @NotBlank、 @Max、 @Min 等注解来对该字段进限制，如下：

User：

如果是嵌套的实体对象，则需要在最外层属性上添加 @Valid 注解：

User：

UserInfo：

2、接口类中添加 @Valid 注解

在 Controller 类中添加接口， POST 方法中接收设置了 @Valid 相关注解的实体对象，然后在参数中添加 @Valid 注解来开启效验功能，需要注意的是， @Valid 对 Get 请求中接收的平面参数请求无效，稍微略显遗憾。

3、全局异常处理类中处理 @Valid 抛出的异常

最后，我们写一个全局异常处理类，然后对接口中抛出的异常进行处理，而 @Valid 配合 Spring 会抛出 MethodArgumentNotValidException 异常，这里我们需要对该异常进行处理即可。

五、SpringBoot 中使用 @Valid 示例

1、Maven 引入相关依赖

Maven 引入 SpringBoot 相关依赖，这里引入了 Lombok 包来简化开发过程。

<code>/<code>

<code><project>/<code>

<code>xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">/<code>

<code><modelversion>4.0.0/<modelversion>/<code>

<code><parent>/<code>

<code><groupid>org.springframework.boot/<groupid>/<code>

<code><artifactid>spring-boot-starter-parent/<artifactid>/<code>

<code><version>2.2.1.RELEASE/<version>/<code>

<code>

<code><groupid>com.aspire/<groupid>/<code>

<code><artifactid>springboot-valid-demo/<artifactid>/<code>

<code><version>0.0.1-SNAPSHOT/<version>/<code>

<code><name>springboot-valid-demo/<name>/<code>

<code><description>@valid demo/<description>/<code>

<code><properties>/<code>

<code><java.version>1.8/<java.version>/<code>

<code>

<code><dependencies>/<code>

<code><dependency>/<code>

<code><groupid>org.springframework.boot/<groupid>/<code>

<code><artifactid>spring-boot-starter-web/<artifactid>/<code>

<code>

<code><dependency>/<code>

<code><groupid>org.projectlombok/<groupid>/<code>

<code><artifactid>lombok/<artifactid>/<code>

<code><optional>true/<optional>/<code>

<code>

<code>

<code><build>/<code>

<code><plugins>/<code>

<code><plugin>/<code>

<code><groupid>org.springframework.boot/<groupid>/<code>

<code><artifactid>spring-boot-maven-plugin/<artifactid>/<code>

<code>

<code>

<code>

<code>

2、自定义个异常类

自定义个异常类，方便我们处理 GET 请求（GET 请求参数中一般是没有实体对象的，所以不能使用 @Valid），当请求验证失败时，手动抛出自定义异常，交由全局异常处理。

3、自定义响应枚举类

定义一个返回信息的枚举类，方便我们快速响应信息，不必每次都写返回消息和响应码。

4、自定义响应对象类

创建用于返回调用方的响应信息的实体类。

5、自定义实体类中添加 @Valid 相关注解

下面将创建用于 POST 方法接收参数的实体对象，里面添加 @Valid 相关验证注解，并在注解中添加出错时的响应消息。

User

UserInfo

6、Controller 中添加 @Valid 注解

接口类中添加 GET 和 POST 方法的两个接口用于测试，其中 POST 方法以上面创建的 Uer 实体对象接收参数，并使用 @Valid，而 GET 请求一般接收参数较少，所以使用正常判断逻辑进行参数效验。

<code>import club . myd1q. valid. entity .ResponseResult;/<code>

<code>import club . myd1q.valid.entity.User;/<code>

<code>import club . myd1q. valid. enums . ResultEnum;/<code>

<code>import club . myd1q. valid. exception. ParamaErrorException;/<code>

<code>import org. springframework . validation . annotation .Validated;/<code>

<code>import org. springframework . web. bind . annotation.* ;/<code>

<code>import javax . validation.Valid;/<code>

<code>@RestController/<code>

<code>public class TestController {/<code>

<code>/**/<code>

<code>获取用户信息/<code>

<code>@param username/<code>

<code>姓名/<code>

<code>@return ResponseResult/<code>

<code>/**/<code>

<code>@Validated/<code>

<code>@GetMapping(" /user/{username }")/<code>

<code>public ResponseResult findUserInfo (@PathVariable String username) {/<code>

<code>if (username == null | |/<code>

<code>””. equals(username)) {/<code>

<code>throw new Par amaErrorException("username不能为空”);/<code>

<code>}/<code>

<code>return new ResponseResult (ResultEnum . SUCCESS);/<code>

<code>}/<code>

<code>/**/<code>

<code>新增用户/<code>

<code>@param user/<code>

<code>用户信息/<code>

<code>@return ResponseResult /<code>

<code>**//<code>

<code>@PostMapping(" /user")/<code>

<code>public ResponseResult addUserInfo(@Valid @RequestBody User user) {/<code>

<code>return new ResponseResult (ResultEnum. SUCCESS);/<code>

<code>}/<code>

<code>}/<code>

7、全局异常处理

这里创建一个全局异常处理类，方便统一处理异常错误信息。里面添加了不同异常处理的方法，专门用于处理接口中抛出的异常信。

8、启动类

9、示例测试

下面将针对上面示例中设置的两种接口进行测试，分别来验证参数效验功能。

|| - 测试接口 /user/{username}

使用 GET 方法请求地址 http://localhost:8080/user?username=test 时，返回信息：

|| - 测试接口 /user

(1)、使用 POST 方法发起请求，首先进行不加 JSON 请求体来对 http://localhost:8080/user 地址进行请求，返回信息：

<code>{    "code": 1001,    "msg": "参数体不能为空"}/<code>

(2)、输入部分参数进行测试。

请求内容：

<code>{ "username":"test",  "password":"123"}/<code>

返回信息：

<code>{    "code": 1001,     "msg": "userinfo不能为空"}/<code>

(3)、输入完整参数，且设置 age > 18 时，进行测试。

<code>{ "username":"111",   "password":"sa",     "userInfo":{    "age":19,        "gender":"男"                 }}/<code>

返回信息：

<code>{    "code": 1001,     "msg": "不能超过18岁"}/<code>

可以看到在执行 POST 请求，也能正常按我们全局异常处理器中的设置处理异常信息，且提示信息为我们设置在实体类中的 Message。

分享到:

閱讀更多 Java高級架構師 的文章

關鍵字: 优雅验证添加