SpringMVC 数组类型参数定义以及前端如何传参

朴灿烈づ我的快乐病毒、 2023-10-02 16:53 15阅读 0赞

如果数组参数是定义在请求体中（@RequestBody），那前端传参无非就是一个数组格式的json。  
如果数组参数是定义在请求参数上（@RequestParam…），那前端传参可就奇奇怪怪了。本文就来尝试列举**数组传参的各种定义场景**以及**前端在请求时应该如何传参**。

*  **简单类型集合**

@DeleteMapping("/list")
        public void delete(@RequestParam("ids") Set<String> ids) {
         // String[]、List<Stirng> 同理
            ...
        }

请求url示例：`/list?ids=1&ids=2`  
直接使用Set<String> ids，没有配置@RequestParam时，会报错！

*  对象类型集合

@RequestMapping("/list/bean")
        public void beans(@RequestParam("beans") ArrayList<Bean> beans) {
        
            ...
        }
    ...
    class Bean {
        
        String id;
        String name;
        //省略get set
    }

请求url示例：亲测**无法给参数赋值！** 有找到方法的同学可分享下。

*  **Bean中的简单类型集合属性**

@RequestMapping("/bean/list")
        public Object beanList(StringListWrapper bean) {
        
            ...
        }
    ...
    class StringListWrapper {
        
        List<String> ids;
        //省略get set
    }

请求url示例：`/bean/list?ids=1&ids=2`

*  **Bean中的对象类型集合属性**

@RequestMapping("/bean/list2")
        public Object beanList2(BeanListWrapper bean) {
        
            ...
        }
    ...
    class BeanListWrapper {
        
        List<Bean> beans;
        //省略get set
    }
    class Bean {
        
        String id;
        String name;
        //省略get set
    }

请求url示例：`/bean/list2?beans[0].id=1&beans[1].id=2`  
由于url上不能存在特殊字符，所以实际请求时需要进行 URLEncode 编码。‘\[‘编码后为’%5B’, ‘\]‘编码后为’%5D’，所以**实际请求的url**为：`/bean/list2?beans%5B0%5D.id=1&beans%5B1%5D.id=2`

*  **Bean中的Bean中的对象类型集合属性**

@RequestMapping("/bean/list3")
        public Object beanList2(OuterWrapper bean) {
        
            ,,.
        }
    ...
    class OuterWrapper {
        
        BeanListWrapper bean;
        //省略get set
    }
    class BeanListWrapper {
        
        List<Bean> beans;
        //省略get set
    }
    class Bean {
        
        String id;
        String name;
        //省略get set
    }

请求url示例：`/bean/list3?bean.beans[0].id=1&bean.beans[1].id=2`  
同上，在实际请求时需要URLEncode，**实际请求的url**为：`/bean/list3?bean.beans%5B0%5D.id&bean.beans%5B1%5D.id`

**小结**：属性通过 `.` 指定，数组通过 `[]` 指定。

**重点强调：对于请求参数，SpringMVC也支持从 Form表单 中获取参数值，所以，上述请求url示例中的`参数 若存在于 Form表单 中也是可以请求成功的！`**  
比如：url参数为 `/bean/list2?beans[0].id=1&beans[1].id=2`  
若使用 Form表单提交，其请求报文格式为：

POST /bean/list2  HTTP/1.1
    Content-Type: application/x-www-form-urlencoded
    
    beans[0].id=1&beans[1].id=2

**相关源码**

*  参数解析器的获取逻辑：org.springframework.web.method.support.HandlerMethodArgumentResolverComposite\#getArgumentResolver
 *  解析参数，给参数赋值：org.springframework.web.method.support.HandlerMethodArgumentResolverComposite\#resolveArgument