springboot自定义starter时使用@AutoConfigureBefore、@AutoConfigureAfter的细节问题

已于 2023-12-26 10:49:09 修改
阅读量932 收藏 5
点赞数
分类专栏： springboot 文章标签： spring boot
于 2023-02-24 13:59:23 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/guntun8987/article/details/129196280
版权

正常利用springboot的自动装配

ConfB

@Configuration(proxyBeanMethods=false)
public class ConfB {
    
    public ConfB(){
        System.out.println("ConfB构造方式执行...");
    }
}

不加spring.factories

项目包结构
在这里插入图片描述

此时resources中没有spring.factories
执行结果

2023-02-24 13:44:49.809  INFO 33820 --- [           main] test.MyStarterApplication                : No active profile set, falling back to default profiles: default
2023-02-24 13:44:50.294  INFO 33820 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8080 (http)
2023-02-24 13:44:50.300  INFO 33820 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2023-02-24 13:44:50.300  INFO 33820 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: [Apache Tomcat/9.0.46]
2023-02-24 13:44:50.354  INFO 33820 --- [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2023-02-24 13:44:50.354  INFO 33820 --- [           main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 518 ms
2023-02-24 13:44:50.456  INFO 33820 --- [           main] o.s.s.concurrent.ThreadPoolTaskExecutor  : Initializing ExecutorService 'applicationTaskExecutor'
2023-02-24 13:44:50.954  INFO 33820 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2023-02-24 13:44:51.004  INFO 33820 --- [           main] test.MyStarterApplication                : Started MyStarterApplication in 1.422 seconds (JVM running for 2.013)

没看到ConfB构造方法执行，因为执行类MyStarterApplication在test包下，test和conf包是并列关系，所以启动时是扫描不到conf包下的内容的，又因为没有spring.factories所以没有加载到ConfB是正常情况。下面加 spring.factories

添加spring.factories

项目包结构
在这里插入图片描述

spring.factories
在这里插入图片描述

执行结果

2023-02-24 13:46:21.289  INFO 6400 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat initialized with port(s): 8080 (http)
2023-02-24 13:46:21.294  INFO 6400 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2023-02-24 13:46:21.294  INFO 6400 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: [Apache Tomcat/9.0.46]
2023-02-24 13:46:21.349  INFO 6400 --- [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2023-02-24 13:46:21.349  INFO 6400 --- [           main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 515 ms
2023-02-24 13:46:21.445  INFO 6400 --- [           main] o.s.s.concurrent.ThreadPoolTaskExecutor  : Initializing ExecutorService 'applicationTaskExecutor'
ConfB构造方式执行...
2023-02-24 13:46:21.944  INFO 6400 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2023-02-24 13:46:21.977  INFO 6400 --- [           main] test.MyStarterApplication                : Started MyStarterApplication in 1.397 seconds (JVM running for 1.97)

看到ConfB被正常加载了

其实ConfB已经在spring.factories中指定了，所以类上不加@Configuration注解也可以加载的，如果加的话也是使用@Configuration(proxyBeanMethods=false)

@AutoConfigureBefore、@AutoConfigureAfter的注意事项

@AutoConfigureBefore、@AutoConfigureAfter是用来控制bean之间的加载顺序的，但也有很多的问题要注意

新增ConfA 和ConfC
ConfA

public class ConfA {
    
    public ConfA(){
        System.out.println("ConfA构造方式执行...");
    }
}

ConfB

@AutoConfigureAfter(ConfA.class)
@AutoConfigureBefore(ConfC.class)
public class ConfB {
    
    public ConfB(){
        System.out.println("ConfB构造方式执行...");
    }
}

ConfC

public class ConfC {
    
    public ConfC(){
        System.out.println("ConfC构造方式执行...");
    }
}

正常的控制加载顺序

项目结构
在这里插入图片描述

spring.factories
在这里插入图片描述

执行结果

2023-02-24 13:49:20.099  INFO 23672 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2023-02-24 13:49:20.099  INFO 23672 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: [Apache Tomcat/9.0.46]
2023-02-24 13:49:20.157  INFO 23672 --- [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2023-02-24 13:49:20.157  INFO 23672 --- [           main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 528 ms
2023-02-24 13:49:20.253  INFO 23672 --- [           main] o.s.s.concurrent.ThreadPoolTaskExecutor  : Initializing ExecutorService 'applicationTaskExecutor'
ConfA构造方式执行...
ConfB构造方式执行...
ConfC构造方式执行...
2023-02-24 13:49:20.740  INFO 23672 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2023-02-24 13:49:20.796  INFO 23672 --- [           main] test.MyStarterApplication                : Started MyStarterApplication in 1.427 seconds (JVM running for 2.048)

可以看到@AutoConfigureBefore、@AutoConfigureAfter作用生效了ConfA 、ConfB 、ConfC 按照指定的顺序进行了加载

不能进行加载

项目结构不变，把ConfA 、ConfC 从spring.factories去除，然后在这两个类上加上@Configuration(proxyBeanMethods=false)注解再试试
ConfA

@Configuration(proxyBeanMethods=false)
public class ConfA {
    
    public ConfA(){
        System.out.println("ConfA构造方式执行...");
    }
}

ConfC

@Configuration(proxyBeanMethods=false)
public class ConfC {
    
    public ConfC(){
        System.out.println("ConfC构造方式执行...");
    }
}

spring.factories
在这里插入图片描述

执行结果

2023-02-24 13:52:42.244  INFO 16748 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2023-02-24 13:52:42.245  INFO 16748 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: [Apache Tomcat/9.0.46]
2023-02-24 13:52:42.299  INFO 16748 --- [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2023-02-24 13:52:42.299  INFO 16748 --- [           main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 513 ms
2023-02-24 13:52:42.394  INFO 16748 --- [           main] o.s.s.concurrent.ThreadPoolTaskExecutor  : Initializing ExecutorService 'applicationTaskExecutor'
ConfB构造方式执行...
2023-02-24 13:52:42.875  INFO 16748 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2023-02-24 13:52:42.920  INFO 16748 --- [           main] test.MyStarterApplication                : Started MyStarterApplication in 1.392 seconds (JVM running for 2.02)

可以看到只有ConfB加载成功。

结论：使用@AutoConfigureBefore、@AutoConfigureAfter中的类必须在spring.factories中指定才行

不能控制加载顺序

那么再换种思路，不在spring.factories中指定，但是使用@Configuration注解让springboot启动时自动扫描到来处理呢，试一下
ConfA

@Configuration(proxyBeanMethods=false)
public class ConfA {
    
    public ConfA(){
        System.out.println("ConfA构造方式执行...");
    }
}

ConfB

@AutoConfigureAfter(ConfA.class)
@AutoConfigureBefore(ConfC.class)
@Configuration(proxyBeanMethods=false)
public class ConfB {
    
    public ConfB(){
        System.out.println("ConfB构造方式执行...");
    }
}

ConfC

@Configuration(proxyBeanMethods=false)
public class ConfC {
    
    public ConfC(){
        System.out.println("ConfC构造方式执行...");
    }
}

项目结构
在这里插入图片描述

spring.factories
在这里插入图片描述

将conf包放到了test包下，这样springboot的启动类就能自动扫描到ConfA、ConfB、ConfC了
执行结果

2023-02-24 13:54:38.107  INFO 27784 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]
2023-02-24 13:54:38.107  INFO 27784 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet engine: [Apache Tomcat/9.0.46]
2023-02-24 13:54:38.161  INFO 27784 --- [           main] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext
2023-02-24 13:54:38.161  INFO 27784 --- [           main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 515 ms
ConfA构造方式执行...
ConfC构造方式执行...
2023-02-24 13:54:38.257  INFO 27784 --- [           main] o.s.s.concurrent.ThreadPoolTaskExecutor  : Initializing ExecutorService 'applicationTaskExecutor'
ConfB构造方式执行...
2023-02-24 13:54:38.741  INFO 27784 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8080 (http) with context path ''
2023-02-24 13:54:38.797  INFO 27784 --- [           main] test.MyStarterApplication                : Started MyStarterApplication in 1.41 seconds (JVM running for 2.025)

可以看到ConfA、ConfB、ConfC没有按照指定的顺序进行加载

结论：
将 ConfA、ConfB、ConfC 添加到 spring.factories 中。在保证不会被扫描包自动扫描到的范围内的情况下才能够保证指定顺序的加载

总结

  • 自定义 starter 中spring.factories 中指定的配置类，要避免被自动扫描到才行
  • @ComponetScan 也就是自动扫描能扫描到的范围下的配置类，会立即初始化，所以这三个配置类的加载顺序也就无法保证了。
  • spring.factories 中的指定的配置类是不需要 @Configuration 注解的，如果要配置@Configuration 注解，要配置成@Configuration(proxyBeanMethods = false)

@AutoConfigureBefore、@AutoConfigureAfter中参数的注意

@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE })
@Documented
public @interface AutoConfigureAfter {

	/**
	 * The auto-configure classes that should have already been applied.
	 * @return the classes
	 */
	Class<?>[] value() default {};

	/**
	 * The names of the auto-configure classes that should have already been applied.
	 * @return the class names
	 * @since 1.2.2
	 */
	String[] name() default {};

}

可以看到有两个参数value和name，value是指自动装配类的bean的类名字，name是指自动装配类的bean名字。

举例说明

@AutoConfigureAfter(ConfA.class)
public class ConfB {
    
    public ConfB(){
        System.out.println("ConfB构造方式执行...");
    }
}

案例中，用到了@AutoConfigureAfter的value，注意：即使项目引入了ConfA的依赖，但是ConfA没有被注入到spring容器中的话，依旧会被判定ConfA不存在，那么ConfB也不会被加载bean，因为ConfB被加载bean的条件就是要在ConfA加载bean的后面执行

阿星不是程序员
关注
专栏目录
头秃了，使用@AutoConfigureBefore指定配置类顺序竟没生效？
fk_99的博客
01-10 4064
前言 日常工作中对于Spring Boot提供的一些启动器可能已经足够使用了，但是不可避免地需要自定义启动器，比如整合一个陌生的组件，也想要达到开箱即用的效果。 在上一章节从底层源码介绍了Spring Boot的自动配置的原理，未读过的朋友建议看一下：Spring Boot 自动配置源码解析 这篇文章将会介绍如何自定义一个启动器，同时对于自动配置类的执行顺序做一个详细的分析。 如何自定义一个starter？ 启动器的核心其实就是自动配置类，在自动配置源码分析的章节已经介绍过，AutoC...
springboot之自定义一个starter
iME_cho的博客
04-15 805
文章目录举例新建项目install到本地仓库新建项目测试 springboot发展至今，已经可以变得很轻巧了。需要用什么配置只需导入对应的依赖也就是对应的starter即可，为何加入了对应的start就可以实现对应的配置和功能呢？我们带着问题来探讨一下： 举例 我们以mybatis为例，看看它的starter实现 <dependency> <groupId>or......
@order注解_使用@AutoConfigureBefore、After、Order调整Spring Boot自动配置顺序
weixin_39980809的博客
11-26 1791
前言 Spring Boot是Spring家族具有划时代意义的一款产品，它发展自Spring Framework却又高于它，这种高于主要表现在其最重要的三大特性，而相较于这三大特性中更为重要的便是Spring Boot的自动配置（AutoConfiguration）。与其说是自动，倒不如说是“智慧”，该框架看起来好像“更聪明”了。因此它也顺理成章的成为了构建微服务的基础设施，稳坐第一宝座。 生活...
SpringBoot之@AutoConfigureBefore、@AutoConfigureAfter、@AutoConfigureOrder注解
最新发布
好记性不如烂笔头
05-28 2174
SpringBoot通过@AutoConfigureOrder、@AutoConfigureBefore、@AutoConfigureAfter注解，控制自动配置类的实例化顺序。
SpringBoot - 指定配置类的配置顺序 @AutoConfigureBefore、@AutoConfigureAfter、@AutoConfigureOrder
你今天真好看呀
10-15 2092
AutoConfigureBefore：用在自动配置类上面，表示该自动配置类需要在另外指定的自动配置类配置完之后配置。@AutoConfigureAfter：用在自动配置类上面，表示该自动配置类需要在另外指定的自动配置类配置完之前配置。@AutoConfigureOrder：确定配置加载的优先级顺序，表示绝对顺序（数字越小，优先顺序越高）
使用@AutoConfigureBefore调整配置顺序
qq_24692021的博客
11-18 411
目录 前言 如何自定义一个starter？ 分享一个经典的误区 源码分析自动配置类如何排序？ 准备自己的自动配置类 将自动配置类设置在spring.factories 如何指定自动配置类的执行顺序？ 总结 前言 日常工作中对于Spring Boot提供的一些启动器可能已经足够使用了，但是不可避免的需要自定义启动器，比如整合一个陌生的组件，也想要达到开箱即用的效果。 在上一章节从底层源码介绍.
springboot自定义Starter的具体流程
08-25
SpringBoot自定义Starter的具体流程 SpringBoot自定义Starter是一种特殊的starter，它可以根据项目的需求进行自定义和配置，从而满足不同的业务需求。在 본节中，我们将详细介绍SpringBoot自定义Starter的具体流程...
springboot自定义Starter过程解析
08-25
在Spring Boot生态系统中，自定义Starter是一种强大的方式来封装和重用代码，使得其他开发者可以轻松地在他们的项目中引入特定的功能。本篇文章将详细解析如何创建一个自定义的Spring Boot Starter，以及在这个过程...
microservice-starter-springboot-源码.rar
10-10
当我们谈论“microservice-starter-springboot-源码”时，实际上是在探讨如何利用SpringBoot来构建微服务的起点。本文将深入剖析SpringBoot源码，揭示其在微服务开发中的核心机制。 一、SpringBoot概述 SpringBoot...
SpringBoot-创建自己的starter和autoconfiguration
惜暮
09-13 3026
这篇文章主要是告诉我们怎么创建自己的SpringBoot autoconfiguration Auto-configuration classes能被绑定在一个外部jar包并且能被Spring Boot加载。每一个Auto-configuration能够被关联到一个starter，创建步骤（1）实现XxxxxxAutoConfiguration.class类，并加上@Conditional限制条件（
SpringBoot @AutoConfigureAfter 注解
热门推荐
Pazz
08-27 5万+
@AutoConfigureAfter 在加载参数类之后再加载当前类 它的value 是一个数组 一般配合着@import 注解使用 ，在使用import时必须要让这个类先被spring ioc 加载好 所以@AutoConfigureAfter必不可少 @Retention(RetentionPolicy.RUNTIME) @Target({ ElementType.TYPE }) pub...
【SpringBoot-注解学习】@AutoConfigureBefore、@AutoConfigureAfter、@AutoConfigureOrder
daohangtaiqian的博客
12-28 1323
今天看到公司大佬写了Configuration的配置类，是解决将feign默认请求修改为okhttp配置。但是我看到了一个不认识的注解所以就学习了一下。，现在就总结下自己的学习成果。
SpringBoot 2.3.7：@AutoConfigureAfter || @AutoConfigureBefore 注解失效问题解决 （基于官方文档分析解决）
Specif1c的博客
03-13 2918
一、前言： 最近项目有一需求，我需要指定一个配置类必须在另一个配置类执行之后才能执行。SpringBoot 提供了两个注解 ：@AutoConfigureAfter或@AutoConfigureBefore注解为配置类指定特定的顺序。在实现的过程中遇到一些问题，注解不生效，没有按照特定顺序执行，这里做下分析及解决办法。 二、原关键问题代码： 目的：我想先加载 WebMvcConfig 配置，让 yml 文件里面值注入到静态成员变量中，然后再加载 DirConfig 配置类获取 WebMvcConfig
@AutoConfigureBefore、@AutoConfigureAfter使用细节
guntun8987的博客
09-06 1380
@AutoConfigureBefore、@AutoConfigureAfter使用细节
SpringBoot: @AutoConfigureAfter 和 @AutoConfigureBefore失效问题
weixin_37672801的博客
05-30 1万+
目录 问题场景 几个注解 问题分析 Spring加载配置文件 SpringBoot加载配置文件 错误示例 正确示例 问题场景 项目启动时需要加载多个配置类，且需要控制某些配置类的加载顺序。使用@Configuration标注配置类，使用@AutoConfigureAfter、@AutoConfigureBefore设置配置类加载顺序。 结果：能够正常加载配置类，但无法控制配置类的加载顺序。 几个注解 @ComponentScan 自动扫描组件。...
spring-boot版本影响Spring AOP @Before @Around @After等执行顺序
九尾狐的yi巴的博客
06-01 1403
郁闷了半天，我通过AOP切面打印的日志顺序怪怪的，网上查了好几篇文章都说没问题，最后发现是springboot版本升级后@Before @Around @After等执行顺序发生了变化。
@AutoConfigureAfter注解
weixin_42594143的博客
10-07 2265
@AutoConfigureAfter注解
聊聊@AutoConfiguration，@AutoConfigureBefore，@AutoConfigureAfter，@AutoConfigureOrder
weixin_42040314的博客
12-01 1570
对@AutoConfiguration的研究,以及注解@AutoConfigureBefore，@AutoConfigureAfter，@AutoConfigureOrder生效问题``以上就是今天要讲的内容。
spring的@AutoConfigureAfter注解
听海边涛声
01-30 180
spring的@AutoConfigureAfter注解
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值