Spring Boot 自动配置一篇概览

这篇具有很好参考价值的文章主要介绍了Spring Boot 自动配置一篇概览。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

一、什么是自动配置 bean

自动配置类通过添加 @AutoConfiguration 注解实现。

因为 @AutoConfiguration 注解本身是以 @Configuration 注解的,所以自动配置类可以算是一个标准的基于 @Configuration 注解的类。

@Conditional 注解可以用于声明自动配置启用条件,通常,我们可以使用 @ConditionalOnClass、@ConditionalOnMissingBean 注解。

二、自动配置发现

Spring Boot 通过检查【META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports】配置文件获取自动配置类。

文件内包含自定义的自动配置类全限定名,每行一个。

示例如下:

com.mycorp.libx.autoconfigure.LibXAutoConfiguration
com.mycorp.libx.autoconfigure.LibXWebAutoConfiguration  

1、关于约定:

自动配置类必须通过如上配置文件引入。

合理规划其放置包位置,避免被自动包扫描。

内部不要配置自动包扫描,如需要可以使用 @Import 引入。

2、关于顺序

明确的对象先后顺序可以通过配置 @AutoConfiguration 的 before、beforeName、after、afterName 属性,或者使用 @AutoConfigurationBefore、@AutoConfigurationAfter 注解实现。例如 web 服务类配置需要置于 @WebMvcAutoConfiguration 注解之后。

如果没有明确的先后顺序,也可以使用 @AutoConfigureOrder 注解声明顺序。类似 @ Order 注解,不同之处在于其只作用于自动配置类。

三、条件注解

1、类条件

@ConditionalOnClass、@ConditionalOnMissingClass 

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional({OnClassCondition.class})
public @interface ConditionalOnClass {
    Class<?>[] value() default {};

    String[] name() default {};
}

注解元数据是通过 ASM 处理的,所以可以通过 value 属性传递 Class 类型参数,或者也可以通过 name 传递类全限定名作为参数。

无效情景:

@Bean 注解的方法,其返回值类型为类目标条件类本身。在方法上的条件判正之前,JVM 已经加载了相关的类,并且很可能会执行相关的方法引用,如果类不存在的话,就会导致失败。

为了处理此类情景,需要添加额外的 @Configuration 注解,使用如下:

import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@AutoConfiguration
// Some conditions ...
public class MyAutoConfiguration {

    // Auto-configured beans ...

    @Configuration(proxyBeanMethods = false) // 
    @ConditionalOnClass(SomeService.class)
    public static class SomeServiceConfiguration {

        @Bean
        @ConditionalOnMissingBean
        public SomeService someService() {
            return new SomeService();
        }

    }

}

 2、Bean 条件

@ConditionalOnBean、ConditionalOnMissingBean 
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional({OnBeanCondition.class})
public @interface ConditionalOnBean {
    Class<?>[] value() default {};

    String[] type() default {};

    Class<? extends Annotation>[] annotation() default {};

    String[] name() default {};

    SearchStrategy search() default SearchStrategy.ALL;

    Class<?>[] parameterizedContainer() default {};
}
search 属性用于限定搜寻范围。
作用于 @Bean 注解的方法时,默认的目标 Bean 类型为方法的返回值类型。如下:
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;

@AutoConfiguration
public class MyAutoConfiguration {

    @Bean
    @ConditionalOnMissingBean
    public SomeService someService() {
        return new SomeService();
    }

}

条件注解的判正会受 Bean 定义的注册、处理顺序影响,这点需要特别关注。通常建议只在自动配置类上使用条件注解。

@ConditionalOnBean、ConditionalOnMissingBean 条件注解的 @Configuration 类依然会被创建,只不是不会被注册。

当使用 @Bean 注解方法时,返回值最好使用具体的类,而不要使用接口。这一点,对于使用基于 Bean 类型判定的条件注解时尤为重要。

3、属性条件

@ConditionalOnProperty 基于 Spring 的环境变量判正。

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Documented
@Conditional({OnPropertyCondition.class})
public @interface ConditionalOnProperty {
    String[] value() default {};

    String prefix() default "";

    String[] name() default {};

    String havingValue() default "";

    boolean matchIfMissing() default false;
} 

 可以基于前缀或者特定名称来判断。

 4、资源条件

@ConditionalOnResource 基于是否存在特定的资源来判正,如:判定资源“file:/home/user/test.dat”。

5、Web 应用条件

@ConditionalOnWebApplication、@ConditionalOnNotWebApplication
基于当前是否为 Web 应用。
@ConditionalOnWarDeployment、@ConditionalOnNotWarDeployment 判定当前应用是否为传统的部署到 servlet 容器的 WAR 包应用,区别于内嵌的 web 服务器应用。

四、构建 starter

一个典型的 Spring Boot starter 包括如下两点:

  • autoconfigure 模块:包含自动配置相关代码。

  • starter 模块:提供 autoconfigure 模块所需的依赖及其它附属依赖。

1、命名

不要以 spring-boot 做前缀,这是官方保留使用。

以自有工程名做前缀,并附加信息体现其用途。

2、配置键

配置键需要提供专门的命名空间,不要使用 Spring Boot 官方命名空间,

3、autoconfigure 模块

包含使用依赖的所有配置,也可以包括配置键定义及自定义组件初始化的回调接口。

所有引入应该做成可配置的,并且默认为不使用。

Spring Boot 使用注解处理器来收集位于配置文件(META-INF/spring-autoconfigure-metadata.properties)中的自动配置条件,快速过滤掉不需要自动配置的,以加快启动速度。

如果使用 Maven 管理项目,则需要加入如下依赖来处理启用自动配置功能:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-autoconfigure-processor</artifactId>
    <optional>true</optional>
</dependency>  

4、starter 模块

提供依赖。显示声明所有必需的依赖,对于可选的,不要声明。文章来源地址https://www.toymoban.com/news/detail-462582.html

五、附加订阅

Spring Boot 自动配置一篇概览

到了这里,关于Spring Boot 自动配置一篇概览的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

原文地址:https://www.cnblogs.com/niejunlei/p/17427481.html

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 45、Spring Boot自动配置原理

    @lmport + @Configuration + Spring spi 自动配置类由各个starter提供,使用@Configuration + @Bean定义配置类,放到META-INF/spring.factories下 使用Spring spi扫描META-INF/spring.factories下的配置类 使用@lmport导入自动配置类

    2024年02月16日
    浏览(9)
  • Spring Boot的自动配置原理

    Spring Boot的自动配置是Spring框架的一个重要特性,它旨在简化应用程序的开发和部署过程。自动配置通过基于类路径中的依赖关系和配置文件内容来预先配置Spring应用程序的各种组件和功能。这样,我们可以在无需显式配置大量参数的情况下,快速搭建一个运行良好的Spring应

    2024年02月14日
    浏览(7)
  • Spring Boot 自动配置功能介绍

    2024年02月03日
    浏览(9)
  • 聊聊Spring Boot的自动配置

    介绍 Spring Boot的自动配置是其一大核心特性,可以让我们迅速构建出一个Spring应用程序。 Spring Boot 是 Spring Framework 中最火的项目之一,它通过集成各种第三方库和框架来简化开发过程,并提供一些优秀的默认设置,使得开发人员可以快速构建高效的企业级应用。本文将主要讲

    2024年02月10日
    浏览(6)
  • Spring Boot中的Elasticsearch自动配置

    2024年02月12日
    浏览(6)
  • Spring Boot 中的自动配置(autoconfigure)

    文中部分图片来源为 动力节点-王鹤老师的Spring Boot3.0 视频讲解中。 自动配置:从类路径中,搜索相关的 jar,根据 jar 的内容,尝试创建所需的对象。例如,如果有 MyBatis .jar,Spring Boot 会尝试创建 DataSource(根据配置文件中的url,username,password)连接数据库。还需要创建 S

    2024年01月25日
    浏览(11)
  • Spring Boot 3.x 自动配置详解

    基于Spring Boot 3.1.0 系列文章 Spring Boot 源码阅读初始化环境搭建 Spring Boot 框架整体启动流程详解 Spring Boot 系统初始化器详解 Spring Boot 监听器详解 Spring Boot banner详解 Spring Boot 属性配置解析 Spring Boot 属性加载原理解析 Spring Boot 异常报告器解析 Spring Boot 3.x 自动配置详解 Spring

    2024年02月16日
    浏览(15)
  • 【Spring Boot】自动配置及重要注解解析

    1、springboot自动配置了哪些功能 1)tomcat的自动配置 引入了tomcat的相关依赖 2)自动配置springmvc及常用功能 我们在主启动类中加两行代码,查看一下spring boot加载了哪些组件 通过在控制台输出中搜索,我们可以发现转发请求的dispatcherServlet、解决乱码的characterEncodingFilter还有视

    2023年04月09日
    浏览(15)
  • Spring Boot中的Elasticsearch自动配置:原理与使用

    在Spring Boot中,Elasticsearch是非常流行的搜索引擎。为了方便开发人员使用Elasticsearch,Spring Boot提供了Elasticsearch自动配置功能。本文将介绍Elasticsearch自动配置的原理与使用。 Elasticsearch自动配置是Spring Boot对Elasticsearch进行封装的一种方式,它主要是通过将Elasticsearch相关的配置

    2024年02月12日
    浏览(17)
  • Java 框架面试题-Spring Boot自定义配置与自动配置共存

    Spring Boot 是一个快速开发框架,可以简化 Spring 应用程序的开发,其中自定义配置是其中一个非常重要的特性。 在 Spring Boot 中,自定义配置允许开发者以自己的方式来配置应用程序。自定义配置可以用于覆盖默认配置,也可以用于添加新的配置项。本文将详细介绍 java框架面

    2023年04月11日
    浏览(8)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包