MessageContractAttribute 類別

定義

命名空間:

System.ServiceModel

組件:

System.ServiceModel.Primitives.dll

套件:

System.ServiceModel.Primitives v8.1.1

來源:

MessageContractAttribute.cs

定義對應到 SOAP 訊息的強型別類別。

C#

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Struct, AllowMultiple=false)]
public sealed class MessageContractAttribute : Attribute

繼承

Object

Attribute

MessageContractAttribute

屬性

AttributeUsageAttribute

範例

下列程式碼範例會示範如何使用 MessageContractAttribute 控制要求訊息和回應訊息的 SOAP 封套結構，並說明如何使用 MessageHeaderAttribute 建立回應訊息的 SOAP 標頭和使用 MessageBodyMemberAttribute 指定要求訊息和回應訊息的本文。 這個程式碼範例包含每個所傳送訊息的範例。

C#

using System;
using System.Collections.Generic;
using System.Runtime.Serialization;
using System.ServiceModel;
using System.ServiceModel.Channels;

namespace Microsoft.WCF.Documentation
{
  [ServiceContract(Namespace = "Microsoft.WCF.Documentation")]
  interface IMessagingHello
  {
    [OperationContract(
     Action = "http://GreetingMessage/Action",
     ReplyAction = "http://HelloResponseMessage/Action"
    )]
    HelloResponseMessage Hello(HelloGreetingMessage msg);
  }

  [MessageContract]
  public class HelloResponseMessage
  {
    private string localResponse = String.Empty;
    private string extra = String.Empty;

    [MessageBodyMember(
      Name = "ResponseToGreeting",
      Namespace = "http://www.examples.com")]
    public string Response
    {
      get { return localResponse; }
      set { localResponse = value; }
    }

    [MessageHeader(
      Name = "OutOfBandData",
      Namespace = "http://www.examples.com",
      MustUnderstand=true
    )]
    public string ExtraValues
    {
      get { return extra; }
      set { this.extra = value; }
   }

   /*
    The following is the response message, edited for clarity.

    <s:Envelope>
      <s:Header>
        <a:Action s:mustUnderstand="1">http://HelloResponseMessage/Action</a:Action>
        <h:OutOfBandData s:mustUnderstand="1" xmlns:h="http://www.examples.com">Served by object 13804354.</h:OutOfBandData>
      </s:Header>
      <s:Body>
        <HelloResponseMessage xmlns="Microsoft.WCF.Documentation">
          <ResponseToGreeting xmlns="http://www.examples.com">Service received: Hello.</ResponseToGreeting>
        </HelloResponseMessage>
      </s:Body>
    </s:Envelope>
    */
 }
  [MessageContract]
  public class HelloGreetingMessage
  {
    private string localGreeting;

    [MessageBodyMember(
      Name = "Salutations",
      Namespace = "http://www.examples.com"
    )]
    public string Greeting
    {
      get { return localGreeting; }
      set { localGreeting = value; }
    }
  }

  /*
   The following is the request message, edited for clarity.

    <s:Envelope>
      <s:Header>
        <!-- Note: Some header content has been removed for clarity.
        <a:Action>http://GreetingMessage/Action</a:Action>
        <a:To s:mustUnderstand="1"></a:To>
      </s:Header>
      <s:Body u:Id="_0" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
        <HelloGreetingMessage xmlns="Microsoft.WCF.Documentation">
          <Salutations xmlns="http://www.examples.com">Hello.</Salutations>
        </HelloGreetingMessage>
      </s:Body>
   </s:Envelope>
   */

  class MessagingHello : IMessagingHello
  {
    public HelloResponseMessage Hello(HelloGreetingMessage msg)
    {
      Console.WriteLine("Caller sent: " + msg.Greeting);
      HelloResponseMessage responseMsg = new HelloResponseMessage();
      responseMsg.Response = "Service received: " + msg.Greeting;
      responseMsg.ExtraValues = String.Format("Served by object {0}.", this.GetHashCode().ToString());
      Console.WriteLine("Returned response message.");
      return responseMsg;
    }
  }
}

備註

您可以使用 MessageContractAttribute 屬性指定特定訊息的 SOAP 封套結構。 然後，您的服務便可將訊息當成服務作業中的參數或傳回型別使用。 如需控制 SOAP 主體內容的序列化，而不需修改預設 SOAP 信封本身的資訊，請參閱 System.Runtime.Serialization.DataContractAttribute 在 服務合約中指定資料傳輸，以及 使用資料合約。

備註

您無法在服務作業中透過一般的可序列化參數使用自訂訊息類型， 但可使用不是 Message 物件的自訂訊息類型或可序列化參數。 如需詳細資訊，請參閱 在服務合約中指定資料傳輸。

若要實作某類型的訊息合約，請使用 加以標註，並且使用 、 或 標註一個或多個類別欄位或屬性。

備註

System.ServiceModel.MessageParameterAttribute 不是訊息合約屬性，無法與 MessageContractAttribute 一起使用。

請使用 Action 和 ReplyAction 屬性指定 SOAP 訊息中 <Action> 項目的值。

• 請使用 HasProtectionLevel 和 ProtectionLevel 屬性指示 SOAP 訊息類型是否有保護層級，以及是哪一種層級 (如果有的話)。

• 請使用 IsWrapped 屬性指示訊息本文是否有包裝函式項目，如果有的話，則使用 WrapperName 和 WrapperNamespace 屬性分別指定包裝函式項目的名稱和命名空間。

如需詳細資訊，請參閱 使用訊息合約。

建構函式

MessageContractAttribute()

初始化 MessageContractAttribute 類別的新執行個體。

屬性

IsWrapped	取得或設定值，這個值會指定訊息本文是否有包裝函式項目。
WrapperName	取得或設定訊息本文中包裝函式項目的名稱。
WrapperNamespace	取得或設定訊息本文包裝函式項目的命名空間。

適用於