如何定制并发布自己的Spring Boot Starter？

本文共计891个文字，预计阅读时间需要4分钟。

前言：在使用Spring Boot进行开发的时候，我们有时想要将自己编写的代码打包成类似spring-boot-starter-web这样的形式，导入到自己的中央仓库中，以便其他项目可以像使用spring-boot-starter-web一样引用。下面是具体步骤：

1. 创建一个Maven项目，并添加必要的依赖。

2.编写代码，实现所需功能。

3.创建一个打包好的jar包。

4.将jar包上传到自己的中央仓库。

5.在其他项目中，通过添加依赖来使用这个自定义的starter。

下面是具体步骤的详细说明：

1. 创建一个Maven项目，并添加必要的依赖。

xml

org.springframework.boot spring-boot-starter-web

2. 编写代码，实现所需功能。

java@SpringBootApplicationpublic class CustomStarterApplication { public static void main(String[] args) { SpringApplication.run(CustomStarterApplication.class, args); }}

3. 创建一个打包好的jar包。

bashmvn clean package

4. 将jar包上传到自己的中央仓库。

5. 在其他项目中，通过添加依赖来使用这个自定义的starter。

xml com.example custom-starter 1.0.0

前言

在使用spring boot开发的时候，我们有时候想要把自己的代码打包成类似spring-boot-starter-web的样式来导入到自己的中央仓库，然后其他项目就可以引用类似springboot那样的引用了，下面我们就实现一个类似的项目。

1.新建一个spring boot 项目，取名为mybootspringbootstarter，groupId和artifactId如下所示

<groupId>com.my.boot</groupId> <artifactId>myboot-spring-boot-starter</artifactId> <version>1.0-SNAPSHOT</version>

这里需要注意的是为了区分springboot自己的jar，默认规则的话我们把自己的取名放在spring-boot-starter前面，如上面代码所示。

2.引入springboot相关jar包来做基础处理

<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter</artifactId> <version>2.1.3.RELEASE</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-autoconfigure</artifactId> <version>2.1.0.RELEASE</version> </dependency> <!--生成配置文件元数据结构--> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <version>2.1.2.RELEASE</version> </dependency>

spring-boot-starter是核心包,必须添加。

3.添加一个可配置的properties类，用于可配置属性的加载

@ConfigurationProperties(prefix = "com.myboot") public class MyBootProperties { /** * 名称 */ private String name; /** * 是否启用 */ private boolean enable; ....省略get/set方法 }

4.定义一个类来使用properties类的属性引用

public class MyService { /** * 名称 */ private String name; /** * 是否启用 */ private boolean enable; public String getName() { return name; } public void setName(String name) { this.name = name; } public boolean isEnable() { return enable; } public void setEnable(boolean enable) { this.enable = enable; } public void print(){ System.out.println("name:" + this.name + "----enable:" + this.enable); } }

5.定义好以上类后，我们如何像bean一样使用呢？那么我们就需要把它定义为一个bean

@Configuration @EnableConfigurationProperties(MyBootProperties.class) public class MyBootAutoConfiguration { @Bean public MyService myService(MyBootProperties myBootProperties){ MyService myService = new MyService(); myService.setName(myBootProperties.getName()); myService.setEnable(myBootProperties.isEnable()); return myService; } }

6.怎么样才能在其他架构中引入我们定义的bean呢？我们需要在resources/META-INFO下定义spring.factories文件

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ com.my.boot.configure.MyBootAutoConfiguration

这个是spring的标准格式，spring的加载器会自动去寻找这个文件下的所有配置实现自动的注入。

通过以上步骤就完成了基本starter的搭建，最后通过maven clean install就可以生成一个jar了在仓库中，我们可以在另外的项目中像引入springboot相关的jar引入了。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持自由互联。