WebArgumentResolver 自定义参数解析案例

肖哥弹架构2024-06-21 20:45

WebArgumentResolver 用于定义自定义的参数解析逻辑，用于将传入的 Web 请求参数或模型中的属性注入到控制器方法的参数中。

业务场景：

假设你正在开发一个 Web 应用程序，该程序需要处理一些复杂的数据结构，这些结构并不适合直接从标准的请求参数中获取，或者你需要从多个来源（如请求头、请求体、会话等）获取参数。

1. 创建自定义参数解析器：

java 复制代码

import org.springframework.web.method.support.WebArgumentResolver;
import org.springframework.web.bind.annotation.PathVariable;

public class CustomArgumentResolver implements WebArgumentResolver {

    @Override
    public Object resolveArgument(MethodParameter parameter, NativeWebRequest webRequest) throws Exception {
        if (parameter.hasParameterAnnotation(PathVariable.class)) {
            // 从 URL 路径变量中获取参数值
            String name = parameter.getParameterAnnotation(PathVariable.class).value();
            return webRequest.getAttribute(name, 0);
        }
        // 可以添加更多的参数解析逻辑
        return WebArgumentResolver.UNRESOLVED;
    }
}

2. 注册自定义参数解析器：

java 复制代码

import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
        argumentResolvers.add(new CustomArgumentResolver());
    }
}

3. 使用自定义参数解析器：

java 复制代码

@GetMapping("/users/{userId}/profile")
public String getUserProfile(@PathVariable("userId") Long userId, CustomType customType) {
    // 使用 userId 和 customType 中的数据
    return "userProfile";
}

在这个例子中，CustomArgumentResolver 会尝试解析带有 @PathVariable 注解的参数。如果参数是自定义类型 CustomType，它将从请求中获取所需的数据并注入到控制器方法中。

总结

WebArgumentResolver 允许开发者自定义参数的解析逻辑，提供更大的灵活性。
它可以用于处理复杂的数据结构，或者从非标准来源获取参数。
使用 WebArgumentResolver 可以提高应用程序的模块化和可维护性，尤其是当涉及到复杂的参数处理时。