spring-boot 自己编写一个spring-boot-starter-redis

在实际项目开发中，我们常常会用到各种各样的starter，为什么我们引入这些starter依赖就能够快速的使用它们提供的功能，其中到底有什么奥秘，它们的实现原理是什么，本节内容就给大家演示一下如何自己编写spring-boot-starter-redis。

一、新建一个maven项目spring-boot-starter-redis

引入如下依赖：

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
        <version>1.5.7.RELEASE</version>
</dependency>
<dependency>
        <groupId>redis.clients</groupId>
        <artifactId>jedis</artifactId>
        <version>2.9.0</version>
</dependency>

二、在此项目中编写RedisProperties.class，用以从application.properties中读取redis的配置信息。

@ConfigurationProperties(prefix = "redis")public class RedisProperties {    private String host;    private Integer port;    //getter/setter省略...}

三、在此项目中编写RedisAutoConfiguration.class，用以将Jedis的bean装载进spring容器中

@SpringBootConfiguration@EnableConfigurationProperties(RedisProperties.class)@ConditionalOnClass(Jedis.class)public class RedisAutoConfiguration {    @Bean
    @ConditionalOnMissingBean(Jedis.class)    public Jedis jedis(RedisProperties redisProperties) {  
        //spring会自动将RedisProperties这个bean注入进来，读者也可以手动注入
        return new Jedis(redisProperties.getHost(), redisProperties.getPort());
    }
}

为大家解释一下这些注解的含义

• @SpringBootConfiguration：代表这是一个配置类

• @EnableConfigurationProperties(RedisProperties.class)：将RedisProperties加载到spring容器中。参考Spring-Boot之@Enable*注解的工作原理

• @ConditionalOnClass(Jedis.class)：当项目引用了Jedis的jar时，才加载此配置类。参考Spring-Boot autoconfigure之Condition

重点来了
作者在编写RedisProperties.class这个类的时候遇到了一些问题，IDEA提示如下：

Configuration Annotation Processor not found

点击右上角打开spring官方文档查看，说需要我在pom.xml文件中引入spring-boot-configuration-processor依赖

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-configuration-processor</artifactId>
        <version>1.5.7.RELEASE</version>
        <optional>true</optional>
</dependency>

本以为问题解决，没想到又提示我：

Re-run spring boot configuration annotation processor

这下把我给整蒙了，找了好久的资料，最后无意间把问题解决了 - -！

需要把红框圈上的钩给去掉

四、在此项目中resource目录下新建application.properties文件

redis.host=127.0.0.1
redis.port=6379

好，接下来开始我们的另一个项目，去使用我们自己编写的spring-boot-starter-redis

五、新建Blog项目，引入spring-boot-starter-redis依赖

<dependency>
        <groupId>com.bamu.jianshu</groupId>
        <artifactId>spring-boot-starter-redis</artifactId>
        <version>1.0-SNAPSHOT</version>
</dependency>

六、在Blog项目中，编写启动类BlogApplication

@SpringBootApplicationpublic class BlogApplication {    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(BlogApplication.class, args);
        Jedis jedis = context.getBean(Jedis.class);        //如果成功连接上了redis，jedis.ping()会返回一个pong
        System.out.println(jedis.ping());
    }
}

七、本地启动redis

启动redis的过程不再赘述

redis

好，我们现在可以试试看，运行Blog项目的启动类，但是肯定会失败的。原因在于我们的Blog项目获取不到spring-boot-starter-redis项目中的Jedis这个bean。参考Spring-boot @EnableAutoConfiguration源码分析。这篇文章讲述了一种方式，事实上还有另一种方式，编写一个EnableRedis的注解，使用@Import将RedisAutoConfiguration这个类给导入进去。

1）方式1 在Blog项目中编写@EnableRedis注解

@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documented@Import(RedisAutoConfiguration.class)public @interface EnableRedis {
}

将此注解加在BlogApplication.class启动类上

@SpringBootApplication@EnableRedis//关键的一步public class BlogApplication {    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(BlogApplication.class, args);
        Jedis jedis = context.getBean(Jedis.class);
        System.out.println(jedis.ping());
    }
}

2）方式2 在Blog项目中resource的META-INF目录下写一个spring.factoryes配置文件，加载RedisAutoConfiguration.class

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.jianshu.bean.RedisAutoConfiguration

好，所有代码编写完毕。我们可以试一试，可是！！！又报错了，NullPointerException，我们获取到的RedisProperties里面的Host/port字段都会null，为什么？？？难道@ConfigurationProperties注解从环境中没有拿到我这两个字段。

这个问题把我给耽误了好几个小时。这里要着重讲一讲，也是给我自己提个醒。错误的关键点在于编写了host和port这两个字段的默认值的application.properties文件不应写在spring-boot-starter-redis这个项目中，而应写在Blog项目中。

在更换了application.properties文件的位置后，两种方式都能运行成功。

pong

为什么需要写在引用starter的项目中，我的理解是：ConfigurationProperties从环境Environment中获取字段默认值，我们启动的是Blog项目，环境加载的是Blog项目的application.properties文件。所以我们应该把配置写在Blog项目中。

其实从结论倒推原因我们也可以理解，假如我们的项目需要用到某一个starter，例如spring-boot-starter-mongo，难道我还得从starter-mongo的代码中去修改host/port/password等等参数吗？必然是在我们自己项目的application.properties文件中配置参数，就可以直接获取到Bean！

最后，讲一个扩展点：其实spring-boot-autoconfiguration.jar中已经为我们集成了大量的第三方中间件：redis、mongo、kafka等。本文讲述的实现方式是源码中redis的实现方式的简化版，源码作者也编写了两个类RedisProperties、RedisAutoConfiguration，读者可以去一探究竟，试试看能否通过些许配置，拿到redisTemplate这个对象，用以在生产级别来使用。具体实现方式会在接下来的文章中讲解。读者可以持续关注我的springboot系列文章！

作者：八目朱勇铭
链接：https://www.jianshu.com/p/f883dae9a6b6