解决Nginx+Tomcat时ContextPath不同的问题

 

1        问题描述

项目前端模板使用Thymeleaf，在对各种URL进行格式化输出时，都使用@{uri}代码。它会自动读取项目部署的虚拟路径，添加到URI的前端输出。

真实测试和生产环境中，我们使用nginx+Tomcat的部署模式，这就会部署带来一个限制：ngxin配置proxy时，需要同后端application使用相同的context path。

一个比较典型的测试场景：同一个Tomcat，部署多个应用；同一个nginx，配置这三个应用的proxy，但要求都使用独立域名进行访问，不能添加 context path。如图：

 

2        Thymeleaf实现原理

仔细读Thymeleaf的源码，它对uri的封装，是通过 LinkBuilder类实现的。在SpringBoot项目中，相关的代码。

 

有几点需要注意：

1、              最终是在 StandardLinkBuilder中调用request.getContextPath()获取部署context.

2、              SpringTemplateEngine的构造函数中，直接new StandardLinkBuilder对象。

3、              ThymeleafAutoConfiguration的代码和相应的配置定义中，没有发现对LinkBuilder的配置参数。

3        解决方案

根据项目情况，可以有几个解决方案可供选择。

3.1   Filter + HttpServletRequestWrapper

思路：最终代码使用request.getContextPath()，我们只要重新封装一下Request，重写getContextPath()方法即可。

 

并在项目中添加一个Filer，核心代码为：

public void doFilter(ServletRequest request, ServletResponse response,   FilterChain filterChain) throws IOException, ServletException {     CustomContextPathRequest requestWrapper =       new CustomContextPathRequest( (HttpServletRequest) request, this.contextPath);     filterChain.doFilter(requestWrapper, response); }

3.2   扩展 AutoConfiguration

咱重点介绍一下这个方法，借此机会熟悉SpringBoot的机制。

思路：SpringBoot缺省的AutoConfiguration没有提供配置LinkBuilder，我们自己实现一个AutoConfiguration，在Spring完成SpringTemplateEngine成功之后，再替换器LinkBuilder实现。

 

 

3.2.1  ManualContextLinkBuilder

例子是将context path写死为 /demo ，实际代码中，可以通过在application.propertis中的变量来实现，并配合maven profile，实现不同运行环境的差异化实现。

public class ManualContextLinkBuilder extends StandardLinkBuilder { private String nginxContextPath = “/demo”;   @Override protected String computeContextPath(final IExpressionContext context,       final String base, final Map parameters) {     return nginxContextPath; } }

 

3.2.2  ManualContextLinkBuilderConfiguration

@Configuration @AutoConfigureAfter(WebMvcAutoConfiguration.class) public class ManualContextLinkBuilderConfiguration {   @Autowired   SpringTemplateEngine springTemplateEngine;     @Bean   public ILinkBuilder linkBuilder() {     ILinkBuilder linkBuilder = new ManualContextLinkBuilder();     springTemplateEngine.setLinkBuilder(linkBuilder);     return linkBuilder;   } }

 

3.2.3  META-INF/spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ tech.codestory.ManualContextLinkBuilderConfiguration