SpringBoot项目部署时application.yml文件的加载优先级和启动脚本问题

 更新时间:2024年09月22日 10:12:18   作者:苍煜  
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

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • spring boot Mybatis 拦截器实现拼接sql和修改的代码详解

    spring boot Mybatis 拦截器实现拼接sql和修改的代码详解

    这篇文章主要介绍了spring boot Mybatis 拦截器实现拼接sql和修改,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-05-05
  • SpringBoot整合Knife4j的实战示例

    SpringBoot整合Knife4j的实战示例

    Knife4j是一个为Java MVC框架集成Swagger生成API文档的增强解决方案,本文就来介绍一下SpringBoot整合Knife4j的实战示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2025-08-08
  • 解决java字符串转换成时间Unparseable date出错的问题

    解决java字符串转换成时间Unparseable date出错的问题

    这篇文章主要介绍了解决java字符串转换成时间Unparseable date出错的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-06-06
  • SpringSecurity实现多种身份验证方式

    SpringSecurity实现多种身份验证方式

    本文主要介绍了SpringSecurity实现多种身份验证方式,包括表单的认证、HTTP基本认证、HTTP摘要认证、证书认证、OpenIDConnect或OAuth2.0的认证、记住我功能和LDAP认证,感兴趣的可以了解一下
    2025-03-03
  • 详解Java信号量Semaphore的原理及使用

    详解Java信号量Semaphore的原理及使用

    Semaphore来自于JDK1.5的JUC包,直译过来就是信号量,被作为一种多线程并发控制工具来使用。本文将详解其原理与使用方法,感兴趣的可以学习一下
    2022-05-05
  • 基于自定义BufferedReader中的read和readLine方法

    基于自定义BufferedReader中的read和readLine方法

    下面小编就为大家分享一篇基于自定义BufferedReader中的read和readLine方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2017-12-12
  • Java实现同步枚举类数据到数据库

    Java实现同步枚举类数据到数据库

    这篇文章主要为大家详细介绍了Java实现同步枚举类数据到数据库,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-08-08
  • 详解Java多线程编程中互斥锁ReentrantLock类的用法

    详解Java多线程编程中互斥锁ReentrantLock类的用法

    Java多线程并发的程序中使用互斥锁有synchronized和ReentrantLock两种方式,这里我们来详解Java多线程编程中互斥锁ReentrantLock类的用法:
    2016-07-07
  • Java从入门到起飞之数组使用详解

    Java从入门到起飞之数组使用详解

    这篇文章主要介绍了Java从入门到起飞之数组使用的相关资料,包括数组的声明、初始化、长度、索引、遍历和默认值等内容,还介绍了Arrays工具类中常用的方法,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2025-03-03
  • springboot中使用雪花算法生成雪花ID

    springboot中使用雪花算法生成雪花ID

    本文主要介绍了springboot中使用雪花算法生成雪花ID,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-03-03

最新评论