SpringBoot自动配置之自定义起步依赖

SpringBoot自动配置之自定义起步依赖

参考mybatis起步依赖,自定义redis-start起步依赖

自定义redis-start,要求当导入redis坐标的时候,SpringBoot自动创建Jedis的bean

• 步骤一:创建redis-spring-boot-autoconfigure模块

  • RedisBean的自动配置类:

  import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
  import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
  import org.springframework.boot.context.properties.EnableConfigurationProperties;
  import org.springframework.context.annotation.Bean;
  import org.springframework.context.annotation.Configuration;
  import redis.clients.jedis.Jedis;
  
  @Configuration//注解配置
  @EnableConfigurationProperties(RedisProperties.class)//启用加载properties配置类,这样会让配置类proerties被Spring容器识别并加载过来,这样在下方创建jedisbean时就可以动态加载bean
  @ConditionalOnClass(Jedis.class)//条件加载,在有Jedis的前提下再去创建此Bean
  public class RedisAutoConfiguration {
  
      /**
       * 提供Jedis的bean
       */
      @Bean
      @ConditionalOnMissingBean(name = "jedis")//条件加载,如果用户自定义了Jedisbean,就用自定义的,此Bean才会提供
      public Jedis jedis(RedisProperties redisProperties) {
          System.out.println("RedisAutoConfiguration....");
          return new Jedis(redisProperties.getHost(), redisProperties.getPort());
      }
  }
  
  

  • RedisProperties配置类:

    
    import org.springframework.boot.context.properties.ConfigurationProperties;
    
    @ConfigurationProperties(prefix = "redis")//此配置在加载配置文件是redis开头的相关属性都会和此类中对应
    public class RedisProperties {
    
        private String host = "localhost";
        private int port = 6379;
    
        public String getHost() {
            return host;
        }
    
        public void setHost(String host) {
            this.host = host;
        }
    
        public int getPort() {
            return port;
        }
    
        public void setPort(int port) {
            this.port = port;
        }
    }
    
    

• **步骤二:**创建redis-spring-boot-starter模块,依赖redis-spring-boot-autoconfigure模块

• **步骤三:**在redis-spring-boot-autoconfigure模块中初始化jedis的Bean.并且定义META-INF/spring.factories文件(具体可以参考源码,)

  • 源码可以在启动类注解中的@EnableAutoConfiguration中的@Import(AutoConfigurationImportSelector.class)中的getCandidateConfigurations方法中有对应的名字,可以找到对应的源码

  • resources目录下创建:

    org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
      com.itheima.redis.config.RedisAutoConfiguration
    

• 在测试模块中引入自定义的redis-starter依赖,测试获取Jedis的Bean,操作redis