SpringBoot中14個(gè)日志使用技巧分享

更新時(shí)間：2025年05月08日 08:25:17 作者：風(fēng)象南

日志是軟件開(kāi)發(fā)中不可或缺的一部分,它能幫助我們了解應(yīng)用運(yùn)行狀態(tài)、調(diào)試問(wèn)題和監(jiān)控性能,下面我們來(lái)看看14個(gè)SpringBoot日志使用技巧,希望對(duì)大家有所幫助

1. 使用SLF4J門(mén)面模式統(tǒng)一日志API
2. 使用參數(shù)化日志替代字符串拼接
3. 使用條件日志避免高成本計(jì)算
4. 合理使用不同日志級(jí)別
5. MDC (Mapped Diagnostic Context) 上下文信息添加
6. 異常日志記錄最佳實(shí)踐
7. 使用日志標(biāo)記分類(lèi)信息
8. 結(jié)構(gòu)化日志輸出（JSON格式）
9. 實(shí)現(xiàn)自定義日志格式
10. 使用異步日志提升性能
11. 日志輸出敏感信息處理
12. 特定業(yè)務(wù)領(lǐng)域的日志上下文
13. 日志性能監(jiān)控與計(jì)時(shí)
14. 條件日志收集器
總結(jié)

日志是軟件開(kāi)發(fā)中不可或缺的一部分，它能幫助我們了解應(yīng)用運(yùn)行狀態(tài)、調(diào)試問(wèn)題和監(jiān)控性能。

在項(xiàng)目中，使用正確的使用和記錄日志不僅能提高代碼可維護(hù)性，還能在生產(chǎn)環(huán)境中更快地排查問(wèn)題。

1. 使用SLF4J門(mén)面模式統(tǒng)一日志API

SLF4J (Simple Logging Facade for Java) 提供了統(tǒng)一的日志API接口，讓你可以輕松切換底層日志實(shí)現(xiàn)。

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class UserService {
    // 獲取Logger實(shí)例
    private static final Logger logger = LoggerFactory.getLogger(UserService.class);
    
    public void createUser(User user) {
        logger.info("Creating user: {}", user.getUsername());
        // 業(yè)務(wù)邏輯
    }
}

最佳實(shí)踐：始終使用SLF4J作為日志門(mén)面，避免直接依賴(lài)具體實(shí)現(xiàn)如Log4j或Logback，這樣可以在不修改代碼的情況下切換底層日志框架。

2. 使用參數(shù)化日志替代字符串拼接

字符串拼接在日志中是常見(jiàn)的性能陷阱，正確的做法是使用參數(shù)化日志。

// 錯(cuò)誤示例 - 即使日志級(jí)別不滿(mǎn)足也會(huì)執(zhí)行字符串拼接
logger.debug("Processing order: " + order.getId() + " with amount: " + order.getAmount());

// 正確示例 - 只有在日志級(jí)別滿(mǎn)足時(shí)才會(huì)執(zhí)行參數(shù)替換
logger.debug("Processing order: {} with amount: {}", order.getId(), order.getAmount());

性能提升：參數(shù)化日志避免了不必要的字符串拼接操作，特別是當(dāng)日志級(jí)別高于DEBUG時(shí)，可以節(jié)省大量CPU資源。

3. 使用條件日志避免高成本計(jì)算

對(duì)于需要復(fù)雜計(jì)算的日志信息，應(yīng)該先檢查日志級(jí)別。

// 檢查日志級(jí)別再執(zhí)行耗時(shí)操作
if (logger.isDebugEnabled()) {
    logger.debug("Complex calculation result: {}", calculateExpensiveValue());
}

應(yīng)用場(chǎng)景：當(dāng)日志內(nèi)容需要復(fù)雜計(jì)算或資源密集型操作時(shí)，這一方法能顯著提高性能。

4. 合理使用不同日志級(jí)別

選擇正確的日志級(jí)別對(duì)于控制日志輸出量和重要性至關(guān)重要。

// 跟蹤詳細(xì)信息
logger.trace("Entering method with parameters: {}", params);

// 調(diào)試信息
logger.debug("Processing item at index: {}", index);

// 正常業(yè)務(wù)流程信息
logger.info("User {} successfully logged in", username);

// 警告信息
logger.warn("Database connection pool is running low: {} connections left", availableConnections);

// 錯(cuò)誤信息
logger.error("Failed to process transaction", exception);

最佳實(shí)踐：

• TRACE：僅用于非常詳細(xì)的診斷信息
• DEBUG：用于開(kāi)發(fā)和調(diào)試信息
• INFO：用于記錄正常業(yè)務(wù)流程
• WARN：潛在問(wèn)題但不影響正常運(yùn)行
• ERROR：錯(cuò)誤導(dǎo)致功能無(wú)法正常工作

5. MDC (Mapped Diagnostic Context) 上下文信息添加

MDC是一個(gè)非常強(qiáng)大的工具，可以在整個(gè)調(diào)用鏈上傳遞上下文信息。

import org.slf4j.MDC;

// 在請(qǐng)求處理開(kāi)始添加上下文
MDC.put("userId", user.getId());
MDC.put("requestId", UUID.randomUUID().toString());

try {
    // 業(yè)務(wù)邏輯處理
    logger.info("Processing user request");
    // 所有日志都會(huì)自動(dòng)包含MDC中的上下文信息
} finally {
    // 請(qǐng)求結(jié)束后清理上下文
    MDC.clear();
}

配置Logback輸出MDC信息：

<pattern>%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} [userId:%X{userId}, requestId:%X{requestId}] - %msg%n</pattern>

應(yīng)用場(chǎng)景：微服務(wù)架構(gòu)中的請(qǐng)求跟蹤、用戶(hù)操作審計(jì)、多租戶(hù)系統(tǒng)中的租戶(hù)識(shí)別。

6. 異常日志記錄最佳實(shí)踐

記錄異常時(shí)，既要提供上下文信息，也要包含完整的堆棧信息。

try {
    // 業(yè)務(wù)邏輯
} catch (DatabaseException e) {
    // 提供上下文和完整堆棧
    logger.error("Failed to save user data for userId: {}", userId, e);
    
    // 不要這樣做 - 丟失堆棧信息
    // logger.error("Failed to save user data: " + e.getMessage());
}

最佳實(shí)踐：始終將異常對(duì)象作為日志方法的最后一個(gè)參數(shù)，這樣可以捕獲完整堆棧信息。

7. 使用日志標(biāo)記分類(lèi)信息

在復(fù)雜系統(tǒng)中，可以使用標(biāo)記來(lái)分類(lèi)不同類(lèi)型的日志信息。

// 使用Logback的Marker功能
import org.slf4j.Marker;
import org.slf4j.MarkerFactory;

public class SecurityService {
    private static final Logger logger = LoggerFactory.getLogger(SecurityService.class);
    private static final Marker SECURITY_MARKER = MarkerFactory.getMarker("SECURITY");
    
    public void login(String username, boolean success) {
        logger.info(SECURITY_MARKER, "Login attempt: user={}, success={}", username, success);
    }
}

過(guò)濾特定標(biāo)記的日志：

<filter class="ch.qos.logback.core.filter.EvaluatorFilter">
    <evaluator>
        <expression>marker.contains("SECURITY")</expression>
    </evaluator>
    <OnMatch>ACCEPT</OnMatch>
    <OnMismatch>DENY</OnMismatch>
</filter>

8. 結(jié)構(gòu)化日志輸出（JSON格式）

在微服務(wù)環(huán)境中，結(jié)構(gòu)化日志便于集中式日志分析工具處理。

添加Logstash編碼器依賴(lài)：

<dependency>
    <groupId>net.logstash.logback</groupId>
    <artifactId>logstash-logback-encoder</artifactId>
    <version>7.2</version>
</dependency>

Logback配置：

<appender name="JSON" class="ch.qos.logback.core.ConsoleAppender">
    <encoder class="net.logstash.logback.encoder.LogstashEncoder">
        <includeMdcKeyName>userId</includeMdcKeyName>
        <includeMdcKeyName>requestId</includeMdcKeyName>
    </encoder>
</appender>

使用效果：所有日志將輸出為JSON格式，便于ELK或類(lèi)似系統(tǒng)解析。

9. 實(shí)現(xiàn)自定義日志格式

針對(duì)特定需求，可以創(chuàng)建自定義的日志格式。

// 創(chuàng)建自定義日志消息格式化器
public class CustomLogMessageFormatter {
    public static String formatTransaction(String txId, String status, long duration) {
        return String.format("TX[%s] completed with status %s in %dms", txId, status, duration);
    }
}

// 在代碼中使用
logger.info(CustomLogMessageFormatter.formatTransaction("TX12345", "SUCCESS", 134));

最佳實(shí)踐：對(duì)于頻繁使用的復(fù)雜日志格式，封裝成專(zhuān)用方法可以提高代碼可讀性和一致性。

10. 使用異步日志提升性能

日志I/O操作可能成為性能瓶頸，異步日志可以顯著提升應(yīng)用性能。

性能要求極高的場(chǎng)景推薦使用log4j2異步模式，性能遠(yuǎn)高于logback的異步模式。

Logback異步配置：

<appender name="ASYNC" class="ch.qos.logback.classic.AsyncAppender">
    <appender-ref ref="FILE" />
    <queueSize>512</queueSize>
    <discardingThreshold>0</discardingThreshold>
    <includeCallerData>false</includeCallerData>
</appender>
<root level="INFO">
    <appender-ref ref="ASYNC" />
</root>

性能提升：異步日志可以減少主線(xiàn)程的阻塞，在高并發(fā)系統(tǒng)中尤其有效。

11. 日志輸出敏感信息處理

處理用戶(hù)數(shù)據(jù)時(shí)，需要特別注意敏感信息的日志輸出。

// 創(chuàng)建敏感數(shù)據(jù)掩碼工具
public class LogMaskUtil {
    public static String maskCardNumber(String cardNumber) {
        if (cardNumber == null || cardNumber.length() < 8) {
            return "****";
        }
        return "****" + cardNumber.substring(cardNumber.length() - 4);
    }
    
    public static String maskEmail(String email) {
        if (email == null || email.isEmpty() || !email.contains("@")) {
            return "****@****.com";
        }
        String[] parts = email.split("@");
        return parts[0].substring(0, 1) + "***@" + parts[1];
    }
}

// 在日志中使用
logger.info("Processing payment for card: {}", LogMaskUtil.maskCardNumber(card.getNumber()));
logger.info("Sending confirmation to: {}", LogMaskUtil.maskEmail(user.getEmail()));

安全提示：永遠(yuǎn)不要在日志中記錄密碼、完整信用卡號(hào)、社會(huì)安全號(hào)碼等敏感信息，即使在開(kāi)發(fā)環(huán)境中也應(yīng)如此。

12. 特定業(yè)務(wù)領(lǐng)域的日志上下文

為不同業(yè)務(wù)領(lǐng)域創(chuàng)建專(zhuān)用的日志上下文，便于追蹤和分析。

// 創(chuàng)建業(yè)務(wù)上下文日志工具
public class OrderLogContext {
    private String orderId;
    private String customerId;
    private BigDecimal amount;
    
    public OrderLogContext(String orderId, String customerId, BigDecimal amount) {
        this.orderId = orderId;
        this.customerId = customerId;
        this.amount = amount;
    }
    
    public void setupContext() {
        MDC.put("orderId", orderId);
        MDC.put("customerId", customerId);
        MDC.put("amount", amount.toString());
    }
    
    public void clearContext() {
        MDC.remove("orderId");
        MDC.remove("customerId");
        MDC.remove("amount");
    }
    
    // 使用try-with-resources模式
    public static class LogContextResource implements AutoCloseable {
        private final OrderLogContext context;
        
        public LogContextResource(OrderLogContext context) {
            this.context = context;
            this.context.setupContext();
        }
        
        @Override
        public void close() {
            this.context.clearContext();
        }
    }
}

// 在代碼中使用
try (OrderLogContext.LogContextResource ignored = 
        new OrderLogContext.LogContextResource(new OrderLogContext(order.getId(), 
                                                                 order.getCustomerId(), 
                                                                 order.getAmount()))) {
    logger.info("Processing order");
    orderService.process(order);
    logger.info("Order completed successfully");
}

13. 日志性能監(jiān)控與計(jì)時(shí)

使用日志記錄操作執(zhí)行時(shí)間，幫助識(shí)別性能瓶頸。

// 簡(jiǎn)易性能日志
public class PerformanceLogger {
    private static final Logger logger = LoggerFactory.getLogger(PerformanceLogger.class);
    
    public static <T> T logExecutionTime(String operationName, Supplier<T> operation) {
        long startTime = System.currentTimeMillis();
        try {
            return operation.get();
        } finally {
            long duration = System.currentTimeMillis() - startTime;
            logger.info("Operation [{}] completed in {}ms", operationName, duration);
        }
    }
    
    // 無(wú)返回值版本
    public static void logExecutionTime(String operationName, Runnable operation) {
        long startTime = System.currentTimeMillis();
        try {
            operation.run();
        } finally {
            long duration = System.currentTimeMillis() - startTime;
            logger.info("Operation [{}] completed in {}ms", operationName, duration);
        }
    }
}

// 使用示例
User user = PerformanceLogger.logExecutionTime("fetchUserProfile", 
    () -> userService.getUserById(userId));

14. 條件日志收集器

對(duì)于需要收集多條日志然后一次性輸出的場(chǎng)景，可以實(shí)現(xiàn)日志收集器。

// 日志收集器
public class LogCollector {
    private final List<String> messages = new ArrayList<>();
    private final Logger logger;
    private final Level level;
    
    public LogCollector(Logger logger, Level level) {
        this.logger = logger;
        this.level = level;
    }
    
    public void add(String message) {
        messages.add(message);
    }
    
    public void add(String format, Object... args) {
        messages.add(String.format(format, args));
    }
    
    public void flush(String summary) {
        if (messages.isEmpty()) {
            return;
        }
        
        StringBuilder sb = new StringBuilder(summary);
        sb.append(":\n");
        for (int i = 0; i < messages.size(); i++) {
            sb.append("  ").append(i + 1).append(". ")
              .append(messages.get(i)).append("\n");
        }
        
        switch (level.toString()) {
            case "DEBUG":
                logger.debug(sb.toString());
                break;
            case "INFO":
                logger.info(sb.toString());
                break;
            case "WARN":
                logger.warn(sb.toString());
                break;
            case "ERROR":
                logger.error(sb.toString());
                break;
        }
        
        messages.clear();
    }
}

// 使用示例
LogCollector collector = new LogCollector(logger, Level.INFO);
for (Item item : items) {
    try {
        processItem(item);
        collector.add("Item %s processed successfully", item.getId());
    } catch (Exception e) {
        collector.add("Failed to process item %s: %s", item.getId(), e.getMessage());
    }
}
collector.flush("Batch processing results");