SpringBoot中使用Redis實現快取

Joepis發表於2018-05-16
Spring BootRedis快取

Spring Data Redis為我們封裝了Redis客戶端的各種操作，簡化使用。

  • 當Redis當做資料庫或者訊息佇列來操作時，我們一般使用RedisTemplate來操作
  • 當Redis作為快取使用時，我們可以將它作為Spring Cache的實現，直接通過註解使用

關於RedisTemplate的使用可參考：blog.didispace.com/springbootr…

下面總結使用Redis作為快取

引入依賴

SpringBoot從1.4版本開始，spring-boot-starter-redis依賴改名了。

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

配置檔案

spring:
  redis:
    host: 127.0.0.1
    port: 6379
    timeout: 0
    database: 0
    pool:
      max-active: 8
      max-wait: -1
      max-idle: 8
      min-idle: 0
複製程式碼

這樣，SpringBoot將會自動配置redis，注入相關bean，我們就可以使用@CacheConfig，@Cacheable，@CachePut，@CacheEvict了。

使用Cache註解時的問題

快取物件集合中，快取是以key-value形式儲存的。當不指定快取的key時，SpringBoot會使用SimpleKeyGenerator生成key。

public class SimpleKeyGenerator implements KeyGenerator {

	@Override
	public Object generate(Object target, Method method, Object... params) {
		return generateKey(params);
	}

	/**
	 * Generate a key based on the specified parameters.
	 */
	public static Object generateKey(Object... params) {
		if (params.length == 0) {
			return SimpleKey.EMPTY;
		}
		if (params.length == 1) {
			Object param = params[0];
			if (param != null && !param.getClass().isArray()) {
				return param;
			}
		}
		return new SimpleKey(params);
	}
}
複製程式碼
	public SimpleKey(Object... elements) {
		Assert.notNull(elements, "Elements must not be null");
		this.params = new Object[elements.length];
		System.arraycopy(elements, 0, this.params, 0, elements.length);
		this.hashCode = Arrays.deepHashCode(this.params);
	}
複製程式碼

檢視原始碼可以發現，它是使用方法引數組合生成的一個key。 此時有一個問題： 如果2個方法，引數是一樣的，但執行邏輯不同，那麼將會導致執行第二個方法時命中第一個方法的快取。 解決辦法是在@Cacheable註解引數中指定key，或者自己實現一個KeyGenerator，在註解中指定KeyGenerator。 但是如果這樣的情況很多，每一個都要指定key、KeyGenerator很麻煩。

Spring同樣提供了方案：繼承CachingConfigurerSupport並重寫keyGenerator()

下面貼出程式碼：

@EnableCaching
@Configuration
public class RedisCacheConfig extends CachingConfigurerSupport {

    @Autowired
    private JedisConnectionFactory jedisConnectionFactory;

    @Bean
    public RedisTemplate redisTemplate() {
        StringRedisTemplate redisTemplate = new StringRedisTemplate(jedisConnectionFactory);

        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<>(Object.class);
        ObjectMapper om = new ObjectMapper();
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        jackson2JsonRedisSerializer.setObjectMapper(om);

        redisTemplate.setValueSerializer(jackson2JsonRedisSerializer);
        redisTemplate.afterPropertiesSet();
        return redisTemplate;
    }

    @Bean
    public CacheManager cacheManager() {
        String[] cacheNames = {"app_default", "users", "blogs", "goods", "configs", "info"};
        RedisCacheManager redisCacheManager = new RedisCacheManager(redisTemplate(), Arrays.asList(cacheNames));
        redisCacheManager.setDefaultExpiration(86400);
        return redisCacheManager;
    }

    @Bean
    public Cache cache() {
        return cacheManager().getCache("app_default");
    }

    @Bean
    @Override
    public KeyGenerator keyGenerator() {
        return (target, method, objects) -> {
            StringBuilder sb = new StringBuilder();
            sb.append(target.getClass().getName());
            sb.append("::" + method.getName() + ":");
            for (Object obj : objects) {
                sb.append(obj.toString());
            }
            return sb.toString();
        };
    }
}
複製程式碼

此時，快取的key是包名+方法名+引數列表，這樣就很難會衝突了。

相關文章