如何设置具有嵌入式Tomcat会话集群的Spring Boot应用程序?

7
我希望能设置一个集成了Tomcat Session Cluster的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个Spring Boot应用程序实例,具有不同的localClusterMemberPort和clusterMembers

由于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没有得到共享。但是当第二个实例创建一个新会话时,第一个实例的登录信息被清除并且登录无效。
这里发生了什么?Session被共享但HttpSession没有被共享?
顺便说一下,我已经知道标签必须在web.xml上进行指定,以便应用程序使用Tomcat会话集群。但是我不知道如何在Spring Boot的无XML环境中指定它。这是问题的原因吗?那么该如何指定呢?
我已经搜索并找到了一些文档,展示了使用Redis进行集群。但是目前我不想在我的配置中添加另一个移动部件。在我的配置中,3~4个节点是最大的。

1
你可以使用Spring Session,在一个注解上打上标记,然后就完成了。 - chrylis -cautiouslyoptimistic-
1
@chrylis 您能提供一个参考吗?我浏览了几篇与Spring Session相关的文章,但它们似乎都涉及Redis,而我现在不想包含Redis在我的配置中。而且似乎Spring团队目前放弃了嵌入式Redis,因为它存在太多问题。 - zeodtr
@chrylis 我不想以任何方式存储会话状态。我只想要将2~3个Tomcat服务器集群化,如果可能的话,不需要L4交换机的粘性会话功能。 - zeodtr
@chrylis 实际上我并不关心它是否是内存中的。如果可能的话,这是我不想知道的实现细节。我想要的只是在维护登录会话的同时,在2~3个嵌入式Tomcat服务器之间共享工作负载。 - zeodtr
@chrylis 我不关心重启后的持久性。由于有多个Tomcat,其他Tomcat可以使用共享的登录会话信息提供服务,而其中一个Tomcat处于停机状态。当所有Tomcat都关闭时,会话信息可以丢失。 - zeodtr
显示剩余3条评论
2个回答

7
关键是使上下文分布式,并设置管理器。
当我将问题的代码修改如下时,会话集群工作了。
@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.

我有一些担忧关于这个版本的依赖关系。因此,我打开了一个问题


如果您在context.xml中设置了管理器,那么这是否会取消保存会话和会话复制的功能? - Alkanshel
@zeodtr,能否请您为我们提供Spring Boot 2版本的完整解决方案?我们需要类似的行为。 - user2846382
@user2846382 抱歉,我没有使用过第二版。 - zeodtr

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() );
    }
}

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接