SpringBoot 集成ZooKeeper 框架实现LogBack 日志输出

系统管理员 2023-10-10 12:56 150阅读 0赞

今天之前公司的同事咨询一个关于Spring Boot 集成ZooKeeper 框架导致日志文件无法正常输出，让我排查问题。今天将解决过程记录下，以备不时之需。

第一步：审计Spring Boot依赖日志框架和ZooKeeper 依赖的日志框架

ZooKeeper 依赖的日志框架,通过[https://mvnrepository.com/][https_mvnrepository.com]查询相关jar ,可以很清楚ZooKeeper 依赖那些日志框架。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n_size_16_color_FFFFFF_t_70][]

通过上述截图:我们可以清楚知道ZooKeeper 框架依赖slf4j 和log4j 日志框架。

spring-boot-starter-web

spring-boot-starter

spring-boot-starter-logging

查询spring-boot-starter-logging 依赖的日志框架

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n_size_16_color_FFFFFF_t_70 1][]

通过上述截图:我们可以清楚知道spring-boot-starter-logging 框架依赖slf4j 和logback日志框架。

这样看来SpringBoot + ZooKeeper 出现日志框架冲突问题，需要排除log4j 框架。

我这里粘贴出Maven pom.xml 文件关于移除log4j 框架的依赖

<dependency>
    			<groupId>org.apache.zookeeper</groupId>
    			<artifactId>zookeeper</artifactId>
    			<version>3.4.8</version>
    			<exclusions>
    				<exclusion>
    					<groupId>org.slf4j</groupId>
    					<artifactId>slf4j-log4j12</artifactId>
    				</exclusion>
    			</exclusions>
    		</dependency>
    		<dependency>
    			<groupId>com.101tec</groupId>
    			<artifactId>zkclient</artifactId>
    			<version>0.7</version>
    			<exclusions>
    				<exclusion>
    					<groupId>org.slf4j</groupId>
    					<artifactId>slf4j-log4j12</artifactId>
    				</exclusion>
    			</exclusions>
    		</dependency>

但是我还发现朋友的项目依赖的jasperreports-6.10.0(报表Jar 包)依赖了另一个日志框架commons-logging，也要把它移除

<dependency>
    			<groupId>net.sf.jasperreports</groupId>
    			<artifactId>jasperreports</artifactId>
    			<version>6.10.0</version>
                <exclusions>
    				<exclusion>
    					<groupId>commons-logging</groupId>
    					<artifactId>commons-logging</artifactId>
    				</exclusion>
    			</exclusions>
    		</dependency>

LogBack.xml 配置文件，通用模板：

<?xml version="1.0" encoding="UTF-8"?> 
      
      
      
      
      
      
      
    <configuration>  
          
        <property name="log_dir" value="/logs/landray" />  
          
        <property name="maxHistory" value="30"/>  
      
      
          
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
              
            <encoder>  
                <pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger -%msg%n</pattern>  
            </encoder>  
        </appender>  
          
          
          
          
        <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">  
              
            <filter class="ch.qos.logback.classic.filter.LevelFilter">  
                <level>ERROR</level>  
                <onMatch>ACCEPT</onMatch>  
                <onMismatch>DENY</onMismatch>  
            </filter>  
              
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">  
                  
                <fileNamePattern>${log_dir}/%d{yyyy-MM-dd}/biz-error-log.log</fileNamePattern>  
                  
                <maxHistory>${maxHistory}</maxHistory>  
            </rollingPolicy>  
                      
            <encoder>  
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>  
            </encoder>  
        </appender>  
          
          
          
        <appender name="WARN" class="ch.qos.logback.core.rolling.RollingFileAppender">  
              
            <filter class="ch.qos.logback.classic.filter.LevelFilter">  
                <level>WARN</level>  
                <onMatch>ACCEPT</onMatch>  
                <onMismatch>DENY</onMismatch>  
            </filter>  
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">  
                <fileNamePattern>${log_dir}/%d{yyyy-MM-dd}/biz-warn-log.log  
                </fileNamePattern>  
                <maxHistory>${maxHistory}</maxHistory>  
            </rollingPolicy>  
            <encoder>  
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>  
            </encoder>  
        </appender>  
          
          
          
        <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">  
              
            <filter class="ch.qos.logback.classic.filter.LevelFilter">  
                <level>INFO</level>  
                <onMatch>ACCEPT</onMatch>  
                <onMismatch>DENY</onMismatch>  
            </filter>  
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">  
                <fileNamePattern>${log_dir}/%d{yyyy-MM-dd}/biz-info-log.log  
                </fileNamePattern>  
                <maxHistory>${maxHistory}</maxHistory>  
            </rollingPolicy>  
            <encoder>  
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>  
            </encoder>  
        </appender>  
          
          
          
        <appender name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">  
            <filter class="ch.qos.logback.classic.filter.LevelFilter">  
                <level>DEBUG</level>  
                <onMatch>ACCEPT</onMatch>  
                <onMismatch>DENY</onMismatch>  
            </filter>  
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">  
                <fileNamePattern>${log_dir}/%d{yyyy-MM-dd}/biz-debug-log.log  
                </fileNamePattern>  
                <maxHistory>${maxHistory}</maxHistory>  
            </rollingPolicy>  
            <encoder>  
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern>  
            </encoder>  
        </appender>  
        
        <logger name="org.springframework.web" value="DEBUG"/>
        <logger name="com.landray" value="DEBUG"/>
        <logger name="org.apache.commons.digester" value="DEBUG" />
    		
          
          
        <root level="WARN">  
              
            <appender-ref ref="STDOUT" />  
              
            <appender-ref ref="ERROR" />  
            <appender-ref ref="INFO" />  
            <appender-ref ref="WARN" />  
            <appender-ref ref="DEBUG" />  
        </root>  
    </configuration>

在application.properties 配置logback.xml 文件路径地址。

# 指定日志文件配置
    logging.config=classpath:logback.xml

注意:项目打包方式，决定日志启动方式。

项目war 包方式：不行进行额外配置，logback 日志功能自动生效

项目jar 包方式: 需要在启动.bat 程序中，配置--debug 参数，才能使logback 日志功能生效。

示例：

java -Xms512m -Xmx1024m -Xmn128m -jar -Dfile.encoding=UTF-8 **.jar --server.port=8715 --debug
    pause

[https_mvnrepository.com]: https://mvnrepository.com/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20210527142622471.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/2021052714301377.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n,size_16,color_FFFFFF,t_70