SpringBoot配置文件及自动配置原理详解,这应该是SpringBoot最大的优势了吧

本文涉及的产品
云原生内存数据库 Tair,内存型 2GB
云数据库 Redis 版,社区版 2GB
推荐场景:
搭建游戏排行榜
云数据库 Redis 版,经济版 1GB 1个月
简介: springboot的配置文件中存在大量的配置,这一点在官网上就能看到了:docs.spring.io/spring-boot…如果要用的时候直接去官方文档或者百度取确实是个办法,但却并不是最好的办法,最好的办法是理解这些配置文件的原理,以后要用的时候直接通过原理去写配置文件。在前面一章讲自动装配的时候我们已经知道了,Springboot项目在启动时会去META-INF/spring.factories取配置信息

点赞再看,养成习惯,听说微信搜公众号《Java鱼仔》会让自己的技术更上一层楼


(一)概述


SpringBoot使用一个全局的配置文件来修改SpringBoot自动配置的默认值,SpringBoot提供了三种格式的配置文件:

网络异常,图片无法展示
|


如果一个项目中同时有上面三种配置文件,只会执行application*.yml,同理如果只有yaml和properties,只会执行yaml。


yml和yaml具有相同的格式  key:空格value 注意这个空格不能没有


server:
  port: 8080

properties的格式为 key=value

server.port=8080

(二)配置文件从哪来的?


springboot的配置文件中存在大量的配置,这一点在官网上就能看到了:


https://link.juejin.cn/?target=https%3A%2F%2Fdocs.spring.io%2Fspring-boot%2Fdocs%2F2.1.6.RELEASE%2Freference%2Fhtml%2Fcommon-application-properties.html


如果要用的时候直接去官方文档或者百度取确实是个办法,但却并不是最好的办法,最好的办法是理解这些配置文件的原理,以后要用的时候直接通过原理去写配置文件。


在前面一章讲自动装配的时候我们已经知道了,Springboot项目在启动时会去META-INF/spring.factories取配置信息


网络异常,图片无法展示
|


配置文件的源头也来自于这里。


我们以Redis的配置类为例子讲解配置文件的原理,点开spring.factories,通过ctrl+F查找redis,可以找到一个叫RedisAutoConfiguration的类。


网络异常,图片无法展示
|


点进去后你能见到一个叫@EnableConfigurationProperties的注解,并且他后面会带上一个叫XXXProperties的类,Redis这里叫做RedisProperties。XXXProperties是配置文件的核心。 @EnableConfigurationProperties的意思是让@ConfigurationProperties 注解的类生效,后面我们就能看到


网络异常,图片无法展示
|


XXXProperties这个类被@ConfigurationProperties注解,这就和前面的@EnableConfigurationProperties对应上了,@ConfigurationProperties可以将配置文件(比如applicaition.yaml)加载进来,填充对象的对应字段的数据,然后供其他Bean使用。这里需要写一个前缀,在配置文件中通过"前缀.变量"的形式配置相应的值。


@ConfigurationProperties(prefix="spring.redis")
publicclassRedisProperties {
/*** Database index used by the connection factory.*/privateintdatabase=0;
/*** Connection URL. Overrides host, port, and password. User is ignored. Example:* redis://user:password@example.com:6379*/privateStringurl;
/*** Redis server host.*/privateStringhost="localhost";
/*** Login password of the redis server.*/privateStringpassword;
/*** Redis server port.*/privateintport=6379;
/*** Whether to enable SSL support.*/privatebooleanssl;
/*** Connection timeout.*/privateDurationtimeout;
/*** Client name to be set on connections with CLIENT SETNAME.*/privateStringclientName;
privateSentinelsentinel;
privateClustercluster;
privatefinalJedisjedis=newJedis();
privatefinalLettucelettuce=newLettuce();
//。。。。。。。。。。

看到这里我想你们已经知道配置文件的原理了,我们平常写的配置文件,肯定是为某一个类的变量赋予了值,我们写配置文件就可以通过“前缀.变量”的形式来写。 还是以上面的代码为例,我们如果想要给redis设置一个地址,“前缀.变量”就是spring.redis.host,这个值就会被RedisProperties 获取到,


网络异常,图片无法展示
|

(三)配置文件处理总结


  1. 我们可以在META-INF/spring.factories中找到XXXAutoConfiguration这个自动装配类


  1. 所有在配置文件中能配置的属性都是在xxxxProperties类中封装着;


  1. 配置文件能配置什么就可以参照某个功能对应的这个属性类


(四)自己写一个配置类


既然我们知道了springboot是如何取配置文件的,那么我们可以自己来写一个配置类读取配置。 新建一个package properties,在里面新建一个类叫做UserProperties。


@Data@Component@ConfigurationProperties(prefix="myproperties.user")
publicclassUserProperties {
privateStringname;
privateIntegerage;
}

在使用@ConfigurationProperties的同时必须激活它,我现在用了@Component让 Component Scan 扫描到,如果单纯写一个@ConfigurationProperties注解,会提示报错

Notregisteredvia@EnableConfigurationProperties, markedasSpringcomponent, orscannedvia@ConfigurationPropertiesScan

接着在配置文件中赋值,我这里用的是application.yaml

myproperties:
user:
name: javayzage: 23

通过测试方法测试:

@SpringBootTestclassSpringbootdemoApplicationTests {
@AutowiredUserPropertiesuserProperties;
@TestvoidcontextLoads() {
System.out.println(userProperties);
    }
}

网络异常,图片无法展示
|


除了使用@Component来激活配置注解外,我们还可以参考源码的方式激活它:源码是这样写的


网络异常,图片无法展示
|


现在去除UserProperties的@Component注解,新建一个package config,并新建一个类叫UserConfig

@Configuration@EnableConfigurationProperties(UserProperties.class)
publicclassUserConfig {
}

运行测试类后获得相同的正确结果。这就是阅读源码的好处,通过源码学习别人的编码方式。


(五)结语


如果完整的看完整篇文章,我相信你对SpringBoot的配置文件以及自动配置的原理有了比较深刻的原理,看源码有时候并不难。

相关实践学习
基于Redis实现在线游戏积分排行榜
本场景将介绍如何基于Redis数据库实现在线游戏中的游戏玩家积分排行榜功能。
云数据库 Redis 版使用教程
云数据库Redis版是兼容Redis协议标准的、提供持久化的内存数据库服务,基于高可靠双机热备架构及可无缝扩展的集群架构,满足高读写性能场景及容量需弹性变配的业务需求。 产品详情:https://www.aliyun.com/product/kvstore     ------------------------------------------------------------------------- 阿里云数据库体验:数据库上云实战 开发者云会免费提供一台带自建MySQL的源数据库 ECS 实例和一台目标数据库 RDS实例。跟着指引,您可以一步步实现将ECS自建数据库迁移到目标数据库RDS。 点击下方链接,领取免费ECS&RDS资源,30分钟完成数据库上云实战!https://developer.aliyun.com/adc/scenario/51eefbd1894e42f6bb9acacadd3f9121?spm=a2c6h.13788135.J_3257954370.9.4ba85f24utseFl
相关文章
|
10天前
|
机器学习/深度学习 JSON Java
SpringBoot是如何加载配置文件的?
SpringBoot是如何加载配置文件的?
|
4天前
|
消息中间件 Java Maven
深入理解Spring Boot Starter:概念、特点、场景、原理及自定义starter
深入理解Spring Boot Starter:概念、特点、场景、原理及自定义starter
|
12天前
|
Java 应用服务中间件 Spring
解析Spring Boot自动装配的原理与机制
解析Spring Boot自动装配的原理与机制
21 4
|
3天前
|
开发框架 Java 开发者
Spring Boot中的自动装配原理
Spring Boot中的自动装配原理
|
3天前
|
Java
SpringBoot配置-配置文件分类,server.port修改端口,自定义修改配置内容
SpringBoot配置-配置文件分类,server.port修改端口,自定义修改配置内容
|
3天前
|
Java
SpringBoot起步依赖原理分析
SpringBoot起步依赖原理分析
|
25天前
|
缓存 Java 开发者
SpringBoot自动装配原理
SpringBoot自动装配原理
21 1
|
4天前
|
监控 前端开发 Java
SpringBoot 太强了,这些优势你需要了解
SpringBoot 太强了,这些优势你需要了解
|
5天前
|
Java 应用服务中间件 Spring
SpringBoot条件注解原理
可以看到isPresent的逻辑是通过FilteringSpringBootCondition.resolve(className, classLoader); 来尝试加载该类,如果能正常加载,则代表该类存在,如果不能则代表该类不存在。
16 0
|
10天前
|
JavaScript Java 数据库连接
【Spring Boot】掌握Spring Boot:深入解析配置文件的使用与管理
【Spring Boot】掌握Spring Boot:深入解析配置文件的使用与管理
16 0