spring boot自定义starter

在springboot中，使用的最多的就是starter。starter可以理解为一个可拔插式的插件，例如，你想使用jdbc插件，那么可以使用jdbc-starter；如果想使用mongo-starter，可以使用mongo-starter。

如下，一个简单的springboot starter依赖，

<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.4.1.RELEASE</version>
    </parent>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

其中，依赖了starter-log4j2和starter-web两个插件。更多的如何使用springboot可以去spring官网了解更多的使用。

上面了springboot中starter中的基础使用，下面自己定义一个starter。

需求：
自定义一个名为user-starter的starter项目，通过springboot创建一个boss项目，并在项目中调用user-starter中的函数，并输出hello starter。

第一步

创建一个maven项目boss，怎么创建我就不多说了，不熟悉的可以百度创建maven项目，我们重点看下第二步。

第二部

首先在pom.xml中进行依赖，如下

<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.eju.ess</groupId>
    <artifactId>user-starter</artifactId>
    <version>0.0.2-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>user-starter</name>
    <url>http://maven.apache.org</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>


    <dependencies>
        <!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot</artifactId>
            <version>1.4.3.RELEASE</version>
        </dependency>
    </dependencies>

</project>

由于starter项目需要使用到spring的一些特性，因此在starter项目中至少需要依赖一个对org.springframework.boot的依赖。

接着，创建一个maven项目user-starter，创建UserService类，代码如下

UserService

package com.eju.ess;

public class UserService {
    public void helloStarter(){
        System.out.println(">> hello starter");
    }
}

创建一个UserAutoConfiguration类，代码如下

UserAutoConfiguration

package com.eju.ess;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class UserAutoConfiguration {
    @Bean
    public UserService dbCountRunner() {
        return new UserService();
    }
}

==接着在resources目录中创建META-INF文件夹，然后在META-INF文件夹中创建spring.factories文件==，这个文件用于告诉spring boot去找指定的自动配置文件。在应用程序启动过程中，spring boot使用springfactoriesloader类加载器查找org.springframework.boot.autoconfigure.enableautoconfiguration关键字对应的java配置文件。spring boot会遍历在各个jar包种meta-inf目录下的spring.factories文件，构建成一个配置文件链表。

spring.factories内容如下

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.eju.ess.UserAutoConfiguration

第三部

在boss项目中进行依赖，在pom中增加如下代码

<dependency>
            <groupId>com.eju.ess</groupId>
            <artifactId>user-starter</artifactId>
            <version>0.0.2-SNAPSHOT</version>
        </dependency>

在Controller中使用@Autowired进行注入，代码如下，

package com.banana;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.eju.ess.UserService;

import lombok.extern.slf4j.Slf4j;

@Slf4j
@RestController
public class SampleController {

    @Autowired
    private UserService t=null;

    @RequestMapping("/")
    String home() {

        t.helloStarter();

        return "Hello World!";
    }
}

接着启动，springboo程序，访问http://127.0.0.1:8080/在console输入如下

15:04:29.148 [restartedMain] INFO  org.apache.tomcat.util.net.NioSelectorPool - Using a shared selector for servlet write/read
15:04:29.186 [restartedMain] INFO  org.springframework.boot.context.embedded.tomcat.TomcatEmbeddedServletContainer - Tomcat started on port(s): 9900 (http)
15:04:29.195 [restartedMain] INFO  com.banana.Startup - Started Startup in 4.519 seconds (JVM running for 5.464)
15:04:37.260 [http-nio-9900-exec-1] INFO  org.apache.catalina.core.ContainerBase.[Tomcat].[localhost].[/] - Initializing Spring FrameworkServlet 'dispatcherServlet'
15:04:37.261 [http-nio-9900-exec-1] INFO  org.springframework.web.servlet.DispatcherServlet - FrameworkServlet 'dispatcherServlet': initialization started
15:04:37.277 [http-nio-9900-exec-1] INFO  org.springframework.web.servlet.DispatcherServlet - FrameworkServlet 'dispatcherServlet': initialization completed in 16 ms
>> hello starter

可以看到我们前面的需求hello starter已经输出到了console。

文章参考：

http://www.jianshu.com/p/85460c1d835a

==手机QQ扫描下方二维码，快速加入Java架构师交流群==