ASP.NET如何实现错误日志记录功能？

在ASP.NET中记录错误日志是确保应用程序稳定性和可维护性的重要步骤，以下是一些常见的实现方法：

一、使用内置日志功能

1、配置Web.config文件：可以通过配置Web.config文件中的<system.diagnostics>来启用和设置ASP.NET内置的日志功能，比如指定日志级别（如Error、Warning、Information等）以及输出目标（可以是文件、事件日志等），要记录错误级别的信息到文件，可进行如下配置：

 <system.diagnostics>
     <switches>
       <add name="ErrorLevel" value="3" />
     </switches>
     <trace>
       <listeners>
         <add name="FileLog" type="System.Diagnostics.TextWriterTraceListener" initializeData="pathtologfile.log" />
       </listeners>
     </trace>
   </system.diagnostics>

2、在代码中使用Trace类：在需要记录日志的地方，使用System.Diagnostics.Trace类的方法来记录信息，记录一条错误信息可以使用Trace.WriteLine方法，并指定错误级别：

 Trace.WriteLine("This is an error message", "ErrorCategory");

二、使用第三方日志库

1、NLog

安装与配置：首先需通过NuGet包管理器安装NLog库，安装完成后，在项目中添加NLog的配置文件（如NLog.config），在其中配置日志规则，包括日志的目标（如文件、数据库等）、日志级别、日志格式等，要将日志记录到文件，可进行如下配置：

 <nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
       <targets>
         <target name="logfile" xsi:type="File" layout="${longdate}|${level}|${message}" fileName="pathtologfile.txt" />
       </targets>
       <rules>
         <logger name="" minlevel="Info" writeTo="logfile" />
       </rules>
     </nlog>

在代码中使用：在代码中，通过NLog的Logger类来记录日志，记录一条错误日志：

 private static readonly Logger logger = LogManager.GetCurrentClassLogger();
     logger.Error("An error occurred");

2、Serilog

安装与配置：同样先通过NuGet安装Serilog库及相关的Sink（用于指定日志输出的目标，如文件、控制台等），安装完成后，在代码中进行配置，例如将日志记录到文件的配置如下：

 Log.Logger = new LoggerConfiguration()
       .MinimumLevel.Debug()
       .WriteTo.File("pathtologfile.txt", rollingInterval: RollingInterval.Day)
       .CreateLogger();

在代码中使用：之后在需要记录日志的地方，使用Log类的方法记录不同级别的日志，记录一条错误日志：

 Log.Error("An error happened");

三、自定义日志记录方法

1、创建静态方法记录文本文件：可以自己编写一个静态方法，用于将错误信息记录到指定的文本文件中。

 using System.IO;
   using System.Globalization;
   public static void WriteError(string errorMessage)
   {
     try
     {
       string path = "~/Error/" + DateTime.Today.ToString("yyMMdd") + ".txt";
       if (!File.Exists(HttpContext.Current.Server.MapPath(path)))
       {
         File.Create(HttpContext.Current.Server.MapPath(path)).Close();
       }
       using (StreamWriter w = File.AppendText(HttpContext.Current.Server.MapPath(path)))
       {
         w.WriteLine("r
Log Entry : ");
         w.WriteLine("{0}", DateTime.Now.ToString(CultureInfo.InvariantCulture));
         w.WriteLine(errorMessage);
         w.WriteLine("________________________________________________________");
         w.Flush();
         w.Close();
       }
     }
     catch (Exception ex)
     {
       WriteError(ex.Message);
     }
   }

2、在Application_Error中调用自定义方法：在Global.asax文件的Application_Error事件中，获取异常信息并调用自定义的日志记录方法将其记录下来。

 void Application_Error(object sender, EventArgs e)
   {
     Exception objErr = Server.GetLastError().GetBaseException();
     string strIP = Request.UserHostAddress;
     string err = "Ip【" + strIP + "】" + Environment.NewLine + "Error in【" + Request.Url.ToString() + "】" + Environment.NewLine + "Error Message【" + objErr.Message.ToString() + "】";
     FN.WriteError(err);
   }

四、集成日志记录到应用程序的各个层次

1、在WEB API中记录请求和响应详情：在处理HTTP请求的方法中，记录请求的URL、参数、响应状态码等信息，以便追踪每个请求的处理情况，在一个ASP.NET Core Web API的控制器方法中：

 [HttpGet]
   public IActionResult GetSomeData()
   {
     try
     {
       // 业务逻辑代码
       return Ok(someData);
     }
     catch (Exception ex)
     {
       LogError($"Request URL: {Request.Path}, Error: {ex.Message}");
       return StatusCode((int)HttpStatusCode.InternalServerError, "An error occurred");
     }
   }

2、在业务层记录关键业务流程信息：对于重要的业务操作，记录其开始时间、结束时间、执行结果等信息，帮助分析业务流程的性能和正确性，在一个业务服务类中：

 public void ProcessBusinessLogic()
   {
     try
     {
       LogInfo("Start processing business logic");
       // 业务逻辑代码
       LogInfo("Business logic processed successfully");
     }
     catch (Exception ex)
     {
       LogError($"Error processing business logic: {ex.Message}");
     }
   }

3、在数据访问层记录数据库操作异常：当与数据库交互出现异常时，记录相关的异常信息，包括SQL语句、错误消息等，方便排查数据库问题，在一个数据访问类中：

 public void ExecuteDatabaseOperation()
   {
     try
     {
       // 数据库操作代码
     }
     catch (SqlException ex)
     {
       LogError($"Database operation failed. SQL: {ex.Message}");
     }
   }

五、实现异步日志记录（可选）

1、使用异步IO操作：如果日志记录操作可能比较耗时，尤其是在高并发的情况下，为了不影响主线程的响应性能，可以使用异步的IO操作来记录日志，使用Task.Run或async/await关键字来实现异步写入文件：

 public async Task WriteErrorAsync(string errorMessage)
   {
     try
     {
       string path = "~/Error/" + DateTime.Today.ToString("yyMMdd") + ".txt";
       if (!File.Exists(HttpContext.Current.Server.MapPath(path)))
       {
         File.Create(HttpContext.Current.Server.MapPath(path)).Close();
       }
       using (StreamWriter w = File.AppendText(HttpContext.Current.Server.MapPath(path)))
       {
         w.WriteLine("r
Log Entry : ");
         w.WriteLine("{0}", DateTime.Now.ToString(CultureInfo.InvariantCulture));
         w.WriteLine(errorMessage);
         w.WriteLine("________________________________________________________");
         w.Flush();
         w.Close();
       }
     }
     catch (Exception ex)
     {
       await WriteErrorAsync(ex.Message);
     }
   }

2、在Application_Error中调用异步方法：在Global.asax文件的Application_Error事件中，调用上述异步的日志记录方法：

 void Application_Error(object sender, EventArgs e)
   {
     Exception objErr = Server.GetLastError().GetBaseException();
     string strIP = Request.UserHostAddress;
     string err = "Ip【" + strIP + "】" + Environment.NewLine + "Error in【" + Request.Url.ToString() + "】" + Environment.NewLine + "Error Message【" + objErr.Message.ToString() + "】";
     Task.Run(() => FN.WriteErrorAsync(err));
   }

ASP.NET提供了多种记录错误日志的方法，开发者可以根据具体需求选择合适的方式来实现错误日志的记录，从而更好地监控和维护应用程序的运行状态。