From e1d7d9b38f91983158c817c456bca99c0f3675b8 Mon Sep 17 00:00:00 2001
From: Ponfee <ponfee.cn@gmail.com>
Date: Fri, 23 Feb 2024 21:59:04 +0800
Subject: [PATCH] replace logback to log4j2

---
 disjob-admin/ruoyi-admin/pom.xml              | 20 ++++
 .../src/main/resources/application.yml        |  5 +-
 .../ruoyi-admin/src/main/resources/log4j2.xml | 59 ++++++++++++
 .../src/main/resources/logback.xml            | 95 -------------------
 disjob-samples/conf-common/log4j2.xml         | 24 ++++-
 5 files changed, 99 insertions(+), 104 deletions(-)
 create mode 100644 disjob-admin/ruoyi-admin/src/main/resources/log4j2.xml
 delete mode 100644 disjob-admin/ruoyi-admin/src/main/resources/logback.xml

diff --git a/disjob-admin/ruoyi-admin/pom.xml b/disjob-admin/ruoyi-admin/pom.xml
index 11f735b6d..dbbb27029 100644
--- a/disjob-admin/ruoyi-admin/pom.xml
+++ b/disjob-admin/ruoyi-admin/pom.xml
@@ -31,6 +31,26 @@
     <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-logging</artifactId>
+      <exclusions>
+        <exclusion>
+          <groupId>*</groupId>
+          <artifactId>*</artifactId>
+        </exclusion>
+      </exclusions>
+    </dependency>
+
+    <!-- apache log4j2 for log implementation -->
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-log4j2</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>jcl-over-slf4j</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>log4j-over-slf4j</artifactId>
     </dependency>
 
     <!-- SpringBoot集成thymeleaf模板 -->
diff --git a/disjob-admin/ruoyi-admin/src/main/resources/application.yml b/disjob-admin/ruoyi-admin/src/main/resources/application.yml
index e37e4f5aa..7993d699f 100644
--- a/disjob-admin/ruoyi-admin/src/main/resources/application.yml
+++ b/disjob-admin/ruoyi-admin/src/main/resources/application.yml
@@ -26,10 +26,7 @@ server:
       min-spare: 100
 
 # 日志配置
-logging:
-  level:
-    com.ruoyi: debug
-    org.springframework: warn
+logging.config: classpath:log4j2.xml
 
 # 用户配置
 user:
diff --git a/disjob-admin/ruoyi-admin/src/main/resources/log4j2.xml b/disjob-admin/ruoyi-admin/src/main/resources/log4j2.xml
new file mode 100644
index 000000000..e1261b7af
--- /dev/null
+++ b/disjob-admin/ruoyi-admin/src/main/resources/log4j2.xml
@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--日志级别以及优先级排序： OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
+<!-- Log4j 2.x 配置文件：每30秒自动检查和应用配置文件的更新；log4j-core-2.11.0.jar!/Log4j-config.xsd -->
+<Configuration status="WARN" monitorInterval="1800" strict="true" name="disjob-log">
+
+  <properties>
+    <!-- 系统属性变量：System.getProperty("log.home")，${sys:variable_name:-default_value} -->
+    <!-- pattern: https://logging.apache.org/log4j/2.x/manual/layouts.html -->
+    <property name="LOG_HOME">${sys:log.home:-../logs}</property>
+    <property name="APP_NAME">${sys:app.name:-disjob-admin}</property>
+    <property name="PATTERN_CONSOLE">%d{yyyy-MM-dd HH:mm:ss.SSS} | %highlight{%-5p} | %t | %c{1} >>>> %msg%n</property>
+    <property name="PATTERN_FILE">%d{yyyy-MM-dd HH:mm:ss.SSS} | %-5p | %pid | %t | %c{1} : %msg%n</property>
+  </properties>
+
+  <Appenders>
+    <Console name="Console" target="SYSTEM_OUT">
+      <PatternLayout pattern="${PATTERN_CONSOLE}" />
+    </Console>
+
+    <!-- 输出到文件，按天或者超过100MB分割 -->
+    <RollingFile name="RollingFile" fileName="${LOG_HOME}/${APP_NAME}.log" filePattern="${LOG_HOME}/$${date:yyyy-MM}/${APP_NAME}-%d{yyyy-MM-dd}-%i.log.gz">
+      <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
+      <ThresholdFilter level="INFO" onMatch="ACCEPT" onMismatch="DENY" />
+      <PatternLayout pattern="${PATTERN_FILE}" />
+      <Policies>
+        <!-- 启动时就重新滚动日志 -->
+        <!-- <OnStartupTriggeringPolicy /> -->
+
+        <!-- 如果启用此配置，则日志会按文件名生成新压缩文件，即如果filePattern配置的日期格式为 %d{yyyy-MM-dd HH}，
+             则每小时生成一个压缩文件，如果filePattern配置的日期格式为 %d{yyyy-MM-dd} ，则天生成一个压缩文件，
+             modulate=true用来调整时间，interval属性用来指定多久滚动一次，默认是1 hour，
+             比如现在是早上3am，interval=4，那么第一次滚动是在4am，接着是8am，而不是7am
+        -->
+        <!-- <TimeBasedTriggeringPolicy interval="1" modulate="true" /> -->
+        <TimeBasedTriggeringPolicy />
+
+        <SizeBasedTriggeringPolicy size="100 MB" />
+      </Policies>
+      <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件 -->
+      <DefaultRolloverStrategy max="100" />
+    </RollingFile>
+
+    <Async name="AsyncRollingFile">
+      <AppenderRef ref="RollingFile" />
+      <LinkedTransferQueue />
+    </Async>
+  </Appenders>
+
+  <Loggers>
+    <Logger name="com.ruoyi" level="INFO" />
+    <Logger name="cn.ponfee.disjob" level="INFO" />
+
+    <Root level="WARN">
+      <AppenderRef ref="Console" />
+      <AppenderRef ref="AsyncRollingFile" />
+    </Root>
+  </Loggers>
+
+</Configuration>
diff --git a/disjob-admin/ruoyi-admin/src/main/resources/logback.xml b/disjob-admin/ruoyi-admin/src/main/resources/logback.xml
deleted file mode 100644
index 229efa4fb..000000000
--- a/disjob-admin/ruoyi-admin/src/main/resources/logback.xml
+++ /dev/null
@@ -1,95 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<configuration>
-  <!-- 日志存放路径 -->
-  <property name="log.path" value="/Users/ponfee/logs"/>
-  <!-- 日志输出格式 -->
-  <property name="log.pattern" value="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - %msg%n"/>
-
-  <!-- 控制台输出 -->
-  <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
-    <encoder>
-      <pattern>${log.pattern}</pattern>
-    </encoder>
-  </appender>
-
-  <!-- 系统日志输出 -->
-  <appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender">
-    <file>${log.path}/sys-info.log</file>
-    <!-- 循环政策：基于时间创建日志文件 -->
-    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
-      <!-- 日志文件名格式 -->
-      <fileNamePattern>${log.path}/sys-info.%d{yyyy-MM-dd}.log</fileNamePattern>
-      <!-- 日志最大的历史 60天 -->
-      <maxHistory>60</maxHistory>
-    </rollingPolicy>
-    <encoder>
-      <pattern>${log.pattern}</pattern>
-    </encoder>
-    <filter class="ch.qos.logback.classic.filter.LevelFilter">
-      <!-- 过滤的级别 -->
-      <level>INFO</level>
-      <!-- 匹配时的操作：接收（记录） -->
-      <onMatch>ACCEPT</onMatch>
-      <!-- 不匹配时的操作：拒绝（不记录） -->
-      <onMismatch>DENY</onMismatch>
-    </filter>
-  </appender>
-
-  <appender name="file_error" class="ch.qos.logback.core.rolling.RollingFileAppender">
-    <file>${log.path}/sys-error.log</file>
-    <!-- 循环政策：基于时间创建日志文件 -->
-    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
-      <!-- 日志文件名格式 -->
-      <fileNamePattern>${log.path}/sys-error.%d{yyyy-MM-dd}.log</fileNamePattern>
-      <!-- 日志最大的历史 60天 -->
-      <maxHistory>60</maxHistory>
-    </rollingPolicy>
-    <encoder>
-      <pattern>${log.pattern}</pattern>
-    </encoder>
-    <filter class="ch.qos.logback.classic.filter.LevelFilter">
-      <!-- 过滤的级别 -->
-      <level>ERROR</level>
-      <!-- 匹配时的操作：接收（记录） -->
-      <onMatch>ACCEPT</onMatch>
-      <!-- 不匹配时的操作：拒绝（不记录） -->
-      <onMismatch>DENY</onMismatch>
-    </filter>
-  </appender>
-
-  <!-- 用户访问日志输出  -->
-  <appender name="sys-user" class="ch.qos.logback.core.rolling.RollingFileAppender">
-    <file>${log.path}/sys-user.log</file>
-    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
-      <!-- 按天回滚 daily -->
-      <fileNamePattern>${log.path}/sys-user.%d{yyyy-MM-dd}.log</fileNamePattern>
-      <!-- 日志最大的历史 60天 -->
-      <maxHistory>60</maxHistory>
-    </rollingPolicy>
-    <encoder>
-      <pattern>${log.pattern}</pattern>
-    </encoder>
-  </appender>
-
-  <!-- 系统模块日志级别控制  -->
-  <logger name="com.ruoyi" level="info"/>
-  <!-- Spring日志级别控制  -->
-  <logger name="org.springframework" level="warn"/>
-  <logger name="cn.ponfee.disjob.admin.mapper" level="debug"/>
-
-  <root level="info">
-    <appender-ref ref="console"/>
-  </root>
-
-  <!--系统操作日志-->
-  <root level="info">
-    <appender-ref ref="file_info"/>
-    <appender-ref ref="file_error"/>
-  </root>
-
-  <!--系统用户操作日志-->
-  <logger name="sys-user" level="info">
-    <appender-ref ref="sys-user"/>
-  </logger>
-
-</configuration>
diff --git a/disjob-samples/conf-common/log4j2.xml b/disjob-samples/conf-common/log4j2.xml
index 8734adfd1..3621c48a4 100644
--- a/disjob-samples/conf-common/log4j2.xml
+++ b/disjob-samples/conf-common/log4j2.xml
@@ -6,10 +6,12 @@
   <properties>
     <!-- 系统属性变量：System.getProperty("log.home")，${sys:variable_name:-default_value} -->
     <!-- pattern: https://logging.apache.org/log4j/2.x/manual/layouts.html -->
+    <!-- Replace ${sys:PID} with %pid in log4j2 configuration: https://github.com/spring-projects/spring-boot/issues/15426 -->
+    <!-- https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot/src/main/resources/org/springframework/boot/logging/log4j2/log4j2.xml -->
     <property name="LOG_HOME">${sys:log.home:-../logs}</property>
     <property name="APP_NAME">${sys:app.name:-disjob-samples}</property>
     <property name="PATTERN_CONSOLE">%d{yyyy-MM-dd HH:mm:ss.SSS} | %highlight{%-5p} | %t | %c{1} >>>> %msg%n</property>
-    <property name="PATTERN_FILE">%d{yyyy-MM-dd HH:mm:ss.SSS} | %-5p | ${sys:PID} | %t | %c{1} : %msg%n</property>
+    <property name="PATTERN_FILE">%d{yyyy-MM-dd HH:mm:ss.SSS} | %-5p | %pid | %t | %c{1} : %msg%n</property>
   </properties>
 
   <Appenders>
@@ -46,11 +48,24 @@
     </Async>
   </Appenders>
 
+  <!--
+  https://blog.csdn.net/HongZeng_CSDN/article/details/130094219
+  Root Logger：提供默认的Level和Appender设置，当一个普通Logger没有显式地设置Level或Appender时，则会继承Root Logger的设置
+  additivity：指定是否同时输出日志到父类的appender，缺省为true
+  Logger查找：沿着类路径(包路径)逐级向上查找匹配的Logger
+
+  Root Logger
+      ├── com.example (package)
+      │   ├── com.example.MyClass1 (class)
+      │   ├── com.example.MyClass2 (class)
+      │   └── ...
+      ├── com.example.subpackage (package)
+      │   ├── com.example.subpackage.MyClass3 (class)
+      │   └── ...
+      └── ...
+  -->
   <Loggers>
-    <!-- additivity指定是否同时输出日志到父类的appender，缺省为true -->
     <Logger name="cn.ponfee.disjob" level="INFO" />
-    <Logger name="com.zaxxer.hikari" level="INFO" />
-
     <!--
     <Logger name="cn.ponfee.disjob.registry" level="DEBUG" />
     <Logger name="cn.ponfee.disjob.supervisor" level="DEBUG" />
@@ -58,7 +73,6 @@
     <Logger name="cn.ponfee.disjob.worker" level="DEBUG" />
     -->
 
-    <!-- 当根据日志名字获取不到指定的日志器时就使用Root作为默认的日志器 -->
     <Root level="WARN">
       <AppenderRef ref="Console" />
       <AppenderRef ref="AsyncRollingFile" />