Spring-Data-Redis项目(简称SDR)对Redis的Key-Value数据存储操作提供了更高层次的抽象,类似于Spring Framework对JDBC支持一样。

项目主页: http://projects.spring.io/spring-data-redis/

项目文档: http://docs.spring.io/spring-data/redis/docs/1.5.0.RELEASE/reference/html/

本文主要介绍Spring Data Redis的实际使用。

1.Spring Data Redis 1.5新特性

增加了Redis HyperLogLog命令PFADD,PFCOUNT,PFMERGE

可以使用Jackson基于RedisSerializer对Java类型序列化

使用PropertySource配置Redis Sentinel连接,目前仅Jedis客户端支持

2.Spring Data Redis ?

Spring Data Redis使得在Spring应用中读写Redis数据库更加容易。

Spring Data Redis提供了四种Redis服务的Java客户端包的集成,分别是 Jedis ,JRedis , SRP and Lettuce

3.版本要求

Spring Data Redis1.2.x要求JDK1.6+,Spring Framwork3.2.8+

Key-Value存储服务Redis 2.6.x+

4.搭建环境

本文假设已经安装完成了Redis服务,并成功运行。

创建maven项目,添加依赖的Jar,本文主要使用jedis

<dependency>
      <groupId>org.springframework.data</groupId>
      <artifactId>spring-data-redis</artifactId>
      <version>1.5.0.RELEASE</version>
    </dependency>
<dependency>
      <groupId>redis.clients</groupId>
      <artifactId>jedis</artifactId>
      <version>2.6.2</version>
    </dependency>

5.连接Redis服务

在Spring Data Redis中通过org.springframework.data.redis.connection包中的RedisConnection和RedisConnectionFactory类来获取Redis连接。

5.1配置JedisConnectionFactory

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:p="http://www.springframework.org/schema/p"
  xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

  <bean id="jedisConnectionFactory" class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory" p:host-name="server" p:port="6379" />

</beans>

5.2配置Jredis,SRP,Lettuce的配置和上面配置类似,只需要配置对应的RedisConnectionFactory接口实现接口,它门位于如下包中:

5.3关于RedisConnectionFactory注意问题

上面四种连接器并不是都支持Redis的所有特性,它们之间有差异性,如果调用方法在Connection API中不支持则抛出“UnsupportedOperationException”异常,具体情况需要了解对应的Redis Java客户端Jar的实现。

5.4关于Redis Sentinel(这里暂称为:哨兵)支持

Redis Sentinel监听主服务,再主服务发生故障时能够切换至从服务,将从服务升为主服务来保证故障恢复,使用该功能需要在JedisConnectionFactory设置RedisSentinelConfiguration属性,目前Jedis对Redis Sentinel提供支持。

编码方式如下:

public RedisConnectionFactory jedisConnectionFactory() {
  RedisSentinelConfiguration sentinelConfig = new RedisSentinelConfiguration() .master("mymaster")
  .sentinel("127.0.0.1", 26379) .sentinel("127.0.0.1", 26380);
  return new JedisConnectionFactory(sentinelConfig);
}

在Spring容器中配置:

<bean id="sentinelConfig"
    class="org.springframework.data.redis.connection.RedisSentinelConfiguration">
    <constructor-arg name="master" value="mymaster" />
    <constructor-arg name="sentinelHostAndPorts">
      <set>
        <value>192.168.88.153:26379</value>
        <value>192.168.88.153:26380</value>
        <value>192.168.88.153:26382</value>
      </set>
    </constructor-arg>
  </bean>
  
  <bean id="jedisConnectionFactory"
    class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory">
    <constructor-arg ref="sentinelConfig" />
  </bean>

注意:在配置Redis的sentinel.conf文件时注意使用外部可以访问的ip地址,因为当redis-sentinel服务和redis-server在同一台机器的时候,主服务发生变化时配置文件中将主服务ip变为127.0.0.1,这样外部就无法访问了。如果应用程序,Redis服务在同一台机器则不存在这样的隐患,具体情况则更加实际的网络环境。

配置好之后,在实例化JedisConnectionFactory之后,可见如下日志:

  1. 2015-4-1 17:29:30 redis.clients.jedis.JedisSentinelPool initSentinels
  2. 信息: Trying to find master from available Sentinels
  3. 2015-4-1 17:29:30 redis.clients.jedis.JedisSentinelPool initSentinels
  4. 信息: Redis master running at 192.168.88.153:6384, starting Sentinel listeners
  5. 2015-4-1 17:29:30 redis.clients.jedis.JedisSentinelPool initPool
  6. 信息: Created JedisPool to master at 192.168.88.153:6384

实验环境中192.168.88.153:6384的Redis实例是主服务。

5.5下面通过一组代码展示具体使用

  1. @FixMethodOrder(MethodSorters.NAME_ASCENDING)
  2. public class TestJedis {
  3. public static ApplicationContext ctx;
  4. public static JedisConnectionFactory jedisConnetionFactory;
  5. public JedisConnection jedisConnection;
  6. @SuppressWarnings(“unchecked”)
  7. @BeforeClass
  8. public static void setBeforeClass() {
  9. ctx = new ClassPathXmlApplicationContext(“spring-redis.xml”);
  10. jedisConnetionFactory = (JedisConnectionFactory) ctx
  11. .getBean(“jedisConnectionFactory”);
  12. }
  13. @Before
  14. public void setBefore() {
  15. jedisConnection = jedisConnetionFactory.getConnection();
  16. }
  17. @After
  18. public void setAfter() {
  19. jedisConnection.close();
  20. }
  21. private void print(Collection<RedisServer> c) {
  22. for (Iterator<RedisServer> iter = c.iterator(); iter.hasNext();) {
  23. RedisServer rs = (RedisServer) iter.next();
  24. System.out.println(rs.getHost() + “:” + rs.getPort());
  25. }
  26. }
  27. // 简单测试JedisConnection
  28. @Ignore
  29. @Test
  30. public void test1() {
  31. if (!jedisConnection.exists(new String(“zz”).getBytes())) {
  32. jedisConnection.set(new String(“zz”).getBytes(),
  33. new String(“zz”).getBytes());
  34. }
  35. }
  36. @Ignore
  37. @Test
  38. public void test2() {
  39. Set<byte[]> keys = jedisConnection.keys(new String(“*”).getBytes());
  40. for (Iterator<byte[]> iter = keys.iterator(); iter.hasNext();) {
  41. System.out.println(new String(iter.next()));
  42. }
  43. }
  44. // 测试Sentinel
  45. @Ignore
  46. @Test
  47. public void test3() throws InterruptedException {
  48. if (jedisConnetionFactory.getSentinelConnection().isOpen()) {
  49. Collection<RedisServer> c = jedisConnetionFactory
  50. .getSentinelConnection().masters();
  51. print(c);
  52. RedisNode rn = new RedisNode(“192.168.88.153”, 6380);
  53. rn.setName(“mymaster”);
  54. c = jedisConnetionFactory.getSentinelConnection().slaves(rn);
  55. print(c);
  56. }
  57. for (int i = 0; i < 1000; i++) {
  58. jedisConnection.set(new String(“k” + i).getBytes(), new String(“v”
  59. + i).getBytes());
  60. Thread.sleep(1000);
  61. }
  62. Set<byte[]> keys = jedisConnection.keys(new String(“k*”).getBytes());
  63. Assert.assertEquals(1000, keys.size());
  64. }
  65. }

6.RedisTemplate支持

熟悉Spring的JdbcTemplate对象的话,应该大概能猜出来RedisTemplate的作用了,RedisTemplate对象对RedisConnection进行了封装,它提供了连接管理,序列化等功能,它对Redis的交互进行了更高层次的抽象。另外还提供了Redis操作命令的操作视图,这极大的方便和简化了Redis的操作。

下表是具体的操作视图接口类介绍:

Key类型操作
ValueOperations Redis String/Value 操作
ListOperations Redis List 操作
SetOperations Redis Set 操作
ZSetOperations Redis Sort Set 操作
HashOperations Redis Hash 操作
Value约束操作
BoundValueOperations Redis String/Value key 约束
BoundListOperations Redis List key 约束
BoundSetOperations Redis Set key 约束
BoundZSetOperations Redis Sort Set key 约束
BoundHashOperations Redis Hash key 约束

在org.springframework.data.redis.core包中对表中的接口都提供了相应的默认实现。

6.1RedisSerializer

Spring Data Redis提供了对Key-Value的序列号,在使用RedisTemplate对象是默认使用JdkSerializationRedisSerializer实现。还提供了其它的序列化实现如:Jackson2JsonRedisSerializer,JacksonJsonRedisSerializer,GenericToStringSerializer,StringRedisSerializer,OxmSerializer。

另外用户可以提供自己的序列化实现

6.2配置RedisTemplate

<bean id="redisTemplate" class="org.springframework.data.redis.core.RedisTemplate"
    p:connection-factory-ref="jedisConnectionFactory" />
  <bean id="stringRedisTemplate" class="org.springframework.data.redis.core.StringRedisTemplate">
    <property name="connectionFactory" ref="jedisConnectionFactory" />
  </bean>

这里配置了RedisTemplate和StringRedisTemplate,不同之处在于StringRedisTemplate的Key-Value序列化使用的是StringRedisSerializer。使用StringRedisTemplate操作Redis之后的结果是读友好的。

另外对Hash类型而言,还有对应的HashKey序列化(其对应于Hash类型的字段名)。

6.3RedisTemplate的使用

// 测试RedisTemplate,自主处理key的可读性(String序列号)
  @Ignore
  @Test
  public void test4() {
    String key = "spring";
    ListOperations<String, String> lop = redisTemplate.opsForList();
    RedisSerializer<String> serializer = new StringRedisSerializer();
    redisTemplate.setKeySerializer(serializer);
    redisTemplate.setValueSerializer(serializer);
    // rt.setDefaultSerializer(serializer);

    lop.leftPush(key, "aaa");
    lop.leftPush(key, "bbb");
    long size = lop.size(key); // rt.boundListOps(key).size();
    Assert.assertEquals(2, size);
  }

  // 测试便捷对象StringRedisTemplate
  @Ignore
  @Test
  public void test5() {
    ValueOperations<String, String> vop = stringRedisTemplate.opsForValue();
    String key = "string_redis_template";
    String v = "use StringRedisTemplate set k v";
    vop.set(key, v);
    String value = vop.get(key);
    Assert.assertEquals(v, value);
  }

具体使用那种序列化策略则更加存储的Key-Value内容做权衡即可。

通过RedisTemplate中的方法的参数RedisCallback回调接口来获取RedisConnection,进一步操作Redis,比如事务控制。需要注意的是如果使用StringRedisTemplate则返回的是StringRedisConnection对象。

测试RedisCallback代码示例:

  1. // 测试Callback
  2. @Ignore
  3. @Test
  4. public void test61() {
  5. Long dbsize = (Long) stringRedisTemplate
  6. .execute(new RedisCallback<Object>() {
  7. @Override
  8. public Long doInRedis(RedisConnection connection)
  9. throws DataAccessException {
  10. StringRedisConnection stringRedisConnection=(StringRedisConnection)connection;
  11. return stringRedisConnection.dbSize();
  12. }
  13. });
  14. System.out.println(“dbsize:” + dbsize);
  15. }

测试SessionCallback代码示例:

  1. @Test
  2. public void test62() {
  3. List<Object> txresult = stringRedisTemplate
  4. .execute(new SessionCallback<List<Object>>() {
  5. @Override
  6. public List<Object> execute(RedisOperations operations)
  7. throws DataAccessException {
  8. operations.multi();
  9. operations.opsForHash().put(“hkey”, “multikey4”,
  10. “multivalue4”);
  11. operations.opsForHash().get(“hkey”, “k1”);
  12. return operations.exec();
  13. }
  14. });
  15. for (Object o : txresult) {
  16. System.out.println(o);
  17. /**
  18. * 0. false/true
  19. * 1. v1
  20. */
  21. }
  22. }

说明:

  • 在事务中的操作返回都是null,因此不能在execute中对操作的结果进行处理。比如这里get(“hkey”,”k1″)的结果。

  • Hash操作中如果字段存在则返回false(redis中是0),不存在返回true(redis中是1)与字段对应的值是否更新无关联。

  • exec()方法返回List<Object>中的对象对应事务中执行的每条命令的返回结果。

7.执行Lua脚本

Redis中执行Lua脚本开发思路: http://aiilive.blog.51cto.com/1925756/1626372

Spring Data Redis中执行Lua脚本更加便利,下面示例展示使用RedisTemplate对象执行Lua脚本。

  1. // 测试Lua脚本
  2. @Ignore
  3. @Test
  4. public void test71() {
  5. List<String> keys = new ArrayList<String>();
  6. RedisScript<Long> script = new DefaultRedisScript<Long>(
  7. “local size = redis.call(‘dbsize’); return size;”, Long.class);
  8. Long dbsize = stringRedisTemplate
  9. .execute(script, keys, new Object[] {});
  10. System.out.println(“sha1:” + script.getSha1());
  11. System.out.println(“Lua:” + script.getScriptAsString());
  12. System.out.println(“dbsize:” + dbsize);
  13. }
  14. @Test
  15. public void test72() {
  16. DefaultRedisScript<Boolean> script = new DefaultRedisScript<Boolean>();
  17. /**
  18. * isexistskey.lua内容如下:
  19. *
  20. * return tonumber(redis.call(“exists”,KEYS[1])) == 1;
  21. */
  22. script.setScriptSource(new ResourceScriptSource(new ClassPathResource(
  23. “/isexistskey.lua”)));
  24. script.setResultType(Boolean.class);// Must Set
  25. System.out.println(“script:” + script.getScriptAsString());
  26. Boolean isExist = stringRedisTemplate.execute(script,
  27. Collections.singletonList(“k2”), new Object[] {});
  28. Assert.assertTrue(isExist);
  29. }

8.支持类操作

在org.springframework.data.redis.support包中提供了各种可重用组件,这些组件可以应用到Redis存储,如atomic计数,JDK集合,Redis的类型集合(RedisList,RedisSet等)

<redis:collection id="springList" key="springlist"
    template="stringRedisTemplate" type="LIST" />
  1. @Ignore
  2. @Test
  3. public void test8() {
  4. RedisAtomicInteger rai = new RedisAtomicInteger(“redis:atomic”,
  5. jedisConnetionFactory);
  6. System.out.println(rai.get());
  7. }
  8. // 测试Redis Collection
  9. @Ignore
  10. @Test
  11. public void test9() {
  12. @SuppressWarnings(“unchecked”)
  13. RedisList<String> redisList = (RedisList<String>) ctx
  14. .getBean(“springList”);
  15. redisList.clear();
  16. redisList.addFirst(“china”);
  17. redisList.add(“in”);
  18. redisList.add(“go”);
  19. redisList.addLast(“made”);
  20. System.out.println(redisList.getKey());
  21. }

关注微信公众号:

留言暗号给他: 我是程序员  即可赠送一套redis视频 记得不要取消关注 因为不定期送视频

他们有1700G it视频  (识别二维码 或者搜索公众号 历史帝 或者zhenshidelishi)
赠送视频如下:
不定期送视频
1700G it视频  等你来!
留言给他 即可赠送一套视频
更新!!
元宵节巨献:2月12 号 赠送 多套花钱买的架构师视频
赶紧去关注吧!!

SpringBoot 统一时区的方案

系统采用多时区设计的时候,往往我们需要统一时区,需要统一的地方如下: 服务器(Tomcat服务) 数据库(JPA + Hibernate) 前端数据(前端采用Vuejs) ...

阅读全文

php无法连接mysql解决办法

前段时间把我的阿里云机器上面跑的服务修改成了docker部署,但是在升级了mysql容器之后发现另一个wordpress的站一直无法打开,提示无法连接数据库,这个很奇...

阅读全文

Spring Boot 容器选择 Undertow 而不是 Tomcat

Spring Boot内嵌容器支持Tomcat、Jetty、Undertow。为什么选择Undertow? 这里有一篇文章,时间 2017年1月26日发布的: Tomcat vs. Jetty vs. Undertow:...

阅读全文

欢迎留言