如何使@Controller 映射路径可配置？

Question

我正在构建一个内部库，它应该会自动向 Spring MVC 应用程序添加一些控制器。这些控制器都是 @RestController，带有一些用 @RequestMapping 注释的处理程序方法。由于它是一个库，我希望用户能够指定库应该公开所有这些控制器的根路径。插图：

// given that I have a controller like this:
@RestController
@RequestMapping("/admin") 
class AdminController {
  @RequestMapping("/users")
  UsersDto allUsers() { ... }
}

// it will be exposed at `http://localhost/admin/users`

我想要实现的是使 /admin 部分可配置。例如，如果用户说 application.properties:

super.admin.path=/top/secret/location/here

我希望 AdminController 的处理程序在 http://localhost/top/secret/location/here 可用，因此 allUsers() 处理程序的完整路径应为：

http://localhost/top/secret/location/here/users

我该如何实现？感觉这是一项很常见的任务，但我没能找到一个可行的简单解决方案。

我的发现#1

有一个SimpleUrlHandlerMapping机制似乎正是我想要的：

@Bean
public SimpleUrlHandlerMapping simpleUrlHandlerMapping() {
    SimpleUrlHandlerMapping simpleUrlHandlerMapping = new SimpleUrlHandlerMapping();
    simpleUrlHandlerMapping.setOrder(Integer.MAX_VALUE - 2);
    simpleUrlHandlerMapping.setUrlMap(Collections.singletonMap("/ANY_CUSTOM_VALUE_HERE/*", "adminController"));
    return simpleUrlHandlerMapping;
}

但它一直在说

The DispatcherServlet configuration needs to include a HandlerAdapter that supports this handler

我的发现#2

有 Spring Boot Admin 项目具有此确切功能 - 您可以配置它们应在何处公开其所有端点。他们似乎在 PrefixHandlerMapping 中从头开始实现了此功能。他们如何使用它：

...
@Bean
public PrefixHandlerMapping prefixHandlerMappingNotificationFilterController() {
    PrefixHandlerMapping prefixHandlerMapping = new PrefixHandlerMapping(notificationFilterController());
    prefixHandlerMapping.setPrefix(adminServerProperties.getContextPath());
    return prefixHandlerMapping;
}
...

Answer 1

除了@M。 Deinum 解决方案，您可以使用 带占位符的路径模式 。正如 Spring documentation 所述：

Patterns in @RequestMapping annotations support ${…} placeholders against local properties and/or system properties and environment variables. This may be useful in cases where the path a controller is mapped to may need to be customized through configuration.

所以在你的情况下，你的控制器会是这样的：

@RestController
@RequestMapping("/${super.admin.path:admin}") 
class AdminController {
  // Same as before
}

前面的控制器将使用 super.admin.path local/system 属性或环境变量值作为其前缀或 admin（如果未提供）。如果您使用 Spring 启动，请将以下内容添加到您的 application.properties:

super.admin.path=whatever

您可以自定义该前缀。

如何使@Controller 映射路径可配置？

How do I make @Controller mapping path configurable?

spring

spring-mvc

request-mapping

我的发现#1

我的发现#2