Spring Boot自定义starter开发

创建一个自定义的Spring Boot Starter是一个很好的方式来封装和重用一些常用的功能和配置。下面是一个简单的步骤指南，帮助你创建一个自定义的Spring Boot Starter。

1. 创建项目结构

首先，创建一个新的Maven或Gradle项目来存放你的Starter依赖和代码。

Maven项目结构示例：

my-custom-starter/
├── my-custom-starter/
│   ├── src/
│   │   ├── main/
│   │   │   ├── java/com/example/mycustomstarter/
│   │   │   │   ├── MyCustomStarterApplication.java
│   │   │   │   ├── MyCustomStarterConfig.java
│   │   │   │   └── META-INF/
│   │   │   │       └── spring.factories
│   │   │   └── resources/
│   │   │       └── application.properties
│   └── pom.xml
└── pom.xml

Gradle项目结构示例：

my-custom-starter/
├── build.gradle
├── settings.gradle
└── src/
    ├── main/
    │   ├── java/com/example/mycustomstarter/
    │   │   ├── MyCustomStarterApplication.java
    │   │   ├── MyCustomStarterConfig.java
    │   │   └── META-INF/
    │   │       └── spring.factories
    └── test/
        └── java/com/example/mycustomstarter/
            └── MyCustomStarterApplicationTests.java

2. 添加依赖

在pom.xml或build.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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.4</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>my-custom-starter</artifactId>
    <version>1.0.0</version>
    <name>my-custom-starter</name>
    <description>A custom Spring Boot Starter</description>
    <properties>
        <java.version>11</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <!-- Add other dependencies here -->
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

Gradle示例：

plugins {
    id 'org.springframework.boot' version '2.5.4'
    id 'io.spring.dependency-management' version '1.0.11.RELEASE'
    id 'java'
}

group = 'com.example'
version = '1.0.0'
sourceCompatibility = '11'

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter'
    // Add other dependencies here
}

test {
    useJUnitPlatform()
}

3. 创建配置类

创建一个配置类来定义你的Starter的默认配置。

Maven示例：

package com.example.mycustomstarter;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConfigurationProperties(prefix = "my.custom")
public class MyCustomStarterConfig {
    private String property1;
    private int property2;

    // Getters and Setters
    public String getProperty1() {
        return property1;
    }

    public void setProperty1(String property1) {
        this.property1 = property1;
    }

    public int getProperty2() {
        return property2;
    }

    public void setProperty2(int property2) {
        this.property2 = property2;
    }
}

Gradle示例：

package com.example.mycustomstarter;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConfigurationProperties(prefix = "my.custom")
public class MyCustomStarterConfig {
    private String property1;
    private int property2;

    // Getters and Setters
    public String getProperty1() {
        return property1;
    }

    public void setProperty1(String property1) {
        this.property1 = property1;
    }

    public int getProperty2() {
        return property2;
    }

    public void setProperty2(int property2) {
        this.property2 = property2;
    }
}

4. 创建Spring Boot Starter入口类

创建一个入口类来启动你的Starter。

Maven示例：

package com.example.mycustomstarter;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyCustomStarterApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyCustomStarterApplication.class, args);
    }
}

Gradle示例：

package com.example.mycustomstarter;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyCustomStarterApplication {
    public static void main(String[] args) {
        SpringApplication.run(MyCustomStarterApplication.class, args);
    }
}

5. 配置Spring Boot Starter

在src/main/resources/application.properties中配置你的Starter属性。

Maven示例：

my.custom.property1=value1
my.custom.property2=42

Gradle示例：

my.custom.property1=value1
my.custom.property2=42

6. 发布Starter

如果你希望将你的Starter发布到Maven Central或其他仓库，你需要按照相应的流程进行构建和发布。

Maven示例：

mvn clean install

Gradle示例：

./gradlew build

7. 使用Starter

在其他Spring Boot项目中使用你的自定义Starter。

Maven示例：

<dependency>
    <groupId>com.example</groupId>
    <artifactId>my-custom-starter</artifactId>
    <version>1.0.0</version>
</dependency>

Gradle示例：

implementation 'com.example:my-custom-starter:1.0.0'

总结

通过以上步骤，你已经创建了一个简单的自定义Spring Boot Starter。你可以根据需要扩展这个Starter，添加更多的配置属性和自动配置类。希望这个指南对你有所帮助！