660.自定义 Starter

本文讲讲如何自定义 Starter

有些功能是经常用的，我们希望可以将其抽取出来，这样其他微服务引用时，也能自动配置好，此时就得自定义 Starter。

Starter 启动原理

先来复习下原理：

• 首先一个 Starter 仅仅是描述了引入了什么依赖
• 然后该 Starter 会引入一个自定义的 AutoConfigure，自动配置这些依赖
• AutoConfigure 底层会引用 SpringBoot 官方的 spring-boot-starter，该官方 starter 是最底层的，每个 AutoConfigure 都要引入

例如，spring-boot-starter-test 这个 starter，仅仅描述了引用了什么依赖，几乎没什么代码；而其引入的 spring-boot-test-autoconfigure，才是完成配置的

新建项目

新建一个空项目（方便创建多个模块）：

新建一个模块 atguigu-hello-spring-boot-starter-autoconfigure，作为 AutoConfigure

其 pom.xml 文件如下（多余的内容我们可以先删掉）：

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.14</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <groupId>com.peterjxl</groupId>
    <artifactId>atguigu-hello-spring-boot-starter-autoconfigure</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>atguigu-hello-spring-boot-starter-autoconfigure</name>
    <description>atguigu-hello-spring-boot-starter-autoconfigure</description>


    <properties>
        <java.version>1.8</java.version>
    </properties>

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

</project>

然后新建一个模块，作为 starter：

然后我们在 starter 的模块中，引入 autoconfigure（引入后可能会提示找不到，后续我们会 install 自动配置模块到本地仓库中）

<?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.peterjxl</groupId>
    <artifactId>atguigu-hello-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>com.peterjxl</groupId>
            <artifactId>atguigu-hello-spring-boot-starter-autoconfigure</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
    </dependencies>

</project>

新增组件 HelloService

假设我们自定义了一个组件：HelloService，这个是很有用的组件，要被其他模块引入。我们先定义一个配置类，用于 HelloService 的配置读取：

package com.peterjxl.atguiguhellospringbootstarterautoconfigure.bean;


import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix = "atguigu.hello")
public class HelloProperties {
  
    private String prefix;
    private String suffix;

    public String getPrefix() {
        return prefix;
    }

    public void setPrefix(String prefix) {
        this.prefix = prefix;
    }

    public String getSuffix() {
        return suffix;
    }

    public void setSuffix(String suffix) {
        this.suffix = suffix;
    }
}

然后新建 HelloService 类：

package com.peterjxl.atguiguhellospringbootstarterautoconfigure.controller;

import com.peterjxl.atguiguhellospringbootstarterautoconfigure.bean.HelloProperties;
import org.springframework.beans.factory.annotation.Autowired;

/**
 * 默认不要放在容器中
 */
public class HelloService {

    @Autowired
    HelloProperties helloProperties;


    public String sayHello(String name) {
        return helloProperties.getPrefix() + "-" + name + "-" + helloProperties.getSuffix();
    }
}

‍ 至于该组件是否放在容器中，我们单独写一个配置类：

package com.peterjxl.atguiguhellospringbootstarterautoconfigure.auto;


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;
import com.peterjxl.atguiguhellospringbootstarterautoconfigure.controller.HelloService;
import com.peterjxl.atguiguhellospringbootstarterautoconfigure.bean.HelloProperties;

@Configuration
@EnableConfigurationProperties(HelloProperties.class) //默认会放在容器中
public class HelloServiceAutoConfiguration {

    @Bean
    @ConditionalOnMissingBean(HelloService.class)
    public HelloService helloService() {
        HelloService helloService = new HelloService();
        return helloService;
    }
}

新建配置文件 resources\META-INF\spring.factories：

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.peterjxl.atguiguhellospringbootstarterautoconfigure.auto.HelloServiceAutoConfiguration \

‍ 写完后，我们可以进行打包（mvn install），安装到本地仓库

然后 starter 同理，也要 mvn clean 和 mvn install，这样别的项目就可以引入该 starter 了。 ‍

新建测试项目

接下来创建一个测试项目，用来引入 starter 并测试 HelloService。可以引入 web 开发场景的依赖：

‍

并引入 starter：

<dependency>
    <groupId>com.peterjxl</groupId>
    <artifactId>atguigu-hello-spring-boot-starter-autoconfigure</artifactId>
    <version>0.0.1-SNAPSHOT</version>
</dependency>

‍ 在配置文件中 application.yml 中：

atguigu.hello.prefix=ATGUIGU
atguigu.hello.suffix=666

‍ 然后新增一个 Controller，用来注入 HelloService：

package com.peterjxl.learnspringbootcustomerstartertest.controller;


import com.peterjxl.atguiguhellospringbootstarterautoconfigure.controller.HelloService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {

    @Autowired
    HelloService helloService;


    @GetMapping("/hello")
    public String sayHello() {
        return helloService.sayHello("张三");
    }
}

‍ 启动项目，可以项目运行效果一致：

源码

已将本文源码上传到 Gitee (opens new window) 和 GitHub (opens new window)

• LearnSpringBoot-Customer-Starter：包含 starter 和 autoconfigure 两个模块
• LearnSpringBoot-Customer-Starter-Test：用于引入 starter ‍