将上下文路径添加到 Spring Boot 应用程序

*发表于 2022-5-5 08:58:41* · 发表于 2022-5-5 08:58:41

问题
我正在尝试以编程方式设置 Spring Boot 应用程序的上下文根。上下文根的原因是我们想从 localhost:port/{app_name} 访问应用程序并将所有控制器路径附加到它。

这是 Web 应用程序的应用程序配置文件。

@Configuration
public class ApplicationConfiguration {
Logger logger = LoggerFactory.getLogger(ApplicationConfiguration.class);
@Value("${mainstay.web.port:12378}")
private String port;
@Value("${mainstay.web.context:/mainstay}")
private String context;
private Set<ErrorPage> pageHandlers;
@PostConstruct
private void init(){
pageHandlers = new HashSet<ErrorPage>();
pageHandlers.add(new ErrorPage(HttpStatus.NOT_FOUND,"/notfound.html"));
pageHandlers.add(new ErrorPage(HttpStatus.FORBIDDEN,"/forbidden.html"));
}
@Bean
public EmbeddedServletContainerFactory servletContainer(){
TomcatEmbeddedServletContainerFactory factory = new TomcatEmbeddedServletContainerFactory();
logger.info("Setting custom configuration for Mainstay:");
logger.info("Setting port to {}",port);
logger.info("Setting context to {}",context);
factory.setPort(Integer.valueOf(port));
factory.setContextPath(context);
factory.setErrorPages(pageHandlers);
return factory;
}
public String getPort() {
return port;
}
public void setPort(String port) {
this.port = port;
}
}

复制代码

这是主页的索引控制器。

@Controller
public class IndexController {
Logger logger = LoggerFactory.getLogger(IndexController.class);
@RequestMapping("/")
public String index(Model model){
logger.info("Setting index page title to Mainstay - Web");
model.addAttribute("title","Mainstay - Web");
return "index";
}
}

复制代码

应用程序的新根目录应位于 localhost:12378/mainstay ，但仍位于 localhost:12378 。

我错过了什么导致 Spring Boot 在请求映射之前不附加上下文根？

回答
你为什么要提出自己的解决方案。 SpringBoot 已经支持这一点。

如果您还没有，请将 application.properties 文件添加到 src\main\resources 。在该属性文件中，添加 2 个属性：

server.contextPath=/mainstay
server.port=12378

复制代码

更新（Spring Boot 2.0）

从 Spring Boot 2.0 开始（由于 Spring MVC 和 Spring WebFlux 支持）， contextPath 已更改为以下内容：

server.servlet.contextPath=/mainstay

然后可以删除自定义 servlet 容器的配置。如果需要对容器做一些后期处理，可以在配置中添加一个 EmbeddedServletContainerCustomizer 实现（比如添加错误页面）。

基本上，application.properties 中的属性充当默??认值，您可以通过在交付的工件旁边使用另一个 application.properties 或通过添加 JVM 参数 ( -Dserver.port=6666 ) 来覆盖它们。

另请参阅参考指南，尤其是“功能”部分。部分。

该类实现 ServerProperties 。 EmbeddedServletContainerCustomizer 的默认值为 contextPath 。在代码示例中，您直接在“”上设置 contextPath。 .接下来 TomcatEmbeddedServletContainerFactory 实例将处理此问题并将其从您的路径重置为 ServerProperties 。（此行执行“”检查，但它总是失败，因为默认值为 null 并将上下文设置为“”，覆盖你的）。

[软件设计/软件工程] 将上下文路径添加到 Spring Boot 应用程序