SpringSession系列-儲存機制之Redis&Map

glmapper發表於2018-12-15
SpringGseSessionRedis

在之前的文章中已經對SpringSession的功能結構，請求/響應重寫等做了介紹。本文將繼續來介紹下SpringSession中儲存部分的設計。儲存是分散式session中算是最核心的部分，通過引入三方的儲存容器來實現session的儲存，從而有效的解決session共享的問題。

1、SpringSession儲存的頂級抽象介面

SpringSession儲存的頂級抽象介面是org.springframework.session包下的SessionRepository這個介面。SessionRepository的類圖結構如下：

SpringSession系列-儲存機制之Redis&Map

這裡先來看下SessionRepository這個頂層介面中定義了哪些方法：

public interface SessionRepository<S extends Session> {
    //建立一個session
	S createSession();
	//儲存session
	void save(S session);
	//通過ID查詢session
	S findById(String id);
	//通過ID刪除一個session
	void deleteById(String id);
}
複製程式碼

從程式碼來看還是很簡單的，就是增刪查。下面看具體實現。在2.0版本開始SpringSession中也提供了一個和SessionRepository具體相同能力的ReactiveSessionRepository，用於支援響應式程式設計模式。

2、MapSessionRepository

基於HashMap實現的基於記憶體儲存的儲存器實現，這裡就主要看下對於介面中幾個方法的實現。

public class MapSessionRepository implements SessionRepository<MapSession> {
	private Integer defaultMaxInactiveInterval;
	private final Map<String, Session> sessions;
	//...
}
複製程式碼

可以看到就是一個Map，那後面關於增刪查其實就是操作這個Map了。

createSession

@Override
public MapSession createSession() {
	MapSession result = new MapSession();
	if (this.defaultMaxInactiveInterval != null) {
		result.setMaxInactiveInterval(
			Duration.ofSeconds(this.defaultMaxInactiveInterval));
	}
	return result;
}
複製程式碼

這裡很直接，就是new了一個MapSession，然後設定了session的有效期。

save

@Override
public void save(MapSession session) {
	if (!session.getId().equals(session.getOriginalId())) {
		this.sessions.remove(session.getOriginalId());
	}
	this.sessions.put(session.getId(), new MapSession(session));
}
複製程式碼

這裡面先判斷了session中的兩個ID，一個originalId，一個當前id。originalId是第一次生成session物件時建立的，後面都不會在變化。通過原始碼來看，對於originalId，只提供了get方法。對於id呢，其實是可以通過changeSessionId來改變的。

這裡的這個操作實際上是一種優化行為，及時的清除掉老的session資料來釋放記憶體空間。

findById

@Override
public MapSession findById(String id) {
	Session saved = this.sessions.get(id);
	if (saved == null) {
		return null;
	}
	if (saved.isExpired()) {
		deleteById(saved.getId());
		return null;
	}
	return new MapSession(saved);
}
複製程式碼

這個邏輯也很簡單，先從Map中根據id取出session資料，如果沒有就返回null，如果有則再判斷下是否過期了，如果過期了就刪除掉，然後返回null。如果查到了，並且沒有過期的話，則構建一個MapSession返回。

OK，基於記憶體儲存的實現系列就是這些了，下面繼續來看其他儲存的實現。

3、FindByIndexNameSessionRepository

FindByIndexNameSessionRepository繼承了SessionRepository介面，用於擴充套件對第三方儲存的實現。

public interface FindByIndexNameSessionRepository<S extends Session>
		extends SessionRepository<S> {
		
	String PRINCIPAL_NAME_INDEX_NAME = FindByIndexNameSessionRepository.class.getName()
			.concat(".PRINCIPAL_NAME_INDEX_NAME");

	Map<String, S> findByIndexNameAndIndexValue(String indexName, String indexValue);

	default Map<String, S> findByPrincipalName(String principalName) {
		return findByIndexNameAndIndexValue(PRINCIPAL_NAME_INDEX_NAME, principalName);
	}
}
複製程式碼

FindByIndexNameSessionRepository新增一個單獨的方法為指定使用者查詢所有會話。這是通過設定名為FindByIndexNameSessionRepository.PRINCIPAL_NAME_INDEX_NAME的Session的屬性值為指定使用者的username來完成的。開發人員有責任確保屬性被賦值，因為SpringSession不會在意被使用的認證機制。官方文件中給出的例子如下：

String username = "username";
this.session.setAttribute(
	FindByIndexNameSessionRepository.PRINCIPAL_NAME_INDEX_NAME, username);
複製程式碼

FindByIndexNameSessionRepository的一些實現會提供一些鉤子自動的索引其他的session屬性。比如，很多實現都會自動的確保當前的Spring Security使用者名稱稱可通過索引名稱FindByIndexNameSessionRepository.PRINCIPAL_NAME_INDEX_NAME進行索引。一旦會話被索引，就可以通過下面的程式碼檢索：

String username = "username";
Map<String, Session> sessionIdToSession = 
	this.sessionRepository.findByIndexNameAndIndexValue(
	FindByIndexNameSessionRepository.PRINCIPAL_NAME_INDEX_NAME,username);
複製程式碼

下圖是FindByIndexNameSessionRepository介面的三個實現類：

FindByIndexNameSessionRepository

下面來分別分析下這三個儲存的實現細節。

3.1 RedisOperationsSessionRepository

RedisOperationsSessionRepository的類圖結構如下，MessageListener是redis訊息訂閱的監聽介面。

在這裡插入圖片描述

程式碼有點長，就不在這裡面貼了，一些註釋可以在這個 SpringSession中文分支 來看。這裡還是主要來看下對於那幾個方法的實現。

3.1.1 createSession

這裡和MapSessionRepository的實現基本一樣的，那區別就在於Session的封裝模型不一樣，這裡是RedisSession，實際上RedisSession的實現是對MapSession又包了一層。下面會分析RedisSession這個類。

@Override
public RedisSession createSession() { 
    // RedisSession,這裡和MapSession區別開
	RedisSession redisSession = new RedisSession();
	if (this.defaultMaxInactiveInterval != null) {
		redisSession.setMaxInactiveInterval(
				Duration.ofSeconds(this.defaultMaxInactiveInterval));
	}
	return redisSession;
}
複製程式碼

在看其他兩個方法之前，先來看下RedisSession這個類。

3.1.2 RedisSession

這個在模型上是對MapSession的擴充套件，增加了delta這個東西。

final class RedisSession implements Session {
       // MapSession 例項物件，主要存資料的地方
		private final MapSession cached;
		// 原始最後訪問時間
		private Instant originalLastAccessTime;
		private Map<String, Object> delta = new HashMap<>();
		// 是否是新的session物件
		private boolean isNew;
		// 原始主名稱
		private String originalPrincipalName;
		// 原始sessionId
		private String originalSessionId;
複製程式碼

delta是一個Map結構，那麼這裡面到底是放什麼的呢？具體細節見 saveDelta 這個方法。saveDelta 這個方法會在兩個地方被呼叫，一個是下面要說道的save方法，另外一個是 flushImmediateIfNecessary 這個方法：

private void flushImmediateIfNecessary() {
	if (RedisOperationsSessionRepository.this.redisFlushMode == RedisFlushMode.IMMEDIATE) {
		saveDelta();
	}
}
複製程式碼

RedisFlushMode提供了兩種推送模式：

  • ON_SAVE：只有在呼叫save方法時執行，在web環境中這樣做通常是儘快提交HTTP響應
  • IMMEDIATE：只要有變更就會直接寫到redis中，不會像ON_SAVE一樣，在最後commit時一次性寫入

追蹤flushImmediateIfNecessary 方法呼叫鏈如下：

在這裡插入圖片描述
那麼到這裡基本就清楚了，首先save這個方法，當主動呼叫save時就是將資料推到redis中去的，也就是ON_SAVE這種情況。那麼對於IMMEDIATE這種情況，只有呼叫了上面的四個方法，SpringSession 才會將資料推送到redis。

所以delta裡面存的是當前一些變更的 key-val 鍵值物件，而這些變更是由setAttribute、removeAttribute、setMaxInactiveIntervalInSeconds、setLastAccessedTime這四個方法觸發的；比如setAttribute(k,v)，那麼這個k->v就會被儲存到delta裡面。

3.1.3 save

在理解了saveDelta方法之後再來看save方法就簡單多了。save 對應的就是RedisFlushMode.ON_SAVE。

@Override
public void save(RedisSession session) {
   // 直接呼叫 saveDelta推資料到redis
	session.saveDelta();
	if (session.isNew()) {
	   // sessionCreatedKey->channl
		String sessionCreatedKey = getSessionCreatedChannel(session.getId());
		// 釋出一個訊息事件，新增 session，以供 MessageListener 回撥處理。
		this.sessionRedisOperations.convertAndSend(sessionCreatedKey, session.delta);
		session.setNew(false);
	}
}
複製程式碼

3.1.4 findById

查詢這部分和基於Map的差別比較大，因為這裡並不是直接操作Map，而是與Redis 進行一次互動。

@Override
public RedisSession findById(String id) {
	return getSession(id, false);
}
複製程式碼

呼叫getSession方法：

private RedisSession getSession(String id, boolean allowExpired) {
	// 根據ID從redis中取出資料
	Map<Object, Object> entries = getSessionBoundHashOperations(id).entries();
	if (entries.isEmpty()) {
		return null;
	}
	//轉換成MapSession
	MapSession loaded = loadSession(id, entries);
	if (!allowExpired && loaded.isExpired()) {
		return null;
	}
	//轉換成RedisSession
	RedisSession result = new RedisSession(loaded);
	result.originalLastAccessTime = loaded.getLastAccessedTime();
	return result;
}
複製程式碼

loadSession中構建MapSession：

private MapSession loadSession(String id, Map<Object, Object> entries) {
   // 生成MapSession例項
	MapSession loaded = new MapSession(id);
	//遍歷資料
	for (Map.Entry<Object, Object> entry : entries.entrySet()) {
		String key = (String) entry.getKey();
		if (CREATION_TIME_ATTR.equals(key)) {
		    // 設定建立時間
			loaded.setCreationTime(Instant.ofEpochMilli((long) entry.getValue()));
		}
		else if (MAX_INACTIVE_ATTR.equals(key)) {
			 // 設定最大有效時間
			loaded.setMaxInactiveInterval(Duration.ofSeconds((int) entry.getValue()));
		}
		else if (LAST_ACCESSED_ATTR.equals(key)) {
			// 設定最後訪問時間
			loaded.setLastAccessedTime(Instant.ofEpochMilli((long) entry.getValue()));
		}
		else if (key.startsWith(SESSION_ATTR_PREFIX)) {
		// 設定屬性
			loaded.setAttribute(key.substring(SESSION_ATTR_PREFIX.length()),
					entry.getValue());
		}
	}
	return loaded;
}
複製程式碼

3.1.5 deleteById

根據sessionId刪除session資料。具體過程看程式碼註釋。

@Override
public void deleteById(String sessionId) {
   // 獲取 RedisSession
	RedisSession session = getSession(sessionId, true);
	if (session == null) {
		return;
	}
   // 清楚當前session資料的索引
	cleanupPrincipalIndex(session);
	//執行刪除操作
	this.expirationPolicy.onDelete(session);
	String expireKey = getExpiredKey(session.getId());
	//刪除expireKey
	this.sessionRedisOperations.delete(expireKey);
	//session有效期設定為0
	session.setMaxInactiveInterval(Duration.ZERO);
	save(session);
}
複製程式碼

3.1.6 onMessage

最後來看下這個訂閱回撥處理。這裡看下核心的一段邏輯：

boolean isDeleted = channel.equals(this.sessionDeletedChannel);
// Deleted 還是 Expired ？
if (isDeleted || channel.equals(this.sessionExpiredChannel)) {
	// 此處省略無關程式碼
	// Deleted
	if (isDeleted) {
	   // 釋出一個 SessionDeletedEvent 事件
		handleDeleted(session);
	}
	// Expired
	else {
		// 釋出一個 SessionExpiredEvent 事件
		handleExpired(session);
	}
}
複製程式碼

3.2 Redis 儲存的一些思考

首先按照我們自己常規的思路來設計的話，我們會怎麼來考慮這個事情。這裡首先要宣告下，我對 Redis 這個東西不是很熟，沒有做過深入的研究；那如果是我來做，可能也就僅僅限於儲存。

  • findByIndexNameAndIndexValue的設計，這個的作用是通過indexName和indexValue來返回當前使用者的所有會話。但是這裡需要考慮的一個事情是，通常情況下，一個使用者只會關聯到一個會話上面去，那這種設計很顯然，我的理解是為了支援單使用者多會話的場景。
    • indexName：FindByIndexNameSessionRepository.PRINCIPAL_NAME_INDEX_NAME
    • indexValue：username
  • 實現 MessageListener 介面，增加事件通知能力。通過監聽這些事件，可以做一些session操作管控。但是實際上 SpringSession 中並沒有做任何事情，從程式碼來看，publishEvent方法是空實現。等待回覆中 #issue 1287
private ApplicationEventPublisher eventPublisher = new ApplicationEventPublisher() {
	@Override
	public void publishEvent(ApplicationEvent event) {
	}
	@Override
	public void publishEvent(Object event) {
	}
};
複製程式碼
  • RedisFlushMode ，SpringSession中提供了兩種模式的推送，一種是ON_SAVE，另外一種是IMMEDIATE。預設是ON_SAVE，也就是常規的在請求處理結束時進行一次sessionCommit操作。RedisFlushMode 的設計感覺是為session資料持久化的時機提供了另外一種思路。

小結

儲存機制設計部分就一基於記憶體和基於Redis兩種來分析；另外基於jdbc和hazelcast有興趣的同學可以自己檢視原始碼。

最後也歡迎訪問我的個人部落格：www.glmapper.com

參考

相關文章