springboot自定義starter的實現(xiàn)教程

spring boot 使用 starter 解決了很多配置問題, 但是, 他是怎么來解決這些問題的呢?

我們提供的服務有：網(wǎng)站設計、網(wǎng)站建設、微信公眾號開發(fā)、網(wǎng)站優(yōu)化、網(wǎng)站認證、薛城ssl等。為成百上千家企事業(yè)單位解決了網(wǎng)站和推廣的問題。提供周到的售前咨詢和貼心的售后服務，是有科學管理、有技術的薛城網(wǎng)站制作公司

這里通過一個簡單的例子, 來看一下, starter是怎么來設置默認配置的.

一. 建 starter 項目

spring boot 自定義starter的實現(xiàn)教程

自定義的starter, 項目命名規(guī)范是：自定義名-spring-boot-starter

先來看一下, 我最后的目錄結構

spring boot 自定義starter的實現(xiàn)教程

1. 修改pom.xml文件


 4.0.0
 org.elvin
 my-spring-boot-starter
 1.0-SNAPSHOT
 jar
 my-spring-boot-starter
 http://maven.apache.org
 
 UTF-8
 
 
 
 org.springframework.boot
 spring-boot-autoconfigure
 1.5.9.RELEASE
 
 
 junit
 junit
 3.8.1
 test
 
 
 
 
 
 org.apache.maven.plugins
 maven-compiler-plugin
 2.3.2
 
  1.8
  1.8

其實只是加入了 spring-boot-autoconfigure

App文件中的main方法, 我注釋掉了, 這個在這里沒有用到

2. 配置屬性對應的接收文件

package org.elvin;
import org.springframework.boot.context.properties.ConfigurationProperties;/**
 * author: Elvin
 * Date: 2017/12/12 14:51
 * Description:
 */
@ConfigurationProperties(prefix = "hello")
public class HelloServiceProperties {
 //默認配置內容
 private static final String MSG = "world";
 private String msg = MSG;
 public String getMsg() {
 return msg;
 }
 public void setMsg(String msg) {
 this.msg = msg;
 }
}

3. 對外Service

package org.elvin;
/**
 * author: Elvin
 * Date: 2017/12/12 14:55
 * Description:
 */
public class HelloService {
 private String msg;
 public String sayHello(){
 return "Hello " + msg;
 }
 public String getMsg() {
 return msg;
 }
 public void setMsg(String msg) {
 this.msg = msg;
 }
}

4. 對外service與配置對應文件關聯(lián)

package org.elvin;
import org.springframework.beans.factory.annotation.Autowired;
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;
/**
 * author: Elvin
 * Date: 2017/12/12 14:59
 * Description:
 */
@Configuration
@EnableConfigurationProperties(HelloServiceProperties.class)
@ConditionalOnClass(HelloService.class)
@ConditionalOnProperty(prefix = "hello", value="enabled", matchIfMissing =true )
public class HelloServiceAutoConfiguration {
 @Autowired
 private HelloServiceProperties helloServiceProperties;
 @Bean
 @ConditionalOnMissingBean(HelloService.class)
 public HelloService helloService(){
 HelloService helloService = new HelloService();
 helloService.setMsg(helloServiceProperties.getMsg());
 return helloService;
 }
}

5. starter配置 : spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=org.elvin.HelloServiceAutoConfiguration

做完這些之后, 通過 mvn clean install , 打包到maven庫里面

二. spring boot 項目使用

新建一個spring boot 項目, 選擇web即可.

目錄結構：

spring boot 自定義starter的實現(xiàn)教程

先看一下引用pom.xml


   org.elvin
   my-spring-boot-starter
   1.0-SNAPSHOT

再看一下HelloController

package org.elvin.learn.springboot.controller;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.elvin.*;
/**
 * author: Elvin
 * Date: 2017/12/12 15:34
 * Description:
 */
@RestController
@RequestMapping("hello")
public class HelloController {
 @Autowired
 private HelloService helloService;
 @RequestMapping("index")
 public String index(){
  return helloService.sayHello();
 }
}

這里的 HelloService 就是前面自定義 starter 里面的.

1. 結果: 未配置情況下, 應該是輸出 hello world

spring boot 自定義starter的實現(xiàn)教程