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

  • Z时代
  • 2024-01-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;
}
...

回答：

除了@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

您可以自定义该前缀。

以上是 如何使@Controller映射路径可配置？ 的全部内容， 来源链接： utcz.com/qa/410483.html

回到顶部