/*
|
* Copyright [2020-2030] [https://www.stylefeng.cn]
|
*
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
* you may not use this file except in compliance with the License.
|
* You may obtain a copy of the License at
|
*
|
* http://www.apache.org/licenses/LICENSE-2.0
|
*
|
* Unless required by applicable law or agreed to in writing, software
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
* See the License for the specific language governing permissions and
|
* limitations under the License.
|
*
|
* Guns采用APACHE LICENSE 2.0开源协议，您在使用过程中，需要注意以下几点：
|
*
|
* 1.请不要删除和修改根目录下的LICENSE文件。
|
* 2.请不要删除和修改Guns源码头部的版权声明。
|
* 3.请保留源码和相关描述文件的项目出处，作者声明等。
|
* 4.分发源码时候，请注明软件出处 https://gitee.com/stylefeng/guns
|
* 5.在修改包名，模块名称，项目代码等时，请注明软件出处 https://gitee.com/stylefeng/guns
|
* 6.若您的项目无法满足以上几点，可申请商业授权
|
*/
|
package cn.stylefeng.roses.kernel.auth.session;
|
|
import cn.hutool.core.bean.BeanUtil;
|
import cn.hutool.core.convert.Convert;
|
import cn.hutool.core.util.ObjectUtil;
|
import cn.hutool.core.util.StrUtil;
|
import cn.stylefeng.roses.kernel.auth.api.SessionManagerApi;
|
import cn.stylefeng.roses.kernel.auth.api.cookie.SessionCookieCreator;
|
import cn.stylefeng.roses.kernel.auth.api.expander.AuthConfigExpander;
|
import cn.stylefeng.roses.kernel.auth.api.pojo.login.LoginUser;
|
import cn.stylefeng.roses.kernel.cache.api.CacheOperatorApi;
|
import cn.stylefeng.roses.kernel.message.api.expander.WebSocketConfigExpander;
|
import cn.stylefeng.roses.kernel.rule.callback.ConfigUpdateCallback;
|
import cn.stylefeng.roses.kernel.rule.util.HttpServletUtil;
|
|
import javax.servlet.http.Cookie;
|
import javax.servlet.http.HttpServletResponse;
|
import java.util.*;
|
|
import static cn.stylefeng.roses.kernel.message.api.constants.MessageConstants.WEB_SOCKET_WS_URL_CONFIG_CODE;
|
|
/**
|
* 基于redis的会话管理
|
*
|
* @author fengshuonan
|
* @date 2019-09-28-14:43
|
*/
|
public class DefaultSessionManager implements SessionManagerApi, ConfigUpdateCallback {
|
|
/**
|
* 登录用户缓存
|
* <p>
|
* key是 LOGGED_TOKEN_PREFIX + 用户的token
|
*/
|
private final CacheOperatorApi<LoginUser> loginUserCache;
|
|
/**
|
* 用户token的缓存，这个缓存用来存储一个用户的所有token
|
* <p>
|
* 没开启单端限制的话，一个用户可能有多个token，因为一个用户可能在多个地点或打开多个浏览器访问系统
|
* <p>
|
* key是 LOGGED_USERID_PREFIX + 用户id
|
* <p>
|
* 这个缓存应该定时刷新下，因为有过期token的用户，所以这个里边的值set得清理
|
*/
|
private final CacheOperatorApi<Set<String>> allPlaceLoginTokenCache;
|
|
/**
|
* session的超时时间
|
*/
|
private final Long sessionExpiredSeconds;
|
|
/**
|
* cookie的创建器，用在session创建时，给response添加cookie
|
*/
|
private final SessionCookieCreator sessionCookieCreator;
|
|
public DefaultSessionManager(CacheOperatorApi<LoginUser> loginUserCache,
|
CacheOperatorApi<Set<String>> allPlaceLoginTokenCache,
|
Long sessionExpiredSeconds,
|
SessionCookieCreator sessionCookieCreator) {
|
this.loginUserCache = loginUserCache;
|
this.allPlaceLoginTokenCache = allPlaceLoginTokenCache;
|
this.sessionExpiredSeconds = sessionExpiredSeconds;
|
this.sessionCookieCreator = sessionCookieCreator;
|
}
|
|
@Override
|
public void createSession(String token, LoginUser loginUser, Boolean createCookie) {
|
|
// 装配用户信息的缓存
|
loginUserCache.put(token, loginUser, sessionExpiredSeconds);
|
|
// 装配用户token的缓存
|
Set<String> theUserTokens = allPlaceLoginTokenCache.get(loginUser.getUserId().toString());
|
if (theUserTokens == null) {
|
theUserTokens = new HashSet<>();
|
}
|
theUserTokens.add(token);
|
allPlaceLoginTokenCache.put(loginUser.getUserId().toString(), theUserTokens);
|
|
// 如果开启了cookie存储会话信息，则需要给HttpServletResponse添加一个cookie
|
if (createCookie) {
|
String sessionCookieName = AuthConfigExpander.getSessionCookieName();
|
Cookie cookie = sessionCookieCreator.createCookie(sessionCookieName, token, Convert.toInt(AuthConfigExpander.getAuthJwtTimeoutSeconds()));
|
HttpServletResponse response = HttpServletUtil.getResponse();
|
response.addCookie(cookie);
|
}
|
|
}
|
|
@Override
|
public void updateSession(String token, LoginUser loginUser) {
|
if (StrUtil.isEmpty(token) || ObjectUtil.isEmpty(loginUser)) {
|
return;
|
}
|
loginUserCache.put(token, loginUser, sessionExpiredSeconds);
|
}
|
|
@Override
|
public LoginUser getSession(String token) {
|
return loginUserCache.get(token);
|
}
|
|
@Override
|
public void removeSession(String token) {
|
|
LoginUser loginUser = loginUserCache.get(token);
|
|
// 删除本token用户信息的缓存
|
loginUserCache.remove(token);
|
|
// 删除多端登录信息
|
if (loginUser != null) {
|
Long userId = loginUser.getUserId();
|
Set<String> userTokens = allPlaceLoginTokenCache.get(userId.toString());
|
if (userTokens != null) {
|
|
// 清除对应的token的信息
|
userTokens.remove(token);
|
allPlaceLoginTokenCache.put(userId.toString(), userTokens);
|
|
// 如果删除后size为0，则把整个key删掉
|
if (userTokens.size() == 0) {
|
allPlaceLoginTokenCache.remove(userId.toString());
|
}
|
}
|
}
|
}
|
|
@Override
|
public void removeSessionExcludeToken(String token) {
|
|
// 获取token对应的会话
|
LoginUser session = this.getSession(token);
|
|
// 如果会话为空，直接返回
|
if (session == null) {
|
return;
|
}
|
|
// 获取用户id
|
Long userId = session.getUserId();
|
|
// 获取这个用户多余的几个登录信息
|
Set<String> thisUserTokens = allPlaceLoginTokenCache.get(userId.toString());
|
for (String thisUserToken : thisUserTokens) {
|
if (!thisUserToken.equals(token)) {
|
loginUserCache.remove(thisUserToken);
|
}
|
}
|
|
// 设置用户id对应的token列表为参数token
|
HashSet<String> tokenSet = new HashSet<>();
|
tokenSet.add(token);
|
allPlaceLoginTokenCache.put(userId.toString(), tokenSet);
|
}
|
|
@Override
|
public boolean haveSession(String token) {
|
return loginUserCache.contains(token);
|
}
|
|
@Override
|
public void refreshSession(String token) {
|
LoginUser loginUser = loginUserCache.get(token);
|
if (loginUser != null) {
|
loginUserCache.expire(token, sessionExpiredSeconds);
|
}
|
}
|
|
@Override
|
public void destroySessionCookie() {
|
// 如果开启了cookie存储会话信息，则需要给HttpServletResponse添加一个cookie
|
String sessionCookieName = AuthConfigExpander.getSessionCookieName();
|
Cookie cookie = sessionCookieCreator.createCookie(sessionCookieName, null, 0);
|
HttpServletResponse response = HttpServletUtil.getResponse();
|
response.addCookie(cookie);
|
}
|
|
@Override
|
public List<LoginUser> onlineUserList() {
|
Map<String, LoginUser> allKeyValues = loginUserCache.getAllKeyValues();
|
|
ArrayList<LoginUser> loginUsers = new ArrayList<>();
|
for (Map.Entry<String, LoginUser> userEntry : allKeyValues.entrySet()) {
|
String token = userEntry.getKey();
|
LoginUser loginUser = userEntry.getValue();
|
LoginUser tempUser = new LoginUser();
|
BeanUtil.copyProperties(loginUser, tempUser);
|
tempUser.setToken(token);
|
loginUsers.add(tempUser);
|
}
|
|
return loginUsers;
|
}
|
|
@Override
|
public void configUpdate(String code, String value) {
|
// 如果系统配置修改了websocket url，则刷新所有在线用户的配置
|
if (WEB_SOCKET_WS_URL_CONFIG_CODE.equals(code)) {
|
Map<String, LoginUser> allKeyValues = loginUserCache.getAllKeyValues();
|
for (LoginUser loginUser : allKeyValues.values()) {
|
loginUser.setWsUrl(WebSocketConfigExpander.getWebSocketWsUrl());
|
this.updateSession(loginUser.getToken(), loginUser);
|
}
|
}
|
}
|
}
|
