【SpringBoot】20、自定义启动器 Starter【保姆级教程】

1、说明

启动器模块是一个 空 jar 文件，仅提供辅助性依赖管理，这些依赖可能用于自动装配或者其他类库；

命名归约：

官方命名：

• 前缀：spring-boot-starter-xxx
• 比如：spring-boot-starter-web…

自定义命名：

• xxx-spring-boot-starter
• 比如：mybatis-spring-boot-starter

2、编写启动器

1）新建一个空项目

• 项目建成后选择jdk版本

2）新建一个普通Maven模块

tuwer-spring-boot-starter 这就是自定义启动器的名称，别处引用时就用这个名称

3）新建一个Springboot模块

4）基本结构

5）模块绑定

在普通Maven模块中加Springboot模块的依赖

<dependency>
    <groupId>com.tuwergroupId>
    <artifactId>tuwer-spring-boot-starter-autoconfigureartifactId>
    <version>0.0.1-SNAPSHOTversion>
dependency>

6）清理Springboot模块

为保持项目干净，建议删除多余部分；不删也能使用

spring-boot-starter 是所有 starter 的基础依赖，必须要有

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starterartifactId>
dependency>

7）编写自已的服务

在SpringBoot模块中编写自已的服务类

public class HelloService {
    /**
     * 配置属性
     */
    HelloProperties helloProperties;

    public HelloProperties getHelloProperties() {
        return helloProperties;
    }

    public void setHelloProperties(HelloProperties helloProperties) {
        this.helloProperties = helloProperties;
    }

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

8）编写属性配置类

如果不需要调用方配置属性的话，可以省略

@ConfigurationProperties(prefix = "tuwer.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;
    }
}

9）编写自动配置类

指明自已的服务类在什么情况下生效，满足生效条件时，自动注入到Spring容器中，供调用方使用

@Configuration // 自动配置类
@ConditionalOnWebApplication // 是web应用时生效
@EnableConfigurationProperties(HelloProperties.class) // 指明属性配置类HelloProperties
public class HelloServiceAutoConfiguration {

    /**
     * 注入属性配置类
     */
    @Autowired
    HelloProperties helloProperties;

    /**
     * 生成服务类，注入到容器中
     * @return
     */
    @Bean
    public HelloService getHelloService(){
        HelloService helloService = new HelloService();
        // 设置属性
        helloService.setHelloProperties(helloProperties);
        return helloService;
    }

}

10）编写spring.factories

指明自动配置类的地址

在 resources 目录下编写一个自己的 META-INF\spring.factories

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.tuwer.config.HelloServiceAutoConfiguration

• 目录结构

11）Install到仓库

安装到maven本地仓库中

3、测试启动器

1）新建一个SpringBoot 项目

2）导入自己的启动器

<dependency>
    <groupId>com.tuwergroupId>
    <artifactId>tuwer-spring-boot-starterartifactId>
    <version>1.0-SNAPSHOTversion>
dependency>

3）编写 HelloController

@RestController
public class HelloController {
    @Autowired
    HelloService helloService;

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

4）编写配置文件 application.properties

tuwer.hello.prefix=1111111 
tuwer.hello.suffix=2222222

5）启动测试

• 不配置属性

可以在HelloProperties中指明默认值为空

4、自定义日志拦截启动器

• 视频地址：https://www.bilibili.com/video/BV16q4y1q71D
• 源码：https://gitee.com/tuwer/mylog-spring-boot-starter