脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot自定义starter

SpringBoot自动配置之自定义starter的实现代码

 更新时间：2020年10月17日 09:36:55   作者：温森  
这篇文章主要介绍了SpringBoot自动配置之自定义starter的实现代码,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下

前言：前面已经介绍了自动配置的很多原理，现在我们着手自己定义一个starter。

需求：自定义redis-starter，要求当导入redis坐标后，SpringBoot自动创建Jedis的Bean。正式开始之前，我们可以查看Mybatis的起步依赖是如果实现自动配置的。我这里就省略了，大家根据之前的分析文章，自己看源码即可。

一、先创建一个SpringBoot工程redis-spring-boot-autoconfigure，该工程中添加jedis依赖，并且创建一个自动配置类RedisAutoConfigure，实现jedis实例（bean）注入到IOC容器中。

/**
 * @description：自定义自动配置类：将Jedis注入到IOC容器中
 * @date： 2020/10/10 15:08
 * @author： winson
 */
@Configuration
@EnableConfigurationProperties(RedisProperties.class)
public class RedisAutoConfigure {

 /**
  * 提供jedis的bean
  * @param redisProperties
  * @return
  */
 @Bean
 public Jedis jedis(RedisProperties redisProperties) {
  return new Jedis(redisProperties.getHost(), redisProperties.getPort());
 }

}

考虑到redis的有两个参数（host、port）必须是可以动态赋值的，所以我们自定义一个属性配置类RedisProperties，该属性配置类从配置文件获取属性值,并设置host、port属性的默认值，如下：

/**
 * @description：自定义属性配置类
 * @date： 2020/10/10 15:11
 * @author： winson
 */
@ConfigurationProperties(prefix = "redis")
public class RedisProperties {

 private String host = "127.0.0.1";

 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;
 }
}

@EnableConfigurationProperties注解的作用：由于自动配置类RedisAutoConfigure中，注册jedis的bean中参数需要使用到RedisProperties的bean，但无法获取到RedisProperties的bean，所以我们可以通过这个注解，手动的将该bean注入到IOC容器中。

在resources目录下按照SpringBoot自动配置目录、文件名称的规则，如下图，新建一个自己的spring.factories文件

spring.factories文件内容：就是将自定义的自动配置类声明为名称为org.springframework.boot.autoconfigure.EnableAutoConfiguration的值，“\”的作用：换行，如果我们有多个自定义的自动配置类，这里可以用逗号分隔。

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.winson.jedis.config.RedisAutoConfigure

二、再创建一个SpringBoot工程redis-spring-boot-starter，引入redis-spring-boot-autoconfigure工程坐标。

<!--引入自定义的redis的starter-->
<dependency>
 <groupId>com.winson</groupId>
 <artifactId>redis-spring-boot-autoconfigure</artifactId>
 <version>0.0.1-SNAPSHOT</version>
</dependency>

三、在测试类中引入自定义的starter，并修改引导类，做测试

 <!--引入自定义的起步依赖-->
  <dependency>
   <groupId>com.winson</groupId>
   <artifactId>redis-spring-boot-starter</artifactId>
   <version>0.0.1-SNAPSHOT</version>
  </dependency>
//引导类
@SpringBootApplication
public class SpringbootEnableApplication {
 public static void main(String[] args) {
  ConfigurableApplicationContext context = SpringApplication.run(SpringbootEnableApplication.class, args);

  Jedis jedis = context.getBean(Jedis.class);
  System.out.println(jedis);
 }
}

四、启动程序，测试结果，自定义stater成功。

下面进行redis测试

一、首先启动本机的redis服务

二、根据测试，修改引导类，向redis中存储数据，并取值

@SpringBootApplication
public class SpringbootEnableApplication {

 public static void main(String[] args) {
  ConfigurableApplicationContext context = SpringApplication.run(SpringbootEnableApplication.class, args);

  Jedis jedis = context.getBean(Jedis.class);
  jedis.set("username", "dufu");

  String username = jedis.get("username");
  System.out.println("username=" + username);
 }
}

三、启动程序，测试结果，也成功。

下面测试修改redis连接信息，测试结果

一、测试类中添加redis的配置信息（根据属性配置类 RedisProperties 的设置进行定义），将port的连接端口，故意写错，如下:

redis:
 host: 127.0.0.1
 port: 6666

二、启动程序，测试结果：发现无法再连接到redis服务器了，说明我们设置的属性配置类RedisProperties 是生效的

三、如果我们将连接信息修改正确，再启动，也是没有问题的

最后，我们可以使用Condition将我们自定义的自动配置类完善一下,使用@ConditionalOnClass(Jedis.class)与@ConditionalOnMissingBean(name = "jedis")，具体的释义，我就不解释。

/**
 * @description：自定义自动配置类：将Jedis注入到IOC容器中
 * @date： 2020/10/10 15:08
 * @author： winson
 */
@Configuration
@EnableConfigurationProperties(RedisProperties.class)
@ConditionalOnClass(Jedis.class)
public class RedisAutoConfigure {
 /**
  * 提供jedis的bean
  * @param redisProperties
  * @return
  */
 @Bean
 @ConditionalOnMissingBean(name = "jedis")
 public Jedis jedis(RedisProperties redisProperties) {
  return new Jedis(redisProperties.getHost(), redisProperties.getPort());
 }
}

小结：如此，我们并完成了自定义starter的示例

到此这篇关于SpringBoot自动配置之自定义starter的实现代码的文章就介绍到这了,更多相关SpringBoot自定义starter内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • 教你用Java Swing做一个定时提醒工具

    教你用Java Swing做一个定时提醒工具

    今天给大家带来的是Java的相关知识,文章围绕着如何用Java做一个定时提醒工具展开,文中有非常详细的介绍及代码示例,需要的朋友可以参考下
    2021-06-06
  • idea maven 项目src下的配置文件没有同步至target的解决操作

    idea maven 项目src下的配置文件没有同步至target的解决操作

    这篇文章主要介绍了idea maven 项目src下的配置文件没有同步至target的解决操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2020-08-08
  • @Scheduled 如何读取动态配置文件

    @Scheduled 如何读取动态配置文件

    这篇文章主要介绍了@Scheduled 如何读取动态配置文件的操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-06-06
  • springboot2.0+elasticsearch5.5+rabbitmq搭建搜索服务的坑

    springboot2.0+elasticsearch5.5+rabbitmq搭建搜索服务的坑

    这篇文章主要介绍了springboot2.0+elasticsearch5.5+rabbitmq搭建搜索服务的坑，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2018-06-06
  • Java超详细分析垃圾回收机制

    Java超详细分析垃圾回收机制

    一个运行中的程序, 产生的对象是大量的, 如果对象不被继续使用, 就会成为垃圾, 最后越堆越多, 最后占满内存, 所以我们要对这些垃圾进行回收,保持程序的正常运行
    2022-05-05
  • SpringBoot自动配置原理详解

    SpringBoot自动配置原理详解

    SpringBoot的诞生就是为了简化Spring中繁琐的XML配置，其本质依然还是Spring框架，使用SpringBoot之后可以不使用任何XML配置来启动一个服务，使得我们在使用微服务架构时可以更加快速的建立一个应用。本文将为具体介绍一下SpringBoot的原理，需要的可以参考一下
    2021-12-12
  • Java中的ArrayList.trimToSize()方法详解

    Java中的ArrayList.trimToSize()方法详解

    这篇文章主要介绍了Java中的ArrayList.trimToSize()方法详解,前几天看了Java ArrayList,没有明白trimToSize()这个方法是什么意思,所以看了一下源码并且debug一下自己的一个例子,明白了其中的含义,需要的朋友可以参考下
    2023-11-11
  • Jedis零基础入门及操作Redis中的数据结构详解

    Jedis零基础入门及操作Redis中的数据结构详解

    Jedis 的 API 方法跟 Redis 的命令基本上完全一致，熟悉 Redis 的操作命令，自然就很容易使用 Jedis，因此官方也推荐 Java 使用 Jedis 来连接和操作 Redis
    2022-09-09
  • Java基础之代理原理与用法详解

    Java基础之代理原理与用法详解

    这篇文章主要介绍了Java基础之代理原理与用法,结合实例形式详细分析了java代理的概念、原理、用法及相关操作注意事项,需要的朋友可以参考下
    2020-02-02
  • Spring boot工具类静态属性注入及多环境配置详解

    Spring boot工具类静态属性注入及多环境配置详解

    这篇文章主要为大家详细介绍了Spring boot工具类静态属性注入，及多环境配置详解，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2018-04-04

最新评论