欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

详解Spring Boot配置排序依赖技巧

程序员文章站 2024-04-02 09:12:52
本文主要介绍了spring boot配置排序依赖技巧,分享给大家,具体如下: spring boot - 被错误使用的注解 我自己曾经在 spring boot 中集成...

本文主要介绍了spring boot配置排序依赖技巧,分享给大家,具体如下:

spring boot - 被错误使用的注解

我自己曾经在 spring boot 中集成通用 mapper 时,写过下面的代码:

@configuration
@autoconfigureafter(mybatisconfig.class)
public class mybatismapperscannerconfig {
//其他
}

这种用法我参考的 mybatis-spring-boot-starter。

由于在我自己这个例子中可以良好的运行,因此我以为 @autoconfigureafter 真正起作用了,否则怎么不报错呢。但是在很长一段时间内,好多人参考这种用法时经常报错,这个配置没有起到应有的作用。我还一直以为他们用的不对。

直到昨天我开始写自己的 pagehelper-spring-boot-starter 时,我才发现,我自己一直以来都用错了。在我自己例子中,之所以能行,完全是靠运气。

spring boot 提供了很多新的注解,但是要注意这个包下面的所有注解:

org.springframework.boot.autoconfigure

这个包下面常见的注解有:

  1. @autoconfigureafter
  2. @autoconfigurebefore
  3. @autoconfigureorder
  4. @autoconfigurationpackage
  5. @enableautoconfiguration
  6. @springbootapplication

前 3 个是不能在普通项目中使用的,这 3 个注解是特地用于 autoconfigure 类的项目,后面 3 个注解是可以用于我们自己项目中的。

autoconfigure 类项目

spring boot starter 提供了规范可以让开发者提供自己的 starter,例如 spring 官方提供的:

  1. spring-boot-starter
  2. spring-boot-starter-activemq
  3. spring-boot-starter-cache
  4. 等等…

还有很多开源项目或公司提供的:

  1. modelmapper-spring-boot-starter
  2. hajdbc-spring-boot-starter
  3. camel-spring-boot-starter
  4. mybatis-spring-boot-starter
  5. 等等…

在 spring boot starter 开发规范中,项目中会有一个空的名为 xxx-spring-boot-starter 的项目,这个项目主要靠 pom.xml 将所有需要的依赖引入进来。同时项目还会有一个 xxx-spring-boot-autoconfigure 项目,这个项目主要写带 @configuration 注解的配置类,在这个类或者类中带 @bean 的方法上,可以使用和顺序有关的注解,也就是前面提到的自己不能使用的这部分注解。xxx-spring-boot-autoconfigure 就是这里提到的 autoconfigure 类项目。

上面的注解只在 autoconfigurationsorter 类中排序时用到了。被排序的这些类,都是通过 xxx-spring-boot-autoconfigure 项目中的 src/resources/meta-inf/spring.factories 配置文件获取的,这个文件中的配置内容一般为:

# auto configure
org.springframework.boot.autoconfigure.enableautoconfiguration=\
com.github.pagehelper.autoconfigure.pagehelperautoconfiguration

spring boot 只会对从这个文件读取的配置类进行排序。

但是你不要以为将自己的配置类也配置在 spring.factories 中就能实现排序,如果你的类被自己 spring boot 启动类扫描到了,这个类的顺序会优先于所有通过 spring.factories 读取的配置类。所以当你的配置类对顺序有要求时就会出错。

通过 spring.factories 巧妙使用排序

如果你将自己的配置类放到特别的包下,不使用 spring boot 启动类扫描。完全通过 spring.factories 读取配置就可以实现这个目的。例如下图的用法:

详解Spring Boot配置排序依赖技巧

当使用上图方式进行配置时,就可以完美的使用第一节中不可使用的注解,如果你想让这个配置应用到更多的项目中,建议按照 spring-boot-starter 规范开发自己的 starter。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。