文章目录
- 前言
- 二、SpringBoot配置
- 1. 了解配置文件的3种格式
- 2.yaml格式语法规则
- 3.读取yaml数据的3种方式
- 4.多环境开发配置
- 5.多环境命令行启动参数设置
- 6. 多环境开发兼容问题
- 7.配置文件分类
- 总结
前言
为了巩固所学的知识,作者尝试着开始发布一些学习笔记类的博客,方便日后回顾。当然,如果能帮到一些萌新进行新技术的学习那也是极好的。作者菜菜一枚,文章中如果有记录错误,欢迎读者朋友们批评指正。
(博客的参考源码可以在我主页的资源里找到,如果在学习的过程中有什么疑问欢迎大家在评论区向我提出)
二、SpringBoot配置
1. 了解配置文件的3种格式
- SpringBoot配置文件种类
- 编码环境准备(辅助理解)
- 创建新的SptingBoot模块,勾选web技术支持
- 运行启动类
从运行结果中我们可以发现默认服务器为tomcat,默认端口为8080
- 编辑application.properties文件,将端口号改为80并运行启动类
server.port=80
我们发现默认端口号变成了80
- 注释掉application.properties文件的内容,创建编辑application.yml文件,将端口号改为81并运行启动类
server:
port: 81
我们发现默认端口号变成了81
- 注释掉application.yml文件的内容,创建编辑application.yaml文件,将端口号改为82并运行启动类
server:
port: 82
我们发现默认端口号变成了82
- 当三种配置文件都开启,运行启动类,我们发现端口号为80;将properties文件注释掉,运行启动类,我们发现默认端口号为81,于是我们得知SpringBoot配置文件加载顺序:
application.properties 优先于 application.yml 优先于 application.yaml
2.yaml格式语法规则
- 了解yaml格式
- yaml语法格式
1.大小写敏感
2.属性层级关系使用多行描述,每行结尾使用冒号结束
3.使用缩进表示层级关系,同层级左侧对齐,只允许使用空格 (不允许使用Tab键)
4.属性值前面添加空格(属性名与属性值之间使用冒号+空格作为分隔)
5.#表示注释
6.数组数据在数据书写位置的下方使用减号作为数据开始符号,每行书写一个数据,减号与数据间空格分隔
核心规则: 数据前面要加空格与冒号隔开
3.读取yaml数据的3种方式
- 方式一:直接调用
使用@Value读取单个数据,属性名引用方式: {一级属性名.二级属性名}
- 方法二:封装全部数据到Environment对象
Environment数据类型 结合 @Autowired 注解调用
- 方法三:自定义对象封装指定数据
将yml文件中的要读取的信息封装为实体类进行访问
- 自定义对象封装指定数据警告解决方案:添加相关依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
4.多环境开发配置
- yaml格式写法(示例)
- properties格式写法(示例)
- application.properties文件
spring.profiles.active=pro
- application-dev.properties文件
server.port=8080
- application-pro.properties文件
server.port=8081
- application-test.properties文件
server.port=8082
5.多环境命令行启动参数设置
- 多环境启动命令行格式
- 在设置中修改字符集,支持中文识别,防止打包失败
- 先执行 clean 指令防止上一次的操作影响到了打包后的运行结果,然后再执行 package 指令
- 在打包好的jar包文件路径上输入cmd进入命令行窗口
- 输入 java -jar d(jar包命名首字母),然后按tab建自动补全,敲回车,运行程序
- ctrl + c 终止程序,根据yaml配置输入更换开发环境命令行,回车运行
我们发现端口号由开发环境 dev 的 80 变成了 test 环境的 82
- ctrl + c 终止程序,输入修改端口号命令行,回车运行
我们发现 test 开发环境的端口号被改成了 88
- 命令行之所以能覆盖配置文件的优先是因为其优先级高
[以下为spring官网关于配置的优先级的叙述](https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.external-config)
6. 多环境开发兼容问题
- 情境导入
提出问题:
maven高级(可以在我博客主页中找到相关文章)中也涉及到了多环境开发,当maven中和SpringBoot中的yml配置同时出现多环境开发管理的时候(比如maven中主导开发环境为开发,而SpringBoot中的主导开发环境是测试),该如何解决这个冲突呢?
思考:
实际上,当我们的程序部署到服务器后是在服务器上用命令行运行,最终启动的是打包好的jar包,而不是本地的电脑编译器,执行package指令是maven的功能,所以当存在多环境开发兼容问题的时候maven应该起主导作用(maven负责管理版本,yml加载maven的版本)。
- 在pom.xml中设置当前开发环境为生产环境pro,在yml文件中设置开发环境为开发环境dev,示例代码如下:
<profiles>
<!--开发环境-->
<profile>
<id>dev</id>
<properties>
</properties>
</profile>
<!--生产环境-->
<profile>
<id>pro</id>
<properties>
</properties>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
</profile>
<!--测试环境-->
<profile>
<id>test</id>
<properties>
</properties>
</profile>
</profiles>
#设置启用的环境
spring:
profiles:
active: dev
---
#开发
spring:
profiles: dev
server:
port: 80
---
#生产
spring:
profiles: pro
server:
port: 81
---
#测试
spring:
profiles: test
server:
port: 82
---
- 执行maven的package指令,找到生成的jar包,在对应路径上输入cmd,回车,输入运行jar包的命令行,观察当 maven(默认环境是pro,对应服务器端口号为81)和 yaml(默认环境是dev,对应服务器端口号为80)同时存在多环境控制时默认开发环境是哪个
通过命令行运行结果我们发现此时默认端口号为80,yml的配置起了主导作用,因为此时maven中的配置还没加载到yml配置文件中
- 将maven配置加载到yml配置文件中,然后将之前打包的jar包删掉,重新打包,再用命令行启动
我们发现此时的端口既不是有maven主导的pro生产环境(端口81),也不是有yml中的主导环境pre(端口80)
- 之所以端口号是8080的原因是因为yml中绑定的${profiles.active}没有解析,我们打开jar包中的BOOT-INF/classes目录中的application.yml文件可以验证这一点
- 解决方案:在pom.xml中添加解析插件并重新运行jar包,问题解决
<!--对资源文件开启对默认占位符的解析-->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>3.2.0</version>
<configuration>
<encoding>UTF-8</encoding>
<useDefaultDelimiters>true</useDefaultDelimiters>
</configuration>
</plugin>
7.配置文件分类
- 情景导入
产品测试的时候jar包运行命令行太多,操作麻烦,容易出错
- 配置文件分类
SpringBoot中4级配置文件:
1级[高]: file : config/application.yml
2级: file : application.yml
3级: classpath: config/application.yml
4级[低]: classpath: application.yml
作用:
1级与2级留做系统打包后设置通用属性
3级与4级用于系统开发阶段设置通用属性
- 3,4级配置文件优先级的探讨
- 2级配置文件优先级的探讨
- 1级配置文件优先级的探讨
- 在target目录下新建目录config, 并新建编辑一个默认端口号为89的application.yml配置文件,再次运行打包好的jar包
- 根据报错信息添加一个子目录
- 再次运行jar包
总结
欢迎各位留言交流以及批评指正,如果文章对您有帮助或者觉得作者写的还不错可以点一下关注,点赞,收藏支持一下。
(博客的参考源码可以在我主页的资源里找到,如果在学习的过程中有什么疑问欢迎大家在评论区向我提出)