自己写一个简单的SpringBoot-starter

前言

在我看来，SpringBoot之所以流行，是因为spring starter模式的提出。spring starter的出现，可以让模块开发更加独立化，互相间依赖更加松散以及可以更加方便的集成。
–《spring源码深度解析》

例如我想要在SpringBoot项目中集成web框架，那么我只需要加入spring-data-web-starter的依赖。这为我们省去了之前很多的配置操作。

如果我们要自己写一个starter，需要怎么做呢？

原理

埋坑

实现

1. 建立一个maven工程，pom如下：

<?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.springstudy</groupId>
    <artifactId>study-client-starter</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>2.0.1.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
</project>

然后我们定义一个接口，可以认为它是当前独立业务开发模块对外暴露的可以直接调用的接口，如下：

package com.spring.study.module;

public interface HelloService {
    public String sayHello();
}

我们对接口做一个简单的实现，返回hello world！字符串：

package com.spring.study.module;
import org.springframework.stereotype.Component;

@Component
public class HelloServiceImpl implements HelloService {
    public String sayHello(){
        return "hello world!";
    }
}

添加自动配置项：

package com.spring.study;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

@Configuration
@ComponentScan({"com.spring.study.module"})
public class HelloServiceAutoConfiguration {
}

我们发现，在HelloServiceAutoConfiguration类中并没有逻辑实现，它存在的目的仅仅是通过注解进行配置的声明，我们可以在ComponentScan中加入这个模块的容器扫描路径。
当然，如果仅仅是到此，Starter还是没有开发完成，还需要最后一步，那就是声明这个配置文件的路径，在Spring的根路径下建立META-INF/spring.factories文件，并声明配置项路径，如图：

发布

到此，一个标准的Starter就开发完成了。我们来看一下怎么使用它：
在控制台输入：mvn install
将文件打成jar包存到maven仓库中

问题：
打jar包时，可能会遇到下面这个问题：

解决方法：IDEA运行报错: Maven编译错误：不再支持源选项 5。请使用 6 或更高版本

测试

新建一个spring boot项目，导入spring-boot-starter-web和study-client-starter。
pom文件如下：

Controller

运行，浏览器：

至此，一个自定义的Starter写好了。