diff --git a/docs/README.md b/docs/README.md index a878144b4..87467da1f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -22,8 +22,6 @@ You use either of the following 2 ways to include `shiro-redis` into your projec > **Note:**\ > Do not use version < 3.1.0\ -> **注意**：\ -> 请不要使用3.1.0以下版本 ## shiro-core/jedis Version Comparison Charts diff --git a/src/integration-test/java/org/crazycake/shiro/RedisSessionDAOIntegrationTest.java b/src/integration-test/java/org/crazycake/shiro/RedisSessionDAOIntegrationTest.java index 13a99a298..b5dcdd6d5 100644 --- a/src/integration-test/java/org/crazycake/shiro/RedisSessionDAOIntegrationTest.java +++ b/src/integration-test/java/org/crazycake/shiro/RedisSessionDAOIntegrationTest.java @@ -5,6 +5,7 @@ import org.crazycake.shiro.common.SessionInMemory; import org.crazycake.shiro.exception.SerializationException; import org.crazycake.shiro.integration.fixture.model.FakeSession; +import org.crazycake.shiro.serializer.ObjectSerializer; import org.crazycake.shiro.serializer.StringSerializer; import org.junit.jupiter.api.AfterEach; import org.junit.jupiter.api.Assertions; @@ -16,6 +17,8 @@ import java.util.Map; import static org.crazycake.shiro.integration.fixture.TestFixture.*; +import static org.hamcrest.CoreMatchers.*; +import static org.hamcrest.MatcherAssert.assertThat; /** * RedisSessionDAO integration test was put under org.crazycake.shiro @@ -29,6 +32,9 @@ public class RedisSessionDAOIntegrationTest { private FakeSession emptySession; private String name1; private String prefix; + private StringSerializer keySerializer = new StringSerializer(); + private ObjectSerializer valueSerializer = new ObjectSerializer(); + private void blast() { blastRedis(); } @@ -136,4 +142,28 @@ public void testRemoveExpiredSessionInMemory() throws InterruptedException, Seri Map sessionMap = (Map) redisSessionDAO.getSessionsInThread().get(); assertEquals(sessionMap.size(), 1); } + + @Test + public void testTurnOffSessionInMemoryEnabled() throws InterruptedException, SerializationException { + redisSessionDAO.setSessionInMemoryTimeout(2000L); + session1.setCompany("apple"); + redisSessionDAO.doCreate(session1); + // Load session into SessionInThread + redisSessionDAO.doReadSession(session1.getId()); + // Directly update session in Redis + session1.setCompany("google"); + RedisManager redisManager = scaffoldStandaloneRedisManager(); + String sessionRedisKey = prefix + session1.getId(); + redisManager.set(keySerializer.serialize(sessionRedisKey), valueSerializer.serialize(session1), 10); + // Try to read session again + Thread.sleep(500); + FakeSession sessionFromThreadLocal = (FakeSession)redisSessionDAO.doReadSession(session1.getId()); + // The company should be the old value + assertThat(sessionFromThreadLocal.getCompany(), is("apple")); + // Turn off sessionInMemoryEnabled + redisSessionDAO.setSessionInMemoryEnabled(false); + // Try to read session again. It should get the version in Redis + FakeSession sessionFromRedis = (FakeSession)redisSessionDAO.doReadSession(session1.getId()); + assertThat(sessionFromRedis.getCompany(), is("google")); + } } diff --git a/src/integration-test/java/org/crazycake/shiro/integration/RedisCacheTest.java b/src/integration-test/java/org/crazycake/shiro/integration/RedisCacheTest.java index ae3d42a11..821717d03 100644 --- a/src/integration-test/java/org/crazycake/shiro/integration/RedisCacheTest.java +++ b/src/integration-test/java/org/crazycake/shiro/integration/RedisCacheTest.java @@ -116,7 +116,6 @@ public void testPutString() { public void testSize() throws InterruptedException { doPutAuth(redisCache, user1); doPutAuth(redisCache, user2); - Thread.sleep(800); assertEquals(redisCache.size(), 2); } diff --git a/src/integration-test/java/org/crazycake/shiro/integration/RedisManagerTest.java b/src/integration-test/java/org/crazycake/shiro/integration/RedisManagerTest.java index 91204954c..6d7936db1 100644 --- a/src/integration-test/java/org/crazycake/shiro/integration/RedisManagerTest.java +++ b/src/integration-test/java/org/crazycake/shiro/integration/RedisManagerTest.java @@ -1,12 +1,8 @@ package org.crazycake.shiro.integration; -import com.github.javafaker.Faker; -import org.apache.commons.lang3.math.NumberUtils; import org.apache.shiro.subject.PrincipalCollection; import org.apache.shiro.subject.SimplePrincipalCollection; -import org.crazycake.shiro.RedisCacheManager; import org.crazycake.shiro.RedisManager; -import org.crazycake.shiro.RedisSessionDAO; import org.crazycake.shiro.exception.SerializationException; import org.crazycake.shiro.integration.fixture.model.UserInfo; import org.crazycake.shiro.serializer.ObjectSerializer; diff --git a/src/integration-test/java/org/crazycake/shiro/integration/fixture/model/FakeSession.java b/src/integration-test/java/org/crazycake/shiro/integration/fixture/model/FakeSession.java index 9ad5a0ae2..0019affdc 100644 --- a/src/integration-test/java/org/crazycake/shiro/integration/fixture/model/FakeSession.java +++ b/src/integration-test/java/org/crazycake/shiro/integration/fixture/model/FakeSession.java @@ -11,6 +11,7 @@ public class FakeSession extends SimpleSession implements Serializable, Session{ private Integer id; private String name; + private String company; public FakeSession() {} @@ -35,6 +36,14 @@ public void setName(String name) { this.name = name; } + public String getCompany() { + return company; + } + + public void setCompany(String company) { + this.company = company; + } + @Override public Date getStartTimestamp() { return null; diff --git a/src/main/java/org/crazycake/shiro/RedisSessionDAO.java b/src/main/java/org/crazycake/shiro/RedisSessionDAO.java index d54c2e657..b24ad3a01 100644 --- a/src/main/java/org/crazycake/shiro/RedisSessionDAO.java +++ b/src/main/java/org/crazycake/shiro/RedisSessionDAO.java @@ -77,6 +77,9 @@ public class RedisSessionDAO extends AbstractSessionDAO { */ @Override public void update(Session session) throws UnknownSessionException { + if (this.sessionInMemoryEnabled) { + this.removeExpiredSessionInMemory(); + } this.saveSession(session); if (this.sessionInMemoryEnabled) { this.setSessionToThreadLocal(session.getId(), session); @@ -117,10 +120,16 @@ private void saveSession(Session session) throws UnknownSessionException { */ @Override public void delete(Session session) { + if (this.sessionInMemoryEnabled) { + this.removeExpiredSessionInMemory(); + } if (session == null || session.getId() == null) { logger.error("session or session id is null"); return; } + if (this.sessionInMemoryEnabled) { + this.delSessionFromThreadLocal(session.getId()); + } try { redisManager.del(keySerializer.serialize(getRedisSessionKey(session.getId()))); } catch (SerializationException e) { @@ -134,6 +143,9 @@ public void delete(Session session) { */ @Override public Collection getActiveSessions() { + if (this.sessionInMemoryEnabled) { + this.removeExpiredSessionInMemory(); + } Set sessions = new HashSet(); try { Set keys = redisManager.keys(keySerializer.serialize(this.keyPrefix + "*")); @@ -151,11 +163,14 @@ public Collection getActiveSessions() { @Override protected Serializable doCreate(Session session) { + if (this.sessionInMemoryEnabled) { + this.removeExpiredSessionInMemory(); + } if (session == null) { logger.error("session is null"); throw new UnknownSessionException("session is null"); } - Serializable sessionId = this.generateSessionId(session); + Serializable sessionId = this.generateSessionId(session); this.assignSessionId(session, sessionId); this.saveSession(session); return sessionId; @@ -168,47 +183,67 @@ protected Serializable doCreate(Session session) { */ @Override protected Session doReadSession(Serializable sessionId) { + if (this.sessionInMemoryEnabled) { + this.removeExpiredSessionInMemory(); + } if (sessionId == null) { logger.warn("session id is null"); return null; } - if (this.sessionInMemoryEnabled) { Session session = getSessionFromThreadLocal(sessionId); if (session != null) { return session; } } - Session session = null; - logger.debug("read session from redis"); try { - session = (Session) valueSerializer.deserialize(redisManager.get(keySerializer.serialize(getRedisSessionKey(sessionId)))); + String sessionRedisKey = getRedisSessionKey(sessionId); + logger.debug("read session: " + sessionRedisKey + " from Redis"); + session = (Session) valueSerializer.deserialize(redisManager.get(keySerializer.serialize(sessionRedisKey))); if (this.sessionInMemoryEnabled) { setSessionToThreadLocal(sessionId, session); } } catch (SerializationException e) { - logger.error("read session error. sessionId=" + sessionId); + logger.error("read session error. sessionId: " + sessionId); } return session; } - private void setSessionToThreadLocal(Serializable sessionId, Session s) { + private void setSessionToThreadLocal(Serializable sessionId, Session session) { + this.initSessionsInThread(); Map sessionMap = (Map) sessionsInThread.get(); - if (sessionMap == null) { - sessionMap = new HashMap(); - sessionsInThread.set(sessionMap); - } + sessionMap.put(sessionId, this.createSessionInMemory(session)); + } - removeExpiredSessionInMemory(sessionMap); + private void delSessionFromThreadLocal(Serializable sessionId) { + Map sessionMap = (Map) sessionsInThread.get(); + if (sessionMap == null) { + return; + } + sessionMap.remove(sessionId); + } + private SessionInMemory createSessionInMemory(Session session) { SessionInMemory sessionInMemory = new SessionInMemory(); sessionInMemory.setCreateTime(new Date()); - sessionInMemory.setSession(s); - sessionMap.put(sessionId, sessionInMemory); + sessionInMemory.setSession(session); + return sessionInMemory; + } + + private void initSessionsInThread() { + Map sessionMap = (Map) sessionsInThread.get(); + if (sessionMap == null) { + sessionMap = new HashMap(); + sessionsInThread.set(sessionMap); + } } - private void removeExpiredSessionInMemory(Map sessionMap) { + private void removeExpiredSessionInMemory() { + Map sessionMap = (Map) sessionsInThread.get(); + if (sessionMap == null) { + return; + } Iterator it = sessionMap.keySet().iterator(); while (it.hasNext()) { Serializable sessionId = it.next(); @@ -222,6 +257,9 @@ private void removeExpiredSessionInMemory(Map ses it.remove(); } } + if (sessionMap.size() == 0) { + sessionsInThread.remove(); + } } private Session getSessionFromThreadLocal(Serializable sessionId) { @@ -234,11 +272,6 @@ private Session getSessionFromThreadLocal(Serializable sessionId) { if (sessionInMemory == null) { return null; } - long liveTime = getSessionInMemoryLiveTime(sessionInMemory); - if (liveTime > sessionInMemoryTimeout) { - sessionMap.remove(sessionId); - return null; - } logger.debug("read session from memory"); return sessionInMemory.getSession(); diff --git a/src/main/java/org/crazycake/shiro/common/WorkAloneRedisManager.java b/src/main/java/org/crazycake/shiro/common/WorkAloneRedisManager.java index 1fe72fdf9..0ee340649 100644 --- a/src/main/java/org/crazycake/shiro/common/WorkAloneRedisManager.java +++ b/src/main/java/org/crazycake/shiro/common/WorkAloneRedisManager.java @@ -60,7 +60,7 @@ public byte[] get(byte[] key) { * set * @param key key * @param value value - * @param expireTime expire time + * @param expireTime expire time in second * @return value */ @Override