简单介绍【spring.factories】的使用

原创 已于 2022-10-13 13:42:49 修改 · 置顶 · 2.8k 阅读 · 6 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#spring #factories #matadata.json

于 2022-09-28 16:36:28 首次发布
本文介绍了如何利用`spring.factories`进行组件注册，包括其在项目启动时的角色，如何创建自己的`spring.factories`文件，如何读取额外的配置文件，以及如何为自定义配置文件添加IDE提示。通过这些步骤，可以实现自定义工具包在不同项目中的无缝集成。
前言

starter的使用在springboot项目中可以说是非常常见，可能有些朋友在使用springboot项目的时候只是在网络上找了一篇如何创建一个springboot，如何又和mybatis或mybatis-plus集成，然后又引入缓存机制redis，消息队列rabbitmq等等，感觉很好用，只需要pom文件中引入相应的依赖就可以了，其他的都不需要管，确实是这样，可能在很长一段时间都在以这样的方式写项目，但久而久之，你可能会在某一次项目中遇到这样一种情况，让你自己写一个工具包可以在另一个环境中集成，这其实很简单，大家都会写这样的工具包。那工具包要求使用springboot，数据库操作使用mybatis-plus，这种情况下，是否有办法来解决呢。我们都知道一个完整的springboot+mybatis-plus的项目都是事先约定好需要扫描的文件以及mybatis-plus需要扫描的xml路径的，我自己搞了一个springboot+mybatis-plus的项目要提供给另一个同样使用springboot框的使用，别人的包路径和我的基本可以确定是不一样的，人家确定了包的扫描，那也只是针对他的项目，我的项目不是那么扫描的，那不就没办法扫描到我的service，mapper了嘛，那别人调用我的项目能使用嘛，显然是不能使用的，情况严重可能连别人的项目都启动不了了。难道没办法解决这种问题了吗，当然不是啦，如果不能处理这种情况，那我们是怎么将mybatis-plus整合到springboot的呢，其实就是在pom文件里边引入mybatis-plus-boot-starter的依赖包就可以了。

一、简单介绍一下mybatis-plus被成功装载的过程

  • mybatis-plus能被spring管理起来主要是项目启动类的联合注解@SpringBootApplication有一个自动装配的注解@EnableAutoConfiguration，只要有这个注解项目在启动的时候就会在引入的jar中找是否存在spring.factories的配置文件，如果找到此配置文件，将会根据此配置文件找到对应的配置类，处理jar内部需要提取的配置信息以及将需要加载到的component交给spring管理
  • 下边是spring.factories和对应的配置信息
    在这里插入图片描述
  • spring.factories配置文件指定的都是mybatis-plus独有的配置，里边对应的配置类将会处理所有需要加载的信息，所以我们自己创建的starter也需要按照这样的步骤来创建
  • 下边是MybatisPlusAutoConfiguration.class
    在这里插入图片描述
  • 要成功被主程序加载到，starter还需要在pom文件中引入spring-boot-autoconfigure的依赖，因为注解@EnableAutoConfiguration对应的jar包就是spring-boot-autoconfigure如果没有引入此jar，那么spring.factories中配置的处理程序不会被主程序处理

2、自己创建一个starter吧

  • 先创建一个极简的springboot项目
  • 修改pom.xml文件
<dependencies>
   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter</artifactId>
       <version>2.4.5</version>
   </dependency>
   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-autoconfigure</artifactId>
       <version>2.4.5</version>
   </dependency>
   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-jdbc</artifactId>
       <version>2.4.5</version>
   </dependency>
   <dependency>
       <groupId>com.baomidou</groupId>
       <artifactId>mybatis-plus-boot-starter</artifactId>
       <version>3.5.2</version>
       <exclusions>
           <exclusion>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-autoconfigure</artifactId>
           </exclusion>
           <exclusion>
               <groupId>org.springframework.boot</groupId>
               <artifactId>spring-boot-starter-jdbc</artifactId>
           </exclusion>
       </exclusions>
   </dependency>
   <dependency>
       <groupId>mysql</groupId>
       <artifactId>mysql-connector-java</artifactId>
       <version>5.1.47</version>
   </dependency>
   <dependency>
       <groupId>org.projectlombok</groupId>
       <artifactId>lombok</artifactId>
       <scope>provided</scope>
       <version>1.18.22</version>
   </dependency>
</dependencies>
  • pom.xml文件中不需要引入spring-boot-starter-web，也不需要继承springboot的父包spring-boot-starter-parent
  • 创建配置类ComponentScanAndMapperScanAutoConfiguration.java，此配置是告诉mybatis-plus需要扫描的mapper接口路径以及service接口实现类的扫描路径
    在这里插入图片描述
  • 如果你使用了xml文件来操作数据库，那么需要轻微的调整一下主程序的application.properties或者application.yml配置文件的mybatis-plus.mapper-locations的配置，此配置是告诉mybatis-plus需要扫描的xml路径，但如果放在jar里他是扫描不到的，所以需要把配置改为classpath*:/**/**/*Mapper.xml，这是告诉mybatis-plus如果resources下找到不到，则扫描jar包里的resources如果都没有那将会报错
mybatis-plus.mapper-locations=classpath*:/**/**/*Mapper.xml
  • 如果是mybatis则使用下边的配置
mybatis.mapper-locations=classpath*:/**/**/*Mapper.xml
  • 注意：项目引入的jar包他会自动扫描application.propertis配置文件，因此不需要额外创建配置文件，他会加载主程序的application.properties，所以数据源和mybatis-plus的相关配置都不需要额外添加。还需要注意的是由于starter不属于web项目因此既不需要application.properties的配置文件也不需要SpringbootApplication的启动类，如果有的话可以删除掉
  • 最后的话通过命令mvn clean install进行打包，然后用其他的springboot项目集成进来调用自定义的接口进行测试了

3、读取额外的配置文件

  1. 可以通过@Value注解来获取配置文件中的配置信息
  2. 创建一个AutoConfiguration来自动注入
  3. 读取配置文件application-rm.properties的内容，配置文件的内容如下
rm.datasource.username=xxx
rm.datasource.password=xxx
rm.datasource.url=jdbc:mysql://xxxxxx:3306/xxxx?serverTimezone=Asia/Shanghai&useLegacyDatetimeCode=false&useSSL=false&nullNamePatternMatchesAll=true&useUnicode=true&characterEncoding=UTF-8&allowMultiQueries=true
rm.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
rm.datasource.minimum-idle=5
rm.datasource.maximum-pool-size=50
rm.datasource.max-lifetime=30000
rm.datasource.connection-test-query=SELECT 1 FROM DUAL
  1. 创建一个DataSourceConnection.java类来加载配置文件中的信息
/**
 * ignoreResourceNotFound=true表示如果配置文件找不到，则使用默认值，避免找不到配置文件报错，此时当前的对象只是一个普通实体类
 */
@PropertySource(ignoreResourceNotFound = true, value = {"classpath:application-rm.properties"})
@ConfigurationProperties(prefix = "rm.datasource")
@Configuration
@Data
public class DataSourceConnection {

    /**
     * 数据库登录名
     */
    private String username;
    /**
     * 数据库登录密码
     */
    private String password;
    /**
     * 数据库连接地址
     */
    private String url;
    /**
     * 数据库驱动
     */
    private String driverClassName;
    /**
     * 数据库连接的最小空闲连接
     */
    private String minimumIdle;
    /**
     * 数据库连接池最大连接数量
     */
    private String maximumPoolSize;
    /**
     * 数据连接的最大生命周期
     */
    private String maxLifetime;
    /**
     * 测试数据库连接的脚本
     */
    private String connectionTestQuery;
}
  1. 创建一个DataSourceAutoConfiguration.java交给EnableAutoConfiguration处理的配置类
    在这里插入图片描述
  2. 通过命令mvn clean install打包集成到项目中，然后调用接口试试效果吧

4、让自定义的application-xxx.properties配置文件也能像spring和mybatis的配置一样能够有提示信息

如果你使用的是idea编程的话，你可能会发现application-rm.properties配置文件里边的所有配置都被标黄了，而且没有任何提示，感觉挺难受的，当然要处理这种情况也很简单

  1. 在项目的pom.xml文件中引入依赖
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-configuration-processor</artifactId>
	<version>2.4.5</version>
</dependency>
  1. 在resources目录下创建一个META-INF下创建一个additional-spring-configuration-metadata.json的文件，引入如下配置
{
  "properties": [
    {
      "name": "rm.datasource.username",
      "type": "java.lang.String",
      "sourceType": "com.xxx.xxx.xxx.DataSourceConnection"
    },
    {
      "name": "rm.datasource.password",
      "type": "java.lang.String",
      "sourceType": "com.xxx.xxx.xxx.DataSourceConnection"
    },
    {
      "name": "rm.datasource.url",
      "type": "java.lang.String",
      "sourceType": "com.xxx.xxx.xxx.DataSourceConnection"
    },
    {
      "name": "rm.datasource.driver-class-name",
      "type": "java.lang.String",
      "sourceType": "com.xxx.xxx.xxx.DataSourceConnection"
    },
    {
      "name": "rm.datasource.minimum-idle",
      "type": "java.lang.Integer",
      "sourceType": "com.xxx.xxx.xxx.DataSourceConnection"
    },
    {
      "name": "rm.datasource.maximum-pool-size",
      "type": "java.lang.Integer",
      "sourceType": "com.xxx.xxx.xxx.DataSourceConnection"
    },
    {
      "name": "rm.datasource.max-lifetime",
      "type": "java.lang.Integer",
      "sourceType": "com.xxx.xxx.xxx.DataSourceConnection"
    },
    {
      "name": "rm.datasource.connection-test-query",
      "type": "java.lang.String",
      "sourceType": "com.xxx.xxx.xxx.DataSourceConnection"
    }
  ]
}
  1. 使用命令mvn clean install打包，然后你可以在jar包的META-INF文件下找到一个json文件spring-configuration-metadata.json，再刷新项目，重新编辑配置文件application-rm.properties，你会发现标黄的配置已经不见了，并且出现了如spring一样的提示信息
一篇博客搞懂spring.factories的基本概念和使用
учёба
08-07 4942
spring.factories 是，用于定义和加载 Spring Boot 自动配置类、监听器、环境后处理器等。它通常位于 META-INF 目录下。
spring.factories
01-26
本文件是springboot1.5.2的启动配置文件（META-INF/spring.factories），容器启动时会自动加载该文件并根据其中配置的内容实例化各个类
Spring Boot 之 spring.factories的用法
爱笑才不是傻帽的博客
10-19 2万+
原因 为什么要使用，因为在程序开发中，可能包名不一样，pom依赖的很多的jar 他们是如何把这些类进行注入到spring容器中的呢。 所以springboot就提出了spring.factories 使用 一、第一种 新建一个Test类 package com.test; public class Test { public Test() { System.out.println("Test加载"); } } 1.看下图 如果我们要把Test这个类注入
Spring Boot spring.factories文件详细说明
最新发布
2509_93873783的博客
11-02 623
spring.factories 文件是 Spring Boot 自动配置机制的核心部分之一。它位于每个 Spring Boot 自动配置模块的 META-INF 目录下，用于声明该模块提供的自动配置类、条件性配置类、环境后处理器等。以下是对 spring.factories 文件的详细说明：相信大家的项目中都会写starter，我们团队写的国际化通用和通用聚合服务等即插即用的功能包，就是用的starter。
spring.factories 的妙用
sebeefe的博客
08-02 1237
我们系统里抽象的各个模块，往往有很多不同的实现方案，比如日志模块的方案，xml解析模块、jdbc模块的方案等。一旦代码里涉及具体的实现类，就违反了可拔插的原则，如果需要替换一种实现，就需要修改代码。@ComponentScan注解的作用是扫描@SpringBootApplication所在的Application类所在的包（basepackage）下所有的@component注解（或拓展了@component的注解）标记的bean，并注册到spring容器中。...
Spring Boot spring.factories 用法及原理
苦行僧
02-19 5563
spring.factories 配置为 Spring Boot 的自动装配提供了方便，在此基础上产生的 Spring Boot starter 机制为很多中间件开发带来了方便。
Spring Boot扩展机制：图文深入分析Spring Factories机制
热门推荐
lldouble的博客
06-14 3万+
在Spring Boot中有一种非常解耦的扩展机制：Spring Factories。这种扩展机制实际上是仿照Java中的SPI扩展机制来实现的。Java SPI机制SPI的全名为Service Provider Interface.大多数开发人员可能不熟悉，因为这个是针对厂商或者插件的。在java.util.ServiceLoader的文档里有比较详细的介绍。简单的总结下java spi机制的思...
【u41n】spring.factories用法指南
SouGit 每一篇文章都有源码
08-22 375
如果想扫描jar中的类，并且该jar包提供了@Configuration组件给第三方项目使用。在module2中创建一个sougit2.Test2AutoConfiguration。我们来通过一个完整的实例、感受一下spring.factories的用处。springboot启动的时候默认只扫描当前package下的类。这个时候 我们启动module1中的 application。我们现在module1中创建一个Controller。命名为module-1 module-2。2、新建两个module。
Spring Factories
zzy7075的专栏
12-17 281
该文章转载自：https://blog.csdn.net/lvoyee/article/details/82017057 Spring Boot中有一种非常解耦的扩展机制：Spring Factories。这种扩展机制实际上是仿照Java中的SPI扩展机制来实现的。 什么是 SPI机制 SPI的全名为Service Provider Interface.大多数开发人员可能不熟悉，因为这个是针...
「Java」spring.factories介绍与使用 自定义自动装配
你走过的路 风都是暖的
12-10 2255
了解过springboot自动装配原理的同学都知道，项目启动时，会加载所有META-INF下的所有的spring.factories文件，根据EnableAutoConfiguration.class加载所有配置类 新建maven项目，如下图 Test就是我们要注入到ioc容器里的bean @Component public class Test { public Test() { System.out.println("hello my test bean")...
spring.factories 的用处
weixin_42759398的博客
03-14 728
文件的主要用途是让 Spring Boot 能够自动发现和加载项目依赖中的自动配置类。在 Spring Boot 应用启动时，它会扫描所有依赖库的文件，依据文件中的配置信息来加载相应的自动配置类，进而实现各种功能的自动配置。当你开发一个 Spring Boot Starter（自定义的 Spring Boot 依赖库）时，可以使用文件来指定自动配置类。这样，其他项目引入你的 Starter 后，Spring Boot 会自动加载这些配置类，完成相应的配置。
spring.factories的作用
m0_71894372的博客
09-28 159
在java spring cloud项目中，我们常常会在子模块中创建公共方法，那么在另外一个子模块中，需要加载配置文件的时候，往往Spring Boot 自动扫描包的时候，只会扫描自己模块下的类。这个是springboot约定俗成的内容。现在我们将其改造一下，采用spring.factories 的方式去加载SwaggerConfig类，在resources目录下新建一个META-INF 的目录，然后在。如果想要被Spring容器管理的Bean的路径不在Spring Boot 的包扫描路径下。
spring.factories详解
lw_jack的博客
07-14 1277
文件的一个妙用是在 Spring Cloud 项目中，它可以用于自动装配那些在子模块中创建的公共类库，即使这些类库不在 Spring Boot 的自动扫描路径下。文件来创建自己的 Starter，只需在该文件中声明自己的自动配置类，Spring Boot 应用就会在启动时自动加载这些配置。是 Spring Boot 中一个重要的配置文件，它用于实现自动配置类和框架的扩展机制。文件中记录了所有需要加入 Spring 容器的自动配置类，这些类通过键值对的方式配置，键是一个固定的名称，如。
spring.factories的常用配置项
毅香雪海的博客
02-29 2384
spring.factories的常用配置项
spring.factories介绍
还在活水泥的未来包工头
10-26 1186
例如，假设有一个接口 com.example.MyInterface，它有两个实现类 com.example.MyInterfaceImpl1 和 com.example.MyInterfaceImpl2。通过 spring.factories 文件，开发者可以将自己的组件注册到 Spring 容器中，使其能够被其他组件自动发现和使用。总之，spring.factories 文件是 Spring Framework 中一种用于自动装配和加载组件的配置文件，通过它可以方便地注册和管理各种组件的实现类。
spring.factories文件解析
06-13
### Spring Boot 中 `spring.factories` 文件的解析机制、作用与原理 #### 1. `spring.factories` 文件的作用 `spring.factories` 文件是 Spring Boot 自动配置机制的核心组成部分之一，它位于每个 Spring Boot 自动配置模块的 `META-INF` 目录下。该文件主要用于声明自动配置类、条件性配置类、环境后处理器等[^4]。通过这种方式，Spring Boot 可以在应用启动时根据引入的各种 Starter 中的 `/META-INF/spring.factories` 文件所指定的配置类加载 Bean[^2]。 #### 2. 解析机制 Spring Boot 在启动过程中会读取所有依赖中包含的 `META-INF/spring.factories` 文件，并将其中的内容注册到容器中。具体解析过程如下： - **资源扫描**：Spring Boot 使用 `SpringFactoriesLoader` 工具类来扫描类路径下的所有 `META-INF/spring.factories` 文件。 - **键值解析**：`spring.factories` 文件采用键值对的形式存储配置信息。例如，`org.springframework.boot.autoconfigure.EnableAutoConfiguration` 键对应的值是一个逗号分隔的自动配置类列表[^5]。 - **实例化**：Spring Boot 根据键值对中的配置类名称，通过反射机制实例化这些类，并将其注册到 Spring 容器中。 以下是一个典型的 `spring.factories` 文件内容示例： ```properties org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ com.example.module.AutoConfigurationClassA,\ com.example.module.AutoConfigurationClassB ``` #### 3. 原理详解 `spring.factories` 文件的解析原理基于 Java 的 SPI（Service Provider Interface）机制。以下是关键点： - **SPI 加载**：`SpringFactoriesLoader` 是 Spring 提供的一个工具类，用于加载服务提供者接口的实现类。它会扫描类路径下的 `META-INF/spring.factories` 文件，并根据键值对加载相应的类[^1]。 - **自动配置**：当 Spring Boot 应用启动时，`SpringApplication` 类会调用 `SpringFactoriesLoader#loadFactoryNames` 方法，加载所有与 `EnableAutoConfiguration` 关联的自动配置类[^3]。 - **条件判断**：加载的自动配置类通常会包含 `@Conditional` 注解，用于根据特定条件决定是否生效。例如，`@ConditionalOnClass` 和 `@ConditionalOnMissingBean` 等注解可以确保只有在满足特定条件时才会应用某个自动配置类。 #### 4. 示例代码 以下是一个简单的代码示例，展示如何通过 `SpringFactoriesLoader` 加载 `spring.factories` 文件中的配置类： ```java import org.springframework.core.io.support.SpringFactoriesLoader; import java.util.List; public class SpringFactoriesExample { public static void main(String[] args) { List<String> autoConfigs = SpringFactoriesLoader.loadFactoryNames( EnableAutoConfiguration.class, Thread.currentThread().getContextClassLoader() ); System.out.println("Loaded Auto Configuration Classes: " + autoConfigs); } } ``` #### 5. 与 `AutoConfiguration.imports` 的对比 从 Spring Boot 2.4 开始，推荐使用 `META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports` 文件替代 `spring.factories` 文件进行自动配置类的声明。这种方式更加简洁和高效，因为它是直接列出类名而不是通过键值对形式声明。 ---
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值