当前位置：首页 > news >正文

第二十四节 SpringBoot使用spring.factories

news 来源：原创 2024/5/4 11:34:06

META-INF/spring.factories文件

如何让我们的starter里的@Configuration在使用者的项目里生效呢？

在SpringBoot的启动类中，@SpringBootApplication注解的代码里面有一句@EnableAutoConfiguration

@ComponentScan注解的作用是扫描@SpringBootApplication所在的Application类（即spring-boot项目的入口类）所在的包（basepackage）下所有的@component注解（或拓展了@component的注解）标记的bean，并注册到spring容器中。

@EnableAutoConfiguration注解加载的是资源目录META-INF文件下的spring.factories的文件。包括导入到项目中的Jar包的META-INF文件夹下的spring.factories文件。spring.factories文件是一个properties文件。

我的spring.factories文件的内容如下。也就是说，其它项目在导入我的这个Jar的时候，会去加载MyConfig与MyConfig2这两个类。多个类用逗号隔开。

#多个类用逗号隔开
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.zhoutianyu.learnspringboot.config.MyConfig

创建SpringBoot项目projectA

最好下载我的源码

下方就是MyConfig的代码。

ConditionalOnClass与ConditionalOnMissingBean

@ConditionalOnClass(SystemInit.class)表示如果编译路径下没有SystemInit.class依赖，那么就不会加载这个Bean。但是实际情况是你既然能够编译打包成功，一定会有这个文件，除非手动在target文件下删除了这个class字节码文件。

@ConditionalOnMissingBean表示，如果Spring容器里没有SystemInit对象，那么就会为容器创建一个SystemInit对象。

@Bean（initMethod）表明创建的SystemInit对象在初始化后会执行init()方法

@Configuration
@ConditionalOnClass(SystemInit.class)
public class MyConfig {
    
    @Bean(initMethod = "init")
    @ConditionalOnMissingBean
    public SystemInit systemInit() {
        return new SystemInit();
    }
}

public class SystemInit {

    public void init() {
        System.out.println("SystemInit类正在始化中....");
    }
}

把projectA打包。

创建SpringBoot项目projectB

projectB项目需要导入projectA的jar，以此来测试projectA的spring.factories文件是否生效。

<?xml version="1.0" encoding="UTF-8"?>

    <groupId>com.zhoutianyu</groupId>
    <artifactId>projectB</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>projectB</name>

    <dependencies>
        ...

        <!-- 导入其它项目依赖，执行它这个JAR中得spring.factories文件-->
        <dependency>
            <groupId>com.zhoutianyu</groupId>
            <artifactId>projectA</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </dependency>
    </dependencies>

</project>

启动projectB，在启动日志中，发现了它打印了projectA项目中SystemInit类的init()方法。说明ProjectA的Spring.factories文件生效。