Spring Boot Starter原理及实践

欢迎关注微信公众号：互联网全栈架构

记得初次使用Spring Boot的时候，被它的快速、简单、高效所震惊。相较于原始的Spring开发：写一大堆的XML配置、手动引入一堆的依赖（曾经碰到过因为依赖的版本问题，导致了OOM）、梦魇般的web.xml，如此种种，让人不得不被Spring Boot的清爽所迷倒，那么，Spring Boot是如何做到这样的呢，今天我们就试图来解析一下，本文主要分为两个部分：

Starter原理剖析；
自定义一个Starter并使用

一、Starter是什么

在日常的程序开发中，依赖管理是一个非常让人头疼的问题，手动的逐个引入这些依赖工作量巨大，而且可能还存在一些潜在的问题，比如前面提到的，由于两个版本的兼容问题，在程序运行一段时间后出现了OOM的情况，那么，针对这样的问题，Starter就应运而生了，它是一种依赖描述符，可以简化配置，把常用的场景抽象出来做成一个个的Starter，在我们的程序中引入这些Starter，相关的依赖都会被引入进来，同时也抛弃了那些繁琐的配置，比如web.xml等等。

Starter出现之前，需要手动引入依赖：

而在Starter出现之后，项目只需要引入对应的Starter即可，当然，Starter本身需要管理好这些依赖，相当于引入了一个抽象层：

Starter的命名也有讲究，官方的Starter以这样的模式命令：spring-boot-starter-*，*代表应用的特定类型，比如下面这样的：

spring-boot-starter-web
spring-boot-starter-activemq
spring-boot-starter-data-mongodb
spring-boot-starter-batch

而第三方Starter，比如自定义的Starter，一般是以模块的名字开头，再加上spring-boot-starter，这样的话方便区分，比如：

acme-spring-boot-starter
fslog-spring-boot-starter

二、Starter的工作原理

我们以常见的的web starter为例，也就是spring-boot-starter-web，如果我们在项目中添加这个依赖，比如下面这样（如果还不熟悉Spring Boot相关项目的搭建，可以参考文章：手把手：Spring Cloud Alibaba项目搭建：

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

在IDEA中，使用Ctrl+鼠标左键，可以看到它依赖的底层源文件：

可以看到，它把web开发相关的一些组件都引入了，像Tomcat、Spring MVC等。这是第一步，Starter会引入相关的一些依赖，接下来就是自动配置，也就是加载相关的Bean以及默认的配置，这个是怎么做到的呢？

在Spring Boot的启动类中，会加上注解@SpringBootApplication，查看这个注解的详情，会发现它由以下注解组成（主要部分）：

EnableAutoConfiguration：这个注解借用@Import，注册依赖包中的相关Bean；

SpringBootConfiguration：相当于一个配置类，作用与@Configuration相同。

在自动配置的功能实现中，这个注解非常关键EnableAutoConfiguration，它会@Import(AutoConfigurationImportSelector.class)，而这个类中的方法selectImports最终会从META-INF/spring.factories文件中加载EnableAutoConfiguration里面的配置值

上面的文字描述略显枯燥，接下来我们定义一个自己的Starter，并在其他项目中使用。

三、自定义Starter

首先创建一个新的Starter模块，主要依赖Spring Boot的自动配置模块，pom文件如下：

<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>
    <parent>
        <groupId>com.fullstack</groupId>
        <artifactId>fs-parent</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <artifactId>mystarter-spring-boot-starter</artifactId>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
    </dependencies>
</project>

再定义接口和实现类：

package com.fullstack.commerce.message;
public interface PrintService {
    String print(String msg);
}

package com.fullstack.commerce.message.impl;
import com.fullstack.commerce.message.PrintService;
public class PrintServiceImpl implements PrintService {
    @Override
    public String print(String msg) {
        return "Starter print:"+msg;
    }
}

然后是自动配置类，它是Starter的关键部分，把业务相关的Bean加载进来：

package com.fullstack.commerce.config;

import com.fullstack.commerce.message.PrintService;
import com.fullstack.commerce.message.impl.PrintServiceImpl;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
@EnableConfigurationProperties(PrintProperties.class) // 它使注解@ConfigurationProperties生效
@ConditionalOnClass(value = {PrintService.class, PrintServiceImpl.class}) // 只有业务类位于classpath上，才会实例当前这个配置类
public class MyAutoConfiguration {
    @Bean
    @ConditionalOnMissingBean  //只有当前上下文不存在这个bean时，才会实例化
    PrintService printService(){
        return new PrintServiceImpl();
    }
}

如果想对Starter中的配置项进行修改，需要定义配置属性类，在Starter中指定默认值，但在使用的时候还可以更改：

package com.fullstack.commerce.config;
import org.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties(prefix = "com.fullstack")
public class PrintProperties {
    private String defaultMsg="Starter msg";
    public String getDefaultMsg() {
        return defaultMsg;
    }
    public void setDefaultMsg(String defaultMsg) {
        this.defaultMsg = defaultMsg;
    }
}

还需要在目录resources/META-INF下创建文件：spring.factories，这个文件把AutoConfiguration配置进去：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=
com.fullstack.commerce.config.MyAutoConfiguration

最后，需要把这个Starter使用install命令安装到本地，其它Module就可以引入这个Starter：

<dependency>
    <groupId>com.fullstack</groupId>
    <artifactId>mystarter-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

在Controller类中引入必要的类，并编写测试方法：

@Resource
private PrintService printService;
@Resource
private PrintProperties printProperties;
@RequestMapping("/print")
public String print(@RequestParam String msg){
    return printService.print(msg+"，配置的消息为："+printProperties.getDefaultMsg());
}