Springboot项目中自定义HandlerMethodArgumentResolver不生效的原因与解法

2023-10-25 03:15:12

自定义 HandlerMethodArgumentResolver: 彻底解析请求参数

前言

在 Springboot 中，参数解析是开发中必不可少的环节。默认情况下，Springboot 使用内置的参数解析器来解析请求中的参数，并将解析结果绑定到方法参数上。然而，在某些情况下，默认的参数解析器可能无法满足我们的需求，需要自定义 HandlerMethodArgumentResolver。

自定义 HandlerMethodArgumentResolver

Springboot 提供了 HandlerMethodArgumentResolver 接口，允许开发者自定义参数解析器。通过实现这个接口，我们可以将请求参数解析为方法参数。在自定义 HandlerMethodArgumentResolver 时，需要关注以下几个方面：

实现 HandlerMethodArgumentResolver 接口： 这是自定义参数解析器的第一步，接口中提供了两个必须实现的方法：supportsParameter 和 resolveArgument。
重写 supportsParameter 方法： 该方法用于判断是否支持解析指定的方法参数。如果返回 true，则调用 resolveArgument 方法进行参数解析。
重写 resolveArgument 方法： 该方法用于解析方法参数并返回解析结果。

代码示例：

@Component
public class TenantIdArgumentResolver implements HandlerMethodArgumentResolver {

    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        return parameter.getParameterType().equals(String.class) && parameter.hasParameterAnnotation(TenantId.class);
    }

    @Override
    public Object resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer, NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
        return webRequest.getHeader("tenant-id");
    }
}

不生效的原因

在使用自定义 HandlerMethodArgumentResolver 时，可能会遇到不生效的问题。造成这种情况的原因主要有：

配置不当： 确保自定义 HandlerMethodArgumentResolver 已经正确配置到 Springboot 容器中，并且优先级足够高。
方法参数类型不匹配： 确保自定义 HandlerMethodArgumentResolver 支持解析指定的方法参数类型。如果类型不匹配，则不会调用 resolveArgument 方法。
参数解析顺序不正确： Springboot 中参数解析顺序是固定的，如果自定义 HandlerMethodArgumentResolver 的优先级低于其他内置的参数解析器，则不会被调用。

解法

根据造成不生效的原因，我们可以采取相应的措施：

配置检查： 确保自定义 HandlerMethodArgumentResolver 正确配置，并调整优先级高于其他内置的参数解析器。
方法参数类型调整： 修改方法参数类型，使其与自定义 HandlerMethodArgumentResolver 支持的类型一致。
参数解析顺序调整： 调整自定义 HandlerMethodArgumentResolver 的优先级，使其高于其他内置的参数解析器。

总结

在使用自定义 HandlerMethodArgumentResolver 时，需要特别注意配置、方法参数类型和参数解析顺序。通过正确配置和调整，可以避免不生效的问题。

常见问题解答

如何配置自定义 HandlerMethodArgumentResolver？
- 在 Springboot 配置类中使用 @Bean 注解注册自定义 HandlerMethodArgumentResolver。
如何设置 HandlerMethodArgumentResolver 的优先级？
- 在 @Bean 注解中使用 @Order 注解指定优先级，数字越小优先级越高。
如何确定方法参数类型是否匹配？
- 通过比较方法参数的类型和自定义 HandlerMethodArgumentResolver 支持的类型。
如何调整参数解析顺序？
- 通过调整 HandlerMethodArgumentResolver 的优先级，使其高于或低于其他内置的参数解析器。
除了参数解析，自定义 HandlerMethodArgumentResolver 还有其他用途吗？
- 是的，还可以用于自定义参数验证和格式化。