Redis 是目前業(yè)界使用最廣泛的內(nèi)存數(shù)據(jù)存儲。相比 Memcached,Redis 支持更豐富的數(shù)據(jù)結(jié)構(gòu),例如 hashes, lists, sets 等,同時支持數(shù)據(jù)持久化。除此之外,Redis 還提供一些類數(shù)據(jù)庫的特性,比如事務(wù),HA,主從庫。可以說 Redis 兼具了緩存系統(tǒng)和數(shù)據(jù)庫的一些特性,因此有著豐富的應(yīng)用場景。本文介紹 Redis 在 Spring Boot 中兩個典型的應(yīng)用場景。
如果在 Java 應(yīng)用中使用過 Redis 緩存,那么對 Jedis
一定不陌生, Lettuce
和 Jedis
一樣,都是連接 Redis Server
的客戶端程序。Jedis
在實現(xiàn)上是直連 Redis Server
,多線程環(huán)境下非線程安全,除非使用連接池,為每個 Jedis
實例增加物理連接。 Lettuce
基于 Netty
的連接實例(StatefulRedisConnection),可以在多個線程間并發(fā)訪問,且線程安全,滿足多線程環(huán)境下的并發(fā)訪問,同時它是可伸縮的設(shè)計,一個連接實例不夠的情況也可以按需增加連接實例。
直接通過 RedisTemplate
來使用
使用 Spring Cache
集成 Redis
通過 Spring Session
做 Session
共享
代碼清單:spring-boot-redis/pom.xml
<dependencies> <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> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.session</groupId> <artifactId>spring-session-data-redis</artifactId> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency></dependencies>
COPY
spring-boot-starter-data-redis :在 Spring Boot 2.x
后底層不再是使用 Jedis
,而是換成了 Lettuce
,如圖:
commons-pool2 : 用作 redis
連接池,如不引入啟動會報錯。
spring-session-data-redis : Spring Session
引入,用作共享 Session
。
代碼清單:spring-boot-redis/src/main/resources/application.yml
server: port: 8080 servlet: session: timeout: 30mspring: application: name: spring-boot-redis cache: # 使用了Spring Cache后,能指定spring.cache.type就手動指定一下,雖然它會自動去適配已有Cache的依賴,但先后順序會對Redis使用有影響(JCache -> EhCache -> Redis -> Guava) type: REDIS redis: host: 192.168.0.128 port: 6379 password: 123456 # 連接超時時間(ms) timeout: 10000 # Redis默認情況下有16個分片,這里配置具體使用的分片,默認是0 database: 0 lettuce: pool: # 連接池最大連接數(shù)(使用負值表示沒有限制) 默認 8 max-active: 100 # 連接池最大阻塞等待時間(使用負值表示沒有限制) 默認 -1 max-wait: -1 # 連接池中的最大空閑連接 默認 8 max-idle: 8 # 連接池中的最小空閑連接 默認 0 min-idle: 0
COPY
這里的配置不多解釋,需要解釋的已經(jīng)標注注釋。
代碼清單:spring-boot-redis/src/main/java/com/springboot/springbootredis/model/User.java
@Data@AllArgsConstructor@NoArgsConstructorpublic class User implements Serializable { private static final long serialVersionUID = 662692455422902539L; private Long id; private String name; private int age;}
COPY
默認情況下的模板只能支持 RedisTemplate<String, String>
,也就是只能存入字符串,這在開發(fā)中是不友好的,所以自定義模板是很有必要的,當自定義了模板又想使用 String
存儲這時候就可以使用 StringRedisTemplate
的方式,它們并不沖突,添加配置類 RedisCacheConfig.java
,代碼如下:
代碼清單:spring-boot-redis/src/main/java/com/springboot/springbootredis/config/RedisCacheConfig.java
@Configuration@AutoConfigureAfter(RedisAutoConfiguration.class)public class RedisCacheConfig { @Bean public RedisTemplate<String, Serializable> redisCacheTemplate(LettuceConnectionFactory redisConnectionFactory) { RedisTemplate<String, Serializable> template = new RedisTemplate<>(); template.setKeySerializer(new StringRedisSerializer()); template.setValueSerializer(new GenericJackson2JsonRedisSerializer()); template.setConnectionFactory(redisConnectionFactory); return template; }}
COPY
代碼清單:
@RestController@Slf4jpublic class UserController { @Autowired private StringRedisTemplate stringRedisTemplate; @Autowired RedisTemplate<String, Serializable> redisCacheTemplate; @Autowired UserService userService; @GetMapping("/test") public void test() { stringRedisTemplate.opsForValue().set("geekdigging", "https://www.geekdigging.com/"); log.info("當前獲取對象:{}",stringRedisTemplate.opsForValue().get("geekdigging")); redisCacheTemplate.opsForValue().set("geekdigging.com", new User(1L, "geekdigging", 18)); User user = (User) redisCacheTemplate.opsForValue().get("geekdigging.com"); log.info("當前獲取對象:{}", user); }}
COPY
啟動服務(wù),打開瀏覽器訪問鏈接:http://localhost:8080/test ,查看控制臺日志打印,如下:
2019-09-24 23:49:30.191 INFO 19108 --- [nio-8080-exec-1] c.s.s.controller.UserController : 當前獲取對象:https://www.geekdigging.com/2019-09-24 23:49:30.243 INFO 19108 --- [nio-8080-exec-1] c.s.s.controller.UserController : 當前獲取對象:User(id=1, name=geekdigging, age=18)
COPY
測試成功。
Spring 3.1 引入了激動人心的基于注釋(annotation)的緩存(cache)技術(shù),它本質(zhì)上不是一個具體的緩存實現(xiàn)方案(例如 EHCache 或者 Redis),而是一個對緩存使用的抽象,通過在既有代碼中添加少量它定義的各種 annotation,即能夠達到緩存方法的返回對象的效果。
Spring Cache 具備相當?shù)暮玫撵`活性,不僅能夠使用 SpEL(Spring Expression Language)來定義緩存的 key 和各種 condition,還提供開箱即用的緩存臨時存儲方案,也支持和主流的專業(yè)緩存例如 EHCache、Redis、Guava 的集成。
基于 annotation 即可使得現(xiàn)有代碼支持緩存
開箱即用 Out-Of-The-Box,不用安裝和部署額外第三方組件即可使用緩存
支持 Spring Express Language,能使用對象的任何屬性或者方法來定義緩存的 key 和 condition
支持 AspectJ,并通過其實現(xiàn)任何方法的緩存支持
支持自定義 key 和自定義緩存管理者,具有相當?shù)撵`活性和擴展性
代碼清單:spring-boot-redis/src/main/java/com/springboot/springbootredis/service/UserService.java
public interface UserService { User save(User user); User get(Long id); void delete(Long id);}
COPY
代碼清單:spring-boot-redis/src/main/java/com/springboot/springbootredis/service/impl/UserServiceImpl.java
@Service@Slf4jpublic class UserServiceImpl implements UserService { private static final Map<Long, User> USER_MAP = new HashMap<>(); static { USER_MAP.put(1L, new User(1L, "geekdigging.com", 18)); USER_MAP.put(2L, new User(2L, "geekdigging.com", 19)); USER_MAP.put(3L, new User(3L, "geekdigging.com", 20)); } @CachePut(value = "user", key = "#user.id") @Override public User save(User user) { USER_MAP.put(user.getId(), user); log.info("進入 save 方法,當前存儲對象:{}", user); return user; } @Cacheable(value = "user", key = "#id") @Override public User get(Long id) { log.info("進入 get 方法,當前獲取對象:{}", USER_MAP.get(id)); return USER_MAP.get(id); } @CacheEvict(value = "user", key = "#id") @Override public void delete(Long id) { USER_MAP.remove(id); log.info("進入 delete 方法,刪除成功"); }}
COPY
為了方便演示數(shù)據(jù)庫操作,直接定義了一個 Map<Long, User> USER_MAP
,這里的核心就是三個注解 @Cacheable
、 @CachePut
、 @CacheEvict
。
根據(jù)方法的請求參數(shù)對其結(jié)果進行緩存
key: 緩存的 key,可以為空,如果指定要按照 SpEL 表達式編寫,如果不指定,則缺省按照方法的所有參數(shù)進行組合(如:@Cacheable(value="user",key="#userName")
)
value: 緩存的名稱,必須指定至少一個(如:@Cacheable(value="user")
或者 @Cacheable(value={"user1","use2"})
)
condition: 緩存的條件,可以為空,使用 SpEL 編寫,返回 true 或者 false,只有為 true 才進行緩存(如:@Cacheable(value = "user", key = "#id",condition = "#id < 10")
)
根據(jù)方法的請求參數(shù)對其結(jié)果進行緩存,和 @Cacheable 不同的是,它每次都會觸發(fā)真實方法的調(diào)用
key: 同上
value: 同上
condition: 同上
根據(jù)條件對緩存進行清空
key: 同上
value: 同上
condition: 同上
allEntries: 是否清空所有緩存內(nèi)容,缺省為 false,如果指定為 true,則方法調(diào)用后將立即清空所有緩存(如: @CacheEvict(value = "user", key = "#id", allEntries = true)
)
beforeInvocation: 是否在方法執(zhí)行前就清空,缺省為 false,如果指定為 true,則在方法還沒有執(zhí)行的時候就清空緩存,缺省情況下,如果方法執(zhí)行拋出異常,則不會清空緩存(如: @CacheEvict(value = "user", key = "#id", beforeInvocation = true)
)
代碼清單:spring-boot-redis/src/main/java/com/springboot/springbootredis/SpringBootRedisApplication.java
@SpringBootApplication@EnableCachingpublic class SpringBootRedisApplication { public static void main(String[] args) { SpringApplication.run(SpringBootRedisApplication.class, args); }}
COPY
這里需增加注解 @EnableCaching
開啟 Spring Session。
代碼清單:spring-boot-redis/src/main/java/com/springboot/springbootredis/controller/UserController.java
@GetMapping("/test1")public void test1() { User user = userService.save(new User(4L, "geekdigging.com", 35)); log.info("當前 save 對象:{}", user); user = userService.get(1L); log.info("當前 get 對象:{}", user); userService.delete(5L);}
COPY
啟動服務(wù),打開瀏覽器訪問鏈接:http://localhost:8080/test ,刷新頁面,控制臺日志打印如下:
2019-09-25 00:07:21.887 INFO 21484 --- [nio-8080-exec-1] c.s.s.service.impl.UserServiceImpl : 進入 save 方法,當前存儲對象:User(id=4, name=geekdigging.com, age=35)2019-09-25 00:07:21.897 INFO 21484 --- [nio-8080-exec-1] c.s.s.controller.UserController : 當前 save 對象:User(id=4, name=geekdigging.com, age=35)2019-09-25 00:07:21.899 INFO 21484 --- [nio-8080-exec-1] c.s.s.service.impl.UserServiceImpl : 進入 get 方法,當前獲取對象:User(id=1, name=geekdigging.com, age=18)2019-09-25 00:07:21.900 INFO 21484 --- [nio-8080-exec-1] c.s.s.controller.UserController : 當前 get 對象:User(id=1, name=geekdigging.com, age=18)2019-09-25 00:07:21.901 INFO 21484 --- [nio-8080-exec-1] c.s.s.service.impl.UserServiceImpl : 進入 delete 方法,刪除成功
COPY
再次刷新頁面,查看控制臺日志:
2019-09-25 00:08:54.076 INFO 21484 --- [nio-8080-exec-7] c.s.s.service.impl.UserServiceImpl : 進入 save 方法,當前存儲對象:User(id=4, name=geekdigging.com, age=35)2019-09-25 00:08:54.077 INFO 21484 --- [nio-8080-exec-7] c.s.s.controller.UserController : 當前 save 對象:User(id=4, name=geekdigging.com, age=35)2019-09-25 00:08:54.079 INFO 21484 --- [nio-8080-exec-7] c.s.s.controller.UserController : 當前 get 對象:User(id=1, name=geekdigging.com, age=18)2019-09-25 00:08:54.079 INFO 21484 --- [nio-8080-exec-7] c.s.s.service.impl.UserServiceImpl : 進入 delete 方法,刪除成功
COPY
結(jié)果和我們期望的一致,可以看到增刪改查中,查詢是沒有日志輸出的,因為它直接從緩存中獲取的數(shù)據(jù),而添加、修改、刪除都是會進入 UserServiceImpl
的方法內(nèi)執(zhí)行具體的業(yè)務(wù)代碼。
Spring Session 提供了一套創(chuàng)建和管理 Servlet HttpSession 的方案。Spring Session 提供了集群 Session(Clustered Sessions)功能,默認采用外置的 Redis 來存儲 Session 數(shù)據(jù),以此來解決 Session 共享的問題。
代碼清單:spring-boot-redis/src/main/java/com/springboot/springbootredis/SpringBootRedisApplication.java
@SpringBootApplication@EnableCaching@EnableRedisHttpSession(maxInactiveIntervalInSeconds = 1800)public class SpringBootRedisApplication { public static void main(String[] args) { SpringApplication.run(SpringBootRedisApplication.class, args); }}
COPY
maxInactiveIntervalInSeconds: 設(shè)置 Session 失效時間,使用 Spring Session 之后,原 Spring Boot 配置文件 application.yml
中的 server.session.timeout
屬性不再生效。
代碼清單:spring-boot-redis/src/main/java/com/springboot/springbootredis/controller/UserController.java
@GetMapping("/getBlogUrl")public String getSessionId(HttpServletRequest request) { String url = (String) request.getSession().getAttribute("url"); if (StringUtils.isEmpty(url)) { request.getSession().setAttribute("url", "https://www.geekdigging.com/"); } log.info("獲取session內(nèi)容為: {}", request.getSession().getAttribute("url")); return request.getRequestedSessionId();}
COPY
啟動服務(wù),打開瀏覽器訪問鏈接:http://localhost:8080/getBlogUrl ,查看 Redis 當前存儲內(nèi)容,如下圖:
其中 1569339180000 為失效時間,意思是這個時間后 Session 失效, b2522824-1094-478e-a435-554a551bc8bb 為 SessionId 。
按照上面的步驟在另一個項目中再次配置一次,啟動后自動就進行了 Session 共享。