当前位置：首页 > news >正文

Meiam.System日志系统深度剖析：NLog集成与全局异常拦截最佳实践

news 2026/6/11 18:09:22

Meiam.System日志系统深度剖析：NLog集成与全局异常拦截最佳实践

【免费下载链接】Meiam.System.NET 8 / .NET 5 WebAPI + Vue 2.0 + RBAC 企业级前后端分离权限框架项目地址: https://gitcode.com/gh_mirrors/me/Meiam.System

Meiam.System是基于.NET 8/.NET 5 WebAPI与Vue 2.0构建的企业级前后端分离权限框架，其日志系统采用NLog实现高效日志管理，并通过全局异常拦截确保系统稳定运行。本文将深入解析这一日志系统的实现原理与最佳实践，帮助开发者快速掌握企业级应用的日志管理方案。

日志系统架构概览

Meiam.System的日志系统采用分层设计，主要由三个核心组件构成：NLog配置模块、全局异常处理机制和日志数据存储层。这种架构确保了日志采集的全面性、异常处理的及时性以及日志数据的可追溯性。

图：Meiam.System日志系统架构示意图，展示了NLog与全局异常处理的协同工作流程

NLog作为日志引擎负责日志的格式化与输出，全局异常拦截则捕获系统运行中的异常信息，两者结合形成了完整的日志采集体系。日志数据既可以输出到文件系统，也可以存储到数据库中，满足不同场景的日志分析需求。

NLog配置详解与最佳实践

NLog的配置文件位于项目根目录下的Meiam.System.Hostd/NLog.config，该文件定义了日志的输出目标、格式和路由规则。配置采用XML格式，主要包含extensions、targets和rules三个部分。

多目标输出配置

配置文件中定义了四种输出目标：

ApiTrace：记录API请求轨迹，包含详细的请求参数和响应时间
database：将日志存储到SQL Server数据库
error：将错误日志输出到文件系统
debug：将调试日志输出到文件系统

数据库目标配置示例：

<target name="database" xsi:type="Database" dbProvider="Microsoft.Data.SqlClient.SqlConnection, Microsoft.Data.SqlClient" connectionString="Server=127.0.0.1;Database=MeiamSystem;UID=meiamsystem;Password=HApVpL8XhFFGz3Oy" commandText="INSERT INTO Sys_Logs (ID, Logger, Level, Host, Url , Method, Cookie, UserAgent, QueryString, Body , Message, CreateTime, IPAddress, Elapsed) VALUES (newId(), @Logger, @Level, @Host, @Url , @Method, @Cookie, @UserAgent, @QueryString, @Body , @Message, @CreateTime, @IPAddress, 0);"> <!-- 参数定义 --> </target>

日志路由规则

rules部分定义了不同级别日志的处理策略：

<logger name="Microsoft.*" maxlevel="Info" final="true" /> <logger name="*" level="Trace" writeTo="ApiTrace" /> <logger name="*" level="Info" writeTo="database" /> <logger name="*" level="Warn" writeTo="database" /> <logger name="*" level="Debug" writeTo="debug" /> <logger name="*" level="Error" writeTo="error" />

最佳实践建议：

设置autoReload="true"实现配置文件热更新
使用throwConfigExceptions="true"捕获配置错误
对Microsoft相关日志设置较低级别，避免冗余
按日志级别分离存储，便于问题定位

全局异常拦截实现

Meiam.System通过GlobalExceptions类实现全局异常拦截，该类位于Meiam.System.Hostd/Global/GlobalExceptions.cs，实现了IExceptionFilter接口。

异常处理流程

捕获异常并构建统一的API响应格式
根据环境变量决定是否返回堆栈信息
将异常信息记录到日志系统
返回标准化的错误响应

核心代码实现：

public void OnException(ExceptionContext context) { ApiResult<string> response = new ApiResult<string>(); response.StatusCode = (int)StatusCodeType.Error; response.Message = context.Exception.Message; if (_env.IsDevelopment()) { response.Data = context.Exception.StackTrace; } context.Result = new JsonResult(response) { StatusCode = (int)StatusCodeType.Success }; _logger.LogError(WriteLog(response.Message, context.Exception)); }

异常日志格式化

WriteLog方法对异常信息进行格式化，包含错误消息、异常类型和堆栈调用信息：

public string WriteLog(string throwMsg, Exception ex) { return $"\r\n【自定义错误】：{throwMsg} \r\n【异常类型】：{ex.GetType().Name} \r\n【异常信息】：{ex.Message} \r\n【堆栈调用】：{ex.StackTrace }\r\n"; }