詳解WCF中的變更處理：不可不知的最佳實(shí)踐
譯文【51CTO快譯】變更總是存在的，包括需求變更、環(huán)境變更和過(guò)程變更。這些因素加在一起使你的WCF服務(wù)也會(huì)發(fā)生變更，幸運(yùn)的是，可以在設(shè)計(jì)之初就采取一些方法來(lái)盡量避免這些變更，或者說(shuō)減少變更給用戶(hù)和自己帶來(lái)的影響。
本文探討的不僅僅是前期如何做才能減少變更次數(shù)，同時(shí)還討論了在遇到未曾預(yù)見(jiàn)的大型變更前該如何應(yīng)對(duì)。
51CTO編輯推薦：WCF開(kāi)發(fā)基礎(chǔ)專(zhuān)題
確定變更
在開(kāi)始著手處理變更之前，有必要弄清楚在基于WCF的服務(wù)中發(fā)生變更意味著什么，下面的行為構(gòu)成了變更：
1、數(shù)據(jù)契約
（1）增加一個(gè)數(shù)據(jù)成員
（2）移除一個(gè)數(shù)據(jù)成員
（3）重命名一個(gè)數(shù)據(jù)成員
（4）改變數(shù)據(jù)成員的類(lèi)型
2、服務(wù)契約
（1）增加一個(gè)操作
（2）移除一個(gè)操作
（3）重命名服務(wù)契約
3、操作契約
（1）重命名一個(gè)操作
（2）修改操作的簽名
這些變更可能源于新的業(yè)務(wù)需求、硬件整合、業(yè)務(wù)兼并、新條例或任何其它外部因素，底線(xiàn)是當(dāng)某些東西超出了開(kāi)發(fā)人員的控制變更外，軟件就必須要調(diào)整，在WCF世界中處理變更總是有好消息也有壞消息，因?yàn)橛袝r(shí)候處理起來(lái)很簡(jiǎn)單，但有時(shí)候會(huì)讓你懼怕，但卻不得不響應(yīng)。
WCF中的版本和變更控制
在.Net世界中，處理變更時(shí)第一個(gè)要考慮的就是如何控制版本，通過(guò)版本組裝，可以在后續(xù)的組件版本中允許無(wú)法預(yù)料的或有問(wèn)題的變更，使用這種方式，受影響的客戶(hù)端可以繼續(xù)使用舊版本，你就可以避免因變更引起的頭痛問(wèn)題。
那么WCF支持版本控制嗎？答案有點(diǎn)擔(dān)憂(yōu)。當(dāng)你在WCF中創(chuàng)建一個(gè)數(shù)據(jù)契約時(shí)，這個(gè)契約會(huì)生成一個(gè)XML schema，引用這個(gè)schema的用戶(hù)使用它生成一個(gè)代理類(lèi)，嚴(yán)格地說(shuō)，數(shù)據(jù)沒(méi)有經(jīng)過(guò)這個(gè)schema驗(yàn)證，正如你將看到的，這將對(duì)服務(wù)使用者產(chǎn)生一些異?；蛄钊司趩实男袨?。
在進(jìn)入細(xì)節(jié)前，仔細(xì)研究下面例子自己先熟悉一下，它提供了本文剩余部分討論的基礎(chǔ)：
namespace SampleService
{
[ServiceContract]
public interface IPersonService
{
[OperationContract]
Person GetPerson(int personId);
[OperationContract]
void UpdatePerson(Person p);
}
public class Person
{
private string _firstName = string.Empty;
private string _lastName = string.Empty;
[DataMember]
public string FirstName
{
get { return _firstName; }
set { _firstName = value; }
}
[DataMember]
public string LastName
{
get { return _lastName; }
set { _lastName = value; }
}
}
}
數(shù)據(jù)契約變更
Person DataContract定義了兩個(gè)屬性：FirstName和LastName，如果某個(gè)客戶(hù)的引用了這個(gè)服務(wù)，你接著將LastName改為SurName，客戶(hù)的不會(huì)被真正斷開(kāi)，只不過(guò)在客戶(hù)端的代理類(lèi)中，LastName屬性將會(huì)顯示為空，這時(shí)因?yàn)楫?dāng)客戶(hù)的將消息持久化到Person類(lèi)時(shí)，發(fā)現(xiàn)沒(méi)有任何名叫LastName的元素了。
這個(gè)簡(jiǎn)單的變更不會(huì)讓客戶(hù)端出現(xiàn)異常錯(cuò)誤，但糟糕的是會(huì)導(dǎo)致一個(gè)異常行為，除非你親自了解每個(gè)客戶(hù)的應(yīng)用程序使用的web服務(wù)，修改將會(huì)是災(zāi)難性的，作為一名開(kāi)發(fā)人員，你應(yīng)該盡一切努力來(lái)保護(hù)變更給客戶(hù)帶來(lái)的影響。
最初，你可以先應(yīng)用一些最佳實(shí)踐，幫助那些孤立的客戶(hù)端應(yīng)對(duì)變更，一個(gè)數(shù)據(jù)契約的升級(jí)版本看起來(lái)如：
在DataContract和DataMember屬性上增加了Namespace、Name和Order參數(shù)來(lái)控制DataContractSerializer的行為，引用這些服務(wù)時(shí)會(huì)增加一個(gè)客戶(hù)端代理，Name參數(shù)會(huì)導(dǎo)致串行轉(zhuǎn)換器使用標(biāo)示的值，而不是真實(shí)的公共成員或?qū)傩缘拿?，這種方法允許在內(nèi)部實(shí)現(xiàn)變更，不影響客戶(hù)端，如下面的變更：
[DataMember(Name="LastName")]
public string SurName
{
get { return _lastName; }
set { _lastName = value; }
}
屬性名從LastName變成SurName將會(huì)中斷現(xiàn)有的客戶(hù)端，因?yàn)榭蛻?hù)端使用的Name參數(shù)任然是LastName，僅僅內(nèi)部實(shí)現(xiàn)變更了。
第二個(gè)顯而易見(jiàn)的變更是增加了IExtensibleDataObject接口，實(shí)現(xiàn)這個(gè)接口讓未在契約中明確定義的客戶(hù)端保留數(shù)據(jù)，這看起來(lái)沒(méi)什么作用，但是當(dāng)客戶(hù)端希望在同一個(gè)Person對(duì)象上執(zhí)行處理并返回時(shí)就有用了，客戶(hù)端可以保留新的數(shù)據(jù)項(xiàng)。例如，使用下面的新成員更新PersonContract不會(huì)強(qiáng)制現(xiàn)有的客戶(hù)端也跟著一起更新：
[DataMember(Name = "MiddleName", Order = 3)]
public string SurName
{
get { return _middleName; }
set { _middleName = value; }
}
事實(shí)上，這個(gè)成員將允許現(xiàn)有的客戶(hù)端保留一個(gè)值放于MiddleName，實(shí)現(xiàn)IExtensibleDataObject對(duì)于未來(lái)你的數(shù)據(jù)契約是一個(gè)好方法，作為一個(gè)最佳實(shí)踐，你應(yīng)該在所有數(shù)據(jù)契約中使用它。
請(qǐng)記住，客戶(hù)端實(shí)際上可以選擇一個(gè)外部schema驗(yàn)證消息，因此，你在處理數(shù)據(jù)契約變更時(shí)有兩件事需要考慮：有schema驗(yàn)證和無(wú)schema驗(yàn)證。
當(dāng)客戶(hù)端添加了schema驗(yàn)證后，數(shù)據(jù)契約中任何添加、修改或減去數(shù)據(jù)項(xiàng)的行為都將導(dǎo)致驗(yàn)證失敗，因此，在實(shí)際生活照，試驗(yàn)了任何嚴(yán)格的schema驗(yàn)證后，契約就不應(yīng)該改變了，相反，你應(yīng)該創(chuàng)建一個(gè)全新的契約并在契約中使用不同的命名空間，以表明是新版本。
例如，從實(shí)現(xiàn)的視角來(lái)看，你應(yīng)該需要兩個(gè)獨(dú)立的服務(wù)點(diǎn)來(lái)使這兩個(gè)版本可用：
幸運(yùn)的是，嚴(yán)格的schema驗(yàn)證不是默認(rèn)行為，這意味著你在不中斷客戶(hù)端的情況下可以添加或移除數(shù)據(jù)成員，然而，根據(jù)前面討論過(guò)的異常行為，移除一個(gè)數(shù)據(jù)成員不是個(gè)好主意，換句話(huà)說(shuō)，增加一個(gè)數(shù)據(jù)成員容易，用戶(hù)會(huì)忽略他們不知道的額外成員。
最關(guān)鍵的是使用DataMember屬性的Order參數(shù)，使用這個(gè)參數(shù)告訴串行轉(zhuǎn)化器在XML中各個(gè)成員應(yīng)該顯示成怎么樣，一個(gè)非預(yù)期的變更可能會(huì)導(dǎo)致XML與原始schema不一致，從一開(kāi)始就使用Order參數(shù)可以避免這個(gè)問(wèn)題，如果你不使用Order參數(shù)，串行轉(zhuǎn)化器將按照下面的順序執(zhí)行：
1、來(lái)自基礎(chǔ)類(lèi)型的成員
2、無(wú)Order參數(shù)的成員（按字母順序）
3、有Order參數(shù)的成員（按值的順序）
數(shù)據(jù)契約變更的最后一種情況是修改數(shù)據(jù)成員的類(lèi)型，在這種情況下，最佳的做法是和新的服務(wù)契約、實(shí)現(xiàn)和終結(jié)點(diǎn)一道創(chuàng)建一個(gè)新版本的數(shù)據(jù)契約。
服務(wù)契約變更
再說(shuō)一次，所有服務(wù)契約應(yīng)該按照最佳實(shí)踐，在ServiceContract屬性上同時(shí)使用Name和Namespace參數(shù)，Person服務(wù)契約的一個(gè)更新版本看起來(lái)如：
[ServiceContract(Name="PersonService", Namespace="
public interface IPersonService
和數(shù)據(jù)契約一樣，使用Name隔離服務(wù)用戶(hù)和真實(shí)接口名，允許內(nèi)部實(shí)現(xiàn)按需變更，Namespace允許你在將來(lái)對(duì)契約進(jìn)行版本控制，記住新版本也需要新的終點(diǎn)。
可以在不中斷現(xiàn)有用戶(hù)的情況下往服務(wù)契約中添加操作，用戶(hù)會(huì)忽略新增加的操作。另一方面，移除操作將會(huì)中斷現(xiàn)有用戶(hù)，如同所有的中斷變更，移除操作需要一個(gè)新版本和一個(gè)新的終點(diǎn)。
操作契約變更
與服務(wù)契約和數(shù)據(jù)契約一樣，應(yīng)該在OperationContract屬性上使用Name參數(shù)：
[OperationContract(Name="GetPerson"]
Person GetPerson(int personId);
再說(shuō)一次，在內(nèi)部實(shí)現(xiàn)中用戶(hù)和變更是隔離的。
最后一個(gè)需要考慮的變更是操作契約的簽名，這是一個(gè)中斷變更，有兩種解決方案：創(chuàng)建一個(gè)新版本或在服務(wù)契約上添加一個(gè)新操作。
遵守你的承諾
變更是不可避免的，但要做好規(guī)劃，并遵循一些原則，可以講WCF服務(wù)上變更的影響降到最低，記住，當(dāng)你發(fā)布一個(gè)服務(wù)時(shí)，你應(yīng)該向用戶(hù)提供一個(gè)承諾，讓他們保證遵守契約，在現(xiàn)有的契約上做改動(dòng)不是一件好事。
為此，請(qǐng)記住下面這些最佳實(shí)踐：
1、在所有契約上使用Name和Namespace參數(shù)；
2、在數(shù)據(jù)成員上總是使用Order參數(shù)；
3、在所有數(shù)據(jù)契約上實(shí)現(xiàn)IExtensibleDataObject；
4、為契約版本控制使用命名空間；
5、記住所有新版本都需要新的終點(diǎn)；
6、使用嚴(yán)格的schema驗(yàn)證時(shí)，不要修改契約，創(chuàng)建一個(gè)新版本；
7、從服務(wù)契約中移除一個(gè)操作時(shí)，請(qǐng)創(chuàng)建一個(gè)新版本；
8、改變一個(gè)操作的簽名時(shí)，請(qǐng)創(chuàng)建一個(gè)新版本。
記住這些最佳實(shí)踐后，在處理你自身或服務(wù)用戶(hù)提出的變更時(shí)就會(huì)游刃有余了。
原文：Best Practices for Handling Change in Your WCF Applications
作者：Steve Stefanovich
【編輯推薦】
