Spring Boot（十一）Redis整合從Docker安裝到分散式Session共享

王磊的部落格發表於2018-11-03
Spring BootRedisDocker分散式Session

一、簡介

Redis是一個開源的使用ANSI C語言編寫、支援網路、可基於記憶體亦可持久化的日誌型、Key-Value資料庫，並提供多種語言的API，Redis也是技術領域使用最為廣泛的儲存中介軟體，它是「Remote Dictionary Service」首字母縮寫，也就是「遠端字典服務」。

Redis相比Memcached提供更多的資料型別支援和資料持久化操作。

二、在Docker中安裝Redis

2.1 下載映象

訪問官網：hub.docker.com/r/library/r… 選擇下載版本，本文選擇最新Stable 4.0.11

使用命令拉取映象：

docker pull redis:4.0.11

2.2 啟動容器

啟動Redis命令如下：

docker run --name myredis -p 6379:6379 -d redis:4.0.11 redis-server --appendonly yes

命令說明：

  • --name 設定別名
  • -p 對映宿主埠到容器埠
  • -d 後臺執行
  • redis-server --appendonly yes 在容器啟動執行redis-server啟動命令，開啟redis持久化

啟動成功之後使用命令：

docker ps

檢視redis執行請求，如下圖為執行成功：

Spring Boot（十一）Redis整合從Docker安裝到分散式Session共享

2.3 使用客戶端連線

連線Redis不錯的GUI工具應該是Redis Desktop Manager了，不過現在只有Linux版可以免費下載，我上傳了一個Windows版本在百度雲，版本號為：0.9.5（釋出於2018.08.24）也是比較新的，連結: pan.baidu.com/s/16npZtnGa… 密碼: 9uqg，還是免安裝的，很好用。

Redis Desktop Manager客戶端預覽：

Spring Boot（十一）Redis整合從Docker安裝到分散式Session共享

三、Redis整合

開發環境

  • Spring Boot 2.0.4 RELEASE
  • Manven

3.1 新增依賴

在pom.xml新增如下依賴：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
複製程式碼

注意不要依賴“spring-boot-starter-redis”它是舊版本，新版已經遷移到“spring-boot-starter-data-redis”了。

3.2 配置Redis

在application.properties進行如下設定：

# Redis 配置
# Redis伺服器地址
spring.redis.host=127.0.0.1
# Redis伺服器連線密碼（預設為空）
spring.redis.password=
# Redis伺服器連線埠
spring.redis.port=6379  
# Redis分片（預設為0）Redis預設有16個分片
spring.redis.database=0
# 連線池最大連線數（使用負值表示沒有限制）
spring.redis.pool.max-active=8  
# 連線池最大阻塞等待時間（使用負值表示沒有限制）
spring.redis.pool.max-wait=-1  
# 連線池中的最大空閒連線
spring.redis.pool.max-idle=8  
# 連線池中的最小空閒連線
spring.redis.pool.min-idle=0  
# 連線超時時間（毫秒）
spring.redis.timeout=10000
# 指定spring的快取為redis
spring.cache.type=redis
複製程式碼

注意：spring.redis.timeout不要設定為0，設定為0查詢Redis時會報錯，因為查詢連線時間太短了。

3.3 Redis使用

完成以上配置之後就可以寫程式碼操作Redis了，示例程式碼如下：

@Autowired
private StringRedisTemplate stringRedisTemplate;

@RequestMapping("/")
public String doTest() {
    String _key = "time"; //快取key
    stringRedisTemplate.opsForValue().set(_key, String.valueOf(new Date().getTime())); //redis存值
    return stringRedisTemplate.opsForValue().get(_key); //redis取值
}
複製程式碼

更多操作：

  • stringRedisTemplate.opsForValue().set("test", "100",60*10,TimeUnit.SECONDS); 向redis裡存入資料和設定快取時間；
  • stringRedisTemplate.hasKey("keyName"); 檢查key是否存在，返回boolean；

四、宣告式快取

為了簡化快取可以直接使用聲名式快取，可以省去設定快取和讀取快取的程式碼，使用起來會方便很多。

宣告式快取使用步驟如下：

4.1 設定Redis快取

在pom.xml檔案設定快取為Redis，程式碼如下：

spring.cache.type=redis

4.2 開啟全域性快取

在啟動檔案Application.java設定開啟快取，程式碼如下：

@SpringBootApplication
@EnableCaching
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}
複製程式碼

4.3 使用註解

註解如下：

  • @Cacheable 設定並讀取快取（第一次設定以後直接讀取）；
  • @CachePut 更新快取（每次刪除並更新快取結果）；
  • @CacheEvict 刪除快取（只刪除快取）；

通用屬性：

  • value 快取名稱；
  • key 使用SpEL表示式自定義的快取Key，比如：#name是以引數name為key的快取，#resule.name是以返回結果的name作為key的快取；

4.3.1 @Cacheable 使用

示例程式碼如下：

// 快取key
private final String _CacheKey = "userCacheKeyTime";
    
@RequestMapping("/")
@Cacheable(value = _CacheKey)
public String index() {
    System.out.println("set cache");
    return "cache:" + new Date().getTime();
}
複製程式碼

只有首次訪問的時候會在控制檯列印“set cache”資訊，之後直接返回Redis結果了，不會在有新增的列印資訊出現。

4.3.2 @CachePut 使用

示例程式碼如下：

// 快取key
private final String _CacheKey = "userCacheKeyTime";

@RequestMapping("/put")
@CachePut(value = _CacheKey)
public String putCache() {
    System.out.println("update cache");
    return "update cache:" + new Date().getTime();
}
複製程式碼

訪問http://xxx/put 每次會把最新的資料儲存快取起來。

4.3.3 @CacheEvict 使用

示例程式碼如下：

// 快取key
private final String _CacheKey = "userCacheKeyTime";

@RequestMapping("/del")
@CacheEvict(value = _CacheKey)
public String delCache() {
    System.out.println("快取刪除");
    return "delete cache:" + new Date().getTime();
}
複製程式碼

訪問http://xxx/del 只會刪除快取，除此之後不會進行任何操作。

五、分散式Session共享

在分散式系統中Session共享有很多種方案，而把Session託管在快取中是最常用的方案之一，下面來看Session在Redis中的託管步驟。

5.1 新增依賴

在pom.xml中新增如下引用：

<dependency>
    <groupId>org.springframework.session</groupId>
    <artifactId>spring-session-data-redis</artifactId>
</dependency>
複製程式碼

5.2 開啟Session功能

在啟動類Application.java的類註解新增開啟Session，程式碼如下：

@SpringBootApplication
@EnableCaching
@EnableRedisHttpSession(maxInactiveIntervalInSeconds = 1800)
public class RedisApplication {
    public static void main(String[] args) {
        SpringApplication.run(RedisApplication.class, args);
    }
}
複製程式碼

其中maxInactiveIntervalInSeconds為Session過期時間，預設30分鐘，設定單位為秒。

5.3 Session使用

接下來編寫一段程式碼來測試一下Session，示例程式碼如下：

@RequestMapping("/uid")
public String testSession(HttpSession session) {
    UUID uid = (UUID) session.getAttribute("uid");
    if (uid == null) {
        uid = UUID.randomUUID();
    }
    session.setAttribute("uid", uid);
    
    return session.getId();
}
複製程式碼

連續訪問兩次請求之後，檢視控制檯資訊如下圖：

Spring Boot（十一）Redis整合從Docker安裝到分散式Session共享

可以看出，兩次訪問的SessionId是一樣的，這個時候在檢視Redis 客戶端，如下圖：

Spring Boot（十一）Redis整合從Docker安裝到分散式Session共享

發現Redis裡儲存的Session過期時間也是對的，符合我們的設定。

5.4 分散式系統共享Session

因為把Session託管給同一臺Redis伺服器了，所以Session在Spring Boot中按照如上方式在配置多臺伺服器，得到的Session是一樣的。

示例原始碼下載：github.com/vipstone/sp…

參考資料

Spring boot中Redis的使用：www.ityouknow.com/springboot/…

相關文章