Tomcat日志配置与优化指南

要使用Tomcat作为服务器将日志记录到文件中，您需要进行以下配置：

1. 添加日志依赖

首先确保您的项目中包含相应的日志框架依赖：

Maven配置 (pom.xml):

<dependencies>
    <!-- SLF4J API -->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
        <version>1.7.36</version>
    </dependency>
    
    <!-- Logback 实现 -->
    <dependency>
        <groupId>ch.qos.logback</groupId>
        <artifactId>logback-classic</artifactId>
        <version>1.2.11</version>
    </dependency>
</dependencies>

2. 配置 logback.xml

在 src/main/resources 目录下创建 logback.xml 文件：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 定义日志文件输出路径 -->
    <property name="LOG_HOME" value="${catalina.base}/logs" />
    <property name="APP_NAME" value="yourapp" />
    
    <!-- 控制台输出 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    
    <!-- 文件输出 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_HOME}/${APP_NAME}.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天滚动 -->
            <fileNamePattern>${LOG_HOME}/${APP_NAME}.%d{yyyy-MM-dd}.log</fileNamePattern>
            <!-- 保留30天的日志 -->
            <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    
    <!-- 特定包的日志级别和输出 -->
    <logger name="com.yourpackage.ClientController" level="INFO" additivity="false">
        <appender-ref ref="FILE" />
        <appender-ref ref="CONSOLE" />
    </logger>
    
    <!-- 根日志配置 -->
    <root level="INFO">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="FILE" />
    </root>
</configuration>

3. 优化您的日志代码

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.alibaba.fastjson.JSON;

public class ClientController {
    private static final Logger LOGGER = LoggerFactory.getLogger(ClientController.class);
    
    public void yourMethod() {
        Map<String, Object> map = new HashMap<>();
        // ... 填充map数据
        
        // 使用占位符方式记录日志，避免不必要的字符串拼接
        LOGGER.info("Request data: {}", JSON.toJSONString(map));
        
        // 或者如果需要更详细的日志级别控制
        if (LOGGER.isDebugEnabled()) {
            LOGGER.debug("Detailed request data: {}", JSON.toJSONString(map));
        }
    }
}

4. 替代方案：使用 log4j2

如果您更喜欢使用 log4j2，配置如下：

依赖：

<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-core</artifactId>
    <version>2.17.2</version>
</dependency>
<dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-slf4j-impl</artifactId>
    <version>2.17.2</version>
</dependency>

log4j2.xml 配置：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
        <RollingFile name="FileAppender" 
                     fileName="${sys:catalina.base}/logs/yourapp.log"
                     filePattern="${sys:catalina.base}/logs/yourapp-%d{yyyy-MM-dd}-%i.log">
            <PatternLayout>
                <Pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n</Pattern>
            </PatternLayout>
            <Policies>
                <TimeBasedTriggeringPolicy />
                <SizeBasedTriggeringPolicy size="100 MB"/>
            </Policies>
        </RollingFile>
    </Appenders>
    <Loggers>
        <Logger name="com.yourpackage.ClientController" level="info" additivity="false">
            <AppenderRef ref="FileAppender"/>
            <AppenderRef ref="Console"/>
        </Logger>
        <Root level="info">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>

5. 注意事项

1. 文件路径 ：使用 ${catalina.base}/logs 确保日志文件生成在Tomcat的logs目录下

2. 权限：确保Tomcat用户对日志目录有写权限

3. 日志轮转：配置合理的日志轮转策略，避免磁盘空间被占满

4. 敏感信息：不要在日志中记录密码等敏感信息

5. 性能：对于大对象，考虑在DEBUG级别记录详细日志