ADO.NET Entity Framework 如何输出日志到 log4net (EF, Log4net)

EF团队推出了一套比较完整的缓存和SQL执行日志的解决方案，EFProviderWrappers。他们的做法是在原来的EF Provider之上，再加一层包装，通过这层包装拦截，进行数据缓存和日志监控。这里缓存的数据是数据库查询后返回的原生数据，并不是Entity实体对象，这样就可以避免Entity实体状态对缓存造成的的极端负面影响。并且这样的缓存对上层的数据查询本身是透明，在同一个封闭区间内，缓存数据所依赖的实体类型在被更新后（对应的表有发生CURD操作），缓存并会被自动清空。对于日志的监控，经过这层包装后就可以非常容易得到处理。大家可以从前面的链接下载到原代码，需要自己编译使用。

简单介绍下使用方法：
1. 下载源码编译，添加引用：
(1)EFProviderWrapperToolkit.dll
(2)EFTracingProvider.dll (用于输出sql)

(3)EFCachingProvider.dll (用于缓存)

2.从生成的ObjectContext中继承一个扩展的ObjectContext，定义所需的扩展属性，其中重点是重新定义构造器，生成包装后的EntityConnection对象。
注意：
(1)name=NORTHWNDEntities 这里的"NORTHWNDEntities" 是生成EF在app.config 或者 web.config 中对应的connectionstring 的名称。
(2)"EFTracingProvider","EFCachingProvider" 如果哪一个没有使用，可以把对应的那个字符串删除。

public ExtendedNorthwindEntities()
: this("name=NorthwindEntities")
{
}
public ExtendedNorthwindEntities(string connectionString)
: base(EntityConnectionWrapperUtils.CreateEntityConnectionWithWrappers(
        connectionString,
        "EFTracingProvider",
        "EFCachingProvider"
))
{
}

3. 在应用程序中注册Provider：
(1) 如果是Winform应用，可以在应用启动时调用下面两句代码，进行注册。

EFTracingProviderConfiguration.RegisterProvider();
EFCachingProviderConfiguration.RegisterProvider();

(2) 如果是Web应用，需要在 web.config 里追加如下配置：(和 system.web 节点平级)

 <system.data>
   <DbProviderFactories>
     <add name="EF Caching Data Provider" invariant="EFCachingProvider" description="Caching Provider Wrapper" type="EFCachingProvider.EFCachingProviderFactory, EFCachingProvider, Version=1.0.0.0, Culture=neutral, PublicKeyToken=def642f226e0e59b" />
     <add name="EF Tracing Data Provider" invariant="EFTracingProvider" description="Tracing Provider Wrapper" type="EFTracingProvider.EFTracingProviderFactory, EFTracingProvider, Version=1.0.0.0, Culture=neutral, PublicKeyToken=def642f226e0e59b" />
     <add name="EF Generic Provider Wrapper" invariant="EFProviderWrapper" description="Generic Provider Wrapper" type="EFProviderWrapperToolkit.EFProviderWrapperFactory, EFProviderWrapperToolkit, Version=1.0.0.0, Culture=neutral, PublicKeyToken=def642f226e0e59b" />
   </DbProviderFactories>
 </system.data>

如何追加 Log4net 的输出：
按照上面的步骤，在ObjectContext的扩展类中，追加了一些代码，详细看代码中的注释：

 public partial class ExtendedNorthwindEntities : NORTHWNDEntities
 {
     private static ILog logger;
     static ExtendedNorthwindEntities()
     {
         // 注册TracingProvider
         EFTracingProviderConfiguration.RegisterProvider();
         // 初始化Log4net,配置在独立的"log4net.config"中配置
         log4net.Config.XmlConfigurator.Configure(new FileInfo("log4net.config"));
         // 初始化一个logger
         logger = log4net.LogManager.GetLogger("EFLog4net");
     }
     public ExtendedNorthwindEntities()
         : this("name=NORTHWNDEntities")
     {
         // 绑定 EFTracingConnection 的 CommandExecuting 事件，输出log
         this.UnwrapConnection<EFTracingConnection>().CommandExecuting += (s, e) => 
         { 
             // 输出 TraceString (SQL文)
             logger.Debug(Environment.NewLine + e.ToTraceString().TrimEnd());
         };
     }
     public ExtendedNorthwindEntities(string connectionString)
         : base(EntityConnectionWrapperUtils.CreateEntityConnectionWithWrappers(
                 connectionString,
                 "EFTracingProvider"
         ))
     {
     }
}

log4net.config 的配置如下：(关于log4net的其他详细配置说明，参考http://logging.apache.org/log4net/release/config-examples.html)

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<log4net>
  <root>
    <level value="ALL" />
    <appender-ref ref="rollingFileAppender" />
    <appender-ref ref="consoleAppender" />
  </root>
  <appender name="rollingFileAppender" type="log4net.Appender.RollingFileAppender,log4net" >
    <param name="File" value="../../logs/EFLogs.txt" />
    <param name="AppendToFile" value="true" />
    <param name="RollingStyle" value="Date" />
    <param name="DatePattern" value="yyyy.MM.dd" />
    <param name="StaticLogFileName" value="true" />
    <layout type="log4net.Layout.PatternLayout,log4net">
      <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n" />
    </layout>
  </appender>
  <appender name="consoleAppender" type="log4net.Appender.ColoredConsoleAppender,log4net">
    <mapping>
      <level value="DEBUG" />
      <!--<foreColor value="White" />-->
      <backColor value="Cyan, HighIntensity" />
    </mapping>
    <layout type="log4net.Layout.PatternLayout,log4net">
      <param name="ConversionPattern" value="%d [%t] [%-5p] %c - %m%n" />
    </layout>
  </appender>
</log4net>
</configuration>

这样在应用程序中，就可以通过log4net的配置文件控制 EF 生成的sql的输出了。上面的log4net里配置了两个Appender一个是输出到Console，一个输出到 EFLogs.txt 里。
下面调用一下 EF, 看看输出的 log：

static void Main(string[] args)
{
    using (var db = new ExtendedNorthwindEntities())
    {
        var toyproducts = from p in db.Products
                          where p.Category.CategoryName.Contains("Seafood")
                          select new { p.Category.CategoryName, p.ProductName, p.UnitPrice };
        Console.WriteLine("-----------------");
        foreach (var p in toyproducts)
            Console.WriteLine("{0,-10} {1,-35} {2,10}", p.CategoryName, p.ProductName, p.UnitPrice);
    }
    Console.Read();
}

上面蓝色背景的输出就是通过log4net配置输出的sql log。另外，这个EFProviderWrappers不仅仅提供让我们输出log这些功能，还有很重要的功能就它的缓存，下一篇文章里我将重点介绍如何使用EFProviderWrappers 实现数据缓存。