SpringBoot(三) ：Spring boot 中 Redis 的使用

Myth丶恋晨 2022-06-01 11:55 110阅读 0赞

SpringBoot对常用的数据库支持外，对[NoSQL][] 数据库也进行了封装自动化。

## redis介绍 ##

Redis是目前业界使用最广泛的内存数据存储。相比memcached，Redis支持更丰富的数据结构，例如hashes, lists, sets等，同时支持数据持久化。除此之外，Redis还提供一些类数据库的特性，比如事务，HA，主从库。可以说Redis兼具了缓存系统和数据库的一些特性，因此有着丰富的应用场景。本文介绍Redis在Spring Boot中两个典型的应用场景。

## 如何使用 ##

1、引入 spring-boot-starter-redis

<table style="margin-left:0px;width:620px;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 </td> 
 <td style="vertical-align:baseline;width:592px;"> <code>&lt;dependency&gt;&nbsp;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;&nbsp;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;artifactId&gt;spring-boot-starter-redis&lt;/artifactId&gt;&nbsp;</code> <code>&lt;/dependency&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

2、添加配置文件

3、添加cache的配置类

<table style="margin-left:0px;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 </td> 
 <td style="vertical-align:baseline;"> <code>@Configuration</code> <code>@EnableCaching</code> <code>public</code><code>class</code> <code> &nbsp;RedisConfig&nbsp;</code><code>extends</code><code>CachingConfigurerSupport{ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Bean</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code><code>KeyGenerator keyGenerator() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code><code>new</code> <code> &nbsp;KeyGenerator() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code><code>Object generate(Object target, Method method, Object... params) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>StringBuilder sb =&nbsp;</code><code>new</code><code>StringBuilder();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>sb.append(target.getClass().getName());</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>sb.append(method.getName());</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>for</code><code>(Object obj : params) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>sb.append(obj.toString());</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code><code>sb.toString();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>};</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@SuppressWarnings</code><code>(</code><code>"rawtypes"</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Bean</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code><code>CacheManager cacheManager(RedisTemplate redisTemplate) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>RedisCacheManager rcm =&nbsp;</code><code>new</code><code>RedisCacheManager(redisTemplate);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//设置缓存过期时间</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//rcm.setDefaultExpiration(60);//秒</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code><code>rcm;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Bean</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code><code>RedisTemplate&lt;String, String&gt; redisTemplate(RedisConnectionFactory factory) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>StringRedisTemplate template =&nbsp;</code><code>new</code><code>StringRedisTemplate(factory);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Jackson2JsonRedisSerializer jackson2JsonRedisSerializer =&nbsp;</code><code>new</code><code>Jackson2JsonRedisSerializer(Object.</code><code>class</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>ObjectMapper om =&nbsp;</code><code>new</code><code>ObjectMapper();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>jackson2JsonRedisSerializer.setObjectMapper(om);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>template.setValueSerializer(jackson2JsonRedisSerializer);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>template.afterPropertiesSet();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code><code>template;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

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

<table style="margin-left:0px;width:620px;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 </td> 
 <td style="vertical-align:baseline;width:585px;"> <code>@RunWith</code><code>(SpringJUnit4ClassRunner.</code><code>class</code><code>)</code> <code>@SpringApplicationConfiguration</code><code>(Application.</code><code>class</code><code>)</code> <code>public</code><code>class</code> <code> &nbsp;TestRedis { </code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Autowired</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code><code>StringRedisTemplate stringRedisTemplate;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Autowired</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code><code>RedisTemplate redisTemplate;</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Test</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code><code>void</code> <code> &nbsp;test()&nbsp;</code><code>throws</code><code>Exception { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>stringRedisTemplate.opsForValue().set(</code><code>"aaa"</code><code>,&nbsp;</code><code>"111"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Assert.assertEquals(</code><code>"111"</code><code>, stringRedisTemplate.opsForValue().get(</code><code>"aaa"</code><code>));</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Test</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code><code>void</code> <code> &nbsp;testObj()&nbsp;</code><code>throws</code><code>Exception { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>User user=</code><code>new</code><code>User(</code><code>"aa@126.com"</code><code>,&nbsp;</code><code>"aa"</code><code>,&nbsp;</code><code>"aa123456"</code><code>,&nbsp;</code><code>"aa"</code><code>,</code><code>"123"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>ValueOperations&lt;String, User&gt; operations=redisTemplate.opsForValue();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>operations.set(</code><code>"com.neox"</code><code>, user);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>operations.set(</code><code>"com.neo.f"</code><code>, user,</code><code>1</code><code>,TimeUnit.SECONDS);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Thread.sleep(</code><code>1000</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>//redisTemplate.delete("com.neo.f");</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>boolean</code><code>exists=redisTemplate.hasKey(</code><code>"com.neo.f"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code><code>(exists){ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println(</code><code>"exists is true"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code><code>else</code><code>{ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println(</code><code>"exists is false"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// Assert.assertEquals("aa", operations.get("com.neo.f").getUserName());</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

以上都是手动使用的方式，如何在查找数据库的时候自动使用缓存呢，看下面；

5、自动根据方法生成缓存

<table style="margin-left:0px;width:620px;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 5 6 7 </td> 
 <td style="vertical-align:baseline;width:592px;"> <code>@RequestMapping</code><code>(</code><code>"/getUser"</code><code>)</code> <code>@Cacheable</code><code>(value=</code><code>"user-key"</code><code>)</code> <code>public</code><code>User getUser() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>User user=userRepository.findByUserName(</code><code>"aa"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>System.out.println(</code><code>"若下面没出现“无缓存的时候调用”字样且能打印出数据表示测试成功"</code><code>);&nbsp;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code><code>user;</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

其中value的值就是缓存到redis中的key

## 共享Session-spring-session-data-redis ##

分布式系统中，sessiong共享有很多的解决方案，其中托管到缓存中应该是最常用的方案之一，

### Spring Session官方说明 ###

Spring Session provides an API and implementations for managing a user’s session information.

### 如何使用 ###

1、引入依赖

<table style="margin-left:0px;width:620px;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 </td> 
 <td style="vertical-align:baseline;width:592px;"> <code>&lt;dependency&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;groupId&gt;org.springframework.session&lt;/groupId&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;artifactId&gt;spring-session-data-redis&lt;/artifactId&gt;</code> <code>&lt;/dependency&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

2、Session配置：

<table style="margin-left:0px;width:620px;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 </td> 
 <td style="vertical-align:baseline;width:592px;"> <code>@Configuration</code> <code>@EnableRedisHttpSession</code><code>(maxInactiveIntervalInSeconds =&nbsp;</code><code>86400</code><code>*</code><code>30</code><code>)</code> <code>public</code><code>class</code> <code> &nbsp;SessionConfig { </code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

maxInactiveIntervalInSeconds: 设置Session失效时间，使用Redis Session之后，原Boot的server.session.timeout属性不再生效

好了，这样就配置好了，我们来测试一下

3、测试

添加测试方法获取sessionid

<table style="margin-left:0px;width:620px;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 3 4 5 6 7 8 9 </td> 
 <td style="vertical-align:baseline;width:592px;"> <code>@RequestMapping</code><code>(</code><code>"/uid"</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>String uid(HttpSession session) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>UUID uid = (UUID) session.getAttribute(</code><code>"uid"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code><code>(uid ==&nbsp;</code><code>null</code><code>) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>uid = UUID.randomUUID();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>session.setAttribute(</code><code>"uid"</code><code>, uid);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code><code>session.getId();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

登录redis 输入 keys ‘\*sessions\*’

<table style="margin-left:0px;width:620px;"> 
 <tbody> 
 <tr> 
 <td style="vertical-align:baseline;"> 1 2 </td> 
 <td style="vertical-align:baseline;width:592px;"> <code>t&lt;spring:session:sessions:db031986-8ecc-48d6-b471-b137a3ed6bc4</code> <code>t(spring:session:expirations:</code><code>1472976480000</code> </td> 
 </tr> 
 </tbody> 
</table>

其中 1472976480000为失效时间，意思是这个时间后session失效，db031986-8ecc-48d6-b471-b137a3ed6bc4 为sessionId,登录http://localhost:8080/uid 发现会一致，就说明session 已经在redis里面进行有效的管理了。

### 如何在两台或者多台中共享session ###

其实就是按照上面的步骤在另一个项目中再次配置一次，启动后自动就进行了session共享。

[示例代码][Link 1]

## 参考 ##

*  [Redis的两个典型应用场景][Redis]
 *  [pringBoot应用之分布式会话][pringBoot]

[NoSQL]: http://blog.jobbole.com/1344/
[Link 1]: https://github.com/ityouknow/spring-boot-examples
[Redis]: http://emacoo.cn/blog/spring-redis
[pringBoot]: https://segmentfault.com/a/1190000004358410