快捷導(dǎo)航

SpringBoot中的自定義starter

更新時(shí)間：2024年01月02日 10:48:01 作者：my_sky_

這篇文章主要介紹了SpringBoot中的自定義starter,Starter是Spring?Boot中的一個(gè)非常重要的概念,Starter相當(dāng)于模塊,它能將模塊所需的依賴(lài)整合起來(lái)并對(duì)模塊內(nèi)的Bean根據(jù)環(huán)境(條件)進(jìn)行自動(dòng)配置,需要的朋友可以參考下

自定義starter

所謂的 starter ，其實(shí)就是一個(gè)普通的 Maven 項(xiàng)目。

1、首先創(chuàng)建一個(gè)普通的 Maven 項(xiàng)目

引入自動(dòng)化配置依賴(lài)：

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-autoconfigure</artifactId>
	<version>2.1.8.RELEASE</version>
	<!-- 表明不傳遞spring-boot-autoconfigure依賴(lài) -->
    <optional>true</optional>
</dependency>

注意：在自定義的starter 的pom中，將spring-boot-autoconfigure的maven依賴(lài)聲明為<optional>true</optional>，表明自定義的starter的jar包不會(huì)傳遞spring-boot-autoconfigure依賴(lài)；否則會(huì)將spring-boot-autoconfigure版本固定，導(dǎo)致引用自定義starter的應(yīng)用出現(xiàn)版本沖突問(wèn)題。

starter命名模式 --> ${module}-spring-boot-starter；

例如：

<groupId>com.hello</groupId>
<artifactId>helloService-spring-boot-starter</artifactId>
<version>0.0.1-SNAPSHOT</version>

2、創(chuàng)建一個(gè)配置類(lèi)

創(chuàng)建一個(gè)配置類(lèi) HelloProperties 來(lái)接受 application.properties 中注入的值：

@ConfigurationProperties(prefix = "javaboy")
public class HelloProperties {
	privatestaticfinal String DEFAULT_NAME = "默認(rèn)名";
	privatestaticfinal String DEFAULT_MSG = "默認(rèn)消息";
	private String name = DEFAULT_NAME;
	private String msg = DEFAULT_MSG;
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public String getMsg() {
		return msg;
	}
	public void setMsg(String msg) {
		this.msg = msg;
	}
}

3、創(chuàng)建一個(gè)服務(wù)類(lèi) HelloService

public class HelloService {
	private String msg;
	private String name;
	public String sayHello() {
		return name + " say " + msg + " !";
	}
	public String getMsg() {
		return msg;
	}
	public void setMsg(String msg) {
		this.msg = msg;
	}
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
}

4、自定義自動(dòng)配置類(lèi)

SpringBoot自動(dòng)裝配的命名規(guī)則：

自動(dòng)裝配類(lèi)應(yīng)命名為：XxxAutoConfiguration；
自動(dòng)裝配package命名模式： ${root-package}.autoconfigure.${module-package}，比如：

org.springframework.boot.autoconfigure.aop.AopAutoConfiguration

@Configuration
@EnableConfigurationProperties(HelloProperties.class)
@ConditionalOnClass(HelloService.class)
public class HelloServiceAutoConfiguration {
	@Autowired
	HelloProperties helloProperties;
	@Bean
	HelloService helloService() {
		HelloService helloService = new HelloService();
		helloService.setName(helloProperties.getName());
		helloService.setMsg(helloProperties.getMsg());
		return helloService;
	}
}

注解 @EnableConfigurationProperties 使我們之前配置的 @ConfigurationProperties 生效，讓配置的屬性注入到 Bean 中。

注解 @ConditionalOnClass 表示當(dāng)項(xiàng)目的 classpath 下存在 HelloService 時(shí)，后面的配置才生效。

5、創(chuàng)建 spring.factories 文件

在resources目錄下新建 META-INF/spring.factories 文件：

org.springframework.boot.autoconfigure.EnableAutoConfiguration = \
com.hello.autoconfigure.HelloServiceAutoConfiguration

這里的key是固定的，value是我們的自動(dòng)配置類(lèi)的全路徑。

SpringBoot 項(xiàng)目啟動(dòng)時(shí)，會(huì)做自動(dòng)配置，會(huì)去掃描所有jar包中的 META-INF/spring.factories 配置文件。

至此，自定義的starter已完成。將這個(gè)自動(dòng)化配置類(lèi)的項(xiàng)目安裝到maven倉(cāng)庫(kù)中，然后在其他項(xiàng)目中引入依賴(lài)就可以使用。

新建一個(gè)普通的 Spring Boot 工程，并加入我們自定義的 starter 的依賴(lài)：

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

此時(shí)我們項(xiàng)目中已有一個(gè) helloService 實(shí)例可以使用，而且我們還可以配置它的屬性數(shù)據(jù)，例如，在 application.properties 中配置：

javaboy.name=我的名字
javaboy.msg=提示消息

我們做個(gè)單元測(cè)試：

@RunWith(SpringRunner.class)
@SpringBootTest
public class MystarterApplicationTest {
	@Autowired
	private HelloService helloService;
	@Test
	public void contextLoads() {
		System.out.println(helloService.sayHello());
	}
}