巧用Spring Boot中的Redis

本篇文章轉載自巧用Spring Boot中的Redis

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來開啓緩存。

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

@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("[email protected]", "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());
    }
}

以上都是手動使用的方式，如何在查找數據庫的時候自動使用緩存呢，看下面；

5、自動根據方法生成緩存

@RestController
public class UserController {

    @RequestMapping("/getUser")
    @Cacheable(value="user-key")
    public User getUser() {
        User user=new User("[email protected]", "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 共享。