Spring Boot中,Redis緩存還能這么用!
經過Spring Boot的整合封裝與自動化配置,在Spring Boot中整合Redis已經變得非常容易了,開發者只需要引入Spring Data Redis依賴,然后簡單配下redis的基本信息,系統就會提供一個RedisTemplate供開發者使用,但是今天松哥想和大伙聊的不是這種用法,而是結合Cache的用法。Spring3.1中開始引入了令人激動的Cache,在Spring Boot中,可以非常方便的使用Redis來作為Cache的實現,進而實現數據的緩存。
工程創建
首先創建一個Spring Boot工程,注意創建的時候需要引入三個依賴,web、cache以及redis,如下圖:
對應的依賴內容如下:
- <dependency>
- <groupId>org.springframework.boot</groupId>
- <artifactId>spring-boot-starter-cache</artifactId>
- </dependency>
- <dependency>
- <groupId>org.springframework.boot</groupId>
- <artifactId>spring-boot-starter-data-redis</artifactId>
- </dependency>
- <dependency>
- <groupId>org.springframework.boot</groupId>
- <artifactId>spring-boot-starter-web</artifactId>
- </dependency>
- ?
基本配置
工程創建好之后,首先需要簡單配置一下Redis,Redis的基本信息,另外,這里要用到Cache,因此還需要稍微配置一下Cache,如下:
- spring.redis.port=6380
- spring.redis.host=192.168.66.128
- spring.cache.cache-names=c1
-
簡單起見,這里我只是配置了Redis的端口和地址,然后給緩存取了一個名字,這個名字在后文會用到。
另外,還需要在配置類上添加如下代碼,表示開啟緩存:
- @SpringBootApplication
- @EnableCaching
- public class RediscacheApplication {
- public static void main(String[] args) {
- SpringApplication.run(RediscacheApplication.class, args);
- }
- }
-
完成了這些配置之后,Spring Boot就會自動幫我們在后臺配置一個RedisCacheManager,相關的配置是在org.springframework.boot.autoconfigure.cache.RedisCacheConfiguration類中完成的。部分源碼如下:
- @Configuration
- @ConditionalOnClass(RedisConnectionFactory.class)
- @AutoConfigureAfter(RedisAutoConfiguration.class)
- @ConditionalOnBean(RedisConnectionFactory.class)
- @ConditionalOnMissingBean(CacheManager.class)
- @Conditional(CacheCondition.class)
- class RedisCacheConfiguration {
- @Bean
- public RedisCacheManager cacheManager(RedisConnectionFactory redisConnectionFactory,
- ResourceLoader resourceLoader) {
- RedisCacheManagerBuilder builder = RedisCacheManager
- .builder(redisConnectionFactory)
- .cacheDefaults(determineConfiguration(resourceLoader.getClassLoader()));
- List<String> cacheNames = this.cacheProperties.getCacheNames();
- if (!cacheNames.isEmpty()) {
- builder.initialCacheNames(new LinkedHashSet<>(cacheNames));
- }
- return this.customizerInvoker.customize(builder.build());
- }
- }
看類上的注解,發現在萬事俱備的情況下,系統會自動提供一個RedisCacheManager的Bean,這個RedisCacheManager間接實現了Spring中的Cache接口,有了這個Bean,我們就可以直接使用Spring中的緩存注解和接口了,而緩存數據則會被自動存儲到Redis上。在單機的Redis中,這個Bean系統會自動提供,如果是Redis集群,這個Bean需要開發者來提供(后面的文章會講到)。
緩存使用
這里主要向小伙伴們介紹緩存中幾個核心的注解使用。
@CacheConfig
這個注解在類上使用,用來描述該類中所有方法使用的緩存名稱,當然也可以不使用該注解,直接在具體的緩存注解上配置名稱,示例代碼如下:
- @Service
- @CacheConfig(cacheNames = "c1")
- public class UserService {
- }
-
@Cacheable
這個注解一般加在查詢方法上,表示將一個方法的返回值緩存起來,默認情況下,緩存的key就是方法的參數,緩存的value就是方法的返回值。示例代碼如下:
- @Cacheable(key = "#id")
- public User getUserById(Integer id,String username) {
- System.out.println("getUserById");
- return getUserFromDBById(id);
- }
-
當有多個參數時,默認就使用多個參數來做key,如果只需要其中某一個參數做key,則可以在@Cacheable注解中,通過key屬性來指定key,如上代碼就表示只使用id作為緩存的key,如果對key有復雜的要求,可以自定義keyGenerator。當然,Spring Cache中提供了root對象,可以在不定義keyGenerator的情況下實現一些復雜的效果:
@CachePut
這個注解一般加在更新方法上,當數據庫中的數據更新后,緩存中的數據也要跟著更新,使用該注解,可以將方法的返回值自動更新到已經存在的key上,示例代碼如下:
- @CachePut(key = "#user.id")
- public User updateUserById(User user) {
- return user;
- }
-
@CacheEvict
這個注解一般加在刪除方法上,當數據庫中的數據刪除后,相關的緩存數據也要自動清除,該注解在使用的時候也可以配置按照某種條件刪除(condition屬性)或者或者配置清除所有緩存(allEntries屬性),示例代碼如下:
- @CacheEvict()
- public void deleteUserById(Integer id) {
- //在這里執行刪除操作, 刪除是去數據庫中刪除
- }
-
總結
在Spring Boot中,使用Redis緩存,既可以使用RedisTemplate自己來實現,也可以使用使用這種方式,這種方式是Spring Cache提供的統一接口,實現既可以是Redis,也可以是Ehcache或者其他支持這種規范的緩存框架。從這個角度來說,Spring Cache和Redis、Ehcache的關系就像JDBC與各種數據庫驅動的關系。
本文授權轉載自公眾號「牧碼小子」。公眾號牧碼小子分享大量Java 微服務干貨,歡迎關注!