曾彪彪的个人博客 -- Create customer Spring Boot Starter with Spring boot 3

In Spring boot 3, the way to create a customer spring boot starter is different with spring 2. You can follow below steps to creat you own spring boot starter.

## Create your spring boot starter project.
You project should be end with xxx-spring-boot-starter to differentiate with the official projects. and don't add a spring maven plugs since it will build the spring boot starter projext as an executable jar. below is the POM.xml
```xml
<?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 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>3.3.1</version>
        <relativePath/> 
    </parent>
    <groupId>com.zengbiaobiao.demo</groupId>
    <artifactId>spring-boot-starter-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring-boot-starter-demo</name>
    <description>spring-boot-starter-demo</description>
    <url/>
    <licenses>
        <license/>
    </licenses>
    <developers>
        <developer/>
    </developers>
    <scm>
        <connection/>
        <developerConnection/>
        <tag/>
        <url/>
    </scm>
    <properties>
        <java.version>21</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>

<build>
        <plugins>
            
            
        </plugins>
    </build>

</project>

```

## Add autoconfiguration class

Create the CustomerAutoConfiguration.java, CustomerProperties.java and CustomerService.java as below.

CustomerAutoConfiguration.java
```java

package com.zengbiaobiao.demo.springbootstarterdemo;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@AutoConfiguration
@EnableConfigurationProperties(CustomerProperties.class)
public class CustomerAutoConfiguration {

@Autowired
    private CustomerProperties properties;

@Bean
    @ConditionalOnMissingBean
    public CustomerService customerService() {
        return new CustomerService(properties.getName());
    }
}
```

CustomerProperties.java

```java

package com.zengbiaobiao.demo.springbootstarterdemo;

@ConfigurationProperties(prefix = "customer")
public class CustomerProperties {

private String name = "defaultName";

public String getName() {
        return name;
    }

public void setName(String name) {
        this.name = name;
    }
}
```

CustomerService.java

```java

package com.zengbiaobiao.demo.springbootstarterdemo;

public class CustomerService {

private final String name;

public CustomerService(String name) {
        this.name = name;
    }

public String getName() {
        return name;
    }
}

```

**Add the dectory "META-INF/spring" under resources folder, note here the folder is "META-INF/spring", not "META-INF.spring", although they display as same in IntelliJ.**
Then add a file name "org.springframework.boot.autoconfigure.AutoConfiguration.imports" under the folder "META-INF/spring".
Add below content into the file "org.springframework.boot.autoconfigure.AutoConfiguration.imports"

```
com.zengbiaobiao.demo.springbootstarterdemo.CustomerAutoConfiguration
```

## build and install the project

Build and install your project

## Test you project

Create a new project with below dependences.

```xml
<?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 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>3.3.1</version>
		<relativePath/> 
	</parent>
	<groupId>com.zengbiaobiao.demo</groupId>
	<artifactId>my-demo</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<name>my-demo</name>
	<description>my-demo</description>
	<url/>
	<licenses>
		<license/>
	</licenses>
	<developers>
		<developer/>
	</developers>
	<scm>
		<connection/>
		<developerConnection/>
		<tag/>
		<url/>
	</scm>
	<properties>
		<java.version>21</java.version>
	</properties>
	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>

<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
		<dependency>
			<groupId>com.zengbiaobiao.demo</groupId>
			<artifactId>spring-boot-starter-demo</artifactId>
			<version>0.0.1-SNAPSHOT</version>
		</dependency>
	</dependencies>

<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>

```

Create customer Spring Boot Starter with Spring boot 3

评论(1)