在列表中添加新值是一種常見(jiàn)而且必要的需求。模式設(shè)計(jì)者通常希望在系統(tǒng)架構(gòu)中構(gòu)建一種添加附加值的方法，并且該附加值在設(shè)計(jì)階段是未知的。模式設(shè)計(jì)者如何創(chuàng)建一個(gè)可擴(kuò)展、易于實(shí)現(xiàn)的枚舉值列表？本文將介紹幾種實(shí)現(xiàn)這一目標(biāo)的方法。
模式設(shè)計(jì)者和實(shí)現(xiàn)人員需要一種擴(kuò)展 XML 模式中現(xiàn)有枚舉列表的方法。不幸的是，XML 模式規(guī)范不允許在這些列表的創(chuàng)建過(guò)程中（參閱 參考資料）進(jìn)行擴(kuò)展。設(shè)計(jì)階段所選的值是固定的，而且都是可用的。盡管有這樣的限制，人們?nèi)允褂酶鞣N替代方案來(lái)實(shí)現(xiàn)列表擴(kuò)展。很多使用現(xiàn)有的不能改變的模式的客戶經(jīng)常提出這一要求。他們希望在添加新功能的同時(shí)保持向后兼容性。本文中，您將會(huì)看到模式設(shè)計(jì)者如何克服障礙實(shí)現(xiàn)該功能。
枚舉列表 是特定數(shù)據(jù)點(diǎn)的一組指定值。例如，您也許通過(guò)固定的值列表查看國(guó)家代碼，包括 DE（德國(guó)）、US（美國(guó)）和 JP（日本）。根據(jù)給定的值集，當(dāng)一個(gè)新國(guó)家被識(shí)別出時(shí)，如 TL（東帝汶）或者 BA（波斯尼亞及黑塞哥維那），該怎么辦？使用以前的名稱列表的客戶必須改變實(shí)現(xiàn)來(lái)容納新值。
當(dāng)使用 XML 模式對(duì)數(shù)據(jù)建模時(shí)，枚舉值被顯式列出。因此，國(guó)家代碼列表依次包含各個(gè)枚舉值。經(jīng)常需要識(shí)別列表中的新值，而且必須將其容納到列表中，模式設(shè)計(jì)者試圖找到一種擴(kuò)展列表的方法，實(shí)際上，是將這種方法構(gòu)建到設(shè)計(jì)中，允許添加在設(shè)計(jì)時(shí)未知的附加值。
創(chuàng)建可擴(kuò)展的枚舉列表
在尋找這一問(wèn)題的解決方案時(shí)，受到四個(gè)關(guān)鍵標(biāo)準(zhǔn)的影響：
首先，要在設(shè)計(jì)階段之后擴(kuò)展列表。不管是快速建立一個(gè)新的貿(mào)易伙伴還是建立時(shí)間關(guān)鍵型的新數(shù)據(jù)字段，在關(guān)鍵時(shí)刻進(jìn)行擴(kuò)展是一項(xiàng)實(shí)際需求。
其次，能夠在解析器中驗(yàn)證值對(duì)于簡(jiǎn)化實(shí)現(xiàn)是非常關(guān)鍵的。
第三，在單個(gè)周期內(nèi)完成解析和驗(yàn)證是至關(guān)重要的。這就避免了像 Genericode 解決方案一樣，在一個(gè)單獨(dú)的周期和解析器中進(jìn)行驗(yàn)證。對(duì)于某些設(shè)置來(lái)說(shuō)，添加新技術(shù)需求會(huì)導(dǎo)致成本太高或者太耗時(shí)。
最后，解決方案必須能夠向后兼容原始的模式。不兼容的列表更改不能稱為擴(kuò)展。
有些人認(rèn)為根本就不應(yīng)該擴(kuò)展枚舉列表。數(shù)據(jù)建模人員也許認(rèn)為如果想讓模型包含更多數(shù)據(jù)、擴(kuò)展模型，那么可以根據(jù)產(chǎn)品創(chuàng)建模式 — 實(shí)際上，在需要時(shí)創(chuàng)建更大的模型并減少限制。如果能夠控制原始模式和數(shù)據(jù)模型，這樣做是可以的，這種方法也許是理想的方法。但是，如果您需要在設(shè)計(jì)階段之后進(jìn)行實(shí)際擴(kuò)展，這樣的方法是行不通的。
還有人認(rèn)為擴(kuò)展枚舉列表的關(guān)鍵是不使用 XML 模式驗(yàn)證解析器。Genericode（參閱 參考資料）建議在第二層對(duì)枚舉列表進(jìn)行驗(yàn)證，脫離初始的 XML 模式解析器驗(yàn)證過(guò)程。這種理論是正確的，而且這種方法的應(yīng)用會(huì)越來(lái)越廣泛。但是，如果要在一個(gè)解析周期內(nèi)完成，這種解決方案是無(wú)法做到的。在某些情況下，不可能執(zhí)行第二個(gè)驗(yàn)證周期。
當(dāng)然，您可以在新列表中創(chuàng)建新元素。但是，不能向后兼容原始模式。我們的目標(biāo)是在保持向后兼容性的同時(shí)實(shí)現(xiàn)一個(gè)可擴(kuò)展的列表（參閱 參考資料）。
對(duì)于本文的目標(biāo)，這里作出的假設(shè)基于我與客戶打交道的經(jīng)驗(yàn) —— 即用附加值擴(kuò)展現(xiàn)有枚舉列表的需求。另外，我假設(shè)在一個(gè)步驟內(nèi)完成 XML 模式解析與驗(yàn)證等操作。
擴(kuò)展枚舉列表的必要條件
該擴(kuò)展示例有四個(gè)必要條件：
允許在設(shè)計(jì)階段之后擴(kuò)展枚舉列表。
用解析器驗(yàn)證枚舉列表。
在一個(gè)周期內(nèi)驗(yàn)證枚舉列表。
維持和原始模式的向后兼容性。
舉例來(lái)說(shuō)，一個(gè)團(tuán)隊(duì)需要處理一個(gè)區(qū)域產(chǎn)業(yè)協(xié)會(huì)的枚舉列表（或任意現(xiàn)有列表）為例，并根據(jù)使用修改模式組件。先前的模式提供 MaritalStatus 組件和值的枚舉列表，如 清單 1 所示。
清單 1. 婚姻狀況枚舉列表

<xsd:simpleType name="MaritalStatusEnumType">
<xsd:restriction base="xsd:normalizedString">
<xsd:enumeration value="Divorced"/>
<xsd:enumeration value="Married"/>
<xsd:enumeration value="NeverMarried"/>
<xsd:enumeration value="Separated"/>
<xsd:enumeration value="SignificantOther"/>
<xsd:enumeration value="Widowed"/>
<xsd:enumeration value="Unknown"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:element name="MaritalStatus" type="MaritalStatusEnumType"/>
假設(shè)一個(gè)公司要使用這些值，另外，還要支持它的重要貿(mào)易伙伴使用另一個(gè)值。CivilUnion 是一個(gè)擴(kuò)展值，公司識(shí)別出該值不屬于原始模式。但是從語(yǔ)義上來(lái)說(shuō)，使用現(xiàn)有元素 —MaritalStatus — 也是可以的。公司要如何實(shí)現(xiàn)呢？
回頁(yè)首
解決方案 1： 編輯原始模式使其包含新枚舉值
當(dāng)然，編輯原始模式使其包含新枚舉值是最直接的方法。保留模式的本地副本，然后編輯這些模式以支持公司使用的枚舉值。
優(yōu)點(diǎn)：易于實(shí)現(xiàn)
缺點(diǎn)：
需要編輯原始模式，這些模式將逐漸改變，以至于無(wú)法控制。如果擴(kuò)展一個(gè)先前存在的列表，那么創(chuàng)建者（貿(mào)易伙伴、協(xié)會(huì)等）可能要發(fā)布列表的新版本。您需要將編輯的內(nèi)容傳播到每個(gè)新版本中。
手動(dòng)編輯模式會(huì)導(dǎo)致意外的編輯錯(cuò)誤。
如果您不能（或不想）編輯原始模式，則需要一種替代方法。
回頁(yè)首
解決方案 2： 創(chuàng)建新枚舉列表并加入到原始列表中
第二個(gè)選擇是創(chuàng)建新枚舉列表，并將其加入到原始枚舉列表中。清單 1 顯示原始婚姻狀況列表。清單 2 顯示最新創(chuàng)建的枚舉列表。
清單 2. 新婚姻狀況枚舉列表

<xsd:simpleType name="MyExtMaritalStatusEnumType">
<xsd:restriction base="xsd:normalizedString">
<xsd:enumeration value="CivilUnion"/>
</xsd:restriction>
</xsd:simpleType>
使用 <xsd:union> 標(biāo)記將其與原始列表結(jié)合，如 清單 3 所示。
清單 3. 將兩個(gè)列表組合起來(lái)

<xsd:simpleType name="MaritalStatusType_Union">
<xsd:union memberTypes="MyExtMaritalStatusEnumType MaritalStatusEnumType"/>
</xsd:simpleType>
<xsd:element name="MaritalStatus" type="MaritalStatusType_Union"/>
該解決方案仍然需要對(duì)模式進(jìn)行編輯 — 即將元素 MaritalStatus 由 MaritalStatusType 類型轉(zhuǎn)換為 MaritalStatusType_Union 類型。改動(dòng)不大，但仍然有一些手動(dòng)編輯工作。
優(yōu)點(diǎn)：不改變?cè)济杜e列表。
缺點(diǎn)：
在設(shè)計(jì)階段所有的值必須是已知的，防止后期綁定解決方案。
需要 <xsd:union> 標(biāo)記支持，但有時(shí)該標(biāo)記無(wú)法用工具實(shí)現(xiàn)。
回頁(yè)首
解決方案 3： 創(chuàng)建一個(gè)模式，并與原始枚舉類型結(jié)合
現(xiàn)在看一下有關(guān)眼睛顏色的人口數(shù)據(jù)用例。清單 4 顯示這一列表。
清單 4. Person Eye Color 枚舉列表

<xsd:simpleType name="PersonEyeColorType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Black"/>
<xsd:enumeration value="Hazel"/>
<xsd:enumeration value="Gray"/>
<xsd:enumeration value="Brown"/>
<xsd:enumeration value="Violet"/>
<xsd:enumeration value="Green"/>
<xsd:enumeration value="Blue"/>
<xsd:enumeration value="Maroon"/>
<xsd:enumeration value="Pink"/>
<xsd:enumeration value="Dichromatic"/>
<xsd:enumeration value="Unknown"/>
</xsd:restriction>
</xsd:simpleType>
接下來(lái)，創(chuàng)建采用新值的模式（一個(gè)正則表達(dá)式）。該模式是以 x: 為前綴的任意字符串。x: 是標(biāo)準(zhǔn)枚舉列表和擴(kuò)展列表之間的描繪程序。清單 5 顯示這一模式。
清單 5. 用于擴(kuò)展的正則表達(dá)式

<xsd:simpleType name="StringPatternType">
<xsd:restriction base="xsd:string">
<xsd:pattern value="x:\S.*"/>
</xsd:restriction>
</xsd:simpleType>
最后，使用 <xsd:union> 標(biāo)記結(jié)合列表與模式，如 清單 6 所示。
清單 6. 枚舉列表與擴(kuò)展模式的結(jié)合

<xsd:simpleType name="MyExtPersonEyeColorType">
<xsd:union memberTypes="PersonEyeColorType StringPatternType"/>
</xsd:simpleType>
<xsd:element name="PersonEyeColor" type="MyExtPersonEyeColorType"/>
同一節(jié)點(diǎn)擁有標(biāo)準(zhǔn)和擴(kuò)展值。兩個(gè)值很容易分離，而且都可以用解析器驗(yàn)證，如 清單 7 所示。
清單 7. XML 實(shí)例樣例

<PersonEyeColor>Black</PersonEyeColor>
<PersonEyeColor>x:Teal</PersonEyeColor>
優(yōu)點(diǎn)：
同一元素可用于所有數(shù)據(jù)。
用解析器對(duì)基本枚舉列表進(jìn)行驗(yàn)證。
清晰地分隔擴(kuò)展值。
該解決方案允許在以后綁定新值。
缺點(diǎn)：
必須解析元素的內(nèi)容，以確定是否已經(jīng)被擴(kuò)展。
模式解析器必須支持正則表達(dá)式。
需要 <xsd:union> 標(biāo)記支持。
回頁(yè)首
解決方案 4：使用單獨(dú)的字段用于擴(kuò)展
在該解決方案中，枚舉字段不會(huì)變化。然而，您要在模式中設(shè)計(jì)一個(gè)擴(kuò)展字段來(lái)容納附加值。在本例中，初始列表是依賴型的（就業(yè)受益者和受養(yǎng)人之間的關(guān)系），如 清單 8 所示。
清單 8. 依賴關(guān)系枚舉列表

<xsd:simpleType name="DependentRelationshipEnumType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="AdoptedChild"/>
<xsd:enumeration value="Brother"/>
<xsd:enumeration value="Child"/>
<xsd:enumeration value="ExSpouse"/>
<xsd:enumeration value="Father"/>
<xsd:enumeration value="Granddaughter"/>
<xsd:enumeration value="Grandson"/>
<xsd:enumeration value="Grandfather"/>
<xsd:enumeration value="Grandmother"/>
<xsd:enumeration value="LifePartner"/>
<xsd:enumeration value="Mother"/>
<xsd:enumeration value="Sister"/>
<xsd:enumeration value="Spouse"/>
<xsd:enumeration value="Extension"/>
</xsd:restriction>
</xsd:simpleType>
需要一個(gè)能夠容納新值的附加屬性 — extension—。清單 9 顯示了該屬性。
清單 9. 依賴關(guān)系的 extension 屬性

<xsd:complexType name="DependentRelationshipType">
<xsd:simpleContent>
<xsd:extension base="DependentRelationshipEnumType">
<xsd:attribute name="extension" type="xsd:string"/>
</xsd:extension>
</xsd:simpleContent>
</xsd:complexType>
<xsd:element name="DependentRelationship" type="DependentRelationshipType"/>
清單 10 顯示一些反映 extension 的 XML 實(shí)例。
清單 10. 示例 XML 實(shí)例

<DependentRelationship>Child</DependentRelationship>
<DependentRelationship extension="MyNewRelationship">Extension</DependentRelationship>
優(yōu)點(diǎn)：
不需要編輯原始模式。
該解決方案允許在以后綁定新值。
在原始模式中顯式設(shè)計(jì) extension 方法。
缺點(diǎn)：
在設(shè)計(jì)階段，必須在每個(gè)枚舉列表中設(shè)計(jì) extension 方法。
必須在元素中而不是在屬性中設(shè)置枚舉值。
回頁(yè)首
解決方案 5： 基于文檔的方法 —— 與字符串結(jié)合
注意：解決方案 5 和解決方案 6 違反了在一個(gè)周期內(nèi)進(jìn)行驗(yàn)證 這一要求。但是，我之所以在這里介紹它們，是因?yàn)樵诤芏鄬?shí)際環(huán)境中可以使用這些方法。
在第 5 個(gè)解決方案中，使用 <xsd:union> 標(biāo)記將枚舉列表與字符串結(jié)合。實(shí)際上，該解決方案提示接收系統(tǒng)哪些值是標(biāo)準(zhǔn)的（包括包裝和拼寫(xiě)）。但實(shí)際上字符串字段可以存放任何值。因此，解析器并不驗(yàn)證值。相反，這些值在第二個(gè)周期或者在接收數(shù)據(jù)的應(yīng)用程序中驗(yàn)證。有些 XML 組織就使用這樣的方案。
清單 11 顯示通過(guò) <xsd:union> 將一個(gè)枚舉列表和 <xsd:string> 結(jié)合。因?yàn)槿我庵刀伎梢允且粋€(gè)字符串，所以不用驗(yàn)證枚舉列表。這些值建議使用標(biāo)準(zhǔn)值。
清單 11. 與字符串結(jié)合的 DayOfWeek 枚舉列表

<xsd:simpleType name="DayOfWeekEnumType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="Sunday"/>
<xsd:enumeration value="Monday"/>
<xsd:enumeration value="Tuesday"/>
<xsd:enumeration value="Wednesday"/>
<xsd:enumeration value="Thursday"/>
<xsd:enumeration value="Friday"/>
<xsd:enumeration value="Saturday"/>
</xsd:restriction>
</xsd:simpleType>
<xsd:element name="DayOfWeek" type="DayOfWeekEnumType"/>
<xsd:simpleType name="ExtendedDayOfWeekType">
<xsd:union memberTypes="DayOfWeekEnumType xsd:string"/>
</xsd:simpleType>
<xsd:element name="DayOfWeek_solution5" type="ExtendedDayOfWeekType"/>
優(yōu)點(diǎn)：可以添加任意的擴(kuò)展值，即使在后期綁定時(shí)也可以添加。
缺點(diǎn)：
解析器不驗(yàn)證枚舉值，在第二個(gè)步驟中才進(jìn)行驗(yàn)證。
需要 <xsd:union> 標(biāo)記支持。
回頁(yè)首
解決方案 6： 基于文檔的方法 —— 使用 <xsd:annotation>
要使用該方法，將實(shí)際的枚舉值放到 <xsd:documentation> 標(biāo)記內(nèi)，同時(shí)將數(shù)據(jù)字段保留為一個(gè)簡(jiǎn)單字符串。清單 12 顯示枚舉值。
清單 12. 在 <xsd:documentation> 標(biāo)記內(nèi)的枚舉值

<xsd:element name="DayOfWeek" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
<!-- suggested enumerations -->
<xsd:enumeration value="Sunday"/>
<xsd:enumeration value="Monday"/>
<xsd:enumeration value="Tuesday"/>
<xsd:enumeration value="Wednesday"/>
<xsd:enumeration value="Thursday"/>
<xsd:enumeration value="Friday"/>
<xsd:enumeration value="Saturday"/>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
優(yōu)點(diǎn)：
可以添加任意的擴(kuò)展值，即使在后期綁定時(shí)也可以添加。
只需要最簡(jiǎn)單的 XML 模式特性。
缺點(diǎn)：解析器不驗(yàn)證枚舉值。
回頁(yè)首
未討論的方法
我省略了其他幾種擴(kuò)展枚舉列表的解決方案。下面簡(jiǎn)單介紹了兩種沒(méi)有使用的方法：
使用 <xsd:redefine> 標(biāo)記： 通常不使用 XML 模式的這一特性，而且一般無(wú)法用工具實(shí)現(xiàn)它。該方法經(jīng)常被認(rèn)為是避免重新定義的最佳實(shí)踐。
使用 substitutionGroup 元素替換包含所有值的聯(lián)合列表： 另外一種出色的解決方案，使用了替換組和聯(lián)合。將原始列表與新列表聯(lián)合以創(chuàng)建一個(gè)完整的枚舉列表，然后使用 substitutionGroups 標(biāo)記（或 <xsi:type> 標(biāo)記）替換一個(gè)全局作用域元素。該方法的缺點(diǎn)是替換不能派生有效的聯(lián)合，替換需要兩個(gè)組件來(lái)自相同的基類型。擴(kuò)展和限制是替換的兩個(gè)有效方法。但是，根據(jù) XML 模式規(guī)范，聯(lián)合并不是有效的派生技術(shù)（參閱 參考資料）。
回頁(yè)首
結(jié)束語(yǔ)
XML 模式設(shè)計(jì)者和實(shí)現(xiàn)人員需要一種方法來(lái)擴(kuò)展現(xiàn)有的枚舉列表。因?yàn)橐坏┰剂斜韯?chuàng)建后，規(guī)范不允許進(jìn)行擴(kuò)展，因此需要找到一種方法實(shí)際實(shí)現(xiàn)擴(kuò)展。實(shí)現(xiàn)人員可以使用本文的示例來(lái)設(shè)計(jì)和擴(kuò)展枚舉列表。每種方法都有優(yōu)缺點(diǎn)，沒(méi)有一種方法在所有用例中都是最佳方法。那么，應(yīng)該使用哪種方法呢？
請(qǐng)考慮這些經(jīng)驗(yàn)法則：
如果您習(xí)慣編輯原始枚舉列表或模式，而且在設(shè)計(jì)階段就知道所有要擴(kuò)展的枚舉值，最好使用 解決方案 1（手動(dòng)編輯原始列表）或 解決方案 2（創(chuàng)建新列表并加入到原始列表中）。
如果想使用相同的語(yǔ)義元素來(lái)包含基本枚舉列表和擴(kuò)展枚舉列表，可以考慮 解決方案 3（與模式聯(lián)合）。
如果允許原始列表與擴(kuò)展列表有不同的字段，可以使用 解決方案 4（獨(dú)立的字段）。
如果不想在解析器中解析枚舉值，可以考慮 Genericode 方法或使用 解決方案 5 或 解決方案 6。
這些指導(dǎo)原則可以使模式設(shè)計(jì)者找到實(shí)用的最佳實(shí)踐，而且可以幫助他們創(chuàng)建易于實(shí)現(xiàn)、可擴(kuò)展的枚舉列表。
XML 模式和 XML 實(shí)例示例 ExtendEnumeratedListsCode.zip 2KB

最新評(píng)論