一、簡介

SpringBoot 最強(qiáng)大的功能就是把我們常用的場景抽取成了一個個starter（場景啟動器），我們通過引入springboot 為我提供的這些場景啟動器，我們再進(jìn)行少量的配置就能使用相應(yīng)的功能。即使是這樣，springboot也不能囊括我們所有的使用場景，往往我們需要自定義starter，來簡化我們對springboot的使用。

專業(yè)成都網(wǎng)站建設(shè)公司，做排名好的好網(wǎng)站，排在同行前面，為您帶來客戶和效益!成都創(chuàng)新互聯(lián)為您提供成都網(wǎng)站建設(shè)，五站合一網(wǎng)站設(shè)計(jì)制作，服務(wù)好的網(wǎng)站設(shè)計(jì)公司，網(wǎng)站設(shè)計(jì)、成都做網(wǎng)站負(fù)責(zé)任的成都網(wǎng)站制作公司!

二、如何自定義starter

1.實(shí)例

如何編寫自動配置 ？

我們參照@WebMvcAutoConfiguration為例，我們看看們需要準(zhǔn)備哪些東西，下面是WebMvcAutoConfiguration的部分代碼：

@Configuration
@ConditionalOnWebApplication
@ConditionalOnClass({Servlet.class, DispatcherServlet.class, WebMvcConfigurerAdapter.class})
@ConditionalOnMissingBean({WebMvcConfigurationSupport.class})
@AutoConfigureOrder(-2147483638)
@AutoConfigureAfter({DispatcherServletAutoConfiguration.class, ValidationAutoConfiguration.class})
public class WebMvcAutoConfiguration {

    @Import({WebMvcAutoConfiguration.EnableWebMvcConfiguration.class})
    @EnableConfigurationProperties({WebMvcProperties.class, ResourceProperties.class})
    public static class WebMvcAutoConfigurationAdapter extends WebMvcConfigurerAdapter {

        @Bean
        @ConditionalOnBean({View.class})
        @ConditionalOnMissingBean
        public BeanNameViewResolver beanNameViewResolver() {
            BeanNameViewResolver resolver = new BeanNameViewResolver();
            resolver.setOrder(2147483637);
            return resolver;
        }
    }
}

我們可以抽取到我們自定義starter時(shí)同樣需要的一些配置。

@Configuration  //指定這個類是一個配置類
@ConditionalOnXXX  //指定條件成立的情況下自動配置類生效
@AutoConfigureOrder  //指定自動配置類的順序
@Bean  //向容器中添加組件
@ConfigurationProperties  //結(jié)合相關(guān)xxxProperties來綁定相關(guān)的配置
@EnableConfigurationProperties  //讓xxxProperties生效加入到容器中

自動配置類要能加載需要將自動配置類，配置在META-INF/spring.factories中
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\

模式

我們參照 spring-boot-starter 我們發(fā)現(xiàn)其中沒有代碼：

我們在看它的pom中的依賴中有個 springboot-starter

    org.springframework.boot
    spring-boot-starter

我們再看看 spring-boot-starter 有個 spring-boot-autoconfigure

    org.springframework.boot
    spring-boot-autoconfigure

關(guān)于web的一些自動配置都寫在了這里 ，所以我們有總結(jié)：

啟動器starter只是用來做依賴管理
需要專門寫一個類似spring-boot-autoconfigure的配置模塊
用的時(shí)候只需要引入啟動器starter，就可以使用自動配置了

命名規(guī)范

官方命名空間

• 前綴：spring-boot-starter-
• 模式：spring-boot-starter-模塊名
• 舉例：spring-boot-starter-web、spring-boot-starter-jdbc

自定義命名空間

• 后綴：-spring-boot-starter
• 模式：模塊-spring-boot-starter
• 舉例：mybatis-spring-boot-starter

三、自定義starter實(shí)例

我們需要先創(chuàng)建兩個工程 hello-spring-boot-starter 和 hello-spring-boot-starter-autoconfigurer

1. hello-spring-boot-starter

1.pom.xml

    4.0.0

    com.gf
    hello-spring-boot-starter
    0.0.1-SNAPSHOT
    jar

    hello-spring-boot-starter

    
    
        
        
            com.gf
            hello-spring-boot-starter-autoconfigurer
            0.0.1-SNAPSHOT
        
    

同時(shí)刪除 啟動類、resources下的文件，test文件。

2. hello-spring-boot-starter-autoconfigurer

1. pom.xml

    4.0.0

    com.gf
    hello-spring-boot-starter-autoconfigurer
    0.0.1-SNAPSHOT
    jar

    hello-spring-boot-starter-autoconfigurer
    Demo project for Spring Boot

    
        org.springframework.boot
        spring-boot-starter-parent
        1.5.9.RELEASE
         
    

    
        UTF-8
        UTF-8
        1.8
    

    
        
        
            org.springframework.boot
            spring-boot-starter
        

    

2. HelloProperties

package com.gf.service;

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix = "gf.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;
    }

}

3. HelloService

package com.gf.service;

public class HelloService {

    HelloProperties helloProperties;

    public HelloProperties getHelloProperties() {
        return helloProperties;
    }

    public void setHelloProperties(HelloProperties helloProperties) {
        this.helloProperties = helloProperties;
    }

    public String sayHello(String name ) {
        return helloProperties.getPrefix()+ "-" + name + helloProperties.getSuffix();
    }
}

4. HelloServiceAutoConfiguration

package com.gf.service;

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;
    }

}

5. spring.factories

在 resources 下創(chuàng)建文件夾 META-INF 并在 META-INF 下創(chuàng)建文件 spring.factories ，內(nèi)容如下：

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.gf.service.HelloServiceAutoConfiguration

到這兒，我們的配置自定義的starter就寫完了 ，我們hello-spring-boot-starter-autoconfigurer、hello-spring-boot-starter 安裝成本地jar包。

三、測試自定義starter

我們創(chuàng)建個項(xiàng)目 hello-spring-boot-starter-test，來測試系我們寫的stater。

1. pom.xml

    4.0.0

    com.gf
    hello-spring-boot-starter-test
    0.0.1-SNAPSHOT
    jar

    hello-spring-boot-starter-test
    Demo project for Spring Boot

    
        org.springframework.boot
        spring-boot-starter-parent
        1.5.9.RELEASE
         
    

    
        UTF-8
        UTF-8
        1.8
    

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

        
        
            com.gf
            hello-spring-boot-starter
            0.0.1-SNAPSHOT
        

        
            org.springframework.boot
            spring-boot-starter-test
            test
        
    

    
        
            
                org.springframework.boot
                spring-boot-maven-plugin
            
        
    

2. HelloController

package com.gf.controller;

import com.gf.service.HelloService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @Autowired
    HelloService helloService;

    @GetMapping("/hello/{name}")
    public String hello(@PathVariable(value = "name") String name) {
        return helloService.sayHello( name + " , " );
    }

}

3. application.properties

gf.hello.prefix = hi
gf.hello.suffix = what's up man ?

我運(yùn)行項(xiàng)目訪問 http://127.0.0.1:8080/hello/zhangsan，結(jié)果如下：

hi-zhangsan , what's up man ?

源碼 : https://github.com/gf-huanchupk/SpringBootLearning

歡迎關(guān)注我的公眾號《程序員果果》，關(guān)注有驚喜~~

另外有需要云服務(wù)器可以了解下創(chuàng)新互聯(lián)scvps.cn，海內(nèi)外云服務(wù)器15元起步，三天無理由+7*72小時(shí)售后在線，公司持有idc許可證，提供“云服務(wù)器、裸金屬服務(wù)器、高防服務(wù)器、香港服務(wù)器、美國服務(wù)器、虛擬主機(jī)、免備案服務(wù)器”等云主機(jī)租用服務(wù)以及企業(yè)上云的綜合解決方案，具有“安全穩(wěn)定、簡單易用、服務(wù)可用性高、性價(jià)比高”等特點(diǎn)與優(yōu)勢，專為企業(yè)上云打造定制，能夠滿足用戶豐富、多元化的應(yīng)用場景需求。

當(dāng)前名稱：SpringBoot自定義starter-創(chuàng)新互聯(lián)
網(wǎng)頁網(wǎng)址：http://weahome.cn/article/iccpe.html