契約Contract(ServiceContract、OperationContract、DataContract、ServiceKnownType和DataMember)
介紹
WCF(Windows Communication Foundation) - 契約(Contract)：服務契約(ServiceContract)，操作契約(OperationContract)，數據契約(DataContract)，服務已知類型(ServiceKnownType)，數據成員(DataMember)。
示例
1、服務
IPersonManager.cs
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using System.Runtime.Serialization;
namespace WCF.ServiceLib.Contract
{
/**//// <summary>
/// 人員管理接口
/// </summary>
// Namespace - 服務契約的命名空間
// Name - 服務契約的名稱（會對應到相關的wsdl，默認情況下本例為接口名“IPersonManager”）
// ConfigurationName - 服務契約在宿主中所配置的服務名稱（默認情況下本例為類的全名“WCF.ServiceLib.Contract.IPersonManager”）
[ServiceContract(Namespace = "http://webabcd.cnblogs.com", Name = "IPersonManager", ConfigurationName = "ConfigurationNameTest")]
// 服務已知類型 - Student（數據契約）繼承自Person（數據契約），要指定Student為已知類型，其才會被序列化
[ServiceKnownType(typeof(Student))]
public interface IPersonManager
{
/**//// <summary>
/// 獲取某人的姓名
/// </summary>
/// <param name="p">Person對象</param>
/// <returns></returns>
// Name - 操作契約的名稱（會對應到相關的wsdl，默認情況下本例為方法名“GetName”）
[OperationContract(Name="GetPersonName")]
string GetName([MessageParameter(Name = "person")] Person p);
}
}
PersonManager.cs
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using System.Runtime.Serialization;
namespace WCF.ServiceLib.Contract
{
/**//// <summary>
/// 人員管理類
/// </summary>
public class PersonManager : IPersonManager
{
/**//// <summary>
/// 獲取某人的姓名
/// </summary>
/// <param name="p">Person對象</param>
/// <returns></returns>
public string GetName(Person p)
{
return "Name: " + p.Name;
}
}
}
Person.cs
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using System.Runtime.Serialization;
namespace WCF.ServiceLib.Contract
{
/**//// <summary>
/// Person的實體類
/// </summary>
// Name - 數據契約的名稱（會對應到相關的wsdl，默認情況下本例為類名“Person”）
[DataContract(Name = "PersonModel")]
public class Person
{
/**//// <summary>
/// Person的實體類的Age屬性
/// </summary>
// Name - 數據成員的名稱（會對應到相關的wsdl，默認情況下本例為屬性名“Age”）
// IsRequired - 該值指示序列化引擎該成員在讀取或反序列化時必須存在
// Order - 數據成員在相關的wsdl中的順序
// EmitDefaultValue - 如果應該在序列化流中生成成員的默認值，則為 true，否則為 false，默認值為 true
[DataMember(Name = "PersonAge", IsRequired = false, Order = 1)]
public int Age { get; set; }
/**//// <summary>
/// Person的實體類的Name屬性
/// </summary>
// Name - 數據成員的名稱（會對應到相關的wsdl，默認情況下本例為屬性名“Name”）
// IsRequired - 該值指示序列化引擎該成員在讀取或反序列化時必須存在
// Order - 數據成員在相關的wsdl中的順序
// EmitDefaultValue - 如果應該在序列化流中生成成員的默認值，則為 true，否則為 false，默認值為 true
[DataMember(Name = "PersonName", IsRequired = false, Order = 0)]
public string Name { get; set; }
}
}
Student.cs
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ServiceModel;
using System.Runtime.Serialization;
namespace WCF.ServiceLib.Contract
{
/**//// <summary>
/// Student的實體類
/// </summary>
// Name - 數據契約的名稱（會對應到相關的wsdl，默認情況下本例為類名“Student”）
[DataContract(Name = "StudentModel")]
public class Student : Person
{
/**//// <summary>
/// Student的實體類的School屬性
/// </summary>
// Name - 數據成員的名稱（會對應到相關的wsdl，默認情況下本例為屬性名“School”）
// IsRequired - 該值指示序列化引擎該成員在讀取或反序列化時必須存在
// Order - 數據成員在相關的wsdl中的順序
// EmitDefaultValue - 如果應該在序列化流中生成成員的默認值，則為 true，否則為 false，默認值為 true
[DataMember(Name = "School", IsRequired = false, Order = 0)]
public string School { get; set; }
}
}
2、宿主
PersonManager.svc
<%@ ServiceHost Language="C#" Debug="true" Service="WCF.ServiceLib.Contract.PersonManager" %>
Web.config
<?xml version="1.0"?> <configuration> <system.serviceModel> <behaviors> <serviceBehaviors> <behavior name="ContractBehavior"> <!--httpGetEnabled - 使用get方式提供服務--> <serviceMetadata httpGetEnabled="true" /> </behavior> </serviceBehaviors> </behaviors> <services> <!--name - 提供服務的類名--> <!--behaviorConfiguration - 指定相關的行為配置--> <service name="WCF.ServiceLib.Contract.PersonManager" behaviorConfiguration="ContractBehavior"> <!--address - 服務地址--> <!--binding - 通信方式--> <!--contract - 服務契約--> <endpoint address="" binding="basicHttpBinding" contract="ConfigurationNameTest" /> </service> </services> </system.serviceModel> </configuration>
3、客戶端
PersonManager.aspx
<%@ Page Language="C#" MasterPageFile="~/Site.master" AutoEventWireup="true" CodeFile="PersonManager.aspx.cs" Inherits="Contract_PersonManager" Title="契約(ServiceContract、OperationContract、DataContract、ServiceKnownType和DataMember)" %> <asp:Content ID="Content1" ContentPlaceHolderID="head" runat="Server"> </asp:Content> <asp:Content ID="Content2" ContentPlaceHolderID="ContentPlaceHolder1" runat="Server"> <asp:TextBox ID="txtName" runat="server" Text="webabcd" /> <asp:Button ID="btnGetName" runat="server" Text="GetName" onclick="btnGetName_Click" /> </asp:Content>
PersonManager.aspx.cs
using System;
using System.Collections;
using System.Configuration;
using System.Data;
using System.Linq;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.HtmlControls;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Xml.Linq;
public partial class Contract_PersonManager : System.Web.UI.Page
{
protected void Page_Load(object sender, EventArgs e)
{
}
protected void btnGetName_Click(object sender, EventArgs e)
{
// Contract.IPersonManager pm = new Contract.PersonManagerClient();
Contract.PersonManagerClient proxy = new Contract.PersonManagerClient();
Contract.StudentModel sm = new Contract.StudentModel() { PersonName = txtName.Text };
Page.ClientScript.RegisterStartupScript(
this.GetType(),
"js",
string.Format("alert('{0}')", proxy.GetPersonName(sm)),
true);
proxy.Close();
}
}
Web.config
<?xml version="1.0"?> <configuration> <system.serviceModel> <client> <!--address - 服務地址--> <!--binding - 通信方式--> <!--contract - 服務契約--> <endpoint address="http://localhost:3502/ServiceHost/Contract/PersonManager.svc" binding="basicHttpBinding" contract="Contract.IPersonManager" /> </client> </system.serviceModel> </configuration>
運行結果：
單擊"btnGetName"後彈出提示框，顯示"Name: webabcd"
OK
