【SpringBoot教程 自定义Starter】1. starter简介和SpringBoot SPI

starter简介

starter是SpringBoot核心之一，SpringBoot利用starter思想简化了繁琐的Maven依赖、实现热插拔技术、自动配置等。

如项目使用到数据库，只需要引入到spring-boot-starter-jdbc，即可。

其它如：

spring-boot-starter-redis

spring-boot-starter-amqp

start命名规范

springboot 官方 starter spring-boot-starter-xxx。

自己定义的为 xxx-spring-boot-starter。

SPI机制

SPI 机制是为了方便第三方扩展和替换。

应用场景：

Java JDBC：Java编写接口，而具体实现交给厂商编写数据库驱动。

日志：SLF4J、Log4j。

Java SPI编写规范：在 src/main/resources 创建/META-INF/services

Spring和Dubbo：Spring和Dubbo项目大量使用到SPI机制，并且在上面自定义封装了。

自定义starter实战

需求：编写一个starter连接mysql的功能。使用者只需要引入starter就能连接上mysql。

项目结构如下

• spi-spring-boot-starter（自定义的starter SPI机制）
• test-starter（使用 starter）

创建spi-spring-boot-starter项目

pom.xml

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.4.2</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<groupId>com.terry</groupId>
<artifactId>spi-spring-boot-starter</artifactId>
<version>1.0-SNAPSHOT</version>

<properties>
    <maven.compiler.source>8</maven.compiler.source>
    <maven.compiler.target>8</maven.compiler.target>
</properties>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-configuration-processor</artifactId>
    </dependency>
    <!-- jdbc -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-jdbc</artifactId>
        <version>5.3.3</version>
    </dependency>
    <dependency>
        <groupId>com.zaxxer</groupId>
        <artifactId>HikariCP</artifactId>
        <version>3.4.5</version>
    </dependency>
    <!-- mysql -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
</dependencies>

创建jdbc 自动装配类

import com.zaxxer.hikari.HikariDataSource;
import lombok.extern.java.Log;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jdbc.core.JdbcTemplate;

/**
 * jdbc 自动装配
 * @author terry
 * @version 1.0
 * @date 2022/6/5 11:48
 */
@Configuration
@Log
public class JdbcAutoConfiguration {

    @Bean
    // mysql属性自动注入到HikariDataSource中
    @ConfigurationProperties(prefix = "mysql")
    public HikariDataSource dataSource(){
        log.info("配置hikar...");
        return new HikariDataSource();
    }

    @Bean
    public JdbcTemplate jdbcTemplate(HikariDataSource dataSource){
        log.info("配置JdbcTemplate..." + dataSource.getJdbcUrl());
        return new JdbcTemplate(dataSource);
    }
}

在resources下创建 META-INF/spring.factories 文件，内容如下：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.terry.config.JdbcAutoConfiguration

目录结构如下：

创建test-starter项目

故意给包名取得不一样，来验证是否能自动装配：

spi-spring-boot-starter包名：com.terry

test-starter包名：com.terrybg

---

pom.xml

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.4.2</version>
</parent>
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.terrybg</groupId>
    <artifactId>test-starter</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>com.terry</groupId>
            <artifactId>spi-spring-boot-starter</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>

启动类

/**
 * 自定义starter 使用
 * @author terry
 * @version 1.0
 * @date 2022/6/5 14:04
 */
@SpringBootApplication
public class App {

    public static void main(String[] args) {
        SpringApplication.run(App.class);
    }
}

application.yml

mysql:
  driverClassName: com.mysql.cj.jdbc.Driver
  jdbcUrl: jdbc:mysql://192.168.126.156:3306/test
  username: root
  password: 123456

测试运行成功：

2022-06-05 15:17:19.342  INFO 40552 --- [           main] o.s.s.concurrent.ThreadPoolTaskExecutor  : Initializing ExecutorService 'applicationTaskExecutor'
2022-06-05 15:17:19.437  INFO 40552 --- [           main] com.terry.config.JdbcAutoConfiguration   : 配置hikar...
2022-06-05 15:17:19.457  INFO 40552 --- [           main] com.terry.config.JdbcAutoConfiguration   : 配置JdbcTemplate...jdbc:mysql://192.168.126.156:3306/test
2022-06-05 15:17:19.522  INFO 40552 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2022-06-05 15:17:19.529  INFO 40552 --- [           main] com.terrybg.App                          : Started App in 2.062 seconds (JVM running for 2.963)