likes
comments
collection
share

如何创建一个Spring Boot Starter

作者站长头像
站长
· 阅读数 6

简介

Spring Boot是一个快速开发的框架，它提供了许多便捷的功能和特性，使得我们能够快速构建和部署Java应用程序。而Spring Boot Starter则是一种用于简化依赖管理和配置的机制，它可以方便地打包和共享一组相关的依赖配置。

在这篇文章中，我们将探讨如何创建一个自定义的Spring Boot Starter相关知识。您将学习如何定义Starter的依赖和配置，如何自动装配Spring Bean。

无论您是想为自己的团队创建一个内部的Starter，还是想为开源社区贡献一个公共的Starter，本文都将为您提供详细的指导。通过创建一个自定义的Spring Boot Starter，您将能够将常用的功能和组件封装起来，使得其他开发者能够更方便地集成和使用。

什么是Spring Boot starter以及它的作用和好处。

是什么

Spring Boot starter是一种用于简化和快速启动Spring Boot应用程序的工具。它是一个被打包成JAR文件的模块，其中包含了特定功能的配置和依赖项。Spring Boot starter提供了一种自动配置的机制，可以根据应用程序的依赖和环境自动配置相关的组件和功能。

作用

Spring Boot starter的作用是减少开发人员在构建Spring Boot应用程序时的配置和集成工作。它封装了复杂的配置和依赖关系，使得开发人员可以更专注于业务逻辑的开发，而不需要花费太多时间和精力在配置和集成上。

好处

  1. 简化配置：Spring Boot starter提供了自动配置的功能，可以根据应用程序的依赖和环境自动配置相关的组件和功能，减少了手动配置的工作量。

  2. 提高开发效率：通过使用预定义的starter，开发人员可以快速启动和构建Spring Boot应用程序，减少了开发和集成的时间和精力。

  3. 一致性和标准化：Spring Boot starter遵循一致的设计和标准，使得不同的应用程序可以采用相同的配置和依赖关系，提高了代码的可读性和可维护性。

  4. 可扩展性：开发人员可以根据自己的需求创建自定义的starter，将常用的功能和组件封装成可重用的模块，方便在不同的项目中使用和扩展。

为什么开发自己的Spring Boot starter可以提高代码的复用性和可维护性。

开发自己的Spring Boot starter可以提高代码的复用性和可维护性，减少重复工作，提高团队协作效率，统一技术栈和标准，并提供可插拔和可扩展的设计。这些优点使得开发人员可以更加专注于业务逻辑的开发，提高代码的质量和可维护性。具体原因如下：

  1. 模块化和封装：自己开发的Spring Boot starter是一个独立的模块，可以将相似的功能和组件封装在一起，形成一个可重用的单元。这样，其他开发人员在构建新的应用程序时可以直接引入这个starter，避免重复编写和配置相同的功能。

  2. 自动配置和约定优于配置：Spring Boot starter的核心特性之一是自动配置。通过自动配置，开发人员可以定义好starter的默认行为和配置项，使得其他开发人员在使用starter时无需手动配置。这种约定优于配置的方式可以大大简化开发过程，提高代码的可维护性。

  3. 提高团队协作效率：开发自己的Spring Boot starter可以使团队内部共享和复用代码成为可能。团队成员可以通过使用相同的starter来实现统一的功能和行为，减少了重复劳动和个人差异，提高了团队协作的效率。

  4. 统一的技术栈和标准：通过开发自己的Spring Boot starter，可以定义和规范团队内部的技术栈和标准。团队成员可以遵循相同的模式和规范进行开发，减少了个人风格和差异，提高了代码的一致性和可维护性。

  5. 可插拔和可扩展性：自己开发的Spring Boot starter可以提供可插拔的功能和扩展点，使得其他开发人员可以根据自己的需求进行定制和扩展。这种可插拔和可扩展的设计可以提高代码的灵活性和可扩展性，以适应不同的业务需求。

Spring Boot starter组成介绍

Spring Boot starter（启动器）：指的是一组预定义的依赖项，用于简化Spring Boot应用程序的配置和构建过程。一个启动器通常包含了一组相关的依赖项，这些依赖项在开发特定类型的应用程序时很常见。启动器提供了一种快速启动和配置应用程序的方式，而无需手动添加大量的依赖项。启动器的定义是通过Maven或Gradle的构建工具来实现的。在构建工具的配置文件中，我们可以定义启动器的依赖项，并将它们打包为一个可重用的模块。

在Spring Boot中，启动器通常使用spring-boot-starter-*的命名约定。例如，spring-boot-starter-web是一个常用的启动器，用于构建基于Web的应用程序。

启动器的定义主要包括以下几个方面：

  1. 自动配置（Auto-configuration）：自动配置是Spring Boot starter的核心特性之一。它是通过条件化配置（Conditional Configuration）实现的，根据应用程序的依赖和环境自动配置相关的组件和功能。自动配置可以大大简化开发人员的配置工作，减少了手动配置的繁琐和错误。

    // 表示这是一个配置类，它将被Spring容器加载。
@Configuration
// 表示只有当HelloService类在类路径中时，才会应用这个自动配置类。
@ConditionalOnClass(HelloService.class)
// 表示启用对HelloProperties配置属性类的支持，将配置属性绑定到HelloProperties对象中。
@EnableConfigurationProperties(HelloProperties.class)
public class HelloAutoConfiguration {

    private final HelloProperties helloProperties;

    // 构造函数注入了HelloProperties对象，用于获取配置属性。
    public HelloAutoConfiguration(HelloProperties helloProperties) {
        this.helloProperties = helloProperties;
    }

    // 注解创建了一个HelloService的Bean
    @Bean
    // 表示只有当容器中没有HelloService的Bean时，才会创建这个Bean。
    @ConditionalOnMissingBean
    public HelloService helloService() {
        HelloService helloService = new HelloService();
        // 在创建HelloService时，我们将配置属性中的消息设置到HelloService实例中。
        helloService.setMessage(helloProperties.getMessage());
        return helloService;
    }
}

    这样，当引入了这个自动配置类的Spring Boot starter时，它将自动配置HelloService的Bean，而无需手动配置。

  2. 依赖管理（Dependency Management）：Spring Boot starter通过依赖管理来解决复杂的依赖关系。它定义了一组预定义的依赖项，这些依赖项包含了应用程序所需的各种功能和组件。开发人员只需要添加相应的starter依赖，就可以自动引入所需的依赖项，而无需手动管理版本和依赖冲突。

    <!-- 定义了一组预定义的依赖项，这些依赖项包含了应用程序所需的各种功能和组件。开发人员只需要添加相应的`starter`依赖，就可以自动引入所需的依赖项，而无需手动管理版本和依赖冲突 -->
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>2.5.4</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
        <!-- 添加其他依赖项 -->
        <!-- <dependency>
            <groupId>com.example</groupId>
            <artifactId>my-library</artifactId>
            <version>1.0.0</version>
        </dependency> -->
    </dependencies>
</dependencyManagement>

    通过引入Spring Boot的依赖管理，我们可以简化对Spring Boot和其他相关依赖项的版本管理。 开发人员只需声明依赖项的groupId、artifactId和版本号，而无需关心具体的版本号和依赖冲突。 在示例中，我们还可以添加其他依赖项，如自定义库或其他第三方库。只需在dependencyManagement中添加相应的<dependency>元素即可。

  3. 条件化注解（Conditional Annotations）：Spring Boot starter使用条件化注解来根据条件选择性地启用或禁用特定的配置和功能。条件化注解可以根据环境、配置参数或其他条件来决定是否应用某个配置。这种灵活的条件化机制使得开发人员可以根据需要进行细粒度的配置和定制。

    @Configuration
// 表示只有当DataSource类在类路径中时，才会应用这个自动配置类。
@ConditionalOnClass(DataSource.class)
// 表示只有当配置文件中myapp.datasource.enabled属性值为true（或没有配置）时，才会应用这个自动配置类。
@ConditionalOnProperty(prefix = "myapp.datasource", name = "enabled", havingValue = "true", matchIfMissing = true)
public class DataSourceAutoConfiguration {

    @Bean
    // 表示将配置文件中以myapp.datasource开头的属性绑定到DataSource对象中
    @ConfigurationProperties(prefix = "myapp.datasource")
    public DataSource dataSource() {
        // 创建和配置数据源
        return new DataSource();
    }

}

  4. 自定义配置（Custom Configuration）：Spring Boot starter支持自定义配置，允许开发人员根据自己的需求进行特定的配置和定制。通过定义配置类或使用属性文件，开发人员可以覆盖默认的自动配置，并提供自己的配置选项。这种自定义配置的机制使得开发人员可以根据自己的业务需求进行灵活的配置。

    // 表示将以myapp.hello开头的配置属性绑定到这个类的字段上。
@ConfigurationProperties(prefix = "myapp.hello")
public class HelloProperties {

    // 在自定义配置类中，我们定义了一个message字段，并提供了对应的getter和setter方法。
    // 在这个示例中，默认的message值是"Hello, world!"。
    private String message = "Hello, world!";

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

    使用自定义配置类，我们可以在应用程序的配置文件（如application.properties或application.yml）中配置自定义属性

    myapp.hello.message = Hello, Codeium!

    然后，我们可以在应用程序中注入HelloProperties对象，并使用其中的属性。例如：

    @Service
public class HelloService {

    private final HelloProperties helloProperties;

    // 构造函数注入
    public HelloService(HelloProperties helloProperties) {
        this.helloProperties = helloProperties;
    }

    public void sayHello() {
        System.out.println(helloProperties.getMessage());
    }

}

  5. 启动器配置，启动器的配置是通过 spring.factories 文件来实现的。spring.factories 文件是一个位于 META-INF 目录下的文件，它使用标准的 Java properties 格式进行配置。在这个文件中，我们可以定义各种自动配置类和其他配置项。

    以下是一个示例 spring.factories 文件的内容：

    # 自动配置类
# EnableAutoConfiguration 键是一个特殊的键，它指定了要自动加载的自动配置类。
# 可以使用反斜杠 '\' 来分隔多个自动配置类的全限定类名。
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.example.myStarter.MyStarterAutoConfiguration

# 其他配置项
# 除了自动配置类之外，我们还可以在 spring.factories 文件中定义其他配置项。
# 这些配置项可以是任意的键值对，用于配置特定的属性或自定义逻辑。
my.custom.property=value

    通过使用 spring.factories 文件，我们可以将启动器的配置和自动配置集中在一个地方，使得启动器的使用更加方便和统一。

Spring Boot starter风格

指的是启动器自身的设计和组织方式。Spring Boot启动器的风格主要遵循以下几个原则：

  1. 简单和轻量：启动器应该尽可能简单和轻量，只包含必要的依赖项和配置。它们应该专注于特定的功能或特性，并提供最小的开销和复杂性。

  2. 自包含：启动器应该是自包含的，即可以独立使用而无需依赖其他启动器或组件。这使得启动器可以方便地被其他项目引入和使用。

  3. 命名约定：启动器通常遵循一定的命名约定，以便开发人员可以更容易地识别和使用它们。通常，启动器的命名以 spring-boot-starter-* 开头，表示它是一个Spring Boot启动器。

  4. 自动配置：启动器通常包含自动配置的功能，以减少手动配置的工作量。自动配置是通过在应用程序启动时自动根据类路径上的依赖项进行配置来实现的。

spring 风格

Spring将Starter和Auto-Configuration分开。分开打包的主要原因是为了提高模块化和可重用性。这种分离允许开发人员根据需要选择和组合不同的Starter和Auto-Configuration，以满足特定的应用程序需求。

Starter是一种用于简化依赖管理的方式，它包含了一组相关的依赖项，以及必要的配置和默认行为。它们通常用于引入特定功能或技术栈，例如数据库访问、Web开发、消息队列等。Starter的目的是提供一种便捷的方式来获取所需的依赖项，并自动配置应用程序以使用这些功能。

Auto-Configuration是一种自动配置机制，它根据类路径上的依赖项和条件进行配置。它的目标是根据应用程序的运行环境和已有依赖的配置，自动为应用程序提供正确的配置。Auto-Configuration通过将bean定义添加到Spring上下文中来实现自动配置。它们通常与Starter配合使用，以提供完整的功能和自动配置。

将Starter和Auto-Configuration分开打包的好处是：

  1. 模块化和可重用性：通过将功能和自动配置分开打包，可以实现模块化和可重用性。开发人员可以根据需要选择和组合不同的Starter和Auto-Configuration，以满足特定的需求，而无需引入不必要的依赖项。

  2. 简化依赖管理：Starter的存在简化了依赖管理的过程。通过引入特定的Starter，开发人员可以一次性获取所需的所有依赖项，而无需手动添加和管理这些依赖项。

其他风格

Starter包含自动配置（Auto-configuration）、依赖管理（Dependency Management）、条件化注解（Conditional Annotations）、自定义配置（Custom Configuration）、启动器配置

例：xxl-job

如何创建一个Spring Boot Starter

如何创建一个Spring Boot Starter

创建一个Spring Boot Starter

这个区域留给你，根据以上介绍的内容，相信不难创建出一个自己的Spring Boot Starter。

如何创建一个Spring Boot Starter

其他文件介绍

MANIFEST.MF：这个文件是Java标准的JAR清单文件，用于声明应用程序的元数据，如版本号、主类等信息。

spring.factories：这个文件是Spring Boot自动配置的核心文件，用于声明和注册自动配置类。Spring Boot会自动扫描这个文件，并根据其中的配置来加载相应的自动配置类。

spring.handlers：这个文件用于声明XML命名空间处理程序的类名。它定义了Spring Boot应用程序中使用的自定义XML命名空间。

spring.schemas：这个文件用于声明XML模式文件的位置和命名空间。它定义了Spring Boot应用程序中使用的自定义XML模式文件。

spring.tooling：这个文件用于与Spring Tool Suite（STS）集成的工具支持。它包含了有关Spring Boot应用程序的信息，以便STS可以提供更好的开发和调试体验。

spring-autoconfigure-metadata.properties：spring-autoconfigure-metadata.properties文件是一个重要的元数据文件，用于描述自动配置类中的属性和条件。该文件位于META-INF/spring-autoconfigure-metadata.properties路径下，通常由Spring Boot的构建工具自动生成。它提供了自动配置类中定义的属性、条件和相关信息，以便Spring Boot能够更好地理解和处理这些自动配置类。

spring-configuration-metadata.json：是一个重要的元数据文件，用于描述应用程序的配置属性。该文件通常位于META-INF/spring-configuration-metadata.json路径下，由Spring Boot的构建工具自动生成。它提供了应用程序中定义的配置属性的详细信息，包括属性的名称、类型、默认值、描述等。spring-configuration-metadata.json文件的作用是帮助开发人员和工具在开发和配置应用程序时能够更好地了解和使用配置属性。

aot.factories：aot.factories和spring.factories都是用于描述和配置自动装配（Auto-Configuration）的机制，但它们在使用上有一些区别。spring.factories是Spring Boot中常见的配置文件，用于指定要自动加载的自动配置类。在spring.factories文件中，我们可以列出要自动加载的自动配置类的全限定类名。这些自动配置类将在应用程序启动时被自动加载和应用。另一方面，aot.factories是用于Ahead-of-Time（AOT）编译的机制，用于在编译时指定要预加载的类。AOT编译是一种将代码预先编译为本地机器码的技术，可以提高应用程序的性能和启动时间。在aot.factories文件中，我们可以列出要预加载的类的全限定类名，这些类将在应用程序启动时被预加载。总结起来，spring.factories用于指定要自动加载的自动配置类，而aot.factories用于指定在AOT编译时要预加载的类。它们都是在不同的阶段和环境中用于配置和加载相关的类。

相关资料

  1. Spring Boot官方文档：Spring Boot官方网站上提供了完整的文档，包括入门指南、参考文档、API文档以及各种示例和教程。这是学习和掌握Spring Boot的最权威和全面的资源。

  2. Spring Initializr：Spring Initializr是一个Web界面，用于生成Spring Boot项目的基础代码。你可以选择所需的依赖项、构建工具和其他配置，然后下载生成的项目模板。这是一个快速开始Spring Boot项目的好工具。

  3. Spring Boot GitHub仓库：Spring Boot的GitHub仓库包含了所有的源代码、问题追踪和社区讨论。你可以在这里查看最新的发行版、获取修复的bug列表，还可以参与社区的讨论和贡献。

  4. Spring Boot示例代码：Spring Boot官方GitHub仓库中有一个示例代码的目录，包含了各种用例和示例项目。你可以从这些示例中学习和借鉴最佳实践，以及探索不同功能和集成的用法。

  5. Spring Boot参考指南：Spring Boot参考指南提供了关于各个方面的详细说明，包括配置、自动配置、部署、测试、监控等。这是一个非常详细和实用的参考资料。

  6. xxl-job，xxl-job的启动器（spring-boot-starter）源码。