|
| 1 | +package com.ruoyi.framework.shiro.web.filter.kickout; |
| 2 | + |
| 3 | +import cn.hutool.core.convert.Convert; |
| 4 | +import cn.hutool.core.util.ObjectUtil; |
| 5 | +import cn.hutool.json.JSONUtil; |
| 6 | +import com.ruoyi.common.base.AjaxResult; |
| 7 | +import com.ruoyi.common.constant.ShiroConstants; |
| 8 | +import com.ruoyi.common.utils.ServletUtils; |
| 9 | +import com.ruoyi.framework.util.ShiroUtils; |
| 10 | +import com.ruoyi.system.domain.SysUser; |
| 11 | +import org.apache.shiro.cache.Cache; |
| 12 | +import org.apache.shiro.cache.CacheManager; |
| 13 | +import org.apache.shiro.session.Session; |
| 14 | +import org.apache.shiro.session.mgt.DefaultSessionKey; |
| 15 | +import org.apache.shiro.session.mgt.SessionManager; |
| 16 | +import org.apache.shiro.subject.Subject; |
| 17 | +import org.apache.shiro.web.filter.AccessControlFilter; |
| 18 | +import org.apache.shiro.web.util.WebUtils; |
| 19 | + |
| 20 | +import javax.servlet.ServletRequest; |
| 21 | +import javax.servlet.ServletResponse; |
| 22 | +import javax.servlet.http.HttpServletRequest; |
| 23 | +import javax.servlet.http.HttpServletResponse; |
| 24 | +import java.io.IOException; |
| 25 | +import java.io.Serializable; |
| 26 | +import java.util.ArrayDeque; |
| 27 | +import java.util.Deque; |
| 28 | + |
| 29 | +/** |
| 30 | + * 登录帐号控制过滤器 |
| 31 | + * |
| 32 | + * @author ruoyi |
| 33 | + */ |
| 34 | +public class KickoutSessionFilter extends AccessControlFilter { |
| 35 | + |
| 36 | + /** |
| 37 | + * 同一个用户最大会话数 |
| 38 | + **/ |
| 39 | + private int maxSession = -1; |
| 40 | + |
| 41 | + /** |
| 42 | + * 踢出之前登录的/之后登录的用户 默认false踢出之前登录的用户 |
| 43 | + **/ |
| 44 | + private Boolean kickoutAfter = false; |
| 45 | + |
| 46 | + /** |
| 47 | + * 踢出后到的地址 |
| 48 | + **/ |
| 49 | + private String kickoutUrl; |
| 50 | + |
| 51 | + private SessionManager sessionManager; |
| 52 | + private Cache<String, Deque<Serializable>> cache; |
| 53 | + |
| 54 | + @Override |
| 55 | + protected boolean isAccessAllowed(ServletRequest servletRequest, ServletResponse servletResponse, Object o) { |
| 56 | + return false; |
| 57 | + } |
| 58 | + |
| 59 | + @Override |
| 60 | + protected boolean onAccessDenied(ServletRequest request, ServletResponse response) throws Exception { |
| 61 | + Subject subject = getSubject(request, response); |
| 62 | + boolean flag = !subject.isAuthenticated() && !subject.isRemembered() || maxSession == -1; |
| 63 | + if (flag) { |
| 64 | + // 如果没有登录或用户最大会话数为-1，直接进行之后的流程 |
| 65 | + return true; |
| 66 | + } |
| 67 | + try { |
| 68 | + Session session = subject.getSession(); |
| 69 | + // 当前登录用户 |
| 70 | + SysUser user = ShiroUtils.getSysUser(); |
| 71 | + String loginName = user.getLoginName(); |
| 72 | + Serializable sessionId = session.getId(); |
| 73 | + |
| 74 | + // 读取缓存用户 没有就存入 |
| 75 | + Deque<Serializable> deque = cache.get(loginName); |
| 76 | + if (deque == null) { |
| 77 | + // 初始化队列 |
| 78 | + deque = new ArrayDeque<>(); |
| 79 | + } |
| 80 | + |
| 81 | + // 如果队列里没有此sessionId，且用户没有被踢出；放入队列 |
| 82 | + if (!deque.contains(sessionId) && session.getAttribute("kickout") == null) { |
| 83 | + // 将sessionId存入队列 |
| 84 | + deque.push(sessionId); |
| 85 | + // 将用户的sessionId队列缓存 |
| 86 | + cache.put(loginName, deque); |
| 87 | + } |
| 88 | + |
| 89 | + // 如果队列里的sessionId数超出最大会话数，开始踢人 |
| 90 | + while (deque.size() > maxSession) { |
| 91 | + Serializable kickoutSessionId = null; |
| 92 | + // 是否踢出后来登录的，默认是false；即后者登录的用户踢出前者登录的用户； |
| 93 | + if (kickoutAfter) { |
| 94 | + // 踢出后者 |
| 95 | + kickoutSessionId = deque.removeFirst(); |
| 96 | + } else { |
| 97 | + // 踢出前者 |
| 98 | + kickoutSessionId = deque.removeLast(); |
| 99 | + } |
| 100 | + // 踢出后再更新下缓存队列 |
| 101 | + cache.put(loginName, deque); |
| 102 | + |
| 103 | + try { |
| 104 | + // 获取被踢出的sessionId的session对象 |
| 105 | + Session kickoutSession = sessionManager.getSession(new DefaultSessionKey(kickoutSessionId)); |
| 106 | + if (null != kickoutSession) { |
| 107 | + // 设置会话的kickout属性表示踢出了 |
| 108 | + kickoutSession.setAttribute("kickout", true); |
| 109 | + } |
| 110 | + } catch (Exception e) { |
| 111 | + // 面对异常，我们选择忽略 |
| 112 | + } |
| 113 | + } |
| 114 | + |
| 115 | + // 如果被踢出了，(前者或后者)直接退出，重定向到踢出后的地址 |
| 116 | + if (ObjectUtil.isNotEmpty(session.getAttribute("kickout")) && Convert.toBool(session.getAttribute("kickout"))) { |
| 117 | + // 退出登录 |
| 118 | + subject.logout(); |
| 119 | + saveRequest(request); |
| 120 | + return isAjaxResponse(request, response); |
| 121 | + } |
| 122 | + return true; |
| 123 | + } catch (Exception e) { |
| 124 | + return isAjaxResponse(request, response); |
| 125 | + } |
| 126 | + } |
| 127 | + |
| 128 | + private boolean isAjaxResponse(ServletRequest request, ServletResponse response) throws IOException { |
| 129 | + HttpServletRequest req = (HttpServletRequest) request; |
| 130 | + HttpServletResponse res = (HttpServletResponse) response; |
| 131 | + if (ServletUtils.isAjaxRequest(req)) { |
| 132 | + AjaxResult ajaxResult = AjaxResult.error("您已在别处登录，请您修改密码或重新登录"); |
| 133 | + ServletUtils.renderString(res, JSONUtil.toJsonStr(ajaxResult)); |
| 134 | + } else { |
| 135 | + WebUtils.issueRedirect(request, response, kickoutUrl); |
| 136 | + } |
| 137 | + return false; |
| 138 | + } |
| 139 | + |
| 140 | + public void setMaxSession(int maxSession) { |
| 141 | + this.maxSession = maxSession; |
| 142 | + } |
| 143 | + |
| 144 | + public void setKickoutAfter(boolean kickoutAfter) { |
| 145 | + this.kickoutAfter = kickoutAfter; |
| 146 | + } |
| 147 | + |
| 148 | + public void setKickoutUrl(String kickoutUrl) { |
| 149 | + this.kickoutUrl = kickoutUrl; |
| 150 | + } |
| 151 | + |
| 152 | + public void setSessionManager(SessionManager sessionManager) { |
| 153 | + this.sessionManager = sessionManager; |
| 154 | + } |
| 155 | + |
| 156 | + /** |
| 157 | + * 设置Cache的key的前缀 |
| 158 | + */ |
| 159 | + public void setCacheManager(CacheManager cacheManager) { |
| 160 | + // 必须和ehcache缓存配置中的缓存name一致 |
| 161 | + this.cache = cacheManager.getCache(ShiroConstants.SYS_USERCACHE); |
| 162 | + } |
| 163 | +} |
0 commit comments