WebGetAttribute 类

定义

命名空间:

System.ServiceModel.Web

程序集:

System.ServiceModel.Web.dll

表示属性，该属性指示服务操作在逻辑上是检索操作，而且可由 WCF REST 编程模型调用。

public ref class WebGetAttribute sealed : Attribute, System::ServiceModel::Description::IOperationBehavior

[System.AttributeUsage(System.AttributeTargets.Method)]
public sealed class WebGetAttribute : Attribute, System.ServiceModel.Description.IOperationBehavior

[<System.AttributeUsage(System.AttributeTargets.Method)>]
type WebGetAttribute = class
    inherit Attribute
    interface IOperationBehavior

Public NotInheritable Class WebGetAttribute
Inherits Attribute
Implements IOperationBehavior

继承

Object

Attribute

WebGetAttribute

属性

AttributeUsageAttribute

实现

IOperationBehavior

示例

下面的示例演示如何使用 WebGetAttribute 特性。

[ServiceContract]
public interface ICalculator
{
    [OperationContract]
    [WebGet]
    long Add(long x, long y);

    [OperationContract]
    [WebGet(UriTemplate = "Sub?x={x}&y={y}")]
    long Subtract(long x, long y);

    [OperationContract]
    [WebGet(UriTemplate = "Mult?x={x}&y={y}", BodyStyle = WebMessageBodyStyle.Bare)]
    long Multiply(long x, long y);

    [OperationContract]
    [WebGet(UriTemplate = "Div?x={x}&y={y}", RequestFormat = WebMessageFormat.Xml)]
    long Divide(long x, long y);

    [OperationContract]
    [WebGet(ResponseFormat= WebMessageFormat.Json)]
    long Mod(long x, long y);
}

<ServiceContract()> _
Public Interface ICalculator
    <OperationContract()> _
    <WebGet()> _
    Function Add(ByVal x As Long, ByVal y As Long) As Long

    <OperationContract()> _
    <WebGet(UriTemplate:="Sub?x={x}&y={y}")> _
    Function Subtract(ByVal x As Long, ByVal y As Long) As Long

    <OperationContract()> _
    <WebGet(UriTemplate:="Mult?x={x}&y={y}", BodyStyle:=WebMessageBodyStyle.Bare)> _
    Function Multiply(ByVal x As Long, ByVal y As Long) As Long

    <OperationContract()> _
    <WebGet(UriTemplate:="Div?x={x}&y={y}", RequestFormat:=WebMessageFormat.Xml)> _
    Function Divide(ByVal x As Long, ByVal y As Long) As Long

    <OperationContract()> _
    <WebGet(ResponseFormat:=WebMessageFormat.Json)> _
    Function Modulo(ByVal x As Long, ByVal y As Long) As Long
End Interface

注解

除了 WebGetAttribute 之外，OperationContractAttribute 属性也会应用到服务操作，并将该操作与 UriTemplate 以及 HTTP 协议 Get 谓词相关联。 与 HTTP Get 谓词相关联意味着该操作可用于从服务中检索信息。 该 WebGetAttribute 属性 是被动操作 行为， (IOperationBehavior 方法不执行任何) 向操作说明添加元数据的操作。 将 WebGetAttribute 特性应用到服务操作无任何效果，除非将在操作说明中查找此元数据的行为（如 WebHttpBehavior）添加到服务的行为集合中。

所有已应用 WebGetAttribute 特性的服务操作在逻辑上都应为检索操作。 HTTP GET 方法会与所有用 WebGetAttribute 特性标记的操作相关联。

构造函数

WebGetAttribute()

初始化 WebGetAttribute 类的新实例。

属性

BodyStyle	获取或设置传入与传出服务操作的消息的正文样式。
IsBodyStyleSetExplicitly	获取 IsBodyStyleSetExplicitly 属性。
IsRequestFormatSetExplicitly	获取 IsRequestFormatSetExplicitly 属性。
IsResponseFormatSetExplicitly	获取 IsResponseFormatSetExplicitly 属性。
RequestFormat	获取或设置 RequestFormat 属性。
ResponseFormat	获取或设置 ResponseFormat 属性。
TypeId	在派生类中实现时，获取此 Attribute 的唯一标识符。 (继承自 Attribute)
UriTemplate	获取或设置用于服务操作的统一资源标识符 (URI) 模板。

方法

Equals(Object)	返回一个值，该值指示此实例是否与指定的对象相等。 (继承自 Attribute)
GetHashCode()	返回此实例的哈希代码。 (继承自 Attribute)
GetType()	获取当前实例的 Type。 (继承自 Object)
IsDefaultAttribute()	在派生类中重写时，指示此实例的值是否是派生类的默认值。 (继承自 Attribute)
Match(Object)	当在派生类中重写时，返回一个指示此实例是否等于指定对象的值。 (继承自 Attribute)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
ToString()	返回表示当前对象的字符串。 (继承自 Object)

显式接口实现

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	将一组名称映射为对应的一组调度标识符。 (继承自 Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	检索对象的类型信息，然后可以使用该信息获取接口的类型信息。 (继承自 Attribute)
_Attribute.GetTypeInfoCount(UInt32)	检索对象提供的类型信息接口的数量（0 或 1）。 (继承自 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	提供对某一对象公开的属性和方法的访问。 (继承自 Attribute)
IOperationBehavior.AddBindingParameters(OperationDescription, BindingParameterCollection)	实现 AddBindingParameters(OperationDescription, BindingParameterCollection) 方法。
IOperationBehavior.ApplyClientBehavior(OperationDescription, ClientOperation)	实现 ApplyClientBehavior(OperationDescription, ClientOperation) 方法。
IOperationBehavior.ApplyDispatchBehavior(OperationDescription, DispatchOperation)	实现 ApplyDispatchBehavior(OperationDescription, DispatchOperation) 方法。
IOperationBehavior.Validate(OperationDescription)	实现 Validate(OperationDescription) 方法。