Spring Boot中GET请求接收字符串数组的实现方法

0 次阅读

Spring Boot开发过程中,GET请求传递数组参数是一种非常常见的场景,例如批量查询用户信息、根据多个ID获取数据、筛选多个条件的数据列表等。由于HTTP GET请求本身通过URL传递参数,因此如何正确接收字符串数组成为后端接口设计中的一个重要问题。

Spring Boot基于Spring MVC框架提供了多种方式接收GET请求中的字符串数组参数,包括使用@RequestParam注解、对象封装接收、集合类型转换等方式。根据实际业务需求选择合适的接收方式,可以提高接口的可维护性和扩展能力。

一、GET请求传递字符串数组的常见格式

客户端向Spring Boot接口传递字符串数组时,通常有以下几种URL格式。

1. 多个相同参数名传递数组

这是Spring MVC默认支持较好的方式:

GET /user/query?ids=1001&ids=1002&ids=1003

对应的参数:

ids=["1001","1002","1003"]

这种方式符合HTTP参数规范,也是Spring官方推荐的数组参数传递方式之一。

2. 使用逗号分隔传递数组

另一种常见形式:

GET /user/query?ids=1001,1002,1003

后端接收到的是一个字符串:

"1001,1002,1003"

需要额外进行字符串拆分处理。

3. 使用数组格式传递

部分前端框架可能会生成类似:

GET /user/query?ids[]=1001&ids[]=1002

这种方式需要根据Spring配置和参数名称进行适配,否则可能出现无法绑定的问题。

二、使用@RequestParam接收字符串数组

在Spring Boot中,最简单的方式就是通过@RequestParam直接绑定数组参数。

示例代码:

@RestController
@RequestMapping("/user")
public class UserController {

    @GetMapping("/query")
    public String queryUser(@RequestParam String[] ids) {
        return Arrays.toString(ids);
    }
}

请求:

GET /user/query?ids=1001&ids=1002&ids=1003

返回结果:

[1001, 1002, 1003]

Spring MVC会自动将多个同名参数转换成字符串数组。

除了数组类型,也可以使用List接收:

@GetMapping("/query")
public String queryUser(@RequestParam List ids) {
    return ids.toString();
}

返回效果:

[1001, 1002, 1003]

相比数组,List在实际业务开发中更加灵活,推荐用于参数数量不固定的场景。

三、设置@RequestParam参数名称

如果请求参数名称与方法变量名称不一致,可以通过value或name属性指定。

例如请求:

GET /user/query?userIds=a01&userIds=a02

Controller:

@GetMapping("/query")
public String queryUser(
        @RequestParam(value = "userIds") List ids) {

    return ids.toString();
}

其中:

  • userIds表示URL中的参数名;

  • ids表示Java方法中的变量名称。

这种方式可以避免接口参数命名受代码变量影响。

四、处理逗号分隔的字符串数组

如果前端传递格式如下:

GET /user/query?ids=a01,a02,a03

默认情况下:

@RequestParam List ids

可能只能接收到一个元素:

["a01,a02,a03"]

可以手动拆分:

@GetMapping("/query")
public List queryUser(
        @RequestParam String ids) {

    return Arrays.asList(ids.split(","));
}

访问:

/user/query?ids=a01,a02,a03

返回:

[
 "a01",
 "a02",
 "a03"
]

这种方式适用于前端统一采用逗号拼接参数的情况。

五、使用集合对象接收复杂GET参数

当GET请求参数较多时,不建议在Controller方法中定义大量@RequestParam,可以使用对象封装。

例如:

请求:

GET /user/search?names=Tom&names=Jack&age=20

创建查询对象:

public class UserQuery {

    private List names;

    private Integer age;

    public List getNames() {
        return names;
    }

    public void setNames(List names) {
        this.names = names;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

Controller:

@GetMapping("/search")
public String search(UserQuery query) {

    return query.getNames().toString();
}

Spring Boot会自动完成参数绑定。

这种方式适合查询条件较多的接口,例如:

  • 商品筛选;

  • 用户搜索;

  • 数据统计查询;

  • 多条件分页查询。

六、GET请求接收数组时的注意事项

1. 参数不能为空问题

如果数组参数必须存在,可以设置required属性:

@GetMapping("/query")
public String query(
        @RequestParam(required = true) List ids) {

    return ids.toString();
}

如果请求中没有ids参数,将返回400错误。

如果参数允许为空:

@RequestParam(required = false)

则需要自行判断:

if(ids == null || ids.isEmpty()){
    return "参数为空";
}

2. 使用defaultValue设置默认值

例如:

@GetMapping("/query")
public String query(
        @RequestParam(
            value="ids",
            required=false,
            defaultValue=""
        ) String[] ids){

    return Arrays.toString(ids);
}

避免参数缺失导致异常。

3. 前后端参数格式保持一致

开发过程中最容易出现的问题就是前端传参格式和后端接收方式不一致。

例如:

前端:

ids=1,2,3

后端:

@RequestParam List ids

可能无法得到预期结果。

接口设计时应该提前约定:

  • 数组参数是否重复传递;

  • 是否使用逗号分隔;

  • 参数名称是否统一。

七、GET数组参数接收失败的常见原因

1. 参数名称不匹配

请求:

?idList=1&idList=2

代码:

@RequestParam List ids

会导致绑定失败。

解决:

@RequestParam("idList") List ids

2. 前端序列化方式不同

例如axios默认可能生成:

ids[]=1&ids[]=2

后端如果没有对应配置,会出现参数为空。

可以调整前端序列化方式,使其生成:

ids=1&ids=2

3. 类型转换异常

如果接收Integer数组:

@RequestParam List ids

请求:

ids=a&ids=b

会出现类型转换异常。

字符串数组不存在这种问题,但其他类型参数需要注意数据格式。

八、实际项目中的推荐写法

普通数组参数:

@GetMapping("/detail")
public Result detail(
        @RequestParam List ids){

    return Result.success(ids);
}

简单、清晰,适合大多数业务。

复杂查询:

@GetMapping("/list")
public Result list(UserQuery query){

    return Result.success(service.query(query));