10

我正在构建一个内部库，它应该自动向 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;
}

但它一直在说

DispatcherServlet 配置需要包含一个支持此处理程序的 HandlerAdapter

我的发现#2

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

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

1 回答 1

13

除了@M。Deinum 解决方案，您可以将Path Patterns 与 Placeholders 一起使用。正如Spring 文档所述：

@RequestMapping注释中的模式支持${…​}针对本地属性和/或系统属性和环境变量的占位符。这在控制器映射到的路径可能需要通过配置进行自定义的情况下可能很有用。

因此，在您的情况下，您的控制器将类似于：

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

前面的控制器将使用super.admin.path本地/系统属性或环境变量值作为其前缀，或者admin如果未提供这些值。如果您使用的是 Spring Boot，请将以下内容添加到您的application.properties：

super.admin.path=whatever

您可以自定义该前缀。

于 2016-05-29T18:45:39.400 回答