SpringBoot之自定义Starter

SpringBoot之自定义Starter

一、 说明

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

命名归约：

官方命名：

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

自定义命名：

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

二、编写启动器

1. 在IDEA中新建一个空项目 spring-boot-starter-diy
2. 新建一个普通Maven模块：Daylight-spring-boot-starter
3. 3
4. 新建一个Springboot模块：Daylight-spring-boot-starter-autoconfigure
5. 5
6. 点击apply即可，基本结构
7. 在我们的 starter 中 导入 autoconfigure 的依赖！

<!-- 启动器 -->
<dependencies>
    <!--  引入自动配置模块 -->
    <dependency>
        <groupId>com.Daylight</groupId>
        <artifactId>Daylight-spring-boot-starter-autoconfigure</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </dependency>
</dependencies>

1. 将 autoconfigure 项目下多余的文件都删掉，Pom中只留下一个 starter，这是所有的启动器基本配置！
2. 我们编写一个自己的服务

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();
    }

}

1. 编写​​HelloProperties​​ 配置类

// 前缀 Daylight.hello
@ConfigurationProperties(prefix = "Daylight.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;
    }
}

1. 编写我们的自动配置类并注入bean，测试！

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@ConditionalOnWebApplication //web应用生效
@EnableConfigurationProperties(HelloProperties.class)
public class HelloServiceAutoConfiguration {

    @Autowired
    HelloProperties helloProperties;

    @Bean
    public HelloService helloService(){
        HelloService service = new HelloService();
        service.setHelloProperties(helloProperties);
        return service;
    }

}

1. 在resources编写一个自己的 ​​META-INF\spring.factories​​

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.Daylight.HelloServiceAutoConfiguration

2. 编写完成后，可以安装到maven仓库中！

三、新建项目测试我们自己写的启动器

1. 新建一个SpringBoot 项目
2. 导入我们自己写的启动器

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

1. 编写一个 ​​HelloController​​ 进行测试我们自己的写的接口！

@RestController
public class HelloController {

    @Autowired
    HelloService helloService;

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

}

1. 编写配置文件 ​​application.properties​​

ss.hello.prefix="latte"
ss.hello.suffix="Daylight"

1. 启动项目进行测试，结果成功 !