springboot中如何自定義starter

springboot中如何自定義starter，相信很多沒有經(jīng)驗(yàn)的人對此束手無策，為此本文總結(jié)了問題出現(xiàn)的原因和解決方法，通過這篇文章希望你能解決這個問題。

1、創(chuàng)建一個Empty Project

2、在該工程中點(diǎn)擊+，選擇new module，新建一個maven工程

點(diǎn)擊確定。

3、在該工程中點(diǎn)擊+，選擇new module，新建一個Spring Initializr工程

后面直接默認(rèn)next，然后點(diǎn)擊finishi。

兩個都創(chuàng)建完畢之后點(diǎn)擊apply，點(diǎn)擊OK。得到如下結(jié)構(gòu)：

4、在gong-spring-boot-starter中引入gong-spring-boot-starter-autoconfigurer，即在gong-spring-boot-starter的pom.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 http://maven.apache.org/xsd/maven-4.0.0.xsd">  <modelVersion>4.0.0</modelVersion>  <groupId>com.gong.starter</groupId>  <artifactId>gong.spring-boot-starter</artifactId>  <version>1.0-SNAPSHOT</version>  <dependencies>    <!--引入自動配置模塊-->    <dependency>      <groupId>com.gong.starter</groupId>      <artifactId>gong-spring-boot-starter-autoconfigurer</artifactId>      <version>0.0.1-SNAPSHOT</version>    </dependency>  </dependencies></project>

我們看下gong-spring-boot-starter-autoconfigurer中的pom.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>2.2.4.RELEASE</version>    <relativePath/> <!-- lookup parent from repository -->  </parent>  <groupId>com.gong.starter</groupId>  <artifactId>gong-spring-boot-starter-autoconfigurer</artifactId>  <version>0.0.1-SNAPSHOT</version>  <name>gong-spring-boot-starter-autoconfigurer</name>  <description>Demo project for Spring Boot</description>  <properties>    <java.version>1.8</java.version>  </properties>  <dependencies>    <!--引入spring-boot-starter：所有starter基本配置-->    <dependency>      <groupId>org.springframework.boot</groupId>      <artifactId>spring-boot-starter</artifactId>    </dependency>  </dependencies></project>

刪除掉創(chuàng)建項(xiàng)目時自動配置的其它東西，只需要一個標(biāo)紅的依賴即可。

5、在gong-spring-boot-starter-autoconfigurer就可以編寫場景啟動的相關(guān)邏輯啦。

（1）新建如下目錄結(jié)構(gòu)及文件

springboot啟動入口可以刪去，resources下文件刪去，test文件夾刪去。在com.gong.starter下新建以上三個java文件，在resources下新建META-INF文件夾，再新建spring.factories文件。

HelloService.java

package com.gong.starter;public class HelloService {  HelloProperties helloProperties;  public HelloProperties getHelloProperties() {    return helloProperties;  }  public void setHelloProperties(HelloProperties helloProperties) {    this.helloProperties = helloProperties;  }  public String sayHelloGong(String name){    return helloProperties.getPrefix()+"-" +name + helloProperties.getSuffix();  }}

sayHelloGong方法可以獲取HelloProperties中的屬性，包括前綴和后綴，然后返回：前綴-name后綴。

HelloProperties.java

package com.gong.starter;import org.springframework.boot.context.properties.ConfigurationProperties;//綁定所有以gong.hello開頭的配置@ConfigurationProperties(prefix = "gong.hello")public class HelloProperties {  private String prefix;  private String suffix;  public String getPrefix() {    return prefix;  }  public void setPrefix(String prefix) {    this.prefix = prefix;  }  public String getSuffix() {    return suffix;  }  public void setSuffix(String suffix) {    this.suffix = suffix;  }}

綁定配置以及定義屬性。

HelloServiceAutoConfiguration.java

package com.gong.starter;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;import org.springframework.boot.context.properties.EnableConfigurationProperties;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;@Configuration //是一個配置類@ConditionalOnWebApplication //web應(yīng)用才生效@EnableConfigurationProperties(HelloProperties.class) //讓屬性文件生效public class HelloServiceAutoConfiguration {  @Autowired  HelloProperties helloProperties;  @Bean  public HelloService helloService(){    HelloService service = new HelloService();    service.setHelloProperties(helloProperties);    return service;  }}

自動配置類。要加入三個注解，并對方法使用@Bean標(biāo)注。

最后，就是在spring.factories中進(jìn)行配置自動注冊：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\com.gong.starter.HelloServiceAutoConfiguration

這樣，我們自己定義的場景啟動器就完成了。

接下來新建一個springboot項(xiàng)目進(jìn)行測試，首先在pom.xml中導(dǎo)入自己定義的場景啟動器：

<!--引入自定義的starter-->    <dependency>      <groupId>com.gong.starter</groupId>      <artifactId>gong.spring-boot-starter</artifactId>      <version>1.0-SNAPSHOT</version>    </dependency>

然后編寫application.properties定義場景啟動器的屬性：

gong.hello.prefix=GONGgong.hello.suffix=HELLO WORLD

接著編寫一個測試類：

package com.gong.springbootjpa.controller;import com.gong.starter.HelloService;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RestController;@RestControllerpublic class HelloController {  @Autowired  HelloService helloService;  @GetMapping("/hello")  public String hello(){    return helloService.sayHelloGong("haha");  }}

看完上述內(nèi)容，你們掌握springboot中如何自定義starter的方法了嗎？如果還想學(xué)到更多技能或想了解更多相關(guān)內(nèi)容，歡迎關(guān)注億速云行業(yè)資訊頻道，感謝各位的閱讀！