Spring Boot 動手寫一個 Start

來醉一場發表於2019-03-08
Spring Boot

我們在使用SpringBoot 專案時，引入一個springboot start依賴，只需要很少的程式碼，或者不用任何程式碼就能直接使用預設配置，再也不用那些繁瑣的配置了，感覺特別神奇。我們自己也動手寫一個start.

一、新建一個 Start 的 Maven 專案

  1. pom 檔案如下
<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>2.1.0.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-autoconfigure</artifactId>
        <scope>compile</scope>
    </dependency>

    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.6</version>
        <optional>true</optional>
        <scope>provided</scope>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>

</dependencies>
複製程式碼
  • spring-boot-autoconfigure springboot 自動配置的核心依賴
  • spring-boot-starter-test 測試包
  • lombok 省去 getter/setter 等簡化程式碼
  1. 演示程式碼

DemoService:

public interface DemoService {

    String getMessage();

    Integer getCode();
}

複製程式碼

DemoServiceImpl:

public class DemoServiceImpl implements DemoService {

    @Override
    public String getMessage() {
        return "Hello!";
    }

    @Override
    public Integer getCode() {
        return 123;
    }
}
複製程式碼

DemoAutoConfiguration:

@Configuration
public class DemoAutoConfiguration {

    @Bean
    @ConditionalOnMissingBean(DemoService.class)
    public DemoService demoService() {
        return new DemoServiceImpl();
    }
}
複製程式碼
  • @Configuration 標註該類為一個配置類
  • ConditionalOnMissingBean(DemoService.class) 條件註解

spingboot 的自動註解主要還是用這些條件註解來實現的。請檢視之前的文章：

Spring Boot 自動配置之條件註解

Spring Boot 自動配置之@Enable*與@Import註解

Spring Boot 自動配置之@EnableAutoConfiguration

  1. 讓springboot 識別自動自動配置的程式碼

需要在resources下新建檔案META-INF/spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.jiuxian.DemoAutoConfiguration
複製程式碼

SpringBoot 中的註解 @EnableAutoConfiguration 在專案啟動的時候會通過 SpringFactoriesLoader.loadFactoryNames 方法獲取 spring.factories 檔案下的配置類

  1. 測試類
  • 首先需要再包下建 Application run 的main 方法
@SpringBootApplication
public class StartDemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(StartDemoApplication.class, args);
    }
}

複製程式碼
  • 測試類
@RunWith(SpringRunner.class)
@SpringBootTest
public class StartDemoApplicationTests {

    @Resource
    private DemoService demoService;

    @Test
    public void test() {
        String message = demoService.getMessage();
        System.out.println(message);
        Assert.assertEquals("Hello!", message);

        Integer code = demoService.getCode();
        System.out.println(code);
        Assert.assertEquals(123, (int) code);
    }
}
複製程式碼

如果沒有 StartDemoApplication 這個類則測試類啟動的時候會報 @SpringBootApplication 找不到錯誤

二、新建 springboot 專案引入剛寫的start專案

  1. service
@Service
public class TestService {

    @Resource
    private DemoService demoService;

    public void message() {
        System.out.println("code:" + demoService.getCode());
        System.out.println("message:" + demoService.getMessage());
    }
}

複製程式碼
  1. 測試
    @Resource
    private TestService testService;

    @Test
    public void test() {
        testService.message();
    }

複製程式碼

結果：

code:123
message:Hello!
複製程式碼
  1. 重寫DemoService方法
@Service
public class DemoServiceImpl implements DemoService {

    @Override
    public String getMessage() {
        return "Hello!";
    }

    @Override
    public Integer getCode() {
        return 123;
    }
}

複製程式碼
  1. 測試結果
code:123
message:Hello!
複製程式碼

之所以這樣的結果，是因為在start專案中的DemoService 實現類中有一個 @ConditionalOnMissingBean(DemoService.class) 的註解，如果不存在則使用預設的

三、Demo 原始碼

GitHub原始碼地址

相關文章