SpringBoot自定义启动器Starter流程详解

 更新时间:2022年11月15日 11:22:39   作者:Decade0712  
SpringBoot中的starter是一种非常重要的机制,能够抛弃以前繁杂的配置,将其统一集成进starter,应用者只需要在maven中引入starter依赖,SpringBoot就能自动扫描到要加载的信息并启动相应的默认配置。starter让我们摆脱了各种依赖库的处理,需要配置各种信息的困扰

一、背景

虽然Spring官方给我们提供了很多的启动器供我们使用

但有时候我们也会遇到某些特殊场景,这些启动器满足不了

这个时候就需要自定义一个启动器供我们使用

二、自定义启动器

在之前学习Spring Boot的过程中,我们已经对启动器有了一个大致的了解

Spring Boot实现某个功能,一般是引入对应场景的启动器(一般不写代码,只是声明这个启动器需要引用哪些依赖),然后这个启动器又有对应的自动配置包

1、创建一个启动器的自动配置模块

先写和配置文件中配置项互相绑定的实体类

package com.decade.autoConfigure.pojo;
import org.springframework.boot.context.properties.ConfigurationProperties;
// 将这个类的属性和系统配置文件中的属性进行绑定
@ConfigurationProperties(prefix = "team")
public class TeamInfo {
    private String winnerName;
    private String loserName;
    public String getWinnerName() {
        return winnerName;
    }
    public void setWinnerName(String winnerName) {
        this.winnerName = winnerName;
    }
    public String getLoserName() {
        return loserName;
    }
    public void setLoserName(String loserName) {
        this.loserName = loserName;
    }
}

再写自己要实现的业务逻辑

package com.decade.autoConfigure.service;
import com.decade.autofigure.pojo.TeamInfo;
import org.springframework.beans.factory.annotation.Autowired;
public class TestService {
	// 引入和yaml文件中配置项绑定的类
    @Autowired
    private TeamInfo teamInfo;
    public String testMethod() {
        return teamInfo.getWinnerName() + "今天早上,绝杀了" + teamInfo.getLoserName();
    }
}

接着,写一个自动配置类,向容器中放入组件

package com.decade.autoConfigure.auto;
import com.decade.autofigure.pojo.TeamInfo;
import com.decade.autofigure.service.TestService;
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;
// 使得TeamInfo中的@ConfigurationProperties注解生效,将TeamInfo注册到容器中
@EnableConfigurationProperties(TeamInfo.class)
@Configuration
public class AutoConfiguration {
    @Bean
    // 只有容器中不存在TestService这个类型的bean时,才回去初始化这个bean
    @ConditionalOnMissingBean(TestService.class)
    public TestService testService() {
        TestService testService = new TestService();
        return testService;
    }
}

最后,在新版本的Spring Boot中为了确保框架启动时加载该配置类

我们需要在这个模块的resource文件下

新建/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件

然后在里面写自己之前创建的自动配置类

注意:老版可能是放在META-INF/spring.factories文件中

com.decade.autoConfigure.auto.AutoConfiguration

2、创建一个启动器模块

不用写任何业务代码,只需要在pom文件中,引用之前的创建的自动配置模块

3、在业务模块中引入启动器

如图,引入我们自己定义的启动器

然后在yaml文件中设置好绑定的配置项

再写一个测试方法进行测试即可

package com.decade;
import com.decade.autoConfigure.service.TestService;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
@Slf4j
class SpringbootWebApplicationTests {
    @Autowired
    private TestService testService;
    @Test
    public void testCustomStarter() {
        System.out.println(testService.testMethod());
    }
}

测试方法结果如下图

到此这篇关于SpringBoot自定义启动器Starter流程详解的文章就介绍到这了,更多相关SpringBoot自定义Starter内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • mybatis基本实例详解

    mybatis基本实例详解

    这篇文章主要介绍了mybatis基本实例详解以及mybatis自由模糊查询,代码简单易懂,非常不错,具有参考借鉴价值,需要的朋友可以参考下
    2017-03-03
  • Java实现将html字符串插入到PPT幻灯片

    Java实现将html字符串插入到PPT幻灯片

    Java后端代码操作PPT幻灯片时,可直接在幻灯片中绘制形状,并在形状中添加文本字符串内容。本篇文章主要介绍通过java实现将html字符串添加到PPT幻灯片的的方法,可添加文字、图片、视频、音频等。以下是具体方法和步骤。
    2021-11-11
  • SpringBoot利用拦截器实现避免重复请求

    SpringBoot利用拦截器实现避免重复请求

    Spring MVC中的拦截器(Interceptor)类似于Servlet中的过滤器(Filter),它主要用于拦截用户请求并作相应的处理。本文就将利用拦截器实现避免重复请求,感兴趣的小伙伴可以了解一下
    2022-11-11
  • SpringBoot配置文件导入方法详细讲解

    SpringBoot配置文件导入方法详细讲解

    Spring Boot虽然是Spring的衍生物, 但默认情况下Boot是不能直接使用Spring的配置文件的, 我们可以通过两种方式导入Spring的配置
    2022-10-10
  • Java简单实现定时器

    Java简单实现定时器

    这篇文章主要为大家详细介绍了Java简单实现定时器,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-04-04
  • SpringBoot + Mybatis-plus实战之Mybatis-plus的一级缓存、二级缓存

    SpringBoot + Mybatis-plus实战之Mybatis-plus的一级缓存、二级缓存

    这篇文章主要介绍了SpringBoot + Mybatis-plus实战之Mybatis-plus的一级缓存、二级缓存,本文通过实例图文相结合给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-12-12
  • Java毕业设计实战之健身器材商城系统的实现

    Java毕业设计实战之健身器材商城系统的实现

    只学书上的理论是远远不够的,只有在实战中才能获得能力的提升,本篇文章手把手带你用java+Jdbc+Servlet+Ajax+Fileupload+mysql实现健身器材商城系统,大家可以在过程中查缺补漏,提升水平
    2022-03-03
  • SpringBoot实现缓存组件配置动态切换的步骤详解

    SpringBoot实现缓存组件配置动态切换的步骤详解

    现在有多个springboot项目,但是不同的项目中使用的缓存组件是不一样的,有的项目使用redis,有的项目使用ctgcache,现在需要用同一套代码通过配置开关,在不同的项目中切换这两种缓存,本文介绍了SpringBoot实现缓存组件配置动态切换的步骤,需要的朋友可以参考下
    2024-07-07
  • Java为什么匿名内部类参数引用需要用final进行修饰?

    Java为什么匿名内部类参数引用需要用final进行修饰?

    今天小编就为大家分享一篇关于Java为什么匿名内部类参数引用需要用final进行修饰?,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-04-04
  • Java语言描述二叉树的深度和宽度

    Java语言描述二叉树的深度和宽度

    这篇文章主要介绍了Java语言描述二叉树的深度和宽度,具有一定借鉴价值,需要的朋友可以参考下。
    2017-11-11

最新评论