DotNet断言跟踪

这是很久之前的一篇翻译.原文我也不知道在哪?原名翻译<<DotNet的调试>>.不过我觉得<<DotNet断言跟踪>>更适合它

Debug是整个软件开发过程中最痛苦的部分之一。我们不想说发现一个小bug是多么的困难-你可能已经都知道。软件中bug的数量是随着软件的复杂程度和经常没有及时修正bug而增长的。这些bug和软件的负责程度互相影响，使工程变得更加复杂。所以我们不断的监控和修改bug。

最好的办法是执行单元测试的时候来修正bug，当软件出现问题的时候，软件不会告诉我们哪里出现错误，为什么出现错误，我们的任务就是跟踪进程去解决他们。

这篇文章我们就是想告诉你怎样利用DotNet FrameWork来调试和跟踪让这个处理过程变得简单。我们将简要的告诉你怎么样有效的使用他们，并用结合例子说明。

跟踪

在这篇文章中首先要讨论的调试的策略是跟踪。跟踪是很强大的技术，因为他允许你看到应用程序的整个在运行期的整个行为，分析他是最有效的，尽管他不能提供需要的信息。

DotNet在System.Diagnostics名字空间中提供了跟踪的功能，正确的说是Trace Class

Trace是个静态类（这意味着所有的成员是静态的，你不需要初始化他来获得它的功能）

．产生一个断言（有条件或没有）

．根据提供的条件输出跟踪信息

．格式化跟踪输出信息

让我们从简要的成员方法开始研究：

public static void Assert(bool)

public static void Assert(bool,string)

public static void Assert(bool,string,string)

 

Assert方法显示一个失败信息（应用程序失败的时候显示信息，允许用户中断执行，忽略错误或者重新运行引起错误的代码），如果条件是false，两个重载函数允许显示指定的自定义一个或两个跟着的信息。（这些信息通过string参数设置，这么做允许开发者显示额外的断言失败的信息）

//Asertion Demo

//

//Purpose: To Demonstrate Results of Different Assert Method Calls

using System;

using System.Diagnostics

namespace Assertion

{

        class Application

{

        [STAThread]

        static voidMain(string[] args)

        {

                  //Simple assertion. No additional message

                 Trace.Assert(false);

        }

}

}

程序将显示下面的消息对话框：

图

正如你看到的，仅仅是显示异常信息。没有显示任何上下文信息，所以我们不能看到失败的原因。下面，应用程序调用Assert方法用它的一个属性：

//Asertion Demo

//

//Purpose: To Demonstrate Results of Different Assert Method Calls

using System;

using System.Diagnostics

namespace Assertion

{

        class Application

{

        [STAThread]

        static voidMain(string[] args)

        {

                  //Simple assertion. No additional message

                 Trace.Assert(false,”Simple assertion Message”);

        }

}

}

这个程序显示了一个更多信息的对话框。可以看到我们能提供的关于失败原因的信息。

调用有两个信息的Assert方法，组成更加详细的断言：

//Asertion Demo

//

//Purpose: To Demonstrate Results of Different Assert Method Calls

using System;

using System.Diagnostics

namespace Assertion

{

        class Application

{

        [STAThread]

        static voidMain(string[] args)

        {

                  //Simple assertion. No additional message

                 Trace.Assert(false,”Simple assertion Message”，”This message just an example.In real application you can provite detailed information here’);

        }

}

}

你现在看到更加详细的信息：

图

事实上，当检查重要条件，比如数据正确性等情况的时候才用这种方法。下边是他最常用的例子：public void StoreObject(PersistentObject obj)

{

      Trace.Assert(obj != null,　＂Cannot store null object＂);

}

这个方法检查object对象不是null的时候被存储。当程序失败的时候是产生异常的最好时间，但这不是必要条件。例如，如果这个方法保存了一些重要的程序数据，断言是完美的选择。

备注：调试跟踪是有用的，如果最终发行版本中包含了断言信息对用户来说是无法忍受的。下面的窍门可以帮助你控制跟踪开关。

 

如果你手工编译工程（比如命令行编译），缺省显示跟踪信息。如果在c#中用跟踪功能，当你编译代码的时候，要加/d:Trace标志来编译命令行，或者你可以简单的加入#define Trace到文件最顶端。

比如，下面的小程序：

using system;

using System.Diagnostics;

namespace TraceShow

{

      class calss1

{

      ///<summary>

      ///The main entry point for the application

      ///</summary>

      [STAThread]

      static voidMain(string[] args)

      {

             Trace.Listeners.Add(new TextWriterTraceLister(Console.Out));

             Trace.Write(“Hey,this is a trace message\n”, “SIMPLE MESSAGE”);

      }

}

}

如果在命令行编译，你将看不到任何信息，除非你加上/d:Trace或者加入#define Trace到文件顶部。

当你在visual c#中编译程序这种情形将改变，visual c#中默认是可用的，结论是你将看到跟踪信息。关闭调试功能，浏览工程属性（可以在解决方案浏览器重或者view->property菜单项。在这个属性页面对话框中，发现条件编译常量（在configuration properties文件夹下，build pane中这个选项是锁定状态），去掉Trace选项）：

   图

public static void Fail(string)

public static void Fail(string, string)

Fail方法产生一个无条件断言。它的有些行为有点像Assert方法，但是他不需要任何处理条件。

带有简单条件的失败条件不能被选中那么用这个方法。下边的例子是这种异常的处理情形：

try

{

        throw new Exception(“Sample Exception”);

}

catch(Exception Ex)

{

        Trace.Fail(“Exception caught”, Ex.Message);

}

 

pubic static void Write(object)

public static void Write(string)

public static void Write(object, string)

public static void Write(string,string)

 

Trace类可以在不产生任何条件的情况下写入跟踪信息。比如信息输出到作为跟踪信息的接收者的设备中。用write方法执行输出。

Write方法可以建立作为对象或者字符串的描绘信息。以前的案例中，object.ToString被呼叫执行。有其他三个方法可以执行类似的行为：writeline输出行，writeif-条件信息，writelineif输出一行条件信息。

Write方法的第二个参数指定将要写入信息前的分类（比如一个字符串）

输出被注册为侦听器。侦听器是可以输出跟踪信息到一些设备的对象。注意Assert和Fail方法经常输出错误信息到窗体或者控制台，不管那个侦听器被选中。这类对象必须继承TraceListener类，他有以下重要的方法：

public virtual void Fail(string)

public virtual void Fail(string,string)

 

public virtual void Flush(string)

 

public virtual void Write(object)

public abstract void Write(string)

public virtual void Write(object,string)

public virtual void Write(string,string)

 

public virtual void WriteLine(object)

public Virtual void WriteLine(string)

public virtual void writeLine(object,string)

public virtual void WriteLine(string,string)

--------------------------------------------------------------------------------------------

Fail方法不能阻止应用程序运行，他们仅仅输出错误信息。Write和WriteLine方法写入一个消息。他们不同之处仅仅在于后者输出执行后再输出一行。最后，Flush方法刷新缓存。Flush方法对跟踪信息输出的设备有作用（例如，流）。你可以使用自动刷新—每个信息后都自动刷新侦听者。可以在配置文件里面配置：

<configuration>

       <stream.diagnostics>

                  <trace autoflush = “false” />

        </stream.diagnostics>

</configuration>

 

正如你看到的，如果你创建自己的倾听者，需要至少实现write(string)和writeline(string)方法（这些方法是抽象方法）。

微软提供三种跟踪侦听者：DefaultTraceListener,EventLogTraceListener和TextWriteTraceLister.。第一个侦听者有缺省的方法（如果应用程序在命令行的环境下运行，那么输出信息到控制台。如果应用程序在调试情况下，输出到窗口）。第二个侦听者输出信息到指定事件日志中（基于nt技术—winnt,2k,xp或者.net）。第三个倾听者输出文本到流中。

活动倾听者列表可以在编程中设置或者在配置文件中。缺省包括DefaultTraceListener.

编程改变活动倾听者列表，要管理倾听者集合（通过添加和删除方法）。配置文件中管理倾听者，你要用下边的语法：

<configuration>

<system.diagnostics>

        <trace autoflust=”false” indentsize = 4>

                  <listeners>

<add name=”myListener” type=”System.Dianostics.TextWriterTraceListener, system”

initializeData = “c:\MyListener.log”/>

<remove type = “System.Diagnostics.DefaultTraceListener,System”/>

</listeners>

</trace>

</system.dianostics>

</configuration>

InitializeDat参数是传递到构造器的的字符串参数（指定EventLogTraceListener侦听者事件日志）。

侦听者很熟悉创建应用程序使用侦听者输出跟踪信息。代码很简单：

//Trace listeners demo

//

//purpose:To demonstrate how to use listeners

using System;

using System.Diagnostics;

 

namespace Assertion

{

        class Application

        {

                  [STAThread]

                  static voidMain(string[] args)

                  {

                           Trace.WriteLine(“Calling WriteLine method”, “Trace Listeners demo”);

                           Trace.Flush();

                  }

        }

}

 

这些代码还不够，我们必须创建一个配置文件来设置侦听者：

<configuration>

<system.diagnostics>

   <trace autoflush="false" indentsize="4">

<listeners>

     <remove type="System.Diagnostics.DefaultTraceListener"/>

     <add name="myListener" type="System.Diagnostics.TextWriterTraceListener"

           initializeData="myListener.log" />

    <add name="myListenerEventLog" type="System.Diagnostics.EventLogTraceListener"

          initializeData="Application" />

</listeners>

   </trace>

</system.diagnostics>

</configuration>

这个配置文件删除了缺省侦听者加入两个自定义侦听者：第一个输出信息到文本文件，第二个输出到事件日志中。对于第一个侦听者initializeData属性指定输出数据的文件，第二侦听者记录事件到事件日志。

运行程序。检查第一个侦听者，可以看到myListener.log文件，它包含以下信息：Tracing listeners Demo:Calling WriteLine Method

PS:事实上.很多图片的链接都失效了.原作者也找不到了.我也不补上图片了.这篇文章应该很容易看懂.例子也很简单.可以参考MSDN上有关这方面的资料跟踪侦听器