ThreadLocal 方式存储用户信息

因为每次业务层 或者 其他非 Controller 层,需要用到用户信息的时候,就需要把当前用户信息先查询出来在传递,或者是直接把当前的 session 直接往下层传递。这样很繁琐。
可以使用 线程封闭 性来优化这个问题。

最关键的地方在于:

1.每次请求的时候,可能不是同一个线程去执行,会到导致用户数据获取不到。
2.线程要释放绑定的用户数据,不然会出现内存泄露的问题。

先创建 ThreadLocal 操作类

........
import lombok.extern.slf4j.Slf4j;

/**
 * session 操作
 * @author weiximei
 */
@Slf4j
public class SessionLoad {

    private static ThreadLocal threadLocal = new ThreadLocal<>();

    /**
     * 设置用户信息
     * @param user
     */
    public static void setUser(SysUser user){
        log.info("当前线程 --- [{}] --- 设置用户 {} ", Thread.currentThread().getName(), user);
        threadLocal.set(user);
    }

    /**
     * 获取用户信息
     * @return
     */
    public static SysUser getUser() {
        SysUser user = threadLocal.get();
        log.info("当前线程 --- [{}] --- 获取用户 {} ", Thread.currentThread().getName(), user);
        return user;
    }

    /**
     * 移除用户
     */
    public static void removeUser() {
        threadLocal.remove();
    }

}

用户session操作类,针对 ThreadLocal 操作二次封装

........
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.servlet.http.HttpSession;

/**
 * 用户session
 * @author weiximei
 */
@Component
@Slf4j
public class UserControl {

    public static final String SESSION_USER = "user";

    /**
     * 设置用户
     * @param user
     */
    public static void setUser(SysUser user) {
        if (null == user) {
            throw new FoyoException("用户信息不能为空");
        }
        HttpSession session = getSession();
        user.setToken(session.getId());
        session.setAttribute(SESSION_USER, user);
        log.info("当前用户sessionId: {}", session.getId());
        SessionLoad.setUser(user);
    }

    /**
     * 获取当前用户
     * @return
     */
    public static SysUser getUser() {
        HttpSession session = getSession();
        log.info("当前用户sessionId: {}", session.getId());

        SysUser sysUser = SessionLoad.getUser();
        if (null == sysUser) {
            throw new FoyoException("用户未登录");
        }

        return sysUser;
    }

    /**
     * 移除用户
     */
    public static void removeUser() {
        HttpSession session = getSession();
        session.removeAttribute(SESSION_USER);
        log.info("当前用户sessionId: {}, 退出登录", session.getId());

        SessionLoad.removeUser();
    }

    /**
     * 获取当前 Request
     */
    private static HttpSession getSession() {
        HttpSession session = ((ServletRequestAttributes)RequestContextHolder.currentRequestAttributes()).getRequest().getSession();
        return session;
    }
}

定义一个 Filter 解决,每次请求不是同一个线程,造成用户信息获取不到问题

.......
import org.springframework.stereotype.Component;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

/**
 * 过滤器
 * @author weiximei
 */
@Component
public class FoyoFilter implements Filter {

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        HttpServletResponse response = (HttpServletResponse) servletResponse;

        if (request.getRequestURI().equals("/admin/login")) {
            filterChain.doFilter(servletRequest, servletResponse);
            return;
        }

        SysUser user = SessionLoad.getUser();
        if (null == user) {
            user = (SysUser) request.getSession().getAttribute(UserControl.SESSION_USER);
            if (null == user) {
                // 重定向登录
                request.getRequestDispatcher("/admin/toLogin").forward(servletRequest, servletResponse);
                return;
            }
        }

        // 设置用户
        UserControl.setUser(user);

        // 继续执行
        filterChain.doFilter(servletRequest, servletResponse);
    }
}

定义一个 Request 上下文监听器,用于释放线程绑定的用户信息,避免内存泄露
这里也可以选择 Spring Mvc提供的拦截器。但是我这里选择用 Servlet 的原生接口实现

.......
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

import javax.servlet.ServletRequestEvent;
import javax.servlet.ServletRequestListener;
import javax.servlet.http.HttpServletRequest;

/**
 * web 请求监听器
 * @author weiximei
 */
@Component
@Slf4j
public class RequestListener implements ServletRequestListener {

    @Override
    public void requestDestroyed(ServletRequestEvent sre) {
        HttpServletRequest request  = (HttpServletRequest) sre.getServletRequest();
        log.info("当前线程 --- [{}] --- 销毁请求:{}", Thread.currentThread().getName() , request.getRequestURI());

       /**
         * 移除当前线程绑定的用户数据,防止内存泄露
         */
        SessionLoad.removeUser();
    }

    @Override
    public void requestInitialized(ServletRequestEvent sre) {
        HttpServletRequest request  = (HttpServletRequest) sre.getServletRequest();
        log.info("当前线程 --- [{}] --- 创建请求:{}", Thread.currentThread().getName() ,request.getRequestURI());
    }
}

看看结果:

2019-09-02 15:51:57.392  INFO 15848 --- [nio-8080-exec-3] com.huiju.foyo.filter.RequestListener    : 当前线程 ---  [http-nio-8080-exec-3] --- 创建请求:/admin/user/info
2019-09-02 15:51:57.392  INFO 15848 --- [nio-8080-exec-3] com.huiju.foyo.session.SessionLoad       : 当前线程 --- [http-nio-8080-exec-3] --- 获取用户 null 
2019-09-02 15:51:57.392  INFO 15848 --- [nio-8080-exec-3] com.huiju.foyo.session.UserControl       : 当前用户sessionId: 037D8E592F00E126463DA83A73EA4111
2019-09-02 15:51:57.392  INFO 15848 --- [nio-8080-exec-3] com.huiju.foyo.session.SessionLoad       : 当前线程 --- [http-nio-8080-exec-3] --- 设置用户 SysUser(userId=1, name=admin, avatar=https://wpimg.wallstcn.com/f778738c-e4f8-4870-b634-56703b4acafe.gif, loginName=admin, passwd=null, status=1, token=037D8E592F00E126463DA83A73EA4111) 
2019-09-02 15:51:57.393  INFO 15848 --- [nio-8080-exec-3] com.huiju.foyo.session.UserControl       : 当前用户sessionId: 037D8E592F00E126463DA83A73EA4111
2019-09-02 15:51:57.393  INFO 15848 --- [nio-8080-exec-3] com.huiju.foyo.session.SessionLoad       : 当前线程 --- [http-nio-8080-exec-3] --- 获取用户 SysUser(userId=1, name=admin, avatar=https://wpimg.wallstcn.com/f778738c-e4f8-4870-b634-56703b4acafe.gif, loginName=admin, passwd=null, status=1, token=037D8E592F00E126463DA83A73EA4111) 
2019-09-02 15:51:57.394  INFO 15848 --- [nio-8080-exec-3] com.huiju.foyo.filter.RequestListener    : 当前线程 ---  [http-nio-8080-exec-3] --- 销毁请求:/admin/user/info

监听器Listener 和 Filter

Servlet监听器用于监听一些重要事件的发生,监听器对象可以在事情发生前、发生后可以做一些必要的处理。下面将介绍几种常用的监听器,以及它们都适合运用于那些环境。
分类及介绍:
1.ServletContextListener:用于监听WEB 应用启动和销毁的事件,监听器类需要实现javax.servlet.ServletContextListener 接口。
2.ServletContextAttributeListener:用于监听WEB应用属性改变的事件,包括:增加属性、删除属性、修改属性,监听器类需要实现javax.servlet.ServletContextAttributeListener接口。
3.ServletRequestListener : 用于监听请求的创建于销毁, 需要实现 javax.servlet.ServletRequestListener​ 接口
4.ServletRequestAttributeListener:请求属性事件监听器。用于监听请求中的属性改变的事件。
5.HttpSessionListener:用于监听Session对象的创建和销毁,监听器类需要实现javax.servlet.http.HttpSessionListener接口或者javax.servlet.http.HttpSessionActivationListener接口,或者两个都实现。
6.HttpSessionActivationListener:用于监听Session对象的钝化/活化事件,监听器类需要实现javax.servlet.http.HttpSessionListener接口或者javax.servlet.http.HttpSessionActivationListener接口,或者两个都实现。
7.HttpSessionAttributeListener:用于监听Session对象属性的改变事件,监听器类需要实现
8.HttpSessionBindingListener:会话值绑定事件监听器。这是唯一不需要在web.xml中设定的Listener。
9.Filter:用于在客户端的请求访问后端资源之前,拦截这些请求 或者 在服务器的响应发送回客户端之前,处理这些响应

你可能感兴趣的:(ThreadLocal 方式存储用户信息)