当前位置：首页 > article >正文

创建自定义的Spingboot启动器

article 2025/3/6 11:01:44

开发一个Spring Boot启动器（Starter）可以帮助封装和复用自定义功能，从而简化Springboot开发，下面介绍下如何创建自己的启动器:

1. 创建Maven项目

首先，创建一个Maven项目，在pom.xml中添加Spring Boot相关的依赖。通常需要添加spring-boot-starter和spring-boot-autoconfigure。

<?xml version="1.0" encoding="UTF-8"?>
<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>custom-spring-boot-starter</artifactId>
    <version>1.0.0</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <version>2.2.1.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
            <version>2.2.1.RELEASE</version>
        </dependency>
    </dependencies>

</project>

2. 创建自动配置类

创建一个自动配置类，用于配置你的自定义功能。这个类通常使用@Configuration注解，并且包含@Conditional注解来控制配置的条件。

package com.example.autoconfigure;

import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConditionalOnClass(MyService.class)
public class MyAutoConfiguration {

    @Bean
    @ConditionalOnMissingBean
    public MyService myService() {
        return new MyService();
    }
}

3.创建`spring.factories`文件

在src/main/resources/META-INF目录下创建一个spring.factories文件，用于注册自动配置类。

并在spring.factories写入以下内容,注意替换为自己创建的包名和类名:

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.autoconfigure.MyAutoConfiguration

4. 创建自定义功能类

创建一个自定义功能类，这个类将被自动配置类使用。

package com.example.service;

public class MyService {

    public String greet() {
        return "Hello from MyService!";
    }
}

5. 打包和发布

使用Maven打包你的项目，并将其发布到Maven仓库或本地仓库。或使用IDEA maven插件的install来打包

mvn clean install

6. 在其他项目中使用

在其他Spring Boot项目中，可以通过添加依赖来使用自定义启动器。

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

然后在代码中直接使用MyService。

package com.example.demo;

import com.example.service.MyService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MyController {

    @Autowired
    private MyService myService;

    @GetMapping("/greet")
    public String greet() {
        return myService.greet();
    }
}