已经有不少文章介绍使用tomcat-redis-session-manager来实现Redis存储Tomcat的Session,实现分布式Session管理。但是现在官方编译的tomcat-redis-session-manager的jar包已经很旧了,基于的Redis版本也很低。这里我把我自己重新编译并部署它的步骤介绍一下。

1,首先,从Github上clone下载tomcat-redis-session-manager工程的源代码,地址是:

https://github.com/jcoleman/tomcat-redis-session-manager.git

确保你使用的是master分支。

2,下载的工程是没办法直接导入到eclipse中编译的(虽然不是必须的,但是我倾向于为它创建一个eclipse工程。这个下步再说),而是通过gradle来编译,因此我们需要下载gradle,地址是:

https://gradle.org/gradle-download/

下载“Binary only distribution”就可以了。我解压放在C:\gradle-2.13目录下,gradle直接就可以用了。你也可以把路径C:\gradle-2.13\bin放在PATH环境变量里,会方便一些。但我没这么做。

3,打开/tomcat-redis-session-manager/build.gradle。修改依赖包的版本,尽量使用最新的版本。

compileJava {
 sourceCompatibility = 1.7
 targetCompatibility = 1.7}

dependencies {
 compile group: 'org.apache.tomcat', name: 'tomcat-catalina', version: '7.0.69'
 compile group: 'redis.clients', name: 'jedis', version: '2.8.1'
 compile group: 'org.apache.commons', name: 'commons-pool2', version: '2.4.2'
 //compile group: 'commons-codec', name: 'commons-codec', version: '1.10'

 testCompile group: 'junit', name: 'junit', version: '4.+'
 testCompile 'org.hamcrest:hamcrest-core:1.3'
 testCompile 'org.hamcrest:hamcrest-library:1.3'
 testCompile 'org.mockito:mockito-all:1.9.5'
 testCompile group: 'org.apache.tomcat', name: 'tomcat-coyote', version: '7.0.69'}

上面是build.gradle的片段,如高亮的地方所示,

1)把java版本改为你对应的java版本

2)把tomcat-catalina依赖的版本改为你安装的tomcat版本,我是7.0.69

3)把jedis版本改为最新的,当前是2.8.1

4)把commons-pool2版本改为最新的2.4.2

5)也可以把testCompile下的引用也修改为最新的,但这应该不要紧了。

因为gradle也是从maven仓库中下载jar包的,所以最好到http://mvnrepository.com/ 上检查一下,以上引用的group,name,version能在仓库找到。否则gradle还是下载不到jar包会报错。

4,(可选)导入为eclipse工程。还是要打开build.gradle文件。在第一行加上apply plugin:‘eclipse’

apply plugin: 'eclipse

'

apply plugin: 'java'

apply plugin: 'maven'

然后执行命令

cd [root]/tomcat-redis-session-manager

c:\gradle-2.13\bin\gradle eclipse

这样gradle会创建.project, .classpath文件,你就可以把项目导入到eclipse中了。

5, 你可以用eclipse进行编译。或者用gradle编译。

c:\gradle-2.13\bin\gradle build

编译成功:

基于Redis和Tomcat实现集群的Session管理_eclipse

但是我编译的时候其实是遇到一些问题的,如果你也有同样的问题,看我下面的trouble shooting。

6, TroubleShooting

在以上第4步,第5步中,如果使用gradle遇到以下错误:

No such property: sonatypeUsername for class: org.gradle.api.publication.maven.
internal.deployer.
DefaultGroovyMavenDeployer

在build.gradle中,注释掉下面高亮的一行。

repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") {        
//authentication(userName: sonatypeUsername,
password: sonatypePassword)
     }

参考: https://github.com/wealdtech/hawk/issues/16

如果遇到以下错误:

* What went wrong:
Execution failed for task ':signArchives'.
> Cannot perform signing task ':signArchives'
because it has no configured signatory

在build.gradle中,注释掉以下3行:

// signing {//  sign configurations.archives//}

参考: https://groups.google.com/forum/#!topic/gaelyk/WfdEDBOzIOM

7,在tomcat-redis-session-manager\build\libs目录下,可以找到编译成功的jar文件:

tomcat-redis-session-manager-2.0.0.jar

在C:\Users\[user]\.gradle目录下,可以找到另外2个依赖的jar文件(或者从maven里下载)

commons-pool2-2.4.2.jar

jedis-2.8.1.jar

把这3个文件拷贝到\apache-tomcat-7.0.69\lib目录

8,打开\apache-tomcat-7.0.69\conf\context.xml,在<Context>内添加

<Valve className="com.orangefunction.tomcat.redissessions.RedisSessionHandlerValve"/>  
<Manager className="com.orangefunction.tomcat.redissessions.RedisSessionManager"  
        host="127.0.0.1"  
        port="6379"  
        database="0"  
        maxInactiveInterval="60" />

其中的host和port是Redis的地址。(至于Redis集群的配置方式,以后再更新)

如果你是用eclipse中用tomcat进行调试,那么在你的动态网站项目下,在Project Explorer中的Servers里,找到context.xml文件,来添加以上的配置。

以上已经完成了配置,现在简单的测试一下。

1, 在项目中添加一个简单的jsp页。

<%@ page language="java" contentType="text/html; charset=ISO-8859-1"
‍    pageEncoding="ISO-8859-1"%><!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01
   Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><html>
   <head><meta http-equiv="Content-Type" content="text/html;
   charset=ISO-8859-1">
   <title>Insert title here</title></head><body>SessionID:
           <%=session.getId()%>‍
   </body>
 </html>

2,启动后,看到

基于Redis和Tomcat实现集群的Session管理_tomcat_02

3,用redis的python客户端redis-py查看对应的key是不是创建

>>> import redis>>> r=redis.StrictRedis(host='127.0.0.1',port=6379)>>>
r.get('289B7B17C0609FE930617ED659272C60')

基于Redis和Tomcat实现集群的Session管理_tomcat_03


欢迎关注“互联网架构师”,我们分享最有价值的互联网技术干货文章,助力您成为有思想的全栈架构师,只聊架构,不聊其他!打造最有价值的架构师圈子和社区。

长按下方的二维码可以快速关注我们


基于Redis和Tomcat实现集群的Session管理_tomcat_04