Springboot Redis客户端配置及初始化过程源码解读

     最近项目中遇到redis超时的问题， 在查证过程中存在一些疑问。为什么有不同的配置文件？ spring boot是如何加载redis的呢？ redis又是如何工作的呢？redis如何使用连接池的呢？  为了搞清楚背后的机制，阅读源码一探究竟。

 1:  spring boot 集成redis客户端介绍

1.1： jedis客户端  

spring boot 1.x.x在集成redis时，默认jedis作为连接客户端。由于jedis是直连模式，多个线程直接共享一个jedis实例时是线程不安全的，如果想在多线程的环境下使用，就需要使用连接池。 这样每个线程都拥有自己的jedis实例。但是当连接数量增大， 存在性能开销较高的问题。

spring boot 1.x.x 单台配置属性：

spring:  
  redis:
    database: 0 # Redis数据库索引（默认为0）
    host: localhost # Redis服务器地址
    port: 6379 # Redis服务器连接端口 默认6379
    password: 123456 # Redis服务器连接密码（默认为空）
    jedis:
      shutdown-timeout: 300ms #关闭超时
      pool:
        max-active: 10 #连接池最大连接数（使用负值表示没有限制）
        max-wait: 1000 #连接池最大阻塞等待时间（使用负值表示没有限制）
        max-idle: 8 #连接池中的最大空闲连接
        min-idle: 0 #连接池中的最小空闲连接

1.2: lettuce客户端  

在spring boot2版本发布后，采用lettuce作为连接redis服务器的默认客户端， 同时兼容jedis客户端的连接方式，lettuce的连接是基于Netty实现的，netty 是一个多线程、事件驱动的 I/O 框架  ，通过异步的方式可以让我们更好的利用系统资源，而不用浪费线程等待网络或磁盘I/O 。连接实例可以在多线程之间共享，多个线程共享一个连接实例，就不用担心并发线程的数据。同时支持可伸缩的设计，一个连接实例不够的情况，可以按需增加连接实例。

spring boot 2.x.x 单台配置属性例如:

spring:  
 redis:
    database: 0 # Redis数据库索引（默认为0）
    host: localhost # Redis服务器地址
    port: 6379 # Redis服务器连接端口 默认6379
    password: 123456 # Redis服务器连接密码（默认为空）
    lettuce:
      shutdown-timeout: 100ms #关闭超时
      pool:
        max-active: 8 #连接池最大连接数（使用负值表示没有限制）
        max-wait: 1000 #连接池最大阻塞等待时间（使用负值表示没有限制）
        max-idle: 8 #连接池中的最大空闲连接
        min-idle: 0 #连接池中的最小空闲连接
    timeout: 60000 #连接超时时间（毫秒）（默认值为6000）

细心的同学会发现，两个版本的配置的文件的属性不同。那么我们再项目中具体运用的时候要因地制宜。结合自己项目spring  boot的版本进行灵活配置。否则会造成启动报错、或者配置的参数无法生效。

2： spring boot 初始化redis解读

2.1:  版本信息

        项目使用的版本： spring boot版本 2.0.6.RELEASE，对应的lettuce-core 版本是 5.0.5.RELEASE

2.2： spring boot2在启动时候。会加载 spring boot autoConfig模块下有个 RedisAutoConfiguration 类

2.3  LettuceConnectionConfiguration 源码如下 ：

备注： 通过源码我们可以看到LettuceConnectionConfiguration初始化，有个条件就是在项目的pom文件中 必须引入lettuce-core的jar包。 此处有个用途：由于spring boot2默认是lettuce客户端， 那么我们就可以通过在pom文件中 spring-boot-starter-data-redis中 排除lettuce jar包，引入jedis jar ,就可以切换为jedis客户。

2.4. JedisConnectionConfiguration源码如下 ：

备注：这就是为什么spring boot2 默认初始化lettuce客户端的原因

2.5  根据默认客户端资源和配置连接池配置  初始化 lettuce客户端配置

2.6  创建含有对象池的lettuce客户端配置对象

备注：根据配置文件中连接池配置，把参数初始化对象池，然后创建 LettucePoolingClientConfiguration实例。 这个实例是为了在后续从连接池中获取连接。 

2.7  为什么要映入手动引入对象池jar包

以下是 lettuce-core jar包的pom文件，我们可以看到 虽然我们 spring-boot-starter-data-redis jar 默认已入 lettuce-core jar 。但是没有引入common-pool2的jar包， 如果你的项目中没有手动引入commons-pool2 jar，那么你的redis客户端连接不会走连接池， 也就不能把redis的性能发挥的淋漓尽致。

2.8  创建lettuce连接工厂实例 LettuceConnectionFactory

根据配置文件：我们可以创建哨兵模式、集群模式、直接模式 ，至于这几种模式的区别大家可以网上查一下，这里就不展开讨论

截止到此，整理一下思路： spring 已经根据配置文件完成：解析redis配置文件 -----> 根据配置初始化客户端配置 -----> 根据客户端配置创建redis连接工厂 ----->  根据redis连接工厂实例， 创建RedisTemplate 和StringRedisTemplate对象实例注入到容器

我们再回到RedisAutoConfiguration类， 可以看到 在创建RedisTemplate实例时，从容器中把连接工厂对象注入到redisTemplate、StringRedisTemplate对象中。那么就完成了redisTemplate、StringRedisTemplate对象的初始化工作。 项目中就可以直接使用了。

3: RedisTemplate 核心方法解读

3.1  由于RedisTemplate 继承 RedisAccessor ，RedisAccessor 实现了InitializingBean接口，  RedisTemplate 在初始化时候会执行afterPropertiesSet 方法， 设置一些默认属性：

在项目中，由于RedisTemplate 默认采用JdkSerializationRedisSerializer 可读性较差，  我们一般都会自定义 RedisTemplate对象， 设置它的序列化方式，项目中经常 key 采用 StringRedisSerializer序列号，value和hashValue采用 GenericJackson2JsonRedisSerializer, 当然这个根据实际需要场景设置 （备注：StringRedisTemplate对 key 和 value 都是采用 StringRedisSerializer）

3.2  执行指令重要方法 execute 

打开RedisTemplate类，我们可以发现有很多的方法， RedisTemplat封装了对 字符串、哈希、列表、集合、有序集合等类型的读写操作方法, 项目中我们对RedisTemplate对redis进行读写操作时，向redis服务器发送执行指令，通过下面execute方法 ：

3.3： execute方法中获取连接

在 RedisConnectionUtils.doGetConnection方法中我们可以看到获取不同客户端的连接

3.4 LettuceConnection类不同模式获取连接方法介绍

在LettuceConnectFactory中 通过LettuceConnection 创建 LettuceConnection.该类封装了不同类型的连接：如下图集群模式异步指令连接、集群模式非异步连接、哨兵模式连接、直连模式的异步、非异步连接等等。

3.5 LettuceConnection  获取异步连接

在LettuceConnection.getAsyncConnection()方法中， 通过doGetAsyncDedicatedConnection()获取异步连接.

3.6 连接池中获取连接

根据connectionProvider对象实例。如果我们在创建lettuce客户端时包含了连接池配置，那么就可以从连接池对象中获取连接。源码如下：

到此： 我们已经阅读了RedisTemplate源码，了解到该类初始化时默认的序列号方式、以及其核心方法execute，execute封装从工厂中获取连接，执行指令，释放连接的，以及如何从连接池中获取连接。

4： 小结

通过源码分析了解到spring boot 集成和初始化redis的整个过程。 所有的操作封装在RedisTemplate对象中，以组件的形式注入到spring 生态中。 可插拔的设计思想，高度封装化， 低侵入性， 为开发人员在项目中快速集成redis提供了便利。 在项目的实际开发过程中也可以借鉴这种设计思路， 把独立的功能模块封装成独组件注入到spring 生态中，作为公共组件快速集成到不同的项目中， 提高开发效率。