集群间实现Session共享

一、引言

针对企业，为了应对庞大的用户访问压力，目前大多数大型网站服务器都采用集群部署的方式；针对个人，仅一台服务器而言，也会安装多个tomcat进行错时更新，保证更新后台业务时服务不断开，即模拟了集群的运行方式。在此集群中，我们就不得不考虑一个用户鉴权的问题，即在不同服务上如何保证用户均已登录，并能获取相同的用户登录信息。

二、Java Web推荐的（公认的）用户鉴权机制

说此部分之前先了解几个概念：
1.请求，即Request，指客户端向服务器发送的信息，通常是通信的发起方；
2.响应，即Response，指服务器对请求的应答，通常是通信的回复方；
3.会话，即Session，服务器可将请求<->响应这一个完整的过程称为一次会话，并为这次会话生成一个唯一的标识符，即sessionId，用来表示这次会话，Session储存在服务器端；
4.Cookie，客户端保存在本地终端的数据，即Cookie储存在客户端。

Java Web的共用的用户鉴权机制是采用Session-Cookie技术，实现原理是：用户登录时，请求到达服务器，服务器调用通过getSession()方法判断session是否存在，如果不存在，则新建session，并通过其算法为session生成一个随机数作为sessionId，开发者可在session中储存一些用户信息；第二次请求时，如获取用户信息，getSession()方法判断session存在，则取出session，而不是新建，从而从session中获取到用户的相关信息。

客户端请求时，可以将cookie信息储存于request的head中发送给服务器；
服务器响应时，可以将cookie信息置于response中回传给客户端。
如下图代表，名称为test的cookie其值为aaa:

那么getSession()里究竟做了什么？

1.第一次用户请求，客户端本地没有任何数据，即其cookie为空，朝服务器发送request，getSession()中会解析request,发现其约定的cookie为null，则认为没有session，所以会重新创建一个session对象；

2.创建session后会将此session的id放入response中，回传给客户端，客户端则保存response中的cookie；

3.再次请求，服务器getSession()又会重新解析request获取cookie，发现了其中的sessionId，那么根据此sessionId去服务器的中去找，则得到了上次创建的session对象，那么则认为鉴权成功。

如此，便完成了鉴权的整个流程，Java逻辑代码(伪代码)如下：

public HttpSession getSession() {
    //从request中解析cookie
    HttpSession session = null;
    Cookie[] cookies = getRequest().getCookies();
    if (cookies != null) {
        for (Cookie cookie : cookies) {
            if (cookie.getName().equals("JSESSIONID")) {
                String sessionId = cookie.getValue();
                session = //根据sessionId获取内存中的session对象
            }
        }
    }
    if (session == null) {
        session = //创建一个新的session对象
    }

    //通过response将cookie返回
    Cookie cookie = new Cookie("JSESSIONID", session.getId());
    getResponse().addCookie(cookie);

    return session;
}

如上，java中将sessionId在cookie中保存的名称叫做“JSESSIONID”，即“Java Session Id”之意，打开浏览器可以看到类型的信息，如图：

三、集群间如何实现session共享

按照前文所说的session-cookie机制，session是保存在每台服务器的，但在集群中，拥有多台服务器，每台各自为政，势必会造成在这台服务器中登录，获取session成功，但是到另一台服务器上，又会获取不到session，造成鉴权失败，这样对用户来说是极不友好的，那么怎么解决这个问题呢？

通过我们以上的分析，即可得出几种处理方式:
A.找一块公共的空间用来储存session，而不是将session储存在集群节点的某台服务器上，此时，每一台服务器都能访问这块空间，从而实现session共享；

B.仍在每台服务器上保存session信息，不作修改，但采用另一种同步机制，实时同步没一台服务器的session信息；

C.构建一种全新的鉴权机制，不采用session-cookie机制，但要去除此鉴权机制对单个服务器的依赖。

综上所述，列举几种的具体实现方案：

---

1.持久化session到数据库，即使用数据库来储存session。数据库正好是我们普遍使用的公共储存空间，一举两得，推荐使用mysql数据库，轻量并且性能良好。

优点：就地取材，符合大多数人的思维，使用简单，不需要太多额外编码工作
缺点：对mysql性能要求较高，访问mysql需要从连接池中获取连接，又因为大部分请求均需要进行登录鉴权，所以操作数据库非常频繁，当用户量达到一定程度之后，极易造成数据库瓶颈，不适用于处理高并发的情况。

---

2.使用redis共享session。redis是一个key-value的储存系统。可以简单的将其理解为一个数据库，与传统数据库的区别是，它将数据储存于内存中，并自带有内存到硬盘的序列化策略，即按策略将内存中的数据同步到磁盘，避免数据丢失，是目前比较流行的解决方案。

优点：无需增加数据库的压力，因为数据存储于内存中，所以读取非常快，高性能，并能处理多种类型的数据。
缺点：额外增加一些编码，以便操作redis。

---

3.使用memcache同步session，memcache可以实现分布式，可将服务器中的内存组合起来，形成一个“内存池”，以此充当公共空间，保存session信息。

优点：数据储存在内存中，读取非常快，性能好；
缺点：memcache把内存分成很多种规格的存储块，有大有小，不能完全利用内存，会产生内存碎片，浪费资源，如果储存块不足，还会产生内存溢出。

---

4.通过脚本或守护进程在多台服务器之间同步session。

优点：实现了session共享；
缺点：对个人来说实现较为复杂，速度不稳定，有延时性，取决于现实中服务运行状态，偶然性较大，如果用于访问过快，可能出现session还没同步成功的情况。

---

5.使用NFS共享session。NFS是Network File Server共享服务器的简称，最早由Sun公司为解决Unix网络主机间的目录共享而研发。选择一台公共的NFS做共享服务器，储存所有session数据，每台服务器所需的session均从此处获取。

优点：较好的实现了session共享；
缺点：成本较高，对于个人来说难以实现。NFS依托于复杂的安全机制和文件系统，因此并发效率不高。

---

6.使用Cookie共享session。此方案可以说是独辟蹊径了，将分布式思想用到了极致。如上文分析所说，session-cookie机制中，session与cookie相互关联，以cookie做中转站，用来找到对应的session，其中session存放在服务器。那么如果将session中的内容存放在cookie中呢，那么则省略了服务器保存session的过程，后台只需要根据cookie中约定的标识进行鉴权校验即可。

优点：完美的贯彻分布式的理念，将每个用户都利用起来，无需耗费额外的服务器资源；
缺点：受http协议头长度限制，cookie中存储的信息不宜过多；为了保持cookie全局有效，所以其一般依赖在根域名下，所以基本上所有的http请求都需要传递cookie中的这些标记信息，所以会占用一些服务器的带宽；鉴权信息全存储于cookie中，cookie存在于客户端，服务器并没有储存相关信息，cookie存在着泄露的可能，或则其他人揣摩出规则后可以进行伪装，其安全性比其他方案差，故需要对cookie中信息进行加密解密，来增强其安全性。

---

在此，我们将选择方案2使用redis来具体实现集群下的session共享。

四、搭建测试环境

1.为模拟集群环境，需要两台服务器或在一台服务器上安装两个tomcat；
2.使用nginx做集群纷发；
3.安装redis充当公共的空间存储session;
4.框架中编写session储存业务，因为需要使用java操作redis，redis提供了驱动包jedis，故需要掌握jedis进行操作。

五、详细部署

5.1 安装多个tomcat
怎么安装tomcat此处不作说明，只说明安装额外的tomcat，本人原安装的tomcat目录为apache-tomcat-7.0.77

1.拷贝apache-tomcat-7.0.77为apache-tomcat-7.0.77_2
2.修改apache-tomcat-7.0.77_2下conf中server.xml文件端口号
，共三处，将每处在原端口号port之上加1，确保两个tomcat不会共用端口，如下：

<Server port="8006" shutdown="SHUTDOWN">

<Connector port="8081" protocol="HTTP/1.1"
               connectionTimeout="20000"
               redirectPort="8443" />

<Connector port="8010" protocol="AJP/1.3" redirectPort="8443" />

5.2 更改nginx配置，模拟集群
修改nginx配置文件nginx.conf文件，在server闭包外添加upstream，由上可知两个tomcat端口号分别为8080，8081

#建立集群
upstream not_alone {
    server localhost:8080;
    server localhost:8081;
}

# 转发请求到tomcat下mate项目
location / {
    proxy_pass http://not_alone/mate/; 
}

5.2 redis安装与配置

1.下载，官网：https://redis.io/download
2.安装，以4.0.1版本为例

$ wget http://download.redis.io/releases/redis-4.0.1.tar.gz
$ tar xzf redis-4.0.1.tar.gz
$ cd redis-4.0.1
$ make

3.启动

$ src/redis-server

• 1

4.关闭

ctrl + c

5.配置后台启动（redis默认是前台启动，启动成功后界面就持续停止在那个界面上，这对服务器操作很不方便）

#修改其配置文件
vim redis.conf

将daemonize no改为daemonize yes

#保存退出
:wq!

如下图：

6.后台启动

src/redis-server redis.conf

如图：

7.关闭
杀掉redis进程,如图：

8.为redis配置系统服务，本人使用的系统是CentOS 7，需要配置使用systemctl进行管理。
/lib/systemd/system目录下创建文件redis.service，并编辑：

#表示服务信息
[Service]
Type=forking
#注意：需要和redis.conf配置文件中的信息一致
PIDFile=/var/run/redis_6379.pid
#启动服务的命令
#redis-server安装的路径 和 redis.conf配置文件的路径
ExecStart=/server/soft/redis-4.0.1/src/redis-server /server/soft/redis-4.0.1/redis.conf
#重新加载命令
ExecReload=/bin/kill -s HUP $MAINPID
#停止服务的命令
ExecStop=/bin/kill -s QUIT $MAINPID
PrivateTmp=true

#安装相关信息
[Install]
#以哪种方式启动
WantedBy=multi-user.target
#multi-user.target表明当系统以多用户方式（默认的运行级别）启动时，这个服务需要被自动运行。

更多redis systemctl详细配置，请看：http://blog.csdn.net/u011389474/article/details/72303156

配置成功，启动完成后，通过服务可知其运行状态，如图：

至此，redis已全部安装部署完成。

六、编写代码实现功能

为了测试简便，后台web框架我选择的是JFinal，JFinal是中国开源社区中广受好评的后台轻量级极速web框架，因其操作简单，设计灵活而被大多数开发者所喜爱，有兴趣的朋友可以试试，用一次之后你就会喜欢它的，JFinal社区:http://www.jfinal.com/

这里用JFianl的另一个好处就是JFinal核心库中自带Redis插件，集成了jedis的各种使用方法，这样就不用自己去编写了，省了很大的代码量。Jedis基本操作：http://www.cnblogs.com/edisonfeng/p/3571870.html

为帮助理解代码，Jfinal中连接redis，只需要在主配置文件中编写：

/**
 * 插件配置
 */
@Override
public void configPlugin(Plugins me) {
    /*
    * Redis配置：连接本地的mate redis库，端口号默认
    */
    RedisPlugin rp = new RedisPlugin("mate", "localhost");
    me.add(rp);
}

redis存取数据：

Cache cache = Redis.use();

//存
cache.set(key, value);

//取
Object value  = cache.get(key);

//设置redis过期时间
cache.pexpire(key, time);

正式代码如下，我们将会自定义session，每个sesison对象都是唯一的，需要给每个session分配一个唯一id，id生成算法，则可以借用UUID实现，UUID相关介绍： https://baike.baidu.com/item/UUID/5921266?fr=aladdin
自定义随机数工具类：

/**
 * 随机数工具类
 * @author alone
 */
public class RandomUtils {
    /**
     * 获取唯一的可辨识资讯UUID
     * UUID为128位二进制，每4位二进制=16进制，其添加了四个'-'，故总长为36位
     * @param 是否删除标记
     * @return UUID
     */
    public static String getUUID(boolean rmtag) {
        String uuid = UUID.randomUUID().toString();
        if (rmtag) {
            uuid = uuid.replace("-", "");
        }
        return uuid;
    }
}

自定义RedisSession类，将替代原来的HttpSession：

package com.alone.mate.common;

import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;

import com.alone.mate.utils.RandomUtils;
import com.jfinal.plugin.redis.Cache;
import com.jfinal.plugin.redis.Redis;

/**
 * 自定义ResidSession解决集群会话共享
 * @author alone
 */
@SuppressWarnings("serial")
public class RedisSession implements Serializable {

    private String id;
    private SessionType type;
    private long createTime;
    private long destroyTime;
    private Map<String, Object> attrs;

    /**
     * 会话类型，不同类型的会话其有效期不同
     * @author alone
     */
    public enum SessionType {

        /**
         * 移动端，类型为1，会话有效期为一周
         */
        MOBILE(1, 1000 * 60 * 60 * 24 * 7),
        /**
         * 网页端，类型为2，会话有效期为半小时
         */
        BROWSER(2, 1000 * 60 * 30);

        private int type;
        private int value;

        private SessionType(int type, int value) {
            this.type = type;
            this.value = value;
        }

        public int getType() {
            return type;
        }

        public int getValue() {
            return value;
        }

        public static SessionType getSessionType(int type) {
            for (SessionType st : SessionType.values()) {
                if (st.type == type) {
                    return st;
                }
            }
            return null;
        }
    }

    public RedisSession(int sessionType) {
        this.id = RandomUtils.getUUID(true);
        this.type = SessionType.getSessionType(sessionType);
        this.createTime = System.currentTimeMillis();
        this.destroyTime = this.createTime + this.type.value;
        this.attrs = new HashMap<>();
    }

    public Object getAttribute(String key) {
        return attrs.get(key);
    }

    public void setAttribute(String key, Object value) {
        attrs.put(key, value);
        Cache cache = Redis.use();
        cache.set(this.getId(), this);
        cache.pexpire(this.getId(), this.getDestroyTime() - System.currentTimeMillis());//set后会将生存时间清零，需要重新设置有效期
    }

    public void removeAttribute(String key) {
        attrs.remove(key);
        Cache cache = Redis.use();
        cache.set(this.getId(), this);
    }

    public String getId() {
        return id;
    }

    public SessionType getType() {
        return type;
    }

    public long getCreateTime() {
        return createTime;
    }

    public long getDestroyTime() {
        return destroyTime;
    }

    public void setDestroyTime(long destroyTime) {
        this.destroyTime = destroyTime;
    }
}

仿造getSession()实现逻辑在控制器基类BaseController中自定义getSession()方法，获取RedisSession

public class BaseController extends Controller {

    private static final Logger logger = Logger.getLogger(BaseController.class);
    private String sessionId;

    /**
     * 获取RedisSession
     * @param sessionType 会话类型
     * @return
     */
    @SuppressWarnings("null")
    public RedisSession getSession(int sessionType) {
        boolean isReload = false;
        long now = System.currentTimeMillis();
        RedisSession session = null;
        Cache cache = Redis.use();
        if (sessionId == null) {
            Cookie[] cookies = getRequest().getCookies();
            if (cookies != null) {
                for (Cookie cookie : cookies) {
                    if (cookie.getName().equals("JSESSIONID")) {//查看请求中是否有对应的Cookie记录
                        sessionId = cookie.getValue();//本地记录此次请求的sessionId，防止在初次请求时后台多次获取session，获取的session均不同
                    }
                }
            }
        }
        if (sessionId != null) {
            session = cache.get(sessionId);//如果有，从redis中取出对应的Session
            if (session != null) {
                if (session.getType() == RedisSession.SessionType.BROWSER) {
                    session.setDestroyTime(now + RedisSession.SessionType.BROWSER.getValue());//若会话类型为浏览器则刷新其会话有效期
                    isReload = true;
                    logger.info("刷新会话时间，JSESSIONID：" + session.getId() + "，延长：" + RedisSession.SessionType.BROWSER.getValue()/1000/60/60.0 + "小时");
                }
                if (session.getDestroyTime() < now) {//若会话过期，从redis中删除
                    cache.del(session.getId());
                    session = null;
                    logger.info("删除过期会话，JSESSIONID：" + session.getId());
                }
            }
        }

        if (session == null) {
            session = new RedisSession(sessionType);//若请求中没有对应Cookie记录，创建新的session
            sessionId = session.getId();//本地记录此次请求的sessionId，防止在初次请求时后台多次获取session，获取的session均不同
            isReload = true;
            logger.info("创建新会话，JSESSIONID：" + session.getId() + "，有效时间：" + (session.getDestroyTime() - now)/1000/60/60.0 + "小时");
        }
        if (isReload) {//session生命周期发生变化，需要重新redis中存储数据
            cache.set(session.getId(), session);//将session存入redis中
            cache.pexpire(session.getId(), session.getDestroyTime() - now);//设定redis数据储存有效期
        }

        Cookie cookie = new Cookie("JSESSIONID", session.getId());
        cookie.setPath("/");
        cookie.setHttpOnly(true);
        getResponse().addCookie(cookie);//将cookie返回

        return session;
    }
}

说明：
以上代码中，设想服务器给移动端和网页端同时提供服务，为了优化，但我希望移动端不需要频繁登录，就像微信一样，我将这个时间暂设一周；而网页端的话，session生存周期较短，只有半个小时，并且每次鉴权都刷新其可用时间，移动端只倒计时就可以了，一周登录一次就可以了。redis自带有过期策略，可以很好的实现这一点，同时为了保险起见，也手动验证了一下如过期，进行删除。为了避免初次请求时，多次调用getSession()生成多个session，故在创建session成功后记录其sessionId，再次调用getSession()时可对其进行验证。

七、结果测试

1.在Controller中编写两个接口，一为登录接口，登录成功，储存用户uid；二为验证登录接口，获取登录信息：

public void redisLogin() {
    RedisSession session = getSession(RedisSession.SessionType.BROWSER.getType());
    session.setAttribute("uid", 1);
    renderText("登录成功，sessionId：" + session.getId());
}


public void redisCheckLogin() {
    RedisSession session = getSession(RedisSession.SessionType.BROWSER.getType());
    int uid = (int) session.getAttribute("uid");
    renderText("sessionId：" + session.getId() + ", uid: " + uid);
}

2.配置nginx分别跳转到不同tomcat下的不同接口

#测试登录接口跳到8080
location = /tomcat1 {
    proxy_pass http://localhost:8080/mate/test/redisLogin;
}

#校验登录接口跳到8081
location = /tomcat2 {
    proxy_pass http://localhost:8081/mate/test/redisCheckLogin;
}

3.开启redis，nginx，两个tomcat下运行同样的项目，在浏览器中调用接口进行测试。

调用tomcat1的登录接口

日志：

调用tomcat2的登录接口

日志：

可以看到，两个tomcat中的信息完全一样，很好的达到了我们预计的效果。