推荐功能强大的ORM Profiler,ORM问题追踪的利器

待我称王封你为后i 2022-07-15 05:05 190阅读 0赞

[推荐功能强大的ORM Profiler,ORM问题追踪的利器][ORM Profiler_ORM]

应用LLBL Gen作为ORM框架访问数据库，数据读写不再与直接与SQL打交道。读取销售单代码看起来是这样的

public SalesOrderEntity GetSalesOrder(System.String RefNo, IPrefetchPath2 prefetchPath, ExcludeIncludeFieldsList fieldList)
     {
                SalesOrderEntity _SalesOrder = new SalesOrderEntity(RefNo);
                using (DataAccessAdapterBase adapter = GetCompanyDataAccessAdapter())
                {
                    bool found = adapter.FetchEntity(_SalesOrder, prefetchPath, null, fieldList);
                    if (!found) throw new Foundation.Common.RecordNotFoundException("Invalid Sales Order");
                }
                return _SalesOrder;
    }

在界面层，以下面的代码读取销售单

public override EntityBase2 LoadEntity(string customerNo)
     {
                ISalesOrderManager manager = ClientProxyFactory.CreateProxyInstance<ISalesOrderManager>();
                IPrefetchPath2 prefetchPath = new PrefetchPath2((int)Foundation.CustomerServices.EntityType.SalesOrderEntity);
                prefetchPath.Add(SalesOrderEntity.PrefetchPathSalesOrderDetails);
                SalesOrderEntity customer = manager.GetSalesOrder(customerNo, prefetchPath);
                return customer;
    }

虽然这样大大简化了数据库访问方法。但同时，也带来一些不方便的地方。比如，因为ORM是以动态SQL的方式，产生SQL语句，以参数传递的方式，无法追踪到最终发送到SQL Server服务器的原始的SQL语句。其次，ORM产生的行为，与拼凑SQL有些不同。  
例如，SalesOrderEntity order=new SalesOrderEntity();

order.Description=null;  => 产生的SQL是SalesOrder.Description is NULL

order.Description=string.Empty; => 产生的SQL是SalesOrder.Description=’’

也就是NULL和空字符串，是不同的含义。这种情况，在追踪SQL查找问题时，极不容易察觉。

在没有发布ORM Profile之前，要跟踪LLBL产生的SQL，需要对配置文件作如下的设置，应用标准的.NET Trace机制

<system.diagnostics>
            
        </system.diagnostics>

这种方法，将LLBL Gen生成的SQL 写到文本文件，用于诊断产生问题的SQL语句。

借助于.NET 标准的Trace机制，我重写了这样的跟踪，把LLBL Gen产生的SQL发送到指定的程序窗口中，代码如下

public class ORMTraceListener : TraceListener
        {
            static Socket m_socClient;
            static bool m_server=false;
    
            static ORMTraceListener()
            {
                m_server = false;
                OnConnect("127.0.0.1", 8221);
            }
          
            public override void Write(string message)
            {
                if (!String.IsNullOrEmpty(message) && m_server&&NeedSend(message))
                    OnSendData(message);
            }
    
            public override void WriteLine(string message)
            {
                if (!String.IsNullOrEmpty(message) && m_server && NeedSend(message))
                    OnSendData(message+Environment.NewLine);
            }
    }

经过这样的设置，我们追踪到的伪SQL，看起来像这样

Generated Sql query: 
    
        Query: SELECT [Enterprise].[dbo].[User].[UserID] AS [UserId], [Enterprise].[dbo].[User].[UserName], [Enterprise].[dbo].[User].[PassWord], [Enterprise].[dbo].[User].[UserGroup], [Enterprise].[dbo].[User].[Suspended], [Enterprise].[dbo].[User].[DefaultLang], [Enterprise].[dbo].[User].[CreatedDate], [Enterprise].[dbo].[User].[CreatedBy], [Enterprise].[dbo].[User].[RevisedDate], [Enterprise].[dbo].[User].[RevisedBy], [Enterprise].[dbo].[User].[Email], [Enterprise].[dbo].[User].[AllCompany], [Enterprise].[dbo].[User].[AllCustomer], [Enterprise].[dbo].[User].[Allvendor], [Enterprise].[dbo].[User].[Buyer], [Enterprise].[dbo].[User].[SalesMan], [Enterprise].[dbo].[User].[AllReportView] FROM [Enterprise].[dbo].[User]  WHERE ( ( [Enterprise].[dbo].[User].[UserID] = @UserId1))
    
        Parameter: @UserId1 : String. Length: 10. Precision: 0. Scale: 0. Direction: Input. Value: "MIS".

这不能用于查询分析器中直接执行，必须经过转化。

这样已经很接近于ORM Profile的目标了，官方推出的ORM Profile工具，对上面的目标进行更优化的设计。

要让你的程序启动SQL跟踪，只需要在程序启动的地方，加入如下的语句

SD.Tools.OrmProfiler.Interceptor.InterceptorCore.Initialize("Enterprise Solution");

也可以反射调用上面的语句以启动SQL跟踪。在帮助文档中有代码，这里拷贝一份供您参考。

// Thanks to Craig Stuntz
    private static void StartProfiler()
    {
        if (AppSettings["ORMProfiler"] == "1")
        {
            System.Reflection.Assembly ormInterceptor = 
                    System.Reflection.Assembly.Load("SD.Tools.OrmProfiler.Interceptor.EFv4");
            Type interceptor = ormInterceptor.GetType("SD.Tools.OrmProfiler.Interceptor.InterceptorCore");
            interceptor.InvokeMember("Initialize",
                System.Reflection.BindingFlags.Public |
                System.Reflection.BindingFlags.InvokeMethod |
                System.Reflection.BindingFlags.Static,
                null, null, new[] { "My.Web" }, System.Globalization.CultureInfo.CurrentUICulture);
        }
    }

反射可以减少程序集编译时的依赖，您只需要将下面的程序集复制到被跟踪的应用程序目录中即可

*  SD.Tools.OrmProfiler.Interceptor.dll (or for EFv4: SD.Tools.OrmProfiler.Interceptor.EFv4.dll)
 *  SD.Tools.OrmProfiler.Shared.dll
 *  SD.Tools.BCLExtensions.dll
 *  SD.Tools.Algorithmia.dll

这样，当前程序由LLBL Gen产生的SQL就会发送到ORM Profile主窗体中，以用于分析。

相对于问题查找，经常用到的是第二个选项卡Connections in chronological order

[![image][]][image 1]

它显示了数据库连接和发送的SQL语句。这里可以看到，ORM Profile不仅仅可以追踪SQL，还可以用于性能分析。比如这一句SQL，它返回了四笔数据，DB读取时间是123.20ms。在下面的面板中，可以看到对SQL的各种分析。在SQL面板中，它显示的SQL，与上面的相似。如果你想把这个SQL拷贝到查询分析器中，结果如下

SELECT [Framework].[dbo].[User].[UserID] AS [UserId],
           [Framework].[dbo].[User].[UserName],
           [Framework].[dbo].[User].[PassWord],
           [Framework].[dbo].[User].[UserGroup],
           [Framework].[dbo].[User].[Suspended]
    FROM   [Framework].[dbo].[User]
    WHERE  (([Framework].[dbo].[User].[UserID] = 'MIS' /* @p1 */))

看到，这个工具已经将参数直接填充到SQL语句中，在查询分析器中可直接执行，不作任何修改。

ORM Profile把每一次跟踪会话叫做Snapshot，SQL文档中，将这个词语翻译为快照，可理解为一个跟踪会话，它可以保存在硬盘中，以便于再次分析。

对于Win Froms程序，在Main方法中调用Initialize，WPF程序，则在重写的应用程序OnStartUp中调用Initialize，Web应用程序，在Global.asax中的Application\_Start方法，调用Initialize。

在实际产品中，Profile会产生性能损耗，占用额外的内存和发送字节到ORM Profiler主程序中。在调用InterceptorCore.Initialize方法之后，跟踪就开始。我们可以用方法

InterceptorCore.DisableMessageSending(); 停止跟踪

也可再次启用跟踪，应用下面的方法

InterceptorCore.EnableMessageSending();

如果不希望每次都打开ORM Profile来拦截SQL跟踪到的消息，我们可以在代码中，把SQL跟踪直接保存到文件中，在需要时，用ORM Profile打开跟踪文件，以进行分析。下面的代码来自于帮助文件，供您参考

// default ctor call, no filters, default analysis settings. You can specify filter settings and
    // analysis settings in an overload of the ctor.
    var snapshot = new Snapshot();
    snapshot.Record();
    
    // execute database activity here.
    // …
    
    // make sure the interceptor has flushed all messages over the named pipe.
    InterceptorCore.Flush();
    
    // messages arrive on another thread, so we have to wait here before all messages have arrived 
    Thread.Sleep(200);
    // after the pause, we can stop recording. 
    snapshot.Stop();
    
    // if you’ve specified filter settings in the ctor call, you have to do the following:
    snapshot.ApplyFilters();
    // if you want to perform analysis in code prior to saving the snapshot, you should
    // uncomment the following line. NOTE: requires license file to be present.
    // snapshot.ApplyAnalysis();
    
    // the snapshot can now be saved:
    string error=string.Empty;
    snapshot.SaveToFile(filename, out error);

ORM Profile工具相当灵活，可用于编程以集成到自己的产品中，为你的系统稳定，性能提升添加高效率的工具。

分类: [ Enterprise Solution][Enterprise Solution]

好文要顶 关注我  收藏该文 ![icon_weibo_24.png][] ![wechat.png][]

[![sample_face.gif][]][sample_face.gif 1]

[信息化建设][sample_face.gif 1]  
[关注 - 16][- 16]  
[粉丝 - 1368][- 1368]

荣誉： [推荐博客][Link 1]

\+加关注

[« ][Link 2]上一篇： [ASP.NET Web开发框架之三 报表开发][Link 2]  
[» ][Link 3]下一篇： [ASP.NET Web开发框架之四 查询][Link 3]

posted @ 2012-09-21 09:06 [ 信息化建设][Link 4] 阅读( 2655) 评论( 4) [ 编辑][Link 5] [ 收藏][Link 6]

评论列表

[\#1楼][1] \[ 楼主\] 2012-09-21 09:58 [ 信息化建设][Link 4] [  ][Link 7]

下载地址在这里  
[http://www.ormprofiler.com/defaultgeneric.aspx][http_www.ormprofiler.com_defaultgeneric.aspx]

支持(0) 反对(0)

[\#2楼][2]  2012-09-21 10:18 [ 代码乱了][Link 8] [  ][Link 9]

不错，这个工具我也在用

支持(0) 反对(0)

[\#3楼][3]  2012-09-21 10:51 [ 玉菜园][Link 10] [  ][Link 11]

mark

支持(0) 反对(0)

[\#4楼][4]  2478903 2012/9/22 12:29:48 2012-09-22 12:29 [ john23.net][john23.net] [  ][Link 12]

学习了

[ORM Profiler_ORM]: http://www.cnblogs.com/JamesLi2015/archive/2012/09/21/2696336.html
[image]: /images/20220715/282f85e8cb344ccaa0b09d7b0124370c.png
[image 1]: http://images.cnblogs.com/cnblogs_com/JamesLi2015/201209/201209210906002460.png
[Enterprise Solution]: http://www.cnblogs.com/JamesLi2015/category/414115.html
[icon_weibo_24.png]: http://common.cnblogs.com/images/icon_weibo_24.png
[wechat.png]: /images/20220715/703a04ebd7cf4c8ebada28ae727b18ac.png
[sample_face.gif]: /images/20220715/e5b41836945c4833982c7dd4ecbfa441.png
[sample_face.gif 1]: http://home.cnblogs.com/u/JamesLi2015/
[- 16]: http://home.cnblogs.com/u/JamesLi2015/followees
[- 1368]: http://home.cnblogs.com/u/JamesLi2015/followers
[Link 1]: http://www.cnblogs.com/expert/
[Link 2]: http://www.cnblogs.com/JamesLi2015/archive/2012/09/20/2694669.html
[Link 3]: http://www.cnblogs.com/JamesLi2015/archive/2012/09/25/2700992.html
[Link 4]: http://www.cnblogs.com/JamesLi2015/
[Link 5]: https://i.cnblogs.com/EditPosts.aspx?postid=2696336
[Link 6]: http://www.cnblogs.com/JamesLi2015/archive/2012/09/21/2696336.html#
[1]: http://www.cnblogs.com/JamesLi2015/archive/2012/09/21/2696336.html#2477944
[Link 7]: http://msg.cnblogs.com/send/%E4%BF%A1%E6%81%AF%E5%8C%96%E5%BB%BA%E8%AE%BE
[http_www.ormprofiler.com_defaultgeneric.aspx]: http://www.ormprofiler.com/defaultgeneric.aspx
[2]: http://www.cnblogs.com/JamesLi2015/archive/2012/09/21/2696336.html#2477975
[Link 8]: http://www.cnblogs.com/jintan/
[Link 9]: http://msg.cnblogs.com/send/%E4%BB%A3%E7%A0%81%E4%B9%B1%E4%BA%86
[3]: http://www.cnblogs.com/JamesLi2015/archive/2012/09/21/2696336.html#2478017
[Link 10]: http://home.cnblogs.com/u/227254/
[Link 11]: http://msg.cnblogs.com/send/%E7%8E%89%E8%8F%9C%E5%9B%AD
[4]: http://www.cnblogs.com/JamesLi2015/archive/2012/09/21/2696336.html#2478903
[john23.net]: http://www.cnblogs.com/johnwonder/
[Link 12]: http://msg.cnblogs.com/send/john23.net