应用中的配置文件
大约 4 分钟
注意
应用中的配置文件一般不用修改,初学者可以先跳过本章节。当您想进一步了解 Java 程序的配置时可以再来查看。
配置文件位于 jar 包的 BOOT-INF\classes
目录下,一共有两个配置文件,分别为 bootstrap.yml
和 application.yml
。
提示
- 在查看配置文件章节之前,您需要先学习 YAML 的语法规则
- 当使用 安装包部署 时,如果没有特殊需求,不需要修改这里的配置文件。
bootstrap.yml
引导程序配置文件会在程序启动初期生效,主要配置应用程序端口、应用名、注册中心、配置中心、日志输出等信息。
应用程序端口
每个应用程序的端口是固定的,请勿修改,配置方式如下:
server:
port: 8000
应用名称
每个应用程序的名称是固定的,请勿修改,配置方式如下:
spring:
application:
name: basic-paper-gateway
注册中心与配置中心
注册中心和配置中心我们都是用 nacos,不同环境区分使用 namespace
,我们一般不会使用到 group
,所以不用配置,使用默认值即可。配置方式如下所示:
spring:
cloud:
nacos:
server-addr: @nacos.addr@
namespace: @nacos.namespace@
username: @nacos.username@
password: @nacos.password@
discovery:
server-addr: ${spring.cloud.nacos.server-addr} # 注册中心地址
namespace: ${spring.cloud.nacos.namespace} # 命名空间,用于注册中心、配置中心的数据隔离(在同一个注册中心负责多个环境时极其重要),只读取此命名空间下的配置文件。
config:
server-addr: ${spring.cloud.nacos.discovery.server-addr}
file-extension: yaml
namespace: ${spring.cloud.nacos.discovery.namespace}
shared-configs:
- data-id: datasource.yaml # 导入通用数据源配置文件
- 注册中心配置一定以
spring.cloud.nacos
开头,在 yaml 中非常好分辨。 - 每个应用的配置中心配置会略有不同,一般都是
shared-configs
会有所不同,如果发现不一样请勿修改。 - 您只需修改 5-6 行(高亮部分中的
server-addr
、namespace
),其他行保持默认即可。 - 创建自己的命名空间,并配置到
namespace
属性中。 - 一定要创建一个项目专用的
namespace
,不要使用public
命名空间,如何创建命名空间请移步 命名空间管理。 - 如果是 nacos 集群,那么
server-addr
可以配置多个,用逗号分隔开。如:127.0.0.1:8848,127.0.0.2:8848
日志存储配置
日志框架我们使用 logback,可以直接在配置文件中配置,配置方式如下所示:
提示
这是目前的方案,以后融合日志收集和告警系统后可能会有修改
logging:
file:
path: @logging.filePath@ # 日志文件输出路径,请配置物理磁盘,防止日志写入延迟导致程序卡顿
bak-path: @logging.fileBakPath@ # 日志文件备份路径,可以配置网盘路径,用于备份使用
name: ${logging.file.path}/bp_customer.log # 日志的名称,非必要请勿修改
charset:
console: UTF-8 # 日志控制台输出编码,非必要请勿修改
file: UTF-8 # 日志文件编码,非必要请勿修改
logback:
rollingpolicy:
file-name-pattern: ${logging.file.bak-path}/bp_customer/${HOSTNAME}/%d{yyyy-MM-dd}/bp_customer.%d{yyyy-MM-dd}.%i.log.gz # 日志备份完整路径,非必要请勿修改
max-file-size: 50MB # 每个日志文件最大大小,非必要请勿修改
clean-history-on-start: true # 是否清理日志,非必要请勿修改
max-history: 90 # 日志留存数量,由于按照日期存储的日志,所以这里可以理解为日志留存时间
pattern:
dateformat: yyyy-MM-dd HH:mm:ss.SSSXXX # 日期格式化,请勿修改
- 注册中心配置一定以
logging
开头,在 yaml 中非常好分辨。 - 每个应用的配置中心配置会略有不同,一般都是 RPC 详细日志,如果发现不一样请勿修改。
- 您只需修改 3-4 行(高亮部分中的
path
、bak-path
),其他行保持默认即可。 - 日志文件输出路径(
path
),请配置物理磁盘,防止日志写入延迟导致程序卡顿 - 日志文件备份路径(
bak-path
),可以配置网盘路径,用于备份使用 - 可以根据客户的需求来修改日志保留多久,我们默认是 90 天。 第 14 行位置的
max-history
参数。
application.yml
应用配置文件用于配置框架内的一些配置,不需要做任何修改。有兴趣的可以查看应用配置文件(application.yml)了解详细信息。