springboot配置多环境日志打印
springboot配置多环境日志打印
-
为什么要配置？
一般开发用windows ，而程序最终多在linux系统上运行，每次打包发布都要更改对应的配置信息。
-
有几种方法可以实现？
目前常见的有两种方法，一种是基于logback-spring.xml文件中来配置，优点是只有一个文件，缺点是要共用一部分模版配置，另一种是定义不同的Logback配置文件，优点可以针对不同的条件激活不同的配置，缺点是文件过多。其实两个原理是一样的，把日志托管给spring。
-
需要引用哪些依赖？
需要引用日志模块，但是已经包含在springboot-start里面了。
通过不同的文件来达到多环境配置
-
首先在resources新建log文件夹并分在文件夹中别创建logback-dev.xml ,logback-test.xml ,logback-prod.xml文件
-- logback-dev.xml
debug ${CONSOLE_LOG_PATTERN} ${log.path}/white_dev_debug.log %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n UTF-8 ${log.path}/white-dev-debug-%d{yyyy-MM-dd}.%i.log 100MB 15 debug ACCEPT DENY ${log.path}/white_dev_info.log ${FILE_LOG_PATTERN} UTF-8 ${log.path}/white-dev-info-%d{yyyy-MM-dd}.%i.log 100MB 15 info ACCEPT DENY ${log.path}/white_dev_warn.log ${FILE_LOG_PATTERN} UTF-8 ${log.path}/white-dev-warn-%d{yyyy-MM-dd}.%i.log 100MB 15 warn ACCEPT DENY ${log.path}/white_dev_error.log ${FILE_LOG_PATTERN} UTF-8 ${log.path}/white-dev-error-%d{yyyy-MM-dd}.%i.log 100MB 15 ERROR ACCEPT DENY -- logback-test.xml
debug ${CONSOLE_LOG_PATTERN} ${log.path}/white_test_debug.log %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n UTF-8 ${log.path}/white-test-debug-%d{yyyy-MM-dd}.%i.log 100MB 15 debug ACCEPT DENY ${log.path}/white_test_info.log ${FILE_LOG_PATTERN} UTF-8 ${log.path}/white-test-info-%d{yyyy-MM-dd}.%i.log 100MB 15 info ACCEPT DENY ${log.path}/white_test_warn.log ${FILE_LOG_PATTERN} UTF-8 ${log.path}/white-test-warn-%d{yyyy-MM-dd}.%i.log 100MB 15 warn ACCEPT DENY ${log.path}/white_test_error.log ${FILE_LOG_PATTERN} UTF-8 ${log.path}/white-test-error-%d{yyyy-MM-dd}.%i.log 100MB 15 ERROR ACCEPT DENY -- logback-prod.xml
info ${CONSOLE_LOG_PATTERN} ${log.path}/white_prod_debug.log %d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n UTF-8 ${log.path}/white-prod-debug-%d{yyyy-MM-dd}.%i.log 100MB 15 debug ACCEPT DENY ${log.path}/white_prod_info.log ${FILE_LOG_PATTERN} UTF-8 ${log.path}/white-prod-info-%d{yyyy-MM-dd}.%i.log 100MB 15 info ACCEPT DENY ${log.path}/white_prod_warn.log ${FILE_LOG_PATTERN} UTF-8 ${log.path}/white-prod-warn-%d{yyyy-MM-dd}.%i.log 100MB 15 warn ACCEPT DENY ${log.path}/white_prod_error.log ${FILE_LOG_PATTERN} UTF-8 ${log.path}/white-prod-error-%d{yyyy-MM-dd}.%i.log 100MB 15 ERROR ACCEPT DENY -
在resources中创建logback-spring.xml文件,主要是根据不同的spring.profiles.active引入不同的文件到logback-spring.xml中来实现控制，内容如下
logback -- 说明
a. spring.profiles.active定义在application文件中的话，并不会生效，Logback只会去加载名为 logback-spring.profiles.active_IS_UNDEFINED.xml 的文件，需要设置其系统环境变量方可生效。可以通过
来设置 b. springboot2 日志规划有所改变，只有TRACE才能提供更加详细的信息
至此完成了相关配置。
**- 也可以每个配置文件都写成完成的logback.xml格式，通过配置不同的logging.config来实现 **
# dev logging: config: classpath:log/logback-dev.xml # test logging: config: classpath:log/logback-test.xml # prod logging: config: classpath:log/logback-prod.xml
基于logback-spring.xml实现多环境配置
logback
${log.pattern}
UTF-8
${log.path}/log.log
${log.pattern}
UTF-8
${log.path}/file/log-%d{yyyy-MM-dd}.log
15
从上述配置中，可以看到定义了两个appender：一个叫做CONSOLE，用于把日志输出到控制台；另一个叫做FILE，用于把日志输出到文件中。同时还定义了两个不同环境的root配置：dev环境下，给root添加了叫做CONSOLE的appender；test环境下，给root添加了叫做FILE的appender。
通过指定application配置文件中的 spring.profiles.active=dev 或者通过指令 java -jar xx.jar --spring.profiles.active=dev 运行程序时，会发现日志只在控制台输出。同样的，当指定为test环境时，日志也只在文件中输出。
PS：输出到文件的appender，只要其配置生效，即使在当前的环境下，并未使用，也会生成相应的目录和文件信息。
配置属性说明
-
logging.file，设置文件，可以是绝对路径，也可以是相对路径。如：
logging.file=my.log -
logging.path，设置目录，会在该目录下创建spring.log文件，并写入日志内容，如：
logging.path=/var/log如果只配置 logging.file，会在项目的当前路径下生成一个 xxx.log 日志文件。
如果只配置 logging.path，在 /var/log文件夹生成一个日志文件为 spring.log注：二者不能同时使用，如若同时使用，则只有logging.file生效
-
Spring Boot官方推荐优先使用带有
-spring的文件名作为你的日志配置（如使用logback-spring.xml，而不是logback.xml），命名为logback-spring.xml的日志配置文件，spring boot可以为它添加一些spring boot特有的配置项,上面是默认的命名规则，并且放在src/main/resources下面即可。 -
如果你即想完全掌控日志配置，但又不想用
logback.xml作为Logback配置的名字，可以在application.properties配置文件里面通过logging.config属性指定自定义的名字：虽然一般并不需要改变配置文件的名字，但是如果你想针对不同运行时Profile使用不同的日志配置 -
logback相关字段说明
addtivity:是否向上级logger传递打印信息。默认是true。- scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
- scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。
- debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。