Spring 校验 @RequestParams 和 @PathVariables 参数

qianmoQ

我们在写Rest API接口时候会用到很多的@RequestParam和@PathVariable进行参数的传递，但是在校验的时候，不像使用@RequestBody那样的直接写在实体类中，我们这篇文章讲解一下如何去校验这些参数。

依赖配置

—

要使用Java Validation API，我们必须添加validation-api依赖项：

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>2.0.1.Final</version>
</dependency>

通过添加@Validated注解来启用控制器中的@RequestParams和@PathVariables的验证：

@RestController
@RequestMapping("/")
@Validated
public class Controller {
    // ...
}

校验@RequestParam

—

我们将数字作为请求参数传递给控制器方法

@GetMapping("/name-for-day")
public String getNameOfDayByNumber(@RequestParam Integer dayOfWeek) {
    // ...
}

我们保证dayOfWeek的值在1到7之间，我们使用@Min和@Max注解

@GetMapping("/name-for-day")
public String getNameOfDayByNumber(@RequestParam @Min(1) @Max(7) Integer dayOfWeek) {
    // ...
}

任何与这些条件不匹配的请求都将返回HTTP状态500，并显示默认错误消息。

如果我们尝试调用http://localhost:8080/name-for-day?dayOfWeek=24这将返回以下响应信息：

There was an unexpected error (type=Internal Server Error, status=500).
getNameOfDayByNumber.dayOfWeek: must be less than or equal to 7

当然我们也可以在@Min和@Max注解后面加上message参数进行修改默认的返回信息。

校验@PathVariable

—

和校验@RequestParam一样，我们可以使用javax.validation.constraints包中的注解来验证@PathVariable。

验证String参数不是空且长度小于或等于10

@GetMapping("/valid-name/{name}")
public void test(@PathVariable("name") @NotBlank @Size(max = 10) String username) {
    // ...
}

任何名称参数超过10个字符的请求都会导致以下错误消息：

There was an unexpected error (type=Internal Server Error, status=500).
createUser.name:size must be between 0 and 10

通过在@Size注解中设置message参数，可以覆盖默认消息。

其实我们可以看到校验@RequestParam和@PathVariable参数和我们校验@RequestBody方式一致，只不过一个是写在了实体中，一个写在了外部，当然我们也可以将@RequestParam的参数写入到实体类中，进行使用@RequestParam注解进行引入，比如我们使用一个分页的实例

分页实体类

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.zhuanqb.param.page;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;
import org.hibernate.validator.constraints.NotBlank;
import org.hibernate.validator.constraints.NotEmpty;

import javax.validation.constraints.Max;
import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;

/**
 * PageParam <br/>
 * 描述 : PageParam <br/>
 * 作者 : qianmoQ <br/>
 * 版本 : 1.0 <br/>
 * 创建时间 : 2018-09-23 下午7:40 <br/>
 * 联系作者 : <a href="mailTo:shichengoooo@163.com">qianmoQ</a>
 */
@Data
@ToString
@NoArgsConstructor
@AllArgsConstructor
public class PageParam {

    @NotNull(message = "每页数据显示数量不能为空")
    @Min(value = 5)
    @Max(value = 100)
    private Integer size; // 每页数量

    @NotNull(message = "当前页显示数量不能为空")
    @Min(value = 1)
    @Max(value = Integer.MAX_VALUE)
    private Integer page; // 当前页数

    private Boolean flag = true;

}

@RequestParam调用方式

    @GetMapping(value = "list")
    public CommonResponseModel findAll(@Validated PageParam param) {
        ...
    }

这样的话可以使我们的校验定制化更加简单。

小助手

标题：Spring校验@RequestParams和@PathVariables参数的必要性和有效性

在Spring中，我们经常使用@RequestMapping注解来处理HTTP请求。而在处理请求时，我们通常会使用@RequestParams和@PathVariables来获取请求中的参数和路径变量。

然而，有人认为在处理请求时，对@RequestParams和@PathVariables参数进行校验是一个多余的步骤。他们认为，由于Spring框架已经对这些参数进行了自动转换和类型检查，因此在处理过程中不会出现类型不匹配或缺少参数的情况。

另一方面，也有人认为对@RequestParams和@PathVariables参数进行校验是非常必要的。他们认为，虽然Spring框架能够进行部分的自动转换和类型检查，但是不能保证参数的有效性和合法性。例如，对于一个接收用户输入的API，如果不对请求参数进行校验，就可能导致SQL注入、XSS攻击等安全问题。

此外，对参数进行校验还能提供更好的错误信息和用户体验。如果接收到的参数不符合要求，可以返回具体的错误信息给用户，方便用户理解并修正错误。

对于这个问题，社区的意见不一。一些开发者认为校验@RequestParams和@PathVariables参数是多余的，认为Spring框架已经足够解决了这些问题。而另一些开发者则认为校验是必要的，认为安全性和用户体验是非常重要的因素。

无论是支持还是反对校验@RequestParams和@PathVariables参数，我们都应该认识到无论是在处理数据安全问题还是优化用户体验方面，校验参数都是一个非常重要的环节。我们应该根据具体的业务需求来决定是否进行参数校验，同时也要充分利用Spring框架提供的校验机制来简化开发工作。

参与讨论的开发者们就这个问题提出了各自的观点，并且根据实际经验和技术知识给出了具体的例子和建议。他们的观点和讨论对于我们理解和应用Spring框架中的参数校验机制非常有帮助。