Spring Boot(三)：Spring Boot 中 Redis 的使用

純潔的微笑發表於2016-08-08
Spring BootRedis

Spring Boot 對常用的資料庫支援外，對 Nosql 資料庫也進行了封裝自動化。

Redis 介紹

Redis 是目前業界使用最廣泛的記憶體資料儲存。相比 Memcached，Redis 支援更豐富的資料結構，例如 hashes, lists, sets 等，同時支援資料持久化。除此之外，Redis 還提供一些類資料庫的特性，比如事務，HA，主從庫。可以說 Redis 兼具了快取系統和資料庫的一些特性，因此有著豐富的應用場景。本文介紹 Redis 在 Spring Boot 中兩個典型的應用場景。

如何使用

1、引入依賴包

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-pool2</artifactId>
</dependency>

Spring Boot 提供了對 Redis 整合的元件包：spring-boot-starter-data-redis，spring-boot-starter-data-redis依賴於spring-data-redis 和 lettuce 。Spring Boot 1.0 預設使用的是 Jedis 客戶端，2.0 替換成 Lettuce，但如果你從 Spring Boot 1.5.X 切換過來，幾乎感受不大差異，這是因為 spring-boot-starter-data-redis 為我們隔離了其中的差異性。

Lettuce 是一個可伸縮執行緒安全的 Redis 客戶端，多個執行緒可以共享同一個 RedisConnection，它利用優秀 netty NIO 框架來高效地管理多個連線。

2、新增配置檔案

# Redis資料庫索引（預設為0）
spring.redis.database=0  
# Redis伺服器地址
spring.redis.host=localhost
# Redis伺服器連線埠
spring.redis.port=6379  
# Redis伺服器連線密碼（預設為空）
spring.redis.password=
# 連線池最大連線數（使用負值表示沒有限制） 預設 8
spring.redis.lettuce.pool.max-active=8
# 連線池最大阻塞等待時間（使用負值表示沒有限制） 預設 -1
spring.redis.lettuce.pool.max-wait=-1
# 連線池中的最大空閒連線 預設 8
spring.redis.lettuce.pool.max-idle=8
# 連線池中的最小空閒連線 預設 0
spring.redis.lettuce.pool.min-idle=0

3、新增 cache 的配置類

@Configuration
@EnableCaching
public class RedisConfig extends CachingConfigurerSupport{
    
    @Bean
    public KeyGenerator keyGenerator() {
        return new KeyGenerator() {
            @Override
            public Object generate(Object target, Method method, Object... params) {
                StringBuilder sb = new StringBuilder();
                sb.append(target.getClass().getName());
                sb.append(method.getName());
                for (Object obj : params) {
                    sb.append(obj.toString());
                }
                return sb.toString();
            }
        };
    }
}

注意我們使用了註解：@EnableCaching來開啟快取。

3、好了，接下來就可以直接使用了

@RunWith(SpringRunner.class)
@SpringBootTest
public class TestRedis {
    @Autowired
    private StringRedisTemplate stringRedisTemplate;
    @Autowired
    private RedisTemplate redisTemplate;

    @Test
    public void test() throws Exception {
        stringRedisTemplate.opsForValue().set("aaa", "111");
        Assert.assertEquals("111", stringRedisTemplate.opsForValue().get("aaa"));
    }
    
    @Test
    public void testObj() throws Exception {
        User user=new User("aa@126.com", "aa", "aa123456", "aa","123");
        ValueOperations<String, User> operations=redisTemplate.opsForValue();
        operations.set("com.neox", user);
        operations.set("com.neo.f", user,1, TimeUnit.SECONDS);
        Thread.sleep(1000);
        //redisTemplate.delete("com.neo.f");
        boolean exists=redisTemplate.hasKey("com.neo.f");
        if(exists){
            System.out.println("exists is true");
        }else{
            System.out.println("exists is false");
        }
       // Assert.assertEquals("aa", operations.get("com.neo.f").getUserName());
    }
}

以上都是手動使用的方式，如何在查詢資料庫的時候自動使用快取呢，看下面；

4、自動根據方法生成快取

@RestController
public class UserController {

    @RequestMapping("/getUser")
    @Cacheable(value="user-key")
    public User getUser() {
        User user=new User("aa@126.com", "aa", "aa123456", "aa","123");
        System.out.println("若下面沒出現“無快取的時候呼叫”字樣且能列印出資料表示測試成功");
        return user;
    }
}

其中 value 的值就是快取到 Redis 中的 key

共享 Session

分散式系統中，Session 共享有很多的解決方案，其中託管到快取中應該是最常用的方案之一，

Spring Session 官方說明

Spring Session provides an API and implementations for managing a user’s session information.

Spring Session 提供了一套建立和管理 Servlet HttpSession 的方案。Spring Session 提供了叢集 Session（Clustered Sessions）功能，預設採用外接的 Redis 來儲存 Session 資料，以此來解決 Session 共享的問題。

如何使用

1、引入依賴

<dependency>
    <groupId>org.springframework.session</groupId>
    <artifactId>spring-session-data-redis</artifactId>
</dependency>

2、Session 配置：

@Configuration
@EnableRedisHttpSession(maxInactiveIntervalInSeconds = 86400*30)
public class SessionConfig {
}

maxInactiveIntervalInSeconds: 設定 Session 失效時間，使用 Redis Session 之後，原 Spring Boot 的 server.session.timeout 屬性不再生效。

好了，這樣就配置好了，我們來測試一下

3、測試

新增測試方法獲取 sessionid

@RequestMapping("/uid")
String uid(HttpSession session) {
    UUID uid = (UUID) session.getAttribute("uid");
    if (uid == null) {
        uid = UUID.randomUUID();
    }
    session.setAttribute("uid", uid);
    return session.getId();
}

登入 Redis 輸入 keys '*sessions*'

t<spring:session:sessions:db031986-8ecc-48d6-b471-b137a3ed6bc4
t(spring:session:expirations:1472976480000

其中 1472976480000 為失效時間，意思是這個時間後 Session 失效，db031986-8ecc-48d6-b471-b137a3ed6bc4 為 sessionId,登入 http://localhost:8080/uid 發現會一致，就說明 Session 已經在 Redis 裡面進行有效的管理了。

如何在兩臺或者多臺中共享 Session

其實就是按照上面的步驟在另一個專案中再次配置一次，啟動後自動就進行了 Session 共享。

示例程式碼-github

示例程式碼-碼雲

文章內容已經升級到 Spring Boot 2.x

參考

Redis的兩個典型應用場景
SpringBoot應用之分散式會話

相關文章