GitHub 地址

訪問(wèn)GitHub下載最新源碼：https://github.com/JYG0723/SpringBootAction/tree/master/chapter4

Spring Boot 中除了對(duì)常用的關(guān)系型數(shù)據(jù)庫(kù)提供了優(yōu)秀的自動(dòng)化支持之外，對(duì)于很多 NoSQL 數(shù)據(jù)庫(kù)一樣提供了自動(dòng)化配置的支持，包括：Redis嗜桌，MongoDB,赴涵，Elasticsearch,，Solr 和 Cassandra鸽嫂。

Redis

• Redis官網(wǎng)
• Redis中文社區(qū)

Pom

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

Spring Boot提供的數(shù)據(jù)訪問(wèn)框架 Spring Data Redis 基于Jedis织鲸，源碼：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.data</groupId>
        <artifactId>spring-data-redis</artifactId>
    </dependency>
    <dependency>
        <groupId>redis.clients</groupId>
        <artifactId>jedis</artifactId>
    </dependency>
</dependencies>

properties

# REDIS (RedisProperties)
# Redis數(shù)據(jù)庫(kù)索引（默認(rèn)為0）
spring.redis.database=0
# Redis服務(wù)器地址
spring.redis.host=localhost
# Redis服務(wù)器連接端口
spring.redis.port=6379
# Redis服務(wù)器連接密碼（默認(rèn)為空）
spring.redis.password=
# 連接池最大連接數(shù)（使用負(fù)值表示沒(méi)有限制）
spring.redis.pool.max-active=8
# 連接池最大阻塞等待時(shí)間（使用負(fù)值表示沒(méi)有限制）
spring.redis.pool.max-wait=-1
# 連接池中的最大空閑連接
spring.redis.pool.max-idle=8
# 連接池中的最小空閑連接
spring.redis.pool.min-idle=0
# 連接超時(shí)時(shí)間（毫秒）
spring.redis.timeout=0

其中spring.redis.database的配置通常使用0即可，Redis 在配置的時(shí)候可以設(shè)置數(shù)據(jù)庫(kù)數(shù)量溪胶，默認(rèn)為16搂擦，可以理解為數(shù)據(jù)庫(kù)的 schema

因?yàn)橛泻枚嗳嗽鴨?wèn)我是如何看源碼的，(其實(shí)我不怎么看哗脖，偶爾瞟兩眼)瀑踢，然后這里我就簡(jiǎn)單說(shuō)一下我是怎么過(guò)流程的。

看源碼：

這里對(duì)著屬性才避，CTRL + B

到了這里橱夭，我們就進(jìn)入了源碼的世界。

同樣可以根據(jù) CTRL + B 定位到我們的 Libraries 中類(lèi)所在的位置桑逝。我經(jīng)常定位到這里會(huì)看看引入的包的目錄結(jié)構(gòu)棘劣，或者隨便點(diǎn)點(diǎn)看看該包下的其他相關(guān)類(lèi)。

再對(duì)著 RedisProperties 類(lèi) CTRL + B楞遏。我們可以看到很多處引用到該 RedisProperties 類(lèi)的地方茬暇，其中有包引入import ···首昔，還有專(zhuān)門(mén)為該類(lèi)開(kāi)啟關(guān)于@ConfigurationProperties注解的支持，@EnableConfigurationProperties糙俗。還有實(shí)例的聲明勒奇，還有作為構(gòu)造參數(shù)的注入，還有靜態(tài)變量的引用巧骚，還有配置文件對(duì)應(yīng)關(guān)系的指定赊颠。等等，會(huì)有很多作用處被檢索到劈彪。我們需要根據(jù)自己感興趣的內(nèi)容點(diǎn)進(jìn)去一探究竟竣蹦。這里很明顯我們進(jìn)入了 RedisAutoConfiguration(看名字都知道是你)。

一進(jìn)來(lái)就看到了很多的條件沧奴。眾多的@ConditionalOnClass擺在面前痘括。我們?cè)趺礃幽苤肋@些被要求存在于 classpath 的類(lèi)是否存在于 classpath 呢？ 很簡(jiǎn)單扼仲，

我們按住 CTRL 鼠標(biāo)移到該類(lèi)上方远寸，就可以看到這一行詳細(xì)信息，這一段信息向我們交代了它所被包含在 maven 的哪個(gè)包中屠凶。在什么包下驰后，還順帶告訴了我們他繼承了 AbstractRedisConnection 類(lèi)。是不是很直觀很清晰矗愧。下面我們還看到一個(gè)引用了的@ConditionalOnClass的配置 bean灶芝。我們還用剛才的小套路，發(fā)現(xiàn)咦不對(duì)唉韭，乍一看夜涕。如果我們對(duì)一些包依賴(lài)不清晰的話(huà)，以為自己沒(méi)有在 maven 中引入這個(gè)依賴(lài)呢属愤，雖然我們確實(shí)沒(méi)有顯示的依賴(lài)女器。但是我們不妨在右側(cè)的 MavenProjects 欄下的樹(shù)結(jié)構(gòu)找一找看看是否真的沒(méi)有引入該依賴(lài)呢。就這樣住诸，我們找到了它驾胆。原來(lái) springboot 打包好的 starter-data-redis 下的 redis.clients:jedis 依賴(lài)已經(jīng)為我們傳遞依賴(lài)引入了該 commons 依賴(lài)。

到這里贱呐，我們就可以確認(rèn)這個(gè) springboot 為我們自動(dòng)配置的配置類(lèi)可以作用了丧诺。同時(shí)它下面的靜態(tài)內(nèi)部類(lèi) RedisConnectionConfiguration 也可以起作用了。是不是很有感覺(jué)呢 ~ 到這里我們先暫停存檔奄薇，待我們進(jìn)行到后面繼續(xù)帶大家探索驳阎。

測(cè)試訪問(wèn)

我們引入了各種依賴(lài)，也為其配置了屬性，也走了一遍流程呵晚。我們覺(jué)得他應(yīng)該是可以運(yùn)作了蜘腌。可是到底是可以了嗎劣纲？我們也不確定逢捺，那就來(lái)寫(xiě)一個(gè)測(cè)試用例吧谁鳍。

@RunWith(SpringRunner.class)
@SpringBootTest
public class Chapter4ApplicationTests {

    @Autowired
    private StringRedisTemplate stringRedisTemplate;

    @Test
    public void contextLoads() {
    }

    @Test
    public void test() throws Exception {
        stringRedisTemplate.opsForValue().set("aaa", "111");

        Assert.assertEquals("111", stringRedisTemplate.opsForValue().get("aaa"));
    }

}

通過(guò)上面這段極為簡(jiǎn)單的測(cè)試案例演示了如何通過(guò)自動(dòng)配置的StringRedisTemplate對(duì)象進(jìn)行 Redis 的讀寫(xiě)操作癞季，該對(duì)象從命名中就可注意到支持的是 String 類(lèi)型 StringRedisTemplate extends RedisTemplate<String, String>。如果有使用過(guò)spring-data-redis的開(kāi)發(fā)者一定熟悉RedisTemplate<K, V>接口倘潜，StringRedisTemplate就相當(dāng)于RedisTemplate<String, String>的實(shí)現(xiàn)绷柒。

除了 String 類(lèi)型，實(shí)戰(zhàn)中我們還經(jīng)常會(huì)在 Redis 中存儲(chǔ)對(duì)象涮因，這時(shí)候我們就會(huì)想是否可以使用類(lèi)似RedisTemplate<String, User>來(lái)初始化并進(jìn)行操作废睦。但是 Spring Boot 并不支持直接使用，需要我們自己實(shí)現(xiàn)RedisSerializer<T>接口來(lái)對(duì)傳入對(duì)象進(jìn)行序列化和反序列化养泡，下面我們通過(guò)一個(gè)實(shí)例來(lái)完成對(duì)象的讀寫(xiě)操作嗜湃。

Po

public class User implements Serializable {

    // 手動(dòng)聲明較好
    private static final long serialVersionUID = -1L;

    private String username;
    private String password;

    public User(String username, String password) {
        this.username = username;
        this.password = password;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

實(shí)現(xiàn)對(duì)象的序列化接口

public class RedisObjectSerializer implements RedisSerializer<Object> {

    private Converter<Object, byte[]> serializer = new SerializingConverter();
    private Converter<byte[], Object> deserializer = new DeserializingConverter();

    static final byte[] EMPTY_ARRAY = new byte[0];

    @Override
    public Object deserialize(byte[] bytes) {
        if (isEmpty(bytes)) {
            return null;
        }
        try {
            return deserializer.convert(bytes);
        } catch (Exception ex) {
            throw new SerializationException("Cannot deserialize", ex);
        }
    }

    @Override
    public byte[] serialize(Object object) {
        if (object == null) {
            return EMPTY_ARRAY;
        }
        try {
            return serializer.convert(object);
        } catch (Exception ex) {
            return EMPTY_ARRAY;
        }
    }

    private boolean isEmpty(byte[] data) {
        return (data == null || data.length == 0);
    }
}

到這里你可能會(huì)問(wèn)，為什么你要配置這個(gè)呢澜掩？這個(gè)不急购披，我們后面詳談。

針對(duì) User 的 RedisTemplate 實(shí)例

@Configuration
public class RedisConfig {

   @Bean
   JedisConnectionFactory jedisConnectionFactory() { // 方法名即對(duì)象名
       return new JedisConnectionFactory();
   }

   @Bean
   public RedisTemplate<String, User> redisTemplate(RedisConnectionFactory redisConnectionFactory {
       RedisTemplate<String, User> template = new RedisTemplate<String, User>();
       template.setConnectionFactory(jedisConnectionFactory());
       template.setKeySerializer(new StringRedisSerializer());
       template.setValueSerializer(new RedisObjectSerializer());
       return template;
   }
}

到了這里肩榕。你肯定會(huì)問(wèn)我刚陡，為什么要這樣配？這樣配好雜亂株汉，我怎么樣就可以記住它呢筐乳？別忘了我們相當(dāng)于配置了一個(gè) RedisTemplate 類(lèi)的子類(lèi)哦。既然同時(shí)其子類(lèi)乔妈，為什么我們不參考那個(gè)被自動(dòng)配置的 StringRedisTemplate 類(lèi)呢蝙云？

所以我們繼續(xù)我們的源碼：

是不是瞬間明白了我們前面為什么要?jiǎng)?chuàng)建 RedisObjectSerializer 類(lèi)來(lái)實(shí)現(xiàn)對(duì)象的序列化接口。因?yàn)槲覀冊(cè)趯?shí)現(xiàn) RedisTemplate 類(lèi)的時(shí)候需要引用我們關(guān)于對(duì)象的序列化方式路召。既然要?jiǎng)?chuàng)建的序列化接口勃刨，就要去參謀一下別人的序列化接口是怎么實(shí)現(xiàn)的不是嗎？所以來(lái)到 StringRedisSerizlizer 類(lèi)优训。

照貓畫(huà)虎我們也來(lái)一遍自己的實(shí)現(xiàn)朵你。就 ok 了

StringRedisTemplate 類(lèi)的第一個(gè)構(gòu)造函數(shù)看完了。我們?cè)賮?lái)看一看第二個(gè)構(gòu)造函數(shù)有什么要求揣非。

它要求我們配置一個(gè) RedisConnectionFactory 接口式的連接工廠抡医。這里我們不用 RedisConnectionFactory 默認(rèn)的實(shí)現(xiàn)。既然我們是 Java 應(yīng)用 Redis。那就用我們依賴(lài)中包含的傳遞依賴(lài) jedis (即 Java 語(yǔ)言來(lái)操作 Redis) 中的 JedisConnectionFactory 類(lèi)來(lái)創(chuàng)建該鏈接工廠忌傻。同時(shí)該 JedisConnectionFactory 類(lèi)也是專(zhuān)門(mén)針對(duì) Java 語(yǔ)言對(duì)該RedisConnectionFactory 接口的實(shí)現(xiàn)類(lèi)大脉。由于 SpringBoot 為我們自動(dòng)配置 JedisConnectionFactory 的要求是 classpath 中不包含 RedisConnectionFactory 。這里我們只有顯示聲明水孩。同時(shí)也可以在 pom 文件中將其排除出去镰矿。

除此之外。原來(lái)在 StringRedisTemplate 中顯示調(diào)用的 afterproperties() 方法這里由于我們實(shí)現(xiàn)了自己的實(shí)例化接口也不再顯示調(diào)用俘种。該方法由 RedisTemplate 進(jìn)行了擴(kuò)展秤标，為我們鍵值以及 hashkey，hashvalue 判斷如果為空則引用默認(rèn)的實(shí)例化方案宙刘。由于首先調(diào)用了其父類(lèi)的該方法苍姜，我們不妨進(jìn)去看看。一目了然悬包，利用斷言確保我們配置了連接工廠而已衙猪。

到這里我們的源碼探索就結(jié)束了。是不是覺(jué)得看源碼其實(shí)也沒(méi)有那么難布近？

測(cè)試

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserSerializableTest {

    @Autowired
    private RedisTemplate<String, User> redisTemplate;

    @Test
    public void test() throws Exception {

        //保存對(duì)象
        User user = new User("ji", 20);
        redisTemplate.opsForValue().set(user.getUsername(), user);

        user = new User("yong", 30);
        redisTemplate.opsForValue().set(user.getUsername(), user);

        user = new User("guang", 40);
        redisTemplate.opsForValue().set(user.getUsername(), user);

        Assert.assertEquals(20, redisTemplate.opsForValue().get("ji").getAge().longValue());
        Assert.assertEquals(30, redisTemplate.opsForValue().get("yong").getAge().longValue());
        Assert.assertEquals(40, redisTemplate.opsForValue().get("guang").getAge().longValue());
    }
}

可以看到我們?nèi)齻€(gè)對(duì)象已經(jīng)成功序列化并存儲(chǔ)到 Redis 中啦垫释。