spring-logback引用外部文件

配景

        在spring微服务开发和云摆设中，都涉及到日志的收集，很多时间为例方便管理和开发，很多公司都会开发一些基础配置代码。其中日志就是很重要的部分，
        为了方便摆设、收集、查看，以是日志文件必要存储在同一个目次下，且日志格式必须是雷同的。
        但是在微服务开发中，如果每个服务都自己创建的logback-spring.xml文件并配置信息，难免会出现错误大概遗漏的地方。以是必要统一的logback-spring.xml配置，但是由于某些必要，可能服务又会有自己独特的日志文件记载。以是必要日志打印不能请控制，必须未服务留有肯定的自主控制。
原理

        基于以上的要求，使用logback配置文件的继承方式，既可以统一必要的日志的打印存储方式，又可以在肯定水平上给与服务自主开发的空间。
        由于必要引入springboot的一些配置项，以是我们使用spring-logback.xml配置。由于加载顺序：logback.xml > application.properties/application.yaml > logback-spring.xml
logback的引用实现

        logback引入其他的配置项使用<included></included> 和 <include></include> 来实现。
从文件中包罗

1. <include file="src/main/java/com/xxxx/configuration/includedConfig.xml"/>

复制代码

特别留意一点 ：logback-include.xml 在 maven 中 , 不能直接放在 src/resouces 路径下 。
如许的情况就是 , logback-include.xml 在 jar 的根路径中 , 但不是跟 logback.xml 同一目次 . 在没有路径的情况下 , 默认只会去找同目次下的文件 . 就找不到jar包里的了 。
   <!-- logback.xml -->
  <configuration>
          <!-- 这么配置 , 只会找同目次下的文件 -->
          <include resource="logback-include.xml" />
  </configuration>
  从 classpath 中包罗

1. <include resource="includedConfig.xml"/>

复制代码

从 URL 中包罗

1. <include url="http://some.host.com/includedConfig.xml"/>

复制代码

如果包罗不乐成，那么 logback 会打印出一条警告信息，如果不盼望 logback 抱怨，只需如许做：

1. <include optional="true" ..../>

复制代码

实现方式 

公共基础配置

        先新建一个基础配置模块，这个模块将被打成jar包，并在其他项目中被引用，这个项目中包括了基础的日志配置，配置信息如下：
logback-base.xml

1. <included>
3.     <contextName>${APPLICATION_NAME}</contextName>
4.     <springProperty name="APPLICATION_NAME" scope="context" source="spring.application.name" defaultValue="core-logback-base"/>
5.     <springProperty name="LOG_PATH" scope="context" source="logging.file" defaultValue="./log/application/${SERVICE_NAME}"/>
6.     <springProperty name="LOG_MAX_FILE_SIZE" scope="context" source="logback.file.size" defaultValue="50MB"/>
7.     <springProperty name="LOG_FILE_MAX_TIME" scope="context" source="logback.file.maxTime" defaultValue="24"/>
8.     <springProperty name="LOG_FILE_TIME_FORMAT" scope="context" source="logback.file.timeFormat" defaultValue="yyyy-MM-dd'T'HH"/>
9.     <springProperty name="ServerIP" scope="context" source="spring.cloud.client.ip-address" defaultValue="0.0.0.0"/>
10.     <springProperty name="ServerPort" scope="context" source="server.port" defaultValue="0000"/>
12.     <property name="SERVICE_NAME" value="${APPLICATION_NAME}"/>
13.     <property name="LOG_PATTERN" value="[${SERVICE_NAME}] [%d{yyyy-MM-dd HH:mm:ss.SSS}] [%thread] %-5level %logger{30}: %line - %msg %n"/>
15.     <appender name ="InfoLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
16.         <!--指定日志路径和名称-->
17.         <file>${LOG_PATH}/${SERVICE_NAME}-info.log</file>
18.         <!--是否使用追加日志的方式-->
19.         <append>true</append>
20.         <!--级别过滤器，只打印指定级别的日志-->
21.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
22.             <level>INFO</level>
23.             <onMatch>ACCEPT</onMatch>
24.             <onMismatch>DENY</onMismatch>
25.         </filter>
26.         <!-- 当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名 -->
27.         <!--SizeAndTimeBasedRollingPolicy 它根据时间来制定滚动策略，也限制每个文件的大小，既负责滚动也负责出发滚动-->
28.         <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
29.             <!--每天生成一个日志文件，保存maxHistory天的日志文件-->
30.             <!--<fileNamePattern>${LOG_PATH}/rollingFileAppender.%d{yyyy-MM-dd}.log</fileNamePattern>-->
31.             <!--每个分钟生成一个日志文件，保存maxHistory小时的日志文件-->
32.             <!--<fileNamePattern>${LOG_PATH}/rollingFileAppender.%d{yyyy-MM-dd'T'HH}.-%i.log</fileNamePattern>-->
33.             <!--每个小时生成一个日志文件，保存maxHistory分钟的日志文件,并且将及时日志文件进行压缩zip-->
34.             <fileNamePattern>${LOG_PATH}/${SERVICE_NAME}.info.%d{${LOG_FILE_TIME_FORMAT}}.log%i.zip</fileNamePattern>
35.             <!--限制每一个log文件的大小-->
36.             <maxFileSize>100MB</maxFileSize>
37.             <maxHistory>${LOG_FILE_MAX_TIME}</maxHistory>
38.         </rollingPolicy>
39.         <encoder>
40.             <!--日志格式-->
41.     　　　　　　<pattern>${LOG_PATTERN}</pattern>
42.     　　　　</encoder>
43.     </appender>
45.     <appender name ="ErrorLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
46.         <!--指定日志路径和名称-->
47.         <file>${LOG_PATH}/${SERVICE_NAME}-error.log</file>
48.         <!--是否使用追加日志的方式-->
49.         <append>true</append>
50.         <!--级别过滤器，只打印指定级别的日志-->
51.         <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
52.             <level>ERROR</level>
53.         </filter>
54.         <!-- 当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名 -->
55.         <!--SizeAndTimeBasedRollingPolicy 它根据时间来制定滚动策略，也限制每个文件的大小，既负责滚动也负责出发滚动-->
56.         <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
57.             <!--每天生成一个日志文件，保存maxHistory天的日志文件-->
58.             <!--<fileNamePattern>${LOG_PATH}/rollingFileAppender.%d{yyyy-MM-dd}.log</fileNamePattern>-->
59.             <!--每个分钟生成一个日志文件，保存maxHistory小时的日志文件-->
60.             <!--<fileNamePattern>${LOG_PATH}/rollingFileAppender.%d{yyyy-MM-dd'T'HH}.-%i.log</fileNamePattern>-->
61.             <!--每个小时生成一个日志文件，保存maxHistory分钟的日志文件,并且将及时日志文件进行压缩zip-->
62.             <fileNamePattern>${LOG_PATH}/${SERVICE_NAME}.error.%d{${LOG_FILE_TIME_FORMAT}}.log%i.zip</fileNamePattern>
63.             <!--限制每一个log文件的大小-->
64.             <maxFileSize>100MB</maxFileSize>
65.             <maxHistory>24</maxHistory>
66.         </rollingPolicy>
67.         <encoder>
68.             <!--日志格式-->
69. 　　　　　　<pattern>${LOG_PATTERN}</pattern>
70. 　　　　 </encoder>
71.     </appender>
73.     <root level ="INFO">
74.         <appender-ref ref="InfoLog" level ="INFO"/>
75.         <appender-ref ref="ErrorLog" level ="ERROR"/>
76.     </root>
77. </included>

复制代码

 位置不要放在resources下，必要放在java目次或其子目次下，假设起路径是：
   com/test/core/log/xml/logback-base.xml
  引用基础配置

在其他的项目中，我们可以通过maven方式引入公共基础配置的jar包。然后在项目标resources新建logback-spring.xm引入基础配置，并加入自己的配置项。

1. <configuration scan="true" scanPeriod="60 seconds" debug="false">
2.     <include resource="com/test/core/log/xml/logback-base.xml"/>
4.     <!--输出到控制台-->
5.     <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
6.         <encoder>
7.             <pattern>${LOG_PATTERN}</pattern>
8.         </encoder>
9.     </appender>
11.     <root level ="INFO">
12.         <!-- 控制台打印方式 -->
13.         <appender-ref ref="CONSOLE" level="INFO"/>
14.     </root>
15. </configuration>

复制代码

同时在application.properties或application.yaml中配置日志文件方式：
   logging.config=classpath:logback.xml
  如许就完成了所有配置。 

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。