【SpringBoot教程 自定义Starter】2. @Conditional的使用和Maven provided作用域

前言

上篇中主要讲到了简单版本自定义starter的使用。

问题：依赖过多全部堆在一个starter里面，后续项目如果引入依赖会导致打包体积过大。在spring-boot-autoconfigure中，所有的自动配置类都存放在一个包下。但是最后引入starter的时候只引入了对应的依赖。如下图：

在SpringBoot starter源码中使用了大量得@Conditional注解，该注解主要按条件匹配来注入bean：

@Conditional

常见的条件初始化bean：

ConditionalOnProperty：判断配置文件中是否有对应的属性和值才初始化Bean。

ConditionalOnClass：判断项目中有对应的Class才初始化Bean。

ConditionalOnMissingBean：判断容器中是否有对应的Bean才初始化Bean

Maven provided作用域

provided特性：在编译过程中有效，在依赖或者打包时无效。

自定义starter实战

需求：编写一个starter连接mysql的功能。使用者引入starter、并且引入相关的依赖才能连接上mysql。

项目结构如下

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

创建conditional-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>conditional-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>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>com.zaxxer</groupId>
            <artifactId>HikariCP</artifactId>
            <version>3.4.5</version>
            <scope>provided</scope>
        </dependency>
        <!-- mysql -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
    </dependencies>

创建jdbc 自动装配类

import com.mysql.cj.jdbc.Driver;
import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;
import lombok.extern.java.Log;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
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
// 判断项目是否引入了mysql驱动和hikari连接池、如果引入了才会自动装配这个类
@ConditionalOnClass({Driver.class, HikariConfig.class})
@Log
/*@EnableConfigurationProperties(JdbcConfig.class)*/
public class JdbcAutoConfiguration {

    @Bean
    // 判断配置文件是否配置了mysql
    @ConditionalOnProperty(prefix = "mysql", name = "jdbcUrl")
    // mysql属性自动注入到HikariDataSource中
    @ConfigurationProperties(prefix = "mysql")
    public HikariDataSource dataSource(){
        log.info("配置hikar...");
        return new HikariDataSource();
    }

    @Bean
    // 判断配置文件是否配置了HikariDataSource
    @ConditionalOnBean({HikariDataSource.class})
    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>conditional-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:56:05.855  INFO 14280 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8080 (http)
2022-06-05 15:56:05.864  INFO 14280 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2022-06-05 15:56:05.864  INFO 14280 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: [Apache Tomcat/9.0.41]
2022-06-05 15:56:05.943  INFO 14280 --- [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2022-06-05 15:56:05.943  INFO 14280 --- [           main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 808 ms
2022-06-05 15:56:06.173  INFO 14280 --- [           main] o.s.s.concurrent.ThreadPoolTaskExecutor  : Initializing ExecutorService 'applicationTaskExecutor'
2022-06-05 15:56:06.365  INFO 14280 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2022-06-05 15:56:06.375  INFO 14280 --- [           main] com.terrybg.App                          : Started App in 1.735 seconds (JVM running for 2.927)

引入相关依赖后：

        <!-- jdbc -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>5.3.3</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>com.zaxxer</groupId>
            <artifactId>HikariCP</artifactId>
            <version>3.4.5</version>
            <scope>provided</scope>
        </dependency>
        <!-- mysql -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

成功自动装配

Initializing ExecutorService 'applicationTaskExecutor'
2022-06-05 15:57:49.089  INFO 41568 --- [           main] com.terry.config.JdbcAutoConfiguration   : 配置hikar...
2022-06-05 15:57:49.109  INFO 41568 --- [           main] com.terry.config.JdbcAutoConfiguration   : 配置JdbcTemplate...jdbc:mysql://192.168.126.156:3306/test
2022-06-05 15:57:49.173  INFO 41568 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2022-06-05 15:57:49.181  INFO 41568 --- [           main] com.terrybg.App                          : Started App in 1.82 seconds (JVM running for 2.894)