SpringBoot定制化Starter实现方法

更新时间：2023年01月12日 11:24:40 作者：百思不得小赵

小伙伴们曾经可能都经历过整天写着CURD的业务，都没写过一些组件相关的东西，这篇文章记录一下SpringBoot如何自定义一个Starter。原理和理论就不用多说了，可以在网上找到很多关于该方面的资料，这里主要分享如何自定义

什么是Spring Boot Starter

Starters可以理解为启动器，它包含了一系列可以集成到应用里面的依赖包，可以一站式集成 Spring和其他技术，而不需要到处找示例代码和依赖包。Spring Boot Starter的工作原理是：Spring Boot在启动时扫描项目所依赖的JAR包，寻找包含spring.factories文件的JAR包，根据spring.factories配置加载AutoConfigure类，根据@Conditional注解的条件，进行自动配置并将Bean注入Spring Context

为什么要自定义Spring Boot Starter？

在Spring Boot官网为了简化我们的开发，已经提供了非常多场景的Starter来为我们使用，即便如此，也无法全面的满足我们实际工作中的开发场景，这时我们就需要自定义实现定制化的Starter。

实现步骤

1.首先，创建一个Maven空工程，添加两个模块

启动器

启动器中没有任何的源代码，只是告诉我们当前场景需要引入哪些依赖即可！

创建启动器模块为maven工程，命名为

xiaozhao-hello-spring-boot-starter，对应的依赖文件

<groupId>com.zhao</groupId>
<artifactId>xiaozhao-hello-spring-boot-starter</artifactId>
<version>1.0-SNAPSHOT</version>

自动配置包

自动配置包中实现了所有的自动配置功能！

创建自动配置包模块为SpringBoot初始化工程，命名为xiaozhao-hello-spring-boot-starter-autoconfigure

最终的项目模块如下：

2.模块创建完成后，需要在启动器中引入自动配置模块（别人引入场景启动器，自动配置包就会自动引入）

<dependencies>
    <dependency>
        <groupId>com.zhao</groupId>
        <artifactId>xiaozhao-hello-spring-boot-starter-autoconfigure</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </dependency>
</dependencies>

3.编写自动配置模块。

创建自定义的Properties文件

@ConfigurationProperties("xiaozhao.hello")
public class HelloProperties {
    private String prefix;
    private String suffix;
    public String getPrefix() {
        return prefix;
    }
    public void setPrefix(String prefix) {
        this.prefix = prefix;
    }
    public String getSuffix() {
        return suffix;
    }
    public void setSuffix(String suffix) {
        this.suffix = suffix;
    }
}

创建业务类读取Properties文件中的值

public class HelloService {
    @Autowired
    HelloProperties helloProperties;
     public String sayHello(String userName){
        return helloProperties.getPrefix() + ":" + userName + ">" + helloProperties.getSuffix();
     }
}

再个自动配置类，自动进行类加载

@Configuration
@ConditionalOnMissingBean(HelloService.class)
@EnableConfigurationProperties(HelloProperties.class)
public class HelloServiceAutoConfiguration {
    @Bean
    public HelloService helloService(){
        HelloService helloService = new HelloService();
        return helloService;
    }
}

最终的效果如下：

4.在resources目录下创建META-INF/spring.factories添加如下配置信息

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.zhao.hello.auto.HelloServiceAutoConfiguration

5.装hello-spring-boot-starter-autoconfigure模块和xiaozhao-hello-spring-boot-starter

6.装完成后，创建新的项目来引入创建好的starter.新的的项目名为hello-test的Spring Boot初始化项目。

引入我们之前定义的Starter启动器和Spring Boot自带的Web启动器

<dependencies>
   <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
   </dependency>
   <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
   </dependency>
   <dependency>
      <groupId>com.zhao</groupId>
      <artifactId>xiaozhao-hello-spring-boot-starter</artifactId>
      <version>1.0-SNAPSHOT</version>
   </dependency>
</dependencies>

7.在hello-test项目中创建测试Controller

@RestController
public class HelloController {
    @Autowired
    HelloService helloService;
    @GetMapping("/hello")
    public String sayHello() {
        String str = helloService.sayHello("李四");
        return str;
    }
}

编写配置文件

xiaozhao.hello.prefix=hello
xiaozhao.hello.suffix=666

8.启动项目，测试一下

总结自定义Starter的实现逻辑

首先引入自定义的Starter：xiaozhao-hello-spring-boot-starter，在这个Starter中引入自定义的自动配置场景
当自动配置场景启动时，会去寻找spring.factories文件，去自动加载HelloServiceAutoConfiguration类文件
加载完自动配置类后，@ConditionalOnMissingBean(HelloService.class)通过这个注解，当容器中没有HelloService时，去自动添加一个HelloService组件。
HelloService组件的所有属性，通过HelloProperties配置文件进行绑定的，@ConfigurationProperties("xiaozhao.hello")，通过xiaozhao.hello。xxx进行绑定。
如果自己在容器中注入一个HelloService组件，使用的就不是自动配置的，而是重新注入的。

到此这篇关于SpringBoot定制化Starter实现方法的文章就介绍到这了,更多相关SpringBoot Starter内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

IDEA创建Java Web项目的超详细图文教学
IDEA是程序员们常用的java集成开发环境,也是被公认为最好用的java开发工具,下面这篇文章主要给大家介绍了关于IDEA创建Java Web项目的相关资料,文中通过图文介绍的非常详细,需要的朋友可以参考下
2022-12-12
解决idea使用过程中让你觉得不爽的一些问题(小结)
这篇文章主要介绍了解决idea使用过程中让你觉得不爽的一些问题，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-08-08
自己动手写的mybatis分页插件(极其简单好用)
最近做了个项目，需要用到mybatis分页功能，网上找了很多插件，都不太合适，于是就自己动手写了个mybatis分页插件功能，非常不错，代码简单易懂，需要的朋友参考下吧
2016-11-11
javax.validation自定义日期范围校验注解操作
这篇文章主要介绍了javax.validation自定义日期范围校验注解操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-09-09
使用Jackson反序列化遇到的问题及解决
这篇文章主要介绍了使用Jackson反序列化遇到的问题及解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-08-08
Java%(取模运算)全面讲解
这篇文章主要介绍了Java%(取模运算)全面讲解，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-01-01
Java下载https文件并上传阿里云oss服务器
这篇文章主要介绍了Java下载https文件并上传到阿里云oss服务器,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-01-01
详解springboot + profile（不同环境读取不同配置）
本篇文章主要介绍了springboot + profile（不同环境读取不同配置），具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-05-05
java多线程实现同步锁卖票实战项目
本文主要介绍了java多线程实现同步锁卖票实战项目，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-01-01
java String的深入理解
这篇文章主要介绍了java String的深入理解的相关资料,希望通过本文大家能理解String的用法，需要的朋友可以参考下
2017-09-09