通过


调试 ASP.NET 网页(Razor)网站的简介

作者: Tom FitzMacken

本文介绍了调试 ASP.NET 网页(Razor)网站中的页面的各种方法。 调试是查找和修复代码页中的错误的过程。

你将了解的内容:

  • 如何显示有助于分析和调试页面的信息。
  • 如何在 Visual Studio 中使用调试工具。

以下是本文中介绍的 ASP.NET 功能:

  • ServerInfo 辅助工具。
  • ObjectInfo 帮手。

软件版本

  • ASP.NET 网页程序(Razor)3
  • Visual Studio 2013

本教程也适用于 ASP.NET Web Pages 2。 可以使用 WebMatrix 3,但不支持集成调试器。

排查代码中的错误和问题的重要方面是首先避免这些问题。 为此,可以将可能导致错误的代码部分放入 try/catch 块中。 有关详细信息,请参阅“ 使用 Razor 语法 ASP.NET Web 编程简介”中有关处理错误的部分。

帮助 ServerInfo 程序是一种诊断工具,可概述托管页面的 Web 服务器环境的相关信息。 它还显示浏览器请求页面时发送的 HTTP 请求信息。 帮助 ServerInfo 程序显示当前用户标识、发出请求的浏览器类型等。 此类信息可以帮助你排查常见问题。

  1. 创建名为 ServerInfo.cshtml 的新网页。

  2. 在页面末尾,就在结束 </body> 标记之前,添加 @ServerInfo.GetHtml()

    <!DOCTYPE html>
    <html>
        <head>
            <title></title>
        </head>
        <body>
       @ServerInfo.GetHtml()
        </body>
    </html>
    

    可以在页面的任意位置添加 ServerInfo 代码。 但是,在末尾添加它将使输出与其他页面内容分开,这样更易于阅读。

    注释

    重要 在将网页移动到生产服务器之前,应从网页中删除任何诊断代码。 这适用于 ServerInfo 帮助程序以及本文中涉及通过向页面添加代码的其他诊断技术。 你不希望网站访问者查看有关服务器名称、用户名、服务器上的路径以及类似详细信息的信息,因为这种类型的信息可能对恶意用户有用。

  3. 保存页面并在浏览器中运行。

    Debugging-1

    帮助 ServerInfo 程序在页面中显示四个信息表:

    • 服务器配置。 本部分提供有关托管 Web 服务器的信息,包括计算机名称、正在运行的 ASP.NET 版本、域名和服务器时间。

    • ASP.NET 服务器变量。 本部分提供有关许多 HTTP 协议详细信息(称为 HTTP 变量)以及每个网页请求的一部分的值的详细信息。

    • HTTP 运行时信息。 本部分提供有关网页所运行Microsoft .NET Framework 版本、路径、缓存详细信息等的详细信息。 (正如你在《 使用 Razor 语法 ASP.NET Web 编程简介》中了解到的,ASP.NET 使用 Razor 语法的网页是基于Microsoft的 ASP.NET Web 服务器技术构建的,该技术本身基于名为 .NET Framework 的广泛软件开发库构建。

    • 环境变量。 本部分提供 Web 服务器上所有本地环境变量及其值的列表。

      有关所有服务器和请求信息的完整说明超出了本文的范围,但可以看到 ServerInfo 帮助程序返回大量诊断信息。 有关 ServerInfo 返回的值的详细信息,请参阅 Microsoft TechNet 网站上的 已识别的环境变量 和 MSDN 网站上的 IIS 服务器变量

嵌入输出表达式以显示页面值

查看代码中发生的情况的另一种方法是在页面中嵌入输出表达式。 如你所知,可以通过在页面中添加类似 @myVariable@(subTotal * 12) 的元素来直接输出变量的值。 若要进行调试,可以将这些输出表达式放置在代码的战略点。 这使你可以在页面运行时查看键变量的值或计算结果。 完成调试后,可以删除表达式或将其注释掉。此过程说明了使用嵌入表达式帮助调试页面的典型方法。

  1. 创建名为 OutputExpression.cshtml 的新 WebMatrix 页。

  2. 将页面内容替换为以下内容:

    <!DOCTYPE html>
    <html>
        <head>
            <title></title>
        </head>
        <body>   
    
        @{
            var weekday = DateTime.Now.DayOfWeek;
            // As a test, add 1 day to the current weekday.
            if(weekday.ToString() != "Saturday") {
                // If weekday is not Saturday, simply add one day.
                weekday = weekday + 1; 
            }
            else {
                // If weekday is Saturday, reset the day to 0, or Sunday.
                weekday = 0; 
            }
            // Convert weekday to a string value for the switch statement.
            var weekdayText = weekday.ToString(); 
    
            var greeting = "";
            
            switch(weekdayText) 
            { 
                case "Monday":
                    greeting = "Ok, it's a marvelous Monday."; 
                    break; 
                case "Tuesday":
                    greeting = "It's a tremendous Tuesday.";
                    break; 
                case "Wednesday":
                    greeting = "Wild Wednesday is here!";
                    break; 
                case "Thursday":
                    greeting = "All right, it's thrifty Thursday.";
                    break;
                case "Friday":
                    greeting = "It's finally Friday!";
                    break;
                case "Saturday":
                    greeting = "Another slow Saturday is here.";
                    break;
                case "Sunday":
                    greeting = "The best day of all: serene Sunday.";
                    break;
                default:
                    break; 
            }
        }
        
        <h2>@greeting</h2>
    
        </body>
    </html>
    

    该示例使用语句 switch 检查 weekday 变量的值,然后根据星期几显示不同的输出消息。 在此示例中, if 第一个代码块中的块通过向当前工作日值添加一天来任意更改星期几。 这是出于说明目的引入的错误。

  3. 保存页面并在浏览器中运行。

    该页显示一周中错误日期的消息。 无论一周中的哪一天,你都会在一天后看到该消息。 尽管在这种情况下,你知道消息为何关闭(因为代码故意设置不正确的日期值),但实际上,通常很难知道代码中发生错误的情况。 要进行调试,需要发现例如 weekday 这样的关键对象和变量上的值正在发生什么。

  4. 在代码中注释指示的两个位置插入 @weekday 来添加输出表达式。 这些输出表达式将在代码执行中的该点显示变量的值。

    var weekday = DateTime.Now.DayOfWeek;
    // DEBUG: Display the initial value of weekday. 
    @weekday
    
    // As a test, add 1 day to the current weekday.
    if(weekday.ToString() != "Saturday") {
        // If weekday is not Saturday, simply add one day.
        weekday = weekday + 1; 
    }
    else {
        // If weekday is Saturday, reset the day to 0, or Sunday.
        weekday = 0; 
    }
    
    // DEBUG: Display the updated test value of weekday.
    @weekday
    
    // Convert weekday to a string value for the switch statement.
    var weekdayText = weekday.ToString();
    
  5. 在浏览器中保存并运行页面。

    该页面首先显示一周的实际星期几,然后显示通过加一天得到的更新后的星期几,接着显示switch 语句生成的消息。 两个变量表达式(@weekday)的输出之间没有空格,因为你没有将任何 HTML <p> 标记添加到输出;表达式只是为了测试。

    调试-2

    现在,可以看到错误的位置。 首次在代码中显示 weekday 变量时,它会显示正确的一天。 当你第二次在代码中的 if 块后显示它时,日期会差一天。 因此,你知道在weekday变量第一次和第二次出现之间发生了一些事情。 如果这是一个真正的 bug,这种方法将帮助你缩小导致问题的代码的位置。

  6. 通过删除添加的两个输出表达式并删除更改星期几的代码来修复页面中的代码。 其余的完整代码块如以下示例所示:

    @{
        var weekday = DateTime.Now.DayOfWeek;
        var weekdayText = weekday.ToString(); 
    
        var greeting = "";
            
        switch(weekdayText) 
        { 
            case "Monday":
                greeting = "Ok, it's a marvelous Monday."; 
                break; 
            case "Tuesday":
                greeting = "It's a tremendous Tuesday.";
                break; 
            case "Wednesday":
                greeting = "Wild Wednesday is here!";
                break; 
            case "Thursday":
                greeting = "All right, it's thrifty Thursday.";
                break;
            case "Friday":
                greeting = "It's finally Friday!";
                break;
            case "Saturday":
                greeting = "Another slow Saturday is here.";
                break;
            case "Sunday":
                greeting = "The best day of all: serene Sunday.";
                break;
            default:
                break; 
        }
    }
    
  7. 在浏览器中运行页面。 这一次,你会看到针对一周实际日期显示的正确消息。

使用 ObjectInfo 帮助程序显示对象值

ObjectInfo助手显示传给它的每个对象的类型和值。 可以使用它查看代码中的变量和对象的值(就像在前面的示例中使用输出表达式一样),还可以查看有关对象的数据类型信息。

  1. 打开前面创建的名为 OutputExpression.cshtml 的文件。

  2. 将页面中的所有代码替换为以下代码块:

    <!DOCTYPE html>
    <html>
        <head>
            <title></title>
        </head>
        <body>
        @{
          var weekday = DateTime.Now.DayOfWeek;
          @ObjectInfo.Print(weekday)
          var weekdayText = weekday.ToString(); 
      
          var greeting = "";
      
          switch(weekdayText) 
          { 
              case "Monday":
                  greeting = "Ok, it's a marvelous Monday."; 
                  break; 
              case "Tuesday":
                  greeting = "It's a tremendous Tuesday.";
                  break; 
              case "Wednesday":
                  greeting = "Wild Wednesday is here!";
                  break; 
              case "Thursday":
                  greeting = "All right, it's thrifty Thursday.";
                  break;
              case "Friday":
                  greeting = "It's finally Friday!";
                  break;
               case "Saturday":
                  greeting = "Another slow Saturday is here.";
                  break;
               case "Sunday":
                  greeting = "The best day of all: serene Sunday.";
                  break;
              default:
                  break; 
          }
        }
        @ObjectInfo.Print(greeting)
        <h2>@greeting</h2>
    
        </body>
    </html>
    
  3. 在浏览器中保存并运行页面。

    调试-4

    在此示例中, ObjectInfo 帮助程序显示两个项目:

    • 类型。 对于第一个变量,类型为 DayOfWeek. 对于第二个变量,类型为 String.

    • 该值。 在这种情况下,由于已在页面中显示问候语变量的值,因此将变量传递给该变量 ObjectInfo时,将再次显示该值。

      对于更复杂的对象, ObjectInfo 帮助程序可以显示更多信息, 基本上,它可以显示对象的所有属性的类型和值。

在 Visual Studio 中使用调试工具

若要获得更全面的调试体验,请使用 Visual Studio。 使用 Visual Studio,可以在代码中设置要检查的行中的断点。

设置断点

测试网站时,执行代码会在断点处停止。

达到断点

可以检查变量的当前值,并逐行逐步执行代码。

查看值

有关在 Visual Studio 中使用集成调试器调试 ASP.NET Razor 页面的信息,请参阅使用 Visual Studio 编程 ASP.NET 网页(Razor)。

其他资源