SpringBoot 项目打包war 包部署Tomcat,logback 日志记录不生效解决办法

逃离我推掉我的手 2023-10-10 12:57 9阅读 0赞

今天在将自己编写一个小功能的SpringBoot 项目部署至Tomcat 中，日志是采用logback。 项目在eclipse 中正常输出相关日志信息但是在Tomcat 中，日志没有正常输出，今天将遇到的情况总计，以备后续参考。

现将我解决的步骤逐一说明和讲解。

## 第一步:移除内嵌Tomcat和添加javax.servlet ##

<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-web</artifactId>
    			
     
    			<exclusions>
    				<exclusion>
    					<groupId>org.springframework.boot</groupId>
    					<artifactId>spring-boot-starter-tomcat</artifactId>
    				</exclusion>
    			</exclusions>
    		</dependency>
    		
    		<dependency>
    		    <groupId>javax.servlet</groupId>
    		    <artifactId>javax.servlet-api</artifactId>
    		    <scope>provided</scope>
    		</dependency>

## 第二步:移除application.properties 配置文件中的logging.config 属性 ##

![20210531153155210.png][]

## 第三步:继承SpringBootServletInitializer 类，覆写protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) 方法，在该方法中使用System.setProperty("logging.config", "classpath:logback.xml"); 设置日志文件信息 ##

import javax.servlet.ServletContext;
    import javax.servlet.ServletException;
    
    import org.mybatis.spring.annotation.MapperScan;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.boot.builder.SpringApplicationBuilder;
    import org.springframework.boot.web.support.SpringBootServletInitializer;
    import org.springframework.context.ApplicationContext;
    import org.springframework.transaction.annotation.EnableTransactionManagement;
    import org.springframework.web.context.support.WebApplicationContextUtils;
    
    import com.zzg.common.util.SpringContextUtil;
    
    /**
     * 系统服务提供者
     * 
     * @author zzg
     *
     */
    @SpringBootApplication
    @EnableTransactionManagement
    @MapperScan("com.zzg.ucas.mapper")
    public class Provider extends SpringBootServletInitializer {
    
    	public static void main(String[] args) {
    		ApplicationContext applicationContext = SpringApplication.run(Provider.class, args);
    		SpringContextUtil.setApplicationContext(applicationContext);
    		// 代码设置日志
    		System.setProperty("logging.config", "classpath:logback.xml"); 
    		System.out.println("============= SpringBoot gcxt-system-provider Service Start Success =============");
    	}
    
    	@Override
    	protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
    		// 代码设置日志
    		System.setProperty("logging.config", "classpath:logback.xml"); 
    		// 注意这里要指向原先用main方法执行的Application启动类
    		return builder.sources(Provider.class);
    	}
    
    	@Override
    	public void onStartup(ServletContext servletContext) throws ServletException {
    		super.onStartup(servletContext);
    		SpringContextUtil
    				.setApplicationContext(WebApplicationContextUtils.getRequiredWebApplicationContext(servletContext));
    	}
    
    }

注意: 在main 方法及其 configure(SpringApplicationBuilder builder) 方法中都是System.setProperty 方法设置日志文件路径地址。意味着在Eclipse 编辑器中启动Spring Boot项目和Tomcat 部署SpringBoot 项目都不需要在application.properties 文件中涉及logging.config配置。

## 第四步:在Spring Boot 项目中的resource 文件夹中新增logback.xml 配置文件。 ##

<?xml version="1.0" encoding="UTF-8"?> 
      
      
      
      
      
      
      
    <configuration scan="true" scanPeriod="60 seconds" debug="false">  
          
        <property name="log_dir" value="/logs/provider" />  
          
        <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}/neo4j-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}/neo4j-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}/neo4j-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}/neo4j-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="java.sql.PreparedStatement" value="DEBUG" />    
        <logger name="java.sql.Connection" value="DEBUG" />    
        <logger name="java.sql.Statement" value="DEBUG" />    
        <logger name="com.ibatis" value="DEBUG" />    
        <logger name="com.ibatis.common.jdbc.SimpleDataSource" value="DEBUG" />    
        <logger name="com.ibatis.common.jdbc.ScriptRunner" level="DEBUG"/>    
        <logger name="com.ibatis.sqlmap.engine.impl.SqlMapClientDelegate" value="DEBUG" />    
        <logger name="org.springframework.web" level="DEBUG"/>
        <logger name="com.zzg" level="DEBUG"/>
    	<logger name="org.apache.commons.digester" />	
          
          
        <root level="INFO">  
              
            <appender-ref ref="STDOUT" />  
              
            <appender-ref ref="ERROR" />  
            <appender-ref ref="INFO" />  
            <appender-ref ref="WARN" />  
            <appender-ref ref="DEBUG" />  
        </root>  
    </configuration>

针对这个问题，参考网上文章：[解决 WAR 部署方式下日志配置不生效的问题][WAR]

针对作者给出的解决思路，我验证以下几种方式:

第一种：使用Tomcat 默认加载日志文件名称，log4j2的log4j2.properties或log4j2.xml或logback的logback.xml.

结果：日志在Tomcat没有成功记录。

第二种:提升logging.config的优先级

作者给出的解决思路是：在Tomcat\\bin\\catalina.bat 文件中添加启动日志参数配置

-Dlogging.config=classpath:logging-config.xml

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n_size_16_color_FFFFFF_t_70][]

我给出的解决思路是：通过System.setProperty 设置logging.config 来提升优先级。

[20210531153155210.png]: https://img-blog.csdnimg.cn/20210531153155210.png
[WAR]: https://blog.csdn.net/ttyy1112/article/details/90641878
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20210531155311582.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pob3V6aGl3ZW5nYW5n,size_16,color_FFFFFF,t_70