補習系列(14)-springboot redis 整合-資料讀寫
摘要：
目錄
一、簡介
在 補習系列(A3)-springboot redis 與釋出訂閱 一文中，我們介紹了使用 Redis 實現訊息訂閱釋出的機制，並且給出了一個真實用例。
然而，絕大多數場景下 Redis 是作為快取被使用的(這是其主要優勢)。除此之外，由於Redis 提供了 A...
目錄
一、簡介
在 補習系列(A3)-springboot redis 與釋出訂閱 一文中，我們介紹了使用 Redis 實現訊息訂閱釋出的機制，並且給出了一個真實用例。
然而，絕大多數場景下 Redis 是作為快取被使用的(這是其主要優勢)。除此之外，由於Redis 提供了 AOF以及RDB兩種持久化機制，某些情況下也可以作為臨時資料庫使用。
本次將介紹 SpringBoot 中如何使用 Redis 進行快取讀寫。
Redis 的基本命令
在學習之前，需要先了解一些Redis 的基本命令，可以 ofollow,noindex" target="_blank">參考這裡
http://www.redis.cn/
二、SpringBoot Redis 讀寫
A. 引入 spring-data-redis
新增依賴
<!-- redis -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
<version>${spring-boot.version}</version>
</dependency>
spring-boot-starter-redis在1.4版本已經廢棄
配置redis連線
application.properties
# redis 連線配置 spring.redis.database=0 spring.redis.host=127.0.0.1 spring.redis.password= spring.redis.port=6379 spring.redis.ssl=false # 連線池最大數 spring.redis.pool.max-active=10 # 空閒連線最大數 spring.redis.pool.max-idle=10 # 獲取連線最大等待時間(s) spring.redis.pool.max-wait=600000
B. 序列化
同樣，我們需要指定 JSON作為 Key/HashKey/Value的主要方式：
/**
* 序列化定製
*
* @return
*/
@Bean
public Jackson2JsonRedisSerializer<Object> jackson2JsonSerializer() {
Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<>(
Object.class);
// 初始化objectmapper
ObjectMapper mapper = new ObjectMapper();
mapper.setSerializationInclusion(Include.NON_NULL);
mapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
jackson2JsonRedisSerializer.setObjectMapper(mapper);
return jackson2JsonRedisSerializer;
}
/**
* 操作模板
*
* @param connectionFactory
* @param jackson2JsonRedisSerializer
* @return
*/
@Bean
public RedisTemplate<String, Object> redisTemplate(JedisConnectionFactory connectionFactory,
Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer) {
RedisTemplate<String, Object> template = new RedisTemplate<String, Object>();
template.setConnectionFactory(connectionFactory);
// 設定key/hashkey序列化
RedisSerializer<String> stringSerializer = new StringRedisSerializer();
template.setKeySerializer(stringSerializer);
template.setHashKeySerializer(stringSerializer);
// 設定值序列化
template.setValueSerializer(jackson2JsonRedisSerializer);
template.setHashValueSerializer(jackson2JsonRedisSerializer);
template.afterPropertiesSet();
// template.setValueSerializer(new
// GenericToStringSerializer<Object>(Object.class));
return template;
}
Jackson2JsonRedisSerializer是Jackson轉換的橋接器；
RedisTemplate是用於讀寫的主要操作類；
C. 讀寫樣例
首先定義一個Pet實體類
public class RedisPet {
private String name;
private String type;
... ignore get set
利用 RedisTemplate 封裝一層Repository，如下：
@Repository
public static class PetRepository {
private static final String KEY = "Pets";
@Autowired
private RedisTemplate<String, Object> redisTemplate;
private HashOperations<String, String, Object> hashOperations;
@PostConstruct
private void init() {
hashOperations = redisTemplate.opsForHash();
}
public void add(RedisPet pet) {
hashOperations.put(KEY, pet.getName(), pet);
}
public RedisPet find(String name) {
return (RedisPet) hashOperations.get(KEY, name);
}
public Map<String, Object> findAll() {
return hashOperations.entries(KEY);
}
public void clear() {
hashOperations.getOperations().delete(KEY);
}
}
在 PetRepository 的實現中，我們利用Hash結構來儲存 Pet資訊(Pet.name是key)
分別實現了新增(add)/查詢(get)/清除(clear)等方法。
最後，實現讀寫呼叫：
@Service
public class RedisDataOperation {
private static final Logger logger = LoggerFactory.getLogger(RedisDataOperation.class);
@Autowired
private PetRepository petRepo;
@PostConstruct
public void start() {
RedisPet pet1 = new RedisPet("Polly", "Bird");
RedisPet pet2 = new RedisPet("Tom", "Cat");
//寫入寵物資訊
petRepo.add(pet1);
petRepo.add(pet2);
//列印寵物資訊
logger.info("polly {}", JsonUtil.toJson(petRepo.find("Polly")));
logger.info("pets{}", JsonUtil.toJson(petRepo.findAll()));
//清空
petRepo.clear();
}
上面的程式碼在應用啟動時，會寫入兩個Pet資訊，之後完成清理，控制檯輸出如下：
RedisDataOperation : polly {"name":"Polly","type":"Bird"}
RedisDataOperation : pets {"Tom":{"name":"Tom","type":"Cat"},"Polly":{"name":"Polly","type":"Bird"}}
三、方法級快取
除了上面的RedisTemplate， spring-data-redis 還提供了 方法級快取 ,
就是將業務方法的執行結果快取起來，後面再次呼叫直接從快取中取得結果返回。
這種方式可以簡化快取邏輯的程式碼，比如配置類資料的讀取，通過方法註解就可以實現，
下面是一個樣例：
/**
* 方法級快取樣例
*
* @author atp
*
*/
@Service
public class RedisCacheOperation {
private static final Logger logger = LoggerFactory.getLogger(RedisCacheOperation.class);
public static final String PREFIX = "pets:";
public static final String WRAP_PREFIX = "'pets:'";
/**
* 當結果不為空時快取
*
* @param name
* @return
*/
@Cacheable(value = "petCache", key = WRAP_PREFIX + "+#name", unless = "#result==null")
public RedisPet getPet(String name) {
logger.info("get pet {}", name);
return new RedisPet(name, "Bird");
}
/**
* 當結果不為空時淘汰快取
*
* @param pet
* @return
*/
@CacheEvict(value = "petCache", key = WRAP_PREFIX + "+#pet.name", condition = "#result!=null")
public RedisPet updatePet(RedisPet pet) {
logger.info("update pet {}", pet.getName());
return new RedisPet(pet.getName(), "Bird1");
}
/**
* 當結果為true時淘汰快取
*
* @param name
* @return
*/
@CacheEvict(value = "petCache", key = WRAP_PREFIX + "+#name", condition = "#result==true")
public boolean deletePet(String name) {
logger.info("delete pet {}", name);
return true;
}
}
涉及到幾個註解：
| 註解 | 說明 |
|---|---|
| @Cachable | 方法執行結果快取 |
| @CachePut | 方法執行結果快取(強制) |
| @CacheEvict | 方法執行時觸發刪除 |
其中 @CachePut 與 @Cachable 的區別在於，前者一定會執行方法，並嘗試重新整理快取(條件滿足)，
而後者則是當快取中不存在時才會執行方法並更新。
註解中的屬性 key/condition 都支援通過 Spring EL 表示式來引用引數物件。
啟用註解
除了上面的程式碼，我們還需要使用 @EnableCaching 啟用註解：
@EnableCaching
@Configuration
public class RedisConfig {
private static final Logger logger = LoggerFactory.getLogger(RedisConfig.class);
/**
* 快取管理，支援方法級註解
*
* @param template
* @return
*/
@Bean
public RedisCacheManager cacheManager(RedisTemplate<String, Object> template) {
RedisCacheManager redisCacheManager = new RedisCacheManager(template);
// 預設過期時間
redisCacheManager.setDefaultExpiration(30 * 60 * 1000);
return redisCacheManager;
}
當@Cacheable 的key屬性為空時，框架會自動生成，格式類似：
param1,param2,param3...
如果希望修改預設的行為，可以使用自定義的 KeyGenerator ：
/**
* 定製方法快取的key生成策略
*
* @return
*/
@Bean
public KeyGenerator keyGenerator() {
return new KeyGenerator() {
@Override
public Object generate(Object target, Method method, Object... args) {
StringBuilder sb = new StringBuilder();
sb.append(target.getClass().getName());
sb.append(method.getName());
for (Object arg : args) {
sb.append(arg.toString());
}
return sb.toString();
}
};
}
單元測試
使用一小段單元測試程式碼來測試 方法級快取 功能
@RunWith(SpringRunner.class)
@SpringBootTest(classes =BootSampleRedis.class)
public class RedisCacheOperationTest {
private static final Logger logger = LoggerFactory.getLogger(RedisCacheOperationTest.class);
@Autowired
private RedisTemplate<String, Object> redisTemplate;
@Autowired
private RedisCacheOperation operation;
private RedisPet pet1 = new RedisPet("Polly", "Bird");
@Test
public void testGet() {
operation.getPet(pet1.getName());
Object object = redisTemplate.opsForValue().get(RedisCacheOperation.PREFIX + pet1.getName());
logger.info(String.valueOf(object));
assertNotNull(object);
}
@Test
public void testUpdate() {
operation.updatePet(pet1);
Object object = redisTemplate.opsForValue().get(RedisCacheOperation.PREFIX + pet1.getName());
logger.info(String.valueOf(object));
assertNull(object);
}
@Test
public void testDelete() {
operation.getPet(pet1.getName());
// delete cache
operation.deletePet(pet1.getName());
Object object = redisTemplate.opsForValue().get(RedisCacheOperation.PREFIX + pet1.getName());
logger.info(String.valueOf(object));
assertNull(object);
}
}
四、連線池
如果希望通過程式碼來配置 Jedis 的連線池(熟悉的方式)，可以宣告 JedisConnectionFactory 實現：
/**
* 連線池配置
*
* @return
*/
@Bean
public JedisConnectionFactory jedisConnectionFactory() {
JedisPoolConfig config = new JedisPoolConfig();
// 最大連線
config.setMaxTotal(10);
// 最大空閒，與最大連線保持一致，可減少頻繁鍵鏈的開銷
config.setMaxIdle(10);
// 連線最大空閒時間
config.setMinEvictableIdleTimeMillis(10 * 60 * 1000);
// 獲取連線等待的最大時長
config.setMaxWaitMillis(30000);
// 進行空閒連線檢測的時間間隔
config.setTimeBetweenEvictionRunsMillis(30 * 1000);
// 取消不必要的test，有利於效能提升
config.setTestOnBorrow(false);
config.setTestOnReturn(false);
JedisConnectionFactory factory = new JedisConnectionFactory(config);
factory.setHostName("127.0.0.1");
factory.setPort(6379);
logger.info("redis config init first");
return factory;
}
更多配置可 參考這裡
示例程式碼可從 碼雲gitee 下載。
https://gitee.com/littleatp/springboot-samples/
小結
Redis 在大多數專案中的核心用途是 快取 ，spring-data-redis 為 SpringBoot 中整合 Redis 讀寫的封裝。
除了 RedisTemplate之外，還實現了方法級的快取註解，一定程度上簡化了業務的使用。
Redis 在分散式系統中的應用場景有很多，後續有機會將進行更多的探討。
歡迎繼續關注"美碼師的補習系列-springboot篇" ，期待更多精彩內容^-^