挑战：动态复杂请求参数的映射
假设我们有一个restful接口，其get请求可能包含任意数量和名称的参数。我们希望将这些参数根据其值的特定规则（例如，值以“1”开头）分别收集到自定义请求对象myweirdrequest的两个map字段中：startwithone和anythingelse。
// 假设的请求示例 // http://localhost:8088/test?first=aaa&second=1bbb&third=1ccc&fourth=2ddd
我们期望MyWeirdRequest对象最终包含以下结构：
startWithOne=[second:1bbb, third:1ccc] anythingElse=[first:aaa, fourth:2ddd]
如果直接在控制器方法中使用Map
定义复杂请求参数对象
首先，我们需要定义一个Java类来承载解析后的请求参数。考虑到HTTP请求参数可能存在同名参数携带多个值的情况（例如?param=val1¶m=val2），Map的值类型应为String[]而不是String。
import java.util.Map;
import java.util.Arrays;
import java.util.HashMap;
public class MyWeirdRequest {
private Map startWithOne = new HashMap<>();
private Map anythingElse = new HashMap<>();
public Map getStartWithOne() {
return startWithOne;
}
public void setStartWithOne(Map startWithOne) {
this.startWithOne = startWithOne;
}
public Map getAnythingElse() {
return anythingElse;
}
public void setAnythingElse(Map anythingElse) {
this.anythingElse = anythingElse;
}
@Override
public String toString() {
return "MyWeirdRequest{" +
"startWithOne=" + mapToString(startWithOne) +
", anythingElse=" + mapToString(anythingElse) +
'}';
}
private String mapToString(Map map) {
StringBuilder sb = new StringBuilder("{");
map.forEach((key, values) -> {
sb.append(key).append("=").append(Arrays.toString(values)).append(", ");
});
if (sb.length() > 1) { // Remove trailing ", "
sb.setLength(sb.length() - 2);
}
sb.append("}");
return sb.toString();
}
} 实现自定义参数解析器：HandlerMethodArgumentResolver
HandlerMethodArgumentResolver是Spring MVC提供的一个强大接口，它允许我们自定义方法参数的解析逻辑。通过实现这个接口，我们可以完全控制如何从HttpServletRequest中提取数据并将其绑定到控制器方法的特定参数上。
该接口有两个核心方法：
supportsParameter(MethodParameter parameter): 此方法用于判断当前的解析器是否支持处理给定的方法参数。如果返回true，则表示该解析器可以处理此参数；否则，Spring会尝试寻找其他解析器。在这个场景中，我们希望解析器只处理类型为MyWeirdRequest的参数。
resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory): 这是实现参数解析逻辑的核心方法。它接收一个NativeWebRequest对象，通过该对象可以访问到原始的HttpServletRequest，从而获取请求参数、Header等信息。我们在这里实现将请求参数解析并填充到MyWeirdRequest对象中的逻辑。
下面是TestArgumentResolver的实现：
import org.springframework.core.MethodParameter;
import org.springframework.web.bind.support.WebDataBinderFactory;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.method.support.ModelAndViewContainer;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
public class TestArgumentResolver implements HandlerMethodArgumentResolver {
@Override
public boolean supportsParameter(MethodParameter parameter) {
// 判断是否支持MyWeirdRequest类型的参数
return parameter.getParameterType().equals(MyWeirdRequest.class);
}
@Override
public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
NativeWebRequest webRequest, WebDataBinderFactory binderFactory)
throws Exception {
MyWeirdRequest result = new MyWeirdRequest();
Map startsWithOne = new HashMap<>();
Map anythingElse = new HashMap<>();
// 获取所有请求参数，getParameterMap()返回Map
for (Map.Entry paramEntry : webRequest.getParameterMap().entrySet()) {
String paramKey = paramEntry.getKey();
String[] paramValues = paramEntry.getValue();
// 过滤出值以"1"开头的参数
List swoValuesList = Arrays.stream(paramValues)
.filter(v -> v != null && v.startsWith("1"))
.collect(Collectors.toList());
if (!swoValuesList.isEmpty()) {
startsWithOne.put(paramKey, swoValuesList.toArray(new String[0]));
}
// 过滤出值不以"1"开头的参数
List aeValuesList = Arrays.stream(paramValues)
.filter(v -> v != null && !v.startsWith("1"))
.collect(Collectors.toList());
if (!aeValuesList.isEmpty()) {
anythingElse.put(paramKey, aeValuesList.toArray(new String[0]));
}
}
result.setStartWithOne(startsWithOne);
result.setAnythingElse(anythingElse);
return result;
}
} 在resolveArgument方法中，我们通过webRequest.getParameterMap()获取了所有请求参数的Map
注册自定义参数解析器
为了让Spring MVC识别并使用我们自定义的HandlerMethodArgumentResolver，我们需要将其注册到Spring的配置中。这可以通过实现WebMvcConfigurer接口并重写addArgumentResolvers方法来完成。
import org.springframework.context.annotation.Configuration;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import java.util.List;
@Configuration
public class TestRequestConfiguration implements WebMvcConfigurer {
@Override
public void addArgumentResolvers(List argumentResolvers) {
// 将自定义的参数解析器添加到列表中
argumentResolvers.add(new TestArgumentResolver());
}
} 通过@Configuration注解，Spring会自动扫描并加载这个配置类，从而使TestArgumentResolver生效。
控制器中的应用
现在，我们的控制器方法可以非常简洁地使用MyWeirdRequest作为参数，而无需关心复杂的参数解析逻辑：
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
@RestController("TestEndpoint")
@RequestMapping(path = "/", produces = MediaType.APPLICATION_JSON_VALUE)
public class TestEndpoint {
@RequestMapping(method = RequestMethod.GET, value = "/test")
public String getTest(MyWeirdRequest myRequest) {
// MyWeirdRequest对象已经由TestArgumentResolver填充完毕
return myRequest.toString();
}
}当请求http://localhost:8088/test?first=aaa&second=1bbb&third=1ccc&fourth=2ddd时，TestEndpoint的getTest方法将接收到一个已正确填充的MyWeirdRequest实例，其toString()方法输出将类似于：
MyWeirdRequest{startWithOne={second=[1bbb], third=[1ccc]}, anythingElse={first=[aaa], fourth=[2ddd]}}注意事项与总结
- 参数类型匹配：HandlerMethodArgumentResolver的supportsParameter方法是关键，它决定了你的解析器何时会被调用。确保返回true的条件足够精确，以避免不必要的解析或与其他解析器冲突。
-
多值参数处理：HTTP请求中同一个参数名可以对应多个值（例如?param=a¶m=b）。NativeWebRequest.getParameterMap()返回Map
正是为了处理这种情况。在实现解析逻辑时，务必考虑到String[]的使用。 - 错误处理：在resolveArgument方法中，如果解析失败或遇到非法数据，可以抛出适当的异常（例如IllegalArgumentException），Spring MVC会将其转换为HTTP 400 Bad Request等错误响应。
- 优先级：Spring MVC内部有许多默认的HandlerMethodArgumentResolver。如果你自定义的解析器与Spring自带的解析器处理相同的参数类型，那么注册顺序可能会影响哪个解析器生效。通常，自定义解析器会优先于默认解析器执行，但具体行为取决于Spring的版本和配置。
- 复用性与可维护性：通过HandlerMethodArgumentResolver，我们将复杂的请求参数解析逻辑从控制器中解耦，封装到独立的解析器中。这大大提高了代码的复用性（MyWeirdRequest可以在多个控制器方法中使用，而无需重复解析逻辑）和可维护性。
总而言之，当Spring Boot提供的标准注解无法满足复杂的请求参数映射需求时，HandlerMethodArgumentResolver提供了一个强大而灵活的扩展点。它允许开发者完全掌控参数解析过程，从而构建出更加健壮、可维护和业务驱动的RESTful API。
