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

前言

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

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

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

Step By Step 步骤

  1. 创建自定义监听器类,拦截 EF 的命令执行事件(留意注释

    c# 复制代码
    /// <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);
            }
        }
    }
  2. 在 Global.asax 中的 Application_Start 方法注册监听器

    c# 复制代码
    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());
    }
  3. 这样就实现了监听器拦截 EF 消息写日志的功能,当运行程序执行 EF 语句时,就会自动将 EF 生成的 SQL 写到日志文件中

总结

通过实现自定义监听器类并注册监听器,可以跟踪和记录 EF 的操作和事件,在开发过程中更好地了解和调试 EF 的行为,不失为排查 EF 问题和优化 EF 性能的一个好方法。

我是老杨,一个奋斗在一线的资深研发老鸟,让我们一起聊聊技术,聊聊程序人生,共同学习,

相关推荐
△曉風殘月〆2 小时前
WPF MVVM入门系列教程(二、依赖属性)
c#·wpf·mvvm
逐·風4 小时前
unity关于自定义渲染、内存管理、性能调优、复杂物理模拟、并行计算以及插件开发
前端·unity·c#
m0_656974747 小时前
C#中的集合类及其使用
开发语言·c#
九鼎科技-Leo7 小时前
了解 .NET 运行时与 .NET 框架:基础概念与相互关系
windows·c#·.net
九鼎科技-Leo9 小时前
什么是 ASP.NET Core?与 ASP.NET MVC 有什么区别?
windows·后端·c#·asp.net·mvc·.net
.net开发9 小时前
WPF怎么通过RestSharp向后端发请求
前端·c#·.net·wpf
小乖兽技术9 小时前
C#与C++交互开发系列(二十):跨进程通信之共享内存(Shared Memory)
c++·c#·交互·ipc
幼儿园园霸柒柒10 小时前
第七章: 7.3求一个3*3的整型矩阵对角线元素之和
c语言·c++·算法·矩阵·c#·1024程序员节
平凡シンプル12 小时前
C# EF 使用
c#
丁德双13 小时前
winform 加载 office excel 插入QRCode图片如何设定位置
c#·excel