【spring相关技术】springboot进阶-从0开始创建一个starter

创建一个Spring Boot Starter是一个很好的方式来封装常用的配置和依赖，以便在多个项目中重用。以下是一个简单的指南，教你如何开发一个自己的Spring Boot Starter。

一、创建步骤

1. 创建项目

首先，你需要创建一个Maven或Gradle项目。这里我们以Maven为例。

<project xmlns="http://maven.apache.org/POM/4.0.0"  
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
    <modelVersion>4.0.0</modelVersion>  
  
    <groupId>com.example</groupId>  
    <artifactId>example-spring-boot-starter</artifactId>  
    <version>0.0.1-SNAPSHOT</version>  
    <packaging>jar</packaging>  
  
    <parent>  
        <groupId>org.springframework.boot</groupId>  
        <artifactId>spring-boot-starter-parent</artifactId>  
        <version>2.3.1.RELEASE</version>  
    </parent>  
  
    <dependencies>  
        <!-- 添加Spring Boot Starter依赖 -->  
        <dependency>  
            <groupId>org.springframework.boot</groupId>  
            <artifactId>spring-boot-starter</artifactId>  
        </dependency>  
    </dependencies>  
</project>

2. 创建自动配置类

在你的starter项目中创建一个自动配置类。这个类将负责配置你的starter的功能。

package com.example.starter;  
  
import org.springframework.context.annotation.Configuration;  
  
@Configuration
//根据是否使用yml配置
//@PropertySource(value = "classpath:example.yml", encoding = "utf-8", factory = YmlConfigFactory.class)
public class ExampleAutoConfiguration {  
    // 在这里编写你的配置逻辑  
}

3. 创建属性配置类

为了使用户能够自定义starter的行为，你可以创建一个属性配置类。

package com.example.starter;  
  
import org.springframework.boot.context.properties.ConfigurationProperties;  
  
@ConfigurationProperties(prefix = "example")  
public class ExampleProperties {  
    // 定义属性  
    private String name;  
  
    // Getter和Setter  
    public String getName() {  
        return name;  
    }  
  
    public void setName(String name) {  
        this.name = name;  
    }  
}

4. 创建spring.factories文件

• 在src/main/resources/META-INF目录下创建spring.factories文件，并在文件中指定自动配置类。

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\  
com.example.starter.ExampleAutoConfiguration

5:创建 yml配置加载工厂(非必选)

同理也可以创建properties配置加载工厂
将 YamlPropertySourceLoader 替换成 PropertiesPropertySourceLoader 即可

import org.springframework.boot.env.YamlPropertySourceLoader;
import org.springframework.core.env.PropertySource;
import org.springframework.core.io.support.DefaultPropertySourceFactory;
import org.springframework.core.io.support.EncodedResource;
import java.io.IOException;
import java.util.List;

public class YmlConfigFactory extends DefaultPropertySourceFactory {
    @Override
    public PropertySource<?> createPropertySource(String name, EncodedResource resource) throws IOException {
        List<PropertySource<?>> sources = new YamlPropertySourceLoader().load(resource.getResource().getFilename(), resource.getResource());
        return sources.get(0);
    }
}

6. 创建example.yml(可选)

example:
	name: test

7. 打包和发布

将你的starter项目打包并发布到Maven仓库中，这样其他项目就可以通过添加依赖来使用你的starter了。

<dependency>  
    <groupId>com.example</groupId>  
    <artifactId>example-spring-boot-starter</artifactId>  
    <version>0.0.1-SNAPSHOT</version>  
</dependency>

通过以上步骤，你就创建了一个简单的Spring Boot Starter。

二、spring.factories 背景知识

spring.factories 文件是 Spring 框架用于发现和加载特定类型组件的一种机制，特别是在 Spring Boot 中非常常见。它被用来定义自动配置类、条件配置、自定义初始化器等。下面我们详细解析一下 spring.factories 文件的工作原理及其用途。

1. 基本概念

spring.factories 文件通常位于 JAR 包的 META-INF 目录下。它是一个纯文本文件，包含了以特定格式列出的类名列表。Spring Boot 会在启动时搜索所有已加载的 JAR 包中的 spring.factories 文件，并读取其中的内容。

2. 格式说明

spring.factories 文件采用键值对的形式，其中键通常是 Spring Boot 自动配置类的前缀（例如 org.springframework.boot.autoconfigure.*），而值则是一个或多个类的全限定名称，这些类通常是自动配置类。

一个典型的 spring.factories 文件可能如下所示：

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  com.example.ExampleAutoConfiguration

这里的键 org.springframework.boot.autoconfigure.EnableAutoConfiguration 表示自动配置的前缀，而值 com.example.ExampleAutoConfiguration 则是一个具体的自动配置类。

3. 加载过程

当 Spring Boot 启动时，它会执行以下步骤：

1. 查找 spring.factories 文件：Spring Boot 会在 ClassPath 下查找所有的 spring.factories 文件。
2. 解析文件内容：读取并解析每个 spring.factories 文件中的条目。
3. 注册组件：对于每个找到的自动配置类，Spring Boot 会尝试将其注册为 Bean。
4. 应用条件：Spring Boot 会根据自动配置类上的注解（如 @ConditionalOnClass, @ConditionalOnProperty 等）来决定是否实际启用该配置。

4. 自动配置

自动配置是 spring.factories 文件的一个主要用途。Spring Boot 通过在 spring.factories 文件中列出自动配置类来实现这一点。当 Spring Boot 启动时，它会寻找这些文件，并基于条件注解来决定哪些自动配置类应该被激活。

5. 其他用途

除了自动配置之外，spring.factories 文件还可以用于注册其他的组件，例如：

• 初始化器：可以注册自定义的 ApplicationContextInitializer。
• 后处理器：可以注册 BeanPostProcessor 和 BeanFactoryPostProcessor。
• 条件处理：可以注册自定义的条件处理逻辑。

6. 总结

spring.factories 文件是 Spring Boot 中一项重要的机制，它使得自动配置和其他类型的组件发现变得简单。通过这种方式，开发者可以轻松地扩展 Spring Boot 的功能，同时保持代码的整洁性和可维护性。