Spring Boot的自动配置与自定义配置(附配置优先级表)

2023-11-15

相比于Spring MVC,Spring Boot省去了繁琐的配置,提供了大部分场景下的默认配置,用户可以在不做任何配置的情况下使用Spring Boot框架进行开发。如果默认的参数并不能满足用户的需求,也只需创建一个配置文件并加上自定义的配置。Spring Boot的主导思想,想必大家也并不陌生,即:约定优于配置。

本文将简要介绍Spring Boot的自动配置原理,以及自动配置不能满足要求时,如何自定义配置。

一、Spring Boot的自动配置

Spring Boot之所以能做到自动配置,主要靠的是@EnableAutoConfiguration注解。这个注解集成于程序启动类注解@SpringBootApplication中。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
    excludeFilters = {@Filter(
    type = FilterType.CUSTOM,
    classes = {TypeExcludeFilter.class}
), @Filter(
    type = FilterType.CUSTOM,
    classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
	...
}

查看@EnableAutoConfiguration的源码,发现两个主要注解:@AutoConfigurationPackage和@Import。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import({AutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {
    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

    Class<?>[] exclude() default {};

    String[] excludeName() default {};
}

查看@AutoConfigurationPackage注解,发现也使用了@Import注解,所以有必要先搞懂这个注解的作用。这里推荐一篇博文,感兴趣的朋友可以看一下。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import({AutoConfigurationPackages.Registrar.class})
public @interface AutoConfigurationPackage {
    String[] basePackages() default {};

    Class<?>[] basePackageClasses() default {};
}

回到主题,@EnableAutoConfiguration中@Import注解通过引入ImportSelector实现类的方式将依赖中的默认配置加载到容器中。AutoConfigurationImportSelector类的具体内容在这里不做分析,这个过程简而言之就是:

查看Jar包中META-INF/spring.factories文件,获取其中EnableAutoConfiguration配置的value值。value值是由多个url组成,一个url表示一个配置类的全类名。然后通过@Import注解导入这些配置类。

@AutoConfigurationPackage中的@Import是通过引入ImportBeanDefinitionRegistrar实现类方式将各种组件和配置引入Spring容器的。简而言之,就是将标注了该注解的类所在的package设置成为自动配置package,这样主程序所在的包及其子包中的组件都能够被扫描到Spring容器中。

案例

下面将通过Tomcat端口配置举例,版本是spring-boot-actuator-autoconfigure-2.4.2.jar。解压之后打开META-INF/spring.factoryies文件,发现org.springframework.boot.autoconfigure.EnableAutoConfiguration配置中如下配置类:

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
...
org.springframework.boot.autoconfigure.web.servlet.HttpEncodingAutoConfiguration,\
...

查看该配置类源码:

@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties(ServerProperties.class)
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
@ConditionalOnClass(CharacterEncodingFilter.class)
@ConditionalOnProperty(prefix = "server.servlet.encoding", value = "enabled", matchIfMissing = true)
public class HttpEncodingAutoConfiguration {
	...
}

我们重点关注@EnableConfigurationProperties(ServerProperties.class),这个注解的作用是使某个被@ConfigurationProperties标注的类生效,这里指的就是ServerProperties类,我们查看ServerProperties类的源码:

@ConfigurationProperties(prefix = "server", ignoreUnknownFields = true)
public class ServerProperties {

		/**
		 * Server HTTP port.
		 */
		private Integer port;

		/**
		 * Network address to which the server should bind.
		 */
		private InetAddress address;
		...
}

顺便提一句,@ConfigurationProperties是springboot提供读取配置文件的一个注解,它支持属性文件和bean的映射,一般和@component配合使用,不然容器无法获取。如果单独使用@ConfigurationProperties,需要结合@EnableConfigurationProperties(ServerProperties.class)将其注册到spring容器中。

prefix = "server"表示该配置使用server前缀,和属性port结合起来就是:server.port。我们都知道Tomcat的默认端口是8080,那么这个参数又是在哪里配置的呢?答案是META-INF/spring-configuration-metadata.json。

{
	"name": "server.port",
    "defaultValue": 8080
}

可以看到文件中有这么一条配置,这就是我们需要的server.port = 8080。

二、自定义配置

学习完以上内容,想要自定义配置就简单多了,还是以Tomcat为例,如果我想将端口改为8081,只需在application.properties文件中加上:

server.port = 8081

至于为什么最终生效的是server.port = 8081而非server.port = 8080,就要提到Spring Boot中的配置优先级了,Spring Boot会按照从上到下的顺序加载:

  • 命令行参数;
  • 来自 java:comp/env 的 JNDI 属性;
  • Java 系统属性(System.getProperties()) ;
  • 操作系统环境变量;
  • RandomValuePropertySource 配置的 random.*属性值;
  • jar 包外部的 application-{profile}.properties 或 application.yml(带 spring.profile)配置文件;
  • jar 包内部的 application-{profile}.properties 或 application.ym(带 spring.profile)配置文件;
  • jar 包外部的 application.properties 或 application.yml(不带 spring.profile)配置文件;
  • jar 包内部的 application.properties 或 application.ym(不带 spring.profile)配置文件;
  • @Configuration 注解类上的@PropertySource;
  • 通过 SpringApplication.setDefaultProperties 指定的默认属性。

参考:

《深入浅出Spring Boot 2.x》

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

Spring Boot的自动配置与自定义配置(附配置优先级表) 的相关文章

随机推荐

  • 刃边法计算MTF(ESF、LSF、PSF)

    MTF 调制传递函数 评价一个成像系统目前主流的办法主要有三种TV line检测 MTF检测 和SFR检测 MTF是Modulation Transfer Function的英文简称 中文为调制传递函数 是指调制度随空间频率变化的函数称为调
  • 自学网络安全究竟该从何学起?

    一 为什么选择网络安全 这几年随着我国 国家网络空间安全战略 网络安全法 网络安全等级保护2 0 等一系列政策 法规 标准的持续落地 网络安全行业地位 薪资随之水涨船高 未来3 5年 是安全行业的黄金发展期 提前踏入行业 能享受行业发展红利
  • IDEA旗舰版安装与概述

    1 IDEA介绍 IDEA 全称 IntelliJ IDEA 是java编程语言开发的集成环境 IntelliJ在业界被公认为最好的java开发工具 尤其在智能代码助手 代码自动提示 重构 JavaEE支持 各类版本工具 git svn等
  • Cobalt Strike Malleable C2

    郑重声明 本笔记编写目的只用于安全知识提升 并与更多人共享安全知识 切勿使用笔记中的技术进行违法活动 利用笔记中的技术造成的后果与作者本人无关 倡导维护网络安全人人有责 共同维护网络文明和谐 Cobalt Strike Malleable
  • 代码技巧——如何关闭订单?延迟任务的实现方案【建议收藏】

    先思考个问题 为什么要关闭订单 业务上 1 提供待付款时间 而不是简单的 一次付款机会 提高业务指标之一的成单率 成单率 成功下单的人数 发起支付的人数 2 下单成功意味着这个商品被当前订单占用 库存已经预扣减 如果迟迟不支付则需要回收库存
  • ‘WiFi‘ was not declared in this scope报错处理方法

    造成原因 文件头没有定义相应的函数或变量 处理办法 文件头添加以下代码 include
  • java 对称的二叉树

    1 对称的二叉树 1 题目描述 请实现一个函数 用来判断一颗二叉树是不是对称的 注意 如果一个二叉树同此二叉树的镜像是同样的 定义其为对称的 2 解题思路 可以按照类似层次遍历 来判断是否是堆成二叉树 首先根节点以及其左右子树 左子树的左子
  • SpringBoot 防止XSS攻击和SQL攻击拦截器(Filter)

    什么是SQL攻击 什么是XSS攻击 SQL 攻击 把SQL命令插入到Web表单并提交 欺骗服务器执行恶意的SQL命令 XSS 攻击 向有XSS漏洞的网站中输入 传入 恶意的HTML代码 当其它用户浏览该网站时 这段HTML代码会自动执行 从
  • SpringBoot整合ElasticSearch(二)

    文章目录 es的批量操作 es的重中之重 查询 es与springboot集成 es的批量操作 bulk批量操作 导入数据 分析与创建索引 PUT goods mappings properties title type text anal
  • 如何渲染精美3D PCB图

    简介 现在网上大部分PCB渲染方法都比较麻烦 并且会有丝印不清晰 或者走线与铜皮不显现问题 现在分享一种简单有效的PCB渲染方法 图为渲染效果图 工具或材料 AD keyshot 一个带3D封装图的PCB文件 具体步骤 1 AD端操作 在P
  • 写出你所知道的测试工具,并写出他们的用途和优缺点

    写出你所知道的测试工具 并写出他们的用途和优缺点 Jmeter Apache JMeter是Apache组织开发的基于Java的压力测试工具 Apache jmeter 可以用于对静态的和动态的资源 文件 Servlet Perl脚本 ja
  • XXL-JOB详细说明

    XXL JOB 常见任务调度 单机 Timer ExectorService spring scheduled 分布式 xxl job quartz elastic job 原生定时任务的先天缺陷 XXL JOB简介 由调度中心和执行器组成
  • fabric环境

    1 1环境配置链接 https www jianshu com p 6ef2e8425087 https studygolang com articles 17546 Fabric chaincode测试 开发者模式和单元测试 https
  • 计算机网络 传输层的作用,端口,UDP协议,其他传输层协议

    传输层的作用 传输层定义 IP首部中有一个协议字段 用来标识网络层 IP 的 上一层所采用的是哪一种传输层协议 根据这个字段的协议号 就可以识别IP传 输的数据部分究竟是TCP的内容 还是UDP的内容 同样 传输层的TCP和UDP 为了识别
  • 参与 2023 第一季度官方 Flutter 开发者调查

    Flutter 3 7 已经正式发布 每个季度一次的 Flutter 开发者调查也如约而至 邀请社区的各位成员们填写 调查表链接 https flutter cn urls 2023q1wx 本次调研将会涉及既有的对 Flutter 整体和
  • 【李宏毅深度强化学习笔记】—7、Sparse Reward

    原文链接 https blog csdn net ACL lihan article details 104103873 李宏毅深度强化学习笔记 1 策略梯度方法 Policy Gradient 李宏毅深度强化学习笔记 2 Proximal
  • 24个K8S常用场景使用命令(推荐收藏)!

    kubectl是K8S中的一个命令行工具 主要用于管理和操作K8S集群 kubectl通过向K8S API发送REST请求 允许用户与K8S集群中的各种资源进行交互 列如Pod service Deployment等 kubectl提供了一
  • 【数据结构学习笔记】18:线段树(建树、单点修改、区间查询)

    1 线段树上的操作 push up int u 由子节点的信息去计算父节点的信息 例如两个子节点的区间和 加起来就是父节点表示的区间和 其中u是当前节点编号 表示用u的左右两个子节点来算一下自己这个节点的信息 push down 将父节点的
  • 数据爆炸,Python一键获取阿里法拍的爆款商品数据,并保存到数据库!

    目录 前言 获取数据代码实现 步骤1 获取目标网址 步骤2 向目标网址发送请求并获取响应内容 步骤3 解析网页内容并提取商品信息 步骤4 将商品信息保存到DataFrame中 将商品信息保存到数据库中 步骤1 安装MySQL Connect
  • Spring Boot的自动配置与自定义配置(附配置优先级表)

    相比于Spring MVC Spring Boot省去了繁琐的配置 提供了大部分场景下的默认配置 用户可以在不做任何配置的情况下使用Spring Boot框架进行开发 如果默认的参数并不能满足用户的需求 也只需创建一个配置文件并加上自定义的