分享一个 .NET 通过监听器拦截 EF 消息写日志的详细例子_业界新闻

发布时间:2024-07-17 18:19

阅读量:2

前言

EF 开发效率确实很高也很便捷，但当它发生错误时，也挺让人头疼的，为什么？因为 EF 就像是一个黑盒子，一切全被封装起来，出错的时候很难定位原因，如果能够知道并打印 EF 生成的 SQL 语句，对于定位 EF 错误，就很有帮助。

程序员的才智是无限的，虽然 EF 有这个那个的问题，但程序员却总比这些问题多一个办法。

下面分享一个 .NET 通过监听器拦截 EF 消息写日志的详细例子。

Step By Step 步骤

创建自定义监听器类，拦截 EF 的命令执行事件（留意注释）

/// <summary> /// 监听并写 EF 生成的 SQL 到日志 /// </summary> public class EFIntercepterLogging : IDbCommandInterceptor {     /// <summary>     /// 实现接口的 NonQueryExecuting 方法     /// </summary>     /// <param name="command"></param>     /// <param name="interceptionContext"></param>     public void NonQueryExecuting(         DbCommand command,          DbCommandInterceptionContext<int> interceptionContext)     {         LogWhenExecuting(command, interceptionContext);     }      /// <summary>     /// 实现接口的 NonQueryExecuted 方法     /// </summary>     /// <param name="command"></param>     /// <param name="interceptionContext"></param>     public void NonQueryExecuted(         DbCommand command,          DbCommandInterceptionContext<int> interceptionContext)     {         LogIfError(command, interceptionContext);     }      /// <summary>     /// 实现接口的 ReaderExecuting 方法     /// </summary>     /// <param name="command"></param>     /// <param name="interceptionContext"></param>     public void ReaderExecuting(         DbCommand command,          DbCommandInterceptionContext<DbDataReader> interceptionContext)     {         LogWhenExecuting(command, interceptionContext);     }      /// <summary>     /// 实现接口的 ReaderExecuted 方法     /// </summary>     /// <param name="command"></param>     /// <param name="interceptionContext"></param>     public void ReaderExecuted(         DbCommand command,          DbCommandInterceptionContext<DbDataReader> interceptionContext)     {         LogIfError(command, interceptionContext);     }      /// <summary>     /// 实现接口的 ScalarExecuting 方法     /// </summary>     /// <param name="command"></param>     /// <param name="interceptionContext"></param>     public void ScalarExecuting(         DbCommand command,          DbCommandInterceptionContext<object> interceptionContext)     {         LogWhenExecuting(command, interceptionContext);     }      /// <summary>     /// 实现接口的 ScalarExecuted 方法     /// </summary>     /// <param name="command"></param>     /// <param name="interceptionContext"></param>     public void ScalarExecuted(         DbCommand command,          DbCommandInterceptionContext<object> interceptionContext)     {         LogIfError(command, interceptionContext);     }      /// <summary>     /// 写 EF 执行中的 SQL 日志，Debug 级别，用在 Executing 方法     /// </summary>     /// <typeparam name="TResult"></typeparam>     /// <param name="command"></param>     /// <param name="interceptionContext"></param>     private void LogWhenExecuting<TResult>(         DbCommand command,          DbCommandInterceptionContext<TResult> interceptionContext)     {         Logger.DebugFormat("Executing the following SQL: [{0}]", command.CommandText);     }      /// <summary>     /// 出现异常时写日志到 Log4net     /// </summary>     /// <typeparam name="TResult"></typeparam>     /// <param name="command"></param>     /// <param name="interceptionContext"></param>     private void LogIfError<TResult>(         DbCommand command,          DbCommandInterceptionContext<TResult> interceptionContext)     {         if (interceptionContext.Exception != null)         {             var errMsg = new StringBuilder(16);             errMsg.AppendLine("Error occurred when executing the following SQL: ");             errMsg.AppendLine(command.CommandText);             foreach (DbParameter param in command.Parameters)             {                 errMsg.AppendLine($"ParameterName:[{param.ParameterName}] -- DbType:[{param.DbType}] -- Value:[{param.Value}]");             }             Logger.Error(errMsg, interceptionContext.Exception);         }     } }

在 Global.asax 中的 Application_Start 方法注册监听器

protected void Application_Start() {     AreaRegistration.RegisterAllAreas();     FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);     RouteConfig.RegisterRoutes(RouteTable.Routes);     BundleConfig.RegisterBundles(BundleTable.Bundles);     //autofac注册     AutofacConfig.RegisterConfig();     //注册 EF log 监听器     DbInterception.Add(new EFIntercepterLogging()); }