Spring Rest Controller如何实现同一URL同时接收单个对象与数组且不影响现有调用方
问题答复
直接把原端点的入参从单个ExampleObject换成ExampleObject[],一定会对现有调用方造成破坏性影响,不做额外配置的话根本没法平滑升级。
直接改入参的破坏性来源
原有接口和老调用方的约定是:请求体传单个ExampleObject对应的JSON结构,比如:
{ "id": 1, "name": "测试对象" }
当你直接把方法入参改成数组类型后,Spring默认的JSON消息转换器(Jackson)根本没法把上面这种单对象的JSON结构,直接反序列化成ExampleObject[]数组实例,请求会直接抛400参数解析错误,所有老调用方的请求都会直接失败,完全不兼容。
这种入参结构的变更本质是打破了双方约定的请求数据契约,属于典型的破坏性接口变更。
同端点兼容两种请求格式的无破坏实现方式
要在同一个/ExampleObjects POST端点下同时支持单对象、批量数组的请求,且不影响老调用方,可以选两种稳妥的实现:
- 开启Jackson的兼容反序列化配置:方法入参还是保留
ExampleObject[]类型,给Jackson开启DeserializationFeature.ACCEPT_SINGLE_VALUE_AS_ARRAY开关。这个开关打开后,Jackson在解析数组类型的入参时,如果遇到单对象结构的JSON,会自动把它包装成长度为1的数组,老调用方完全不用修改请求格式就能正常访问,新调用方直接传数组格式的批量请求也能正常解析。 - 用通用JSON节点做手动判断:把方法入参改成接收
JsonNode类型的请求体,在方法内部先判断请求体的节点类型——如果是单个对象节点,就转成只含1个元素的对象集合;如果是数组节点,就遍历转成对应的对象集合,后续业务逻辑统一对集合做处理。这种方式不需要调整全局序列化配置,兼容逻辑完全自己可控,也不会对老调用方造成影响。
内容的提问来源于stack exchange,提问作者user14929047
相关产品推荐
相关产品推荐

