自定义 Spring MVC 中的 HandlerMethodMapping 命名策略：让端点命名更具意义

2024-03-27 12:27:52

自定义 Spring MVC 中的 HandlerMethodMapping 命名策略

问题：默认命名策略的局限性

在 Spring MVC 中，默认情况下，每个端点都自动分配一个名称，称为 RequestMappingInfoHandlerMethodMappingNamingStrategy。虽然这种方法在大多数情况下适用，但有时可能需要使用更具性的命名约定，尤其是当应用程序中有大量控制器和方法时。

解决方案：创建自定义命名策略

为了解决此问题，我们可以提供自己的命名策略，以根据特定的规则为每个端点分配名称。Spring MVC 提供了一个 HandlerMethodMappingNamingStrategy 接口，允许我们实现一个自定义策略。

在自定义策略中，我们可以重写 getName() 方法，该方法负责为给定的处理方法生成名称。在这个方法中，我们可以根据需要实现任何自定义命名规则。例如，我们可以使用处理方法所在控制器的完整名称来创建名称：

public String getName(HandlerMethod handlerMethod, RequestMappingInfo mappingInfo) {
    // 返回完整的控制器名称
    return handlerMethod.getBeanType().getName() + "#" + handlerMethod.getMethod().getName();
}

注册自定义策略

创建自定义策略后，我们需要将其注册到 Spring MVC。有两种方法可以做到这一点：

通过实现 RequestMappingHandlerAdapter 的子类：

public class CustomRequestMappingHandlerAdapter extends RequestMappingHandlerAdapter {

    public CustomRequestMappingHandlerAdapter() {
        // 设置自定义命名策略
        setHandlerMethodMappingNamingStrategy(new CustomHandlerMethodMappingNamingStrategy());
    }

}

通过 XML 配置：

<bean id="handlerMethodMappingNamingStrategy" class="CustomHandlerMethodMappingNamingStrategy" />

配置 Spring MVC 以使用自定义策略

注册自定义策略后，我们需要在 Spring MVC 配置中指定使用该策略。这可以通过以下方式完成：

Java 配置：

@Configuration
public class MvcConfig {

    @Bean
    public RequestMappingHandlerAdapter requestMappingHandlerAdapter() {
        RequestMappingHandlerAdapter adapter = new RequestMappingHandlerAdapter();
        adapter.setHandlerMethodMappingNamingStrategy(customHandlerMethodMappingNamingStrategy());
        return adapter;
    }

}

XML 配置：

<mvc:annotation-driven>
    <mvc:handler-adapter>
        <bean class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
            <property name="handlerMethodMappingNamingStrategy" ref="handlerMethodMappingNamingStrategy" />
        </bean>
    </mvc:handler-adapter>
</mvc:annotation-driven>