SpringBoot项目部署时application.yml文件的加载优先级和启动脚本问题
作者:苍煜
Spring Boot在启动时会根据一定的优先级顺序加载配置文件,优先级从高到低依次是:命令行参数、Jar包外部config目录下的配置文件、Jar包同级目录下的配置文件、classpath下的/config目录、classpath根路径
application.yml文件的加载优先级(由高到低)
第一级命令行参数
java -jar demo.jar --spring.config.location=/path/to/application.yml
- 这个是在系统启动参数中直接指定,这个一般不用
第二级Jar包同级目录 /config
/path/to/demo.jar---jar包位置 /path/to/config/application.yml---配置文件位置
- 2级与3级留做系统打包后设置通用属性,2级常用于运维经理进行线上整体项目部署方案调控,
如下是 Jar包同级目录/config的情况,在**/config**文件夹下配置了的话,会覆盖外面application.yml的配置和jar包内部的application.yml配置
第三级Jar包同级目录
/path/to/demo.jar---jar包位置 /path/to/application.yml---配置文件位置
- 2级与3级留做系统打包后设置通用属性,3级服务于运维人员配置涉密线上环境
如下是Jar包同级目录的情况,会将配置的内容替换jar包里面原有的application.yml配置
第四级classpath 下的/config
src/main/resources/config/application.yml
- 4级和5级用于系统开发阶段设置通用属性,4级常用于项目经理进行整体项目属性调控
第五级classpath 根路径/
src/main/resources/application.yml
- 4级和5级用于系统开发阶段设置通用属性,5级服务于开发人员本机开发与测试
总结:
- 多层级配置文件间的属性采用叠加并覆盖的形式作用于程序。
- 如果同一个目录下,有application.yml也有application.properties,默认先读取application.properties。
- 如果同一个配置属性,在多个配置文件都配置了,默认使用第1个读取到的,后面读取的不覆盖前面读取到的。
- 先后加载顺序:若application 和bootstrap 在同一目录下:bootstrap先加载 application后加载
logback.xml 文件加载顺序
Spring Boot 在部署时会按照特定的顺序尝试加载 logback.xml 配置文件。以下是加载 logback.xml 的常见位置和加载顺序:
- 外部配置文件:通过命令行参数指定的外部配置文件。例如,使用 --spring.config.location 参数指定配置文件路径。
- 当前目录下的 /config 子目录
- 当前目录
- 类路径下的 /config 包
- 类路径的根目录
logback.xml 将会按照上述顺序依次查找,并使用找到的第一个配置文件。
如果你想要指定 logback.xml 的加载位置,可以在启动 Spring Boot 应用时通过命令行参数 --spring.config.location 指定。
例如:
java -jar demo.jar --spring.config.location=file:/path/to/config/
注意:
- springboot在启动初,会加载内部的logback.xml,完全启动后,才会加载外部的logback.xml,所以最好保持两者一致
当application.yml 和 bootstrap.yml 同时存在时
- 则bootStrap.yml 的加载顺序要于application.yml,即bootStrap.yml 会优先被加载。
原理:
- bootstrap.yml 于应程序上下的引导阶段。
- bootstrap.yml 由Spring ApplicationContext加载。
- bootstrap.yml 可以理解成系统级别的⼀些参数配置,这些参数⼀般是不会变动的。
- application.yml 可以⽤来定义应⽤级别的,如果搭配 spring-cloud-config 使用 application.yml 定义的文件可以实现动态替换。
java jar包启动脚本
最简单的启动脚本
java -jar demo.jar
后台运行并打印日志
#日志打印输出 nohup java -jar demo.jar >nohup.log 2>&1 &
一个通用脚本
- jar包同级目录下创建logs文件夹
- jar包同级目录下创建config文件夹,包含application.yml 和logback.xml 文件,给777权限
脚本如下:
#!/bin/sh # 该脚本为Linux下启动java程序的脚本 # # 特别注意: # 该脚本使用系统kill命令来强制终止指定的java程序进程。 # 所以在杀死进程前,可能会造成数据丢失或数据不完整。如果必须要考虑到这类情况,则需要改写此脚本, # # # 根据实际情况来修改以下配置信息 ################################## # JAVA应用程序的名称 APP_NAME=xxxx系统 BASEPATH=$(cd `dirname $0`;pwd) # jar包名称-记得更改 JAR_NAME=demo.jar # PID 代表是PID文件 JAR_PID=$JAR_NAME\.pid # java虚拟机启动参数 JAVA_OPTS="-Xms512m -Xmx2048m -XX:MetaspaceSize=512m -XX:MaxMetaspaceSize=512m -XX:ParallelGCThreads=16 -XX:+PrintGCDateStamps -XX:+PrintGCDetails -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=utf-8" # 根据实际情况来修改以上配置信息 ################################## # 检查程序是否处于运行状态 is_exist() { # 查询出应用服务的进程id,grep -v 是反向查询的意思,查找除了grep操作的run.jar的进程之外的所有进程 pid=`ps -ef|grep $JAR_NAME|grep -v grep|awk '{print $2}' ` # [ ]表示条件测试。注意这里的空格很重要。要注意在'['后面和']'前面都必须要有空格 # [ -z STRING ] 如果STRING的长度为零则返回为真,即空是真 # 如果不存在返回0,存在返回1 if [ -z "${pid}" ]; then return 0 else return 1 fi } # ######### Shell脚本中$0、$?、$!、$$、$*、$#、$@等的说明 ######### # $$ Shell本身的PID(ProcessID,即脚本运行的当前 进程ID号) # $! Shell最后运行的后台Process的PID(后台运行的最后一个进程的 进程ID号) # $? 最后运行的命令的结束代码(返回值)即执行上一个指令的返回值 (显示最后命令的退出状态。0表示没有错误,其他任何值表明有错误) # $- 显示shell使用的当前选项,与set命令功能相同 # $* 所有参数列表。如"$*"用「"」括起来的情况、以"$1 $2 … $n"的形式输出所有参数,此选项参数可超过9个。 # $@ 所有参数列表。如"$@"用「"」括起来的情况、以"$1" "$2" … "$n" 的形式输出所有参数。 # $# 添加到Shell的参数个数 # $0 Shell本身的文件名 # $1~$n 添加到Shell的各参数值。$1是第1参数、$2是第2参数…。 # 服务启动方法 start() { is_exist if [ $? -eq "1" ]; then echo "$APP_NAME is already running pid is ${pid}" else # jar服务启动脚本 nohup java $JAVA_OPTS -jar -Dlogging.config=./config/logback.xml $BASEPATH/$JAR_NAME >> ${BASEPATH}/logs/nohup.out 2>&1 & echo $! > $JAR_PID echo "start $APP_NAME successed pid is $! " tail -100f ${BASEPATH}/logs/nohup.out fi } # 服务停止方法 stop() { # is_exist pidf=$(cat $JAR_PID) # echo "$pidf" echo "pid = $pidf begin kill $pidf" kill $pidf rm -rf $JAR_PID sleep 2 # 判断服务进程是否存在 is_exist if [ $? -eq "1" ]; then echo "pid = $pid begin kill -9 $pid" kill -9 $pid sleep 2 echo "$APP_NAME process stopped!" else echo "$APP_NAME is not running!" fi } # 服务运行状态查看方法 status() { is_exist if [ $? -eq "1" ]; then echo "$APP_NAME is running,pid is ${pid}" else echo "$APP_NAME is not running!" fi } # 重启服务方法 restart() { # 调用服务停止命令 stop # 调用服务启动命令 start } # 帮助说明,用于提示输入参数信息 usage() { echo "Usage: sh run-service.sh [ start | stop | restart | status ]" exit 1 } ################################### # 读取脚本的第一个参数($1),进行判断 # 参数取值范围:{ start | stop | restart | status } # 如参数不在指定范围之内,则打印帮助信息 ################################### #根据输入参数,选择执行对应方法,不输入则执行使用说明 case "$1" in 'start') start ;; 'stop') stop ;; 'restart') restart ;; 'status') status ;; *) usage ;; esac exit 0
总结
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。