關係:Logger → (參考) Appender → (使用) Layout
// NuGet 套件管理器主控台
Install-Package log4net
// 或 .NET CLI
dotnet add package log4net
建議獨立檔案而非寫在 web.config,便於 `ConfigureAndWatch` 熱重載:
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<configSections>
<section name="log4net"
type="log4net.Config.Log4NetConfigurationSectionHandler, log4net" />
</configSections>
<log4net debug="false">
<!-- 滾動檔案 Appender:依日期+大小分割 -->
<appender name="RollingFileAppender" type="log4net.Appender.RollingFileAppender">
<file value="Logs/" />
<appendToFile value="true" />
<rollingStyle value="Composite" /> <!-- 複合模式:日期+大小 -->
<datePattern value="yyyy-MM-dd '.log'" /> <!-- 每日一檔 -->
<maxSizeRollBackups value="30" /> <!-- 保留 30 個備份 -->
<maximumFileSize value="10MB" /> <!-- 單檔上限 10MB -->
<staticLogFileName value="true" /> <!-- 固定檔名,備份加後綴 -->
<lockingModel type="log4net.Appender.FileAppender+MinimalLock" />
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%date [%thread] %-5level %logger - %message%newline" />
</layout>
</appender>
<!-- Console 輸出 (開發除錯用) -->
<appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
<layout type="log4net.Layout.PatternLayout">
<conversionPattern value="%date [%thread] %-5level %logger - %message%newline" />
</layout>
</appender>
<!-- 根 Logger 設定 -->
<root>
<level value="DEBUG" /> <!-- 最低記錄等級 -->
<appender-ref ref="RollingFileAppender" />
<appender-ref ref="ConsoleAppender" />
</root>
<!-- 特定命名空間覆寫等級 (可選) -->
<logger name="MyApp.DataAccess">
<level value="INFO" />
</logger>
</log4net>
</configuration>
protected void Application_Start(object sender, EventArgs e)
{
// ConfigureAndWatch:檔案變更自動重新載入設定
var configFile = new FileInfo(Server.MapPath("~/log4net.config"));
log4net.Config.XmlConfigurator.ConfigureAndWatch(configFile);
}
// Program.cs (.NET 6+)
var builder = WebApplication.CreateBuilder(args);
// 註冊 log4net
builder.Logging.ClearProviders();
builder.Logging.AddLog4Net("log4net.config"); // 需 Microsoft.Extensions.Logging.Log4Net.AspNetCore
var app = builder.Build();
// ...
static void Main()
{
var repo = LogManager.CreateRepository("MyApp");
XmlConfigurator.Configure(repo, new FileInfo("log4net.config"));
var log = LogManager.GetLogger(repo.Name, "Program");
log.Info("應用程式啟動");
}
public class OrderService
{
// 命名慣例:類別全名 作為 logger name,方便設定檔針對性配置
private static readonly ILog log = LogManager.GetLogger(typeof(OrderService));
public void CreateOrder(Order order)
{
log.Debug($"開始建立訂單: {order.Id}");
try
{
// 業務邏輯...
log.Info($"訂單建立成功: {order.Id}, 金額: {order.Total}");
}
catch (Exception ex)
{
// Error 等級會自動包含堆疊追蹤
log.Error($"訂單建立失敗: {order.Id}", ex);
throw;
}
}
}
<appender name="JsonFileAppender" type="log4net.Appender.RollingFileAppender">
<file value="Logs/json/" />
<datePattern value="yyyy-MM-dd '.json'" />
<rollingStyle value="Date" />
<layout type="log4net.Layout.SerializedLayout, log4net.Ext.Json">
<decorator type="log4net.Layout.Decorators.StandardTypesDecorator, log4net.Ext.Json" />
<member value="timestamp:date" />
<member value="level:level" />
<member value="logger:logger" />
<member value="message:message" />
<member value="exception:exception" />
<member value="properties:properties" />
</layout>
</appender>
需安裝 `log4net.Ext.Json` NuGet 套件。輸出標準 JSON,直接支援 ELK、Splunk 等日誌分析平台。
| 符號 | 含義 | 範例輸出 |
|---|---|---|
| %date | 日期時間 | 2024-01-15 14:30:45,123 |
| %date{yyyy-MM-dd HH:mm:ss} | 自訂日期格式 | 2024-01-15 14:30:45 |
| %thread | 執行緒名稱/ID | 12 或 MainThread |
| %-5level | 等級 (左靠 5 字寬) | DEBUG, INFO , WARN , ERROR |
| %logger | Logger 名稱 (類別全名) | MyApp.Services.OrderService |
| %message / %m | 日誌訊息 | 訂單建立成功 |
| %exception / %e | 例外堆疊追蹤 | System.NullReferenceException... |
| %property{key} | ThreadContext/LogicalThreadContext 屬性 | UserId=123 |
| %newline / %n | 換行 | (換行) |
設定 `
log4net 透過 XML 設定檔分離配置與程式碼,支援熱重載、多 Appender、彈性格式化。掌握「Logger-Appender-Layout」三要素關係、正確初始化時機、靜態 Logger 模式與等級控制,即可建立生產級日誌系統。現代專案可考慮 Serilog (結構化優先) 或 Microsoft.Extensions.Logging 統一抽象,但 log4net 仍是 .NET Framework 專案最成熟穩定的選擇。