如何使用嵌入式 tomcat 会话集群设置 Spring Boot 应用程序？

Posted 2023-02-27

【中文标题】如何使用嵌入式 tomcat 会话集群设置 Spring Boot 应用程序？

【英文标题】：How to setup a Spring Boot application with embedded tomcat session clustering?

【发布时间】：2016-02-10 22:28:14

【问题描述】：

我想设置一个带有嵌入式 tomcat 会话集群的 Spring Boot 应用程序。

由于嵌入式 tomcat 没有 server.xml 文件，我创建了一个 TomcatEmbeddedServletContainerFactory 并以编程方式设置集群配置。代码如下：

@Configuration
public class TomcatConfig

    @Bean
    public EmbeddedServletContainerFactory servletContainerFactory()
    
        return new TomcatEmbeddedServletContainerFactory()
        
            @Override
            protected TomcatEmbeddedServletContainer getTomcatEmbeddedServletContainer(
                Tomcat tomcat)
            
                configureCluster(tomcat);
                return super.getTomcatEmbeddedServletContainer(tomcat);
            

            private void configureCluster(Tomcat tomcat)
            
                // static membership cluster 

                SimpleTcpCluster cluster = new SimpleTcpCluster();
                cluster.setChannelStartOptions(3);
                
                    DeltaManager manager = new DeltaManager();
                    manager.setNotifyListenersOnReplication(true);
                    cluster.setManagerTemplate(manager);
                
                
                    GroupChannel channel = new GroupChannel();
                    
                        NioReceiver receiver = new NioReceiver();
                        receiver.setPort(localClusterMemberPort);
                        channel.setChannelReceiver(receiver);
                    
                    
                        ReplicationTransmitter sender = new ReplicationTransmitter();
                        sender.setTransport(new PooledParallelSender());
                        channel.setChannelSender(sender);
                    
                    channel.addInterceptor(new TcpPingInterceptor());
                    channel.addInterceptor(new TcpFailureDetector());
                    channel.addInterceptor(new MessageDispatch15Interceptor());
                    
                        StaticMembershipInterceptor membership =
                            new StaticMembershipInterceptor();
                        String[] memberSpecs = clusterMembers.split(",", -1);
                        for (String spec : memberSpecs)
                        
                            ClusterMemberDesc memberDesc = new ClusterMemberDesc(spec);
                            StaticMember member = new StaticMember();
                            member.setHost(memberDesc.address);
                            member.setPort(memberDesc.port);
                            member.setDomain("MyWebAppDomain");
                            member.setUniqueId(memberDesc.uniqueId);
                            membership.addStaticMember(member);
                        
                        channel.addInterceptor(membership);
                    
                    cluster.setChannel(channel);
                
                cluster.addValve(new ReplicationValve());
                cluster.addValve(new JvmRouteBinderValve());
                cluster.addClusterListener(new ClusterSessionListener());

                tomcat.getEngine().setCluster(cluster);
            
        ;
    

    private static class ClusterMemberDesc
    
        public String address;
        public int port;
        public String uniqueId;

        public ClusterMemberDesc(String spec) throws IllegalArgumentException
        
            String[] values = spec.split(":", -1);
            if (values.length != 3)
                throw new IllegalArgumentException("clusterMembers element " +
                    "format must be address:port:uniqueIndex");
            address = values[0];
            port = Integer.parseInt(values[1]);
            int index = Integer.parseInt(values[2]);
            if ((index < 0) || (index > 255))
                throw new IllegalArgumentException("invalid unique index: must be >= 0 and < 256");
            uniqueId = "";
            for (int i = 0; i < 16; i++, index++)
            
                if (i != 0)
                    uniqueId += ',';
                uniqueId += index % 256;
            
            uniqueId += '';
        
    ;

    // This is for example. In fact these are read from application.properties
    private int localClusterMemberPort = 9991;
    private String clusterMembers = "111.222.333.444:9992:1";

我用以下环境测试了代码：

单台 Windows 电脑 2 个具有不同 localClusterMemberPort 和 clusterMembers 的 Spring Boot 应用程序实例

由于 cookie 不考虑端口，因此包含 JSESSIONID 的 cookie 在两个实例之间共享。

当实例启动时，tomcat 集群似乎工作，因为 2 个实例的请求的 JSESSIONID 值是相同的。但是当我使用第一个实例登录后向第二个实例发出请求时，第二个实例找不到 HttpSession。它记录了以下消息：

w.c.HttpSessionSecurityContextRepository : No HttpSession currently exists
w.c.HttpSessionSecurityContextRepository : No SecurityContext was available from the HttpSession: null. A new one will be created.

显然 HttpSession 没有被共享。但是随着第二个实例创建新会话，第一个实例的登录信息被清除，登录无效。

这里发生了什么？会话共享但HttpSession不共享？

顺便说一句，我读到必须在web.xml 上指定<distributed /> 标记，应用程序才能使用tomcat 会话集群。但是我不知道如何用 Spring Boot 的 no-xml 环境来指定它。这是问题的原因吗？那怎么指定呢？

我搜索并找到了一些显示使用 Redis 进行聚类的文档。但目前我不想在我的配置中添加另一个移动部分。在我的配置中，最多 3~4 个节点。

【问题讨论】：

你可以使用 Spring Session，打一个注解，就完成了。

@chrylis 你能提供参考吗？我浏览了几篇与 Spring Session 相关的文章，但它们似乎都涉及 Redis，我目前不想包含我的配置。而且 Spring 团队目前似乎放弃了嵌入式 Redis，因为它太有问题了。

你想在哪里存储会话状态？文件？ SQL？

@chrylis 我不想以任何方式存储会话状态。我想要的只是集群 2~3 个 tomcat 服务器，如果可能的话，没有 L4 交换机的粘性会话功能。

所以您只是在谈论内存中的状态同步，而不是在重新启动或其他任何事情时保持不变？

【参考方案1】：

关键是使上下文可分发，并设置管理器。

当我如下修改问题的代码时，会话集群工作了。

@Configuration
public class TomcatConfig

    @Bean
    public EmbeddedServletContainerFactory servletContainerFactory()
    
        TomcatEmbeddedServletContainerFactory factory = new TomcatEmbeddedServletContainerFactory()
        
            ...
        ;

        factory.addContextCustomizers(new TomcatContextCustomizer()
        
            @Override
            public void customize(Context context)
            
                context.setManager(new DeltaManager());
                context.setDistributable(true);
            
        );

        return factory;
    

    ...
 

对于 Spring Boot 1.2.4，不需要 context.setManager()。但是对于 Spring Boot 到 1.3.0，如果没有调用 context.setManager()，集群会失败并显示如下日志。

2015-11-18 19:59:42.882  WARN 9764 --- [ost-startStop-1] o.a.catalina.ha.tcp.SimpleTcpCluster     : Manager [org.apache.catalina.session.StandardManager[]] does not implement ClusterManager, addition to cluster has been aborted.

我有点担心这种版本依赖性。所以我为此opened an issue。

【讨论】：

...如果您在 context.xml 中设置管理器，那不是取消了保存会话和会话复制吗？

@zeodtr 能否请您为我们提供 Spring Boot 版本 2 的完整解决方案。我们需要一些相同的行为。

@user2846382 抱歉，我没有使用版本 2 的经验。

【参考方案2】：

在 Spring Boot 2.0.x 中，您需要使用WebServerFactoryCustomizer 来配置集群。

@Component
public class WebServerCustomizer implements WebServerFactoryCustomizer<TomcatServletWebServerFactory> 
    @Override
    public void customize( final TomcatServletWebServerFactory factory ) 
        factory.addContextCustomizers( new TomcatClusterContextCustomizer() );
    


public class TomcatClusterContextCustomizer implements TomcatContextCustomizer 
    @Override
    public void customize( final Context context ) 
        // Call method defined in the question text above, but pass Engine 
        // instead of Tomcat
        configureCluster( (Engine)context.getParent().getParent() );