ExtractionRule 类

项目
08/12/2011

用来定义规则的基类，这些规则用于从 Web 性能测试生成的 Web 响应中获取数据。

继承层次结构

命名空间： Microsoft.VisualStudio.TestTools.WebTesting
程序集： Microsoft.VisualStudio.QualityTools.WebTestFramework（在 Microsoft.VisualStudio.QualityTools.WebTestFramework.dll 中）

语法

声明
Public MustInherit Class ExtractionRule

public abstract class ExtractionRule

public ref class ExtractionRule abstract

[<AbstractClass>]
type ExtractionRule =  class end

public abstract class ExtractionRule

ExtractionRule 类型公开以下成员。

构造函数

	名称	说明
	ExtractionRule	初始化 ExtractionRule 类的新实例。

页首

属性

	名称	说明
	ContextParameterName	获取或设置所提取属性的上下文名称。
	RuleDescription	已过时。不再使用此方法。在类中使用 DisplayNameAttribute 来设置此规则的说明。
	RuleName	已过时。不再使用此方法。在类中使用 DisplayNameAttribute 来设置此规则的显示名称。

页首

方法

	名称	说明
	Equals	确定指定的 Object 是否等于当前的 Object。（继承自 Object。）
	Extract	当在派生类中重写时，此方法从 HtmlDocument 中提取信息，并将其放入 WebTestContext。
	Finalize	允许对象在“垃圾回收”回收之前尝试释放资源并执行其他清理操作。（继承自 Object。）
	GetHashCode	用作特定类型的哈希函数。（继承自 Object。）
	GetType	获取当前实例的 Type。（继承自 Object。）
	MemberwiseClone	创建当前 Object 的浅表副本。（继承自 Object。）
	ToString	返回表示当前对象的字符串。（继承自 Object。）

页首

备注

ExtractionRule 类必须由任何提取规则（无论是用户编写的还是内置的）继承。在收到响应后运行与请求定义关联的提取规则，提取结果将添加到 WebTestContext。

对继承者的说明

当从 ExtractionRule 继承时，必须重写以下成员：Extract、RuleDescription 和 RuleName。

示例

以下自定义提取规则从 HtmlDocument 中提取复选框，并将找到的复选框的状态放到上下文中。

using System;
using Microsoft.VisualStudio.TestTools.WebTesting;

namespace ClassLibrary2
{
    public class ExtractCheckBoxes : ExtractionRule
    {
        private string myContextParameter = "ExtractCBoxParam";
        private bool isChecked = true;

        public override string ContextParameterName
        {
            get { return myContextParameter; }
            set
            {
                if (value != string.Empty)
                    myContextParameter = value;
            }
        }

        public bool FindCheckedBoxes
        {
            get { return isChecked; }
            set { isChecked = value; }
        }

        public override string RuleName
        {
            get { return "Extract Check Boxes"; }
        }

        public override string RuleDescription
        {
            get { return "Extract check boxes based on whether they are" +
                    " checked or not."; }
        }

        public override void Extract(object sender, ExtractionEventArgs e)
        {   
            e.Success = false;
            
            if (e.Response.HtmlDocument != null)
            {   // Gets all input tags
                foreach (HtmlTag tag in e.Response.HtmlDocument
                    .GetFilteredHtmlTags(new string[] { "input" }))
                {   // Verify that current tag is a checkbox
                    if (tag.GetAttributeValueAsString("type") == "checkbox")
                    {   // Is the checkbox checked
                        if (tag.GetAttributeValueAsString("checked") == "CHECKED")
                        {   // Add checked check boxes to context
                            if (isChecked)
                            {
                                e.WebTest.Context.Add(myContextParameter + "_" +
                                    tag.GetAttributeValueAsString("id"),
                                    "Is Checked");
                                e.Success = true;
                            }
                        }
                        else // The checkbox is not checked
                        {   // Add non-checked boxes to context
                            if (!isChecked)
                            {
                                e.WebTest.Context.Add(myContextParameter + "_" +
                                    tag.GetAttributeValueAsString("id"),
                                    "Is Not Checked");
                                e.Success = true;
                            }
                        }
                    }
                }
            }
            if (e.Success)
                e.Message = "Extracted check boxes.";
            else
                e.Message = "No check boxes extracted.";
        }
    }
}

Imports System
Imports Microsoft.VisualStudio.TestTools.WebTesting

Namespace ClassLibrary2
    Public Class ExtractCheckBoxes
        Inherits ExtractionRule

        Private myContextParameter As String = "ExtractCBoxParam"
        Private isChecked As Boolean = True

        Public Overrides Property ContextParameterName() As String
            Get
                Return myContextParameter
            End Get
            Set(ByVal value As String)
                If (value <> String.Empty) Then
                    myContextParameter = value
                End If
            End Set
        End Property

        Public Property FindCheckedBoxes() As Boolean
            Get
                Return isChecked
            End Get
            Set(ByVal value As Boolean)
                isChecked = value
            End Set
        End Property

        Public Overrides ReadOnly Property RuleName() As String
            Get
                Return "Extract Check Boxes"
            End Get
        End Property

        Public Overrides ReadOnly Property RuleDescription() As String
            Get
                Return "Extract check boxes based on whether they are" + _
                    " checked or not."
            End Get
        End Property

        Public Overrides Sub Extract(ByVal sender As Object, ByVal e As ExtractionEventArgs)
            e.Success = False
            If Not e.Response.HtmlDocument Is Nothing Then
                ' Gets all input tags
                Dim tag As HtmlTag
                For Each tag In e.Response.HtmlDocument.GetFilteredHtmlTags(New String() {"input"})
                    ' Verify if current tag is a checkbox
                    If tag.GetAttributeValueAsString("type") = "checkbox" Then
                        ' Is the check box checked
                        If tag.GetAttributeValueAsString("checked") = "CHECKED" Then
                            ' Add checked checkbox to context
                            If isChecked = True Then
                                e.WebTest.Context.Add(myContextParameter + "_" + _
                                tag.GetAttributeValueAsString("id"), "Is Checked")
                                e.Success = True
                            End If
                        Else ' The check box is not checked
                            If isChecked = False Then
                                ' Add non-checked boxes to context
                                e.WebTest.Context.Add(myContextParameter + "_" + _
                                tag.GetAttributeValueAsString("id"), "Is Not Checked")
                                e.Success = True
                            End If
                        End If
                    End If
                Next
            End If
            If e.Success = True Then
                e.Message = "Extracted check boxes."
            Else
                e.Message = "No check boxes extracted."
            End If
        End Sub
    End Class
End Namespace

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared）成员都是线程安全的。但不保证所有实例成员都是线程安全的。

请参见

参考

Microsoft.VisualStudio.TestTools.WebTesting 命名空间

其他资源

如何：为 Web 性能测试创建自定义提取规则

如何：向 Web 性能测试添加提取规则

通过

ExtractionRule 类

继承层次结构

语法

构造函数

属性

方法

备注

示例

线程安全

请参见

参考

其他资源

其他资源