1.1 基礎知識介紹
- XML簡介:XML是可擴展標記語言(eXtensible Markup Language)的縮寫,它是一種數據表示格式,可以描述非常復雜的數據結構,常用于傳輸和存儲數據。xml文件、xml消息。
- XSD簡介:是XML Schema Description的縮寫,描述XML的結構,以驗證XML是否符合要求。編寫直接使用xml語言,無需學習新語言,描述了可能出現的元素、屬性和值等。
1.2 XSD的核心組件
元素和屬性定義:如何定義元素和屬性,包括簡單類型和復雜類型。
- element – 定義普通元素,類型為內置類型(xs:string\xs:date\xs:decimal\xs:integer\xs:boolean\xs:time)
- simpleType – 在普通類型基礎上,有其余額外的格式要求(通過xs:restriction來限定,后面會詳細說明限定如何設置)
- complexType – 含有多個子元素(xs:sequence–子元素必須按順序出現,默認只出現一次,可通過minOccurs/maxOccurs設置出現次數)
student.xml:
<students><class>Grade one of high school</class><student><name>test1</name><age>16</age></student><student><name>test2</name><age>15</age></student>
</students>
class – 為element 簡易元素
name – 為simpleType,名字格式有特殊要求,必須是test開頭+數字
student – 為compleType,含有多個子元素,且可出現1次至無數次
student.xsd:
<?xml version="1.0" encoding='utf-8'?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name="students"><xs:complexType><xs:sequence><xs:element name="class" type="xs:string"/><xs:element name='student' maxOccurs='unbounded'><xs:complexType><xs:sequence><xs:element name='name'><xs:simpleType><xs:restriction base="xs:string"><xs:pattern value='test\d{1,}'/></xs:restriction></xs:simpleType></xs:element><xs:element name="age" type="xs:integer"/></xs:sequence></xs:complexType></xs:element></xs:sequence></xs:complexType></xs:element>
</xs:schema>
- 模型組:介紹xs:sequence, xs:choice, xs:all等模型組的使用和區別。
- xs:sequence:用于定義一組元素,這些元素必須按照在 xs:sequence 中聲明的順序出現在XML文檔中。
- xs:choice:允許在其子元素中選擇一個出現。只能選擇其中一個。
- xs:all:允許其子元素以任何順序出現,每個元素最多出現一次。這適用于元素的順序不重要的情況。但子元素不能是復雜元素。
- 數據類型:內置數據類型和用戶自定義數據類型的使用。
- 常用的內置數據類型:
- xs:string
- xs:decimal
- xs:integer
- xs:boolean
- xs:date
- xs:time
- 用戶自定義類型:xs:restriction限定。
- enumeration 定義可接受值列表
- 常用的內置數據類型:
<?xml version="1.0" encoding='utf-8'?>
<!-- 性別元素的值只能是男或女 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name="gender"><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value='男'/><xs:enumeration value='女'/></xs:restriction></xs:simpleType></xs:element>
</xs:schema>
- fractionDigits 指定允許的最大小數位數。必須大于或等于零
<?xml version="1.0" encoding='utf-8'?>
<!-- 體重元素,最多2位小數位 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name='weight'><xs:simpleType><xs:restriction base='xs:decimal'><xs:fractionDigits value='2'/></xs:restriction></xs:simpleType></xs:element>
</xs:schema>
- length 指定允許的精確字符數或列表項數。必須大于或等于零
<?xml version="1.0" encoding='utf-8'?>
<!-- 學號元素,長度必須為10位數 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name='studentid'><xs:simpleType><xs:restriction base="xs:string"><xs:length value='10'/></xs:restriction></xs:simpleType></xs:element>
</xs:schema>
- maxExclusive 指定數值的上界(值必須小于此值)
<?xml version="1.0" encoding='utf-8'?>
<!-- 分數元素,最大值為150,整數位至少1位,至多3位,小數位至多2位,小數位可以沒有 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name='score'><xs:simpleType><xs:restriction base="xs:decimal"><xs:maxExclusive value='151'/><xs:pattern value='\d{1,3}.?\d{0,2}'/></xs:restriction></xs:simpleType></xs:element>
</xs:schema>
- maxInclusive 指定數值的上限(值必須小于或等于此值)
<?xml version="1.0" encoding='utf-8'?>
<!-- 分數元素,最大值為150,整數位至少1位,至多3位,小數位至多2位,小數位可以沒有 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name='score'><xs:simpleType><xs:restriction base="xs:decimal"><xs:maxInclusive value='150'/><xs:pattern value='\d{1,3}.?\d{0,2}'/></xs:restriction></xs:simpleType></xs:element>
</xs:schema>
- maxLength 指定允許的最大字符數或列表項數。必須大于或等于零
<?xml version="1.0" encoding='utf-8'?>
<!-- 座右銘元素,最長字符數限制為100字符 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name='motto'><xs:simpleType><xs:restriction base="xs:string"><xs:maxLength value='100'/></xs:restriction></xs:simpleType></xs:element>
</xs:schema>
- minExclusive 指定數值的下界(值必須大于此值)
<?xml version="1.0" encoding='utf-8'?>
<!-- 分數元素,最小值為0,最大值為150,整數位至少1位,至多3位,小數位至多2位,小數位可以沒有 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name='score'><xs:simpleType><xs:restriction base="xs:decimal"><xs:minExclusive value='-1'/><xs:maxInclusive value='150'/><xs:pattern value='\d{1,3}.?\d{0,2}'/></xs:restriction></xs:simpleType></xs:element>
</xs:schema>
- minInclusive 指定數值的下限(值必須大于或等于此值)
<?xml version="1.0" encoding='utf-8'?>
<!-- 分數元素,最小值為0,最大值為150,整數位至少1位,至多3位,小數位至多2位,小數位可以沒有 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name='score'><xs:simpleType><xs:restriction base="xs:decimal"><xs:minInclusive value='0'/><xs:maxInclusive value='150'/><xs:pattern value='\d{1,3}.?\d{0,2}'/></xs:restriction></xs:simpleType></xs:element>
</xs:schema>
- minLength 指定允許的最小字符數或列表項數。必須大于或等于零
<?xml version="1.0" encoding='utf-8'?>
<!-- 座右銘元素,最短為1個字符,最長字符數限制為100字符 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name='motto'><xs:simpleType><xs:restriction base="xs:string"><xs:minLength value='1'/><xs:maxLength value='100'/></xs:restriction></xs:simpleType></xs:element>
</xs:schema>
- pattern 定義可接受的確切字符序列
<?xml version="1.0" encoding='utf-8'?>
<!-- 性別元素的值只能是男或女 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name="gender"><xs:simpleType><xs:restriction base="xs:string"><xs:pattern value='[男|女]'/></xs:restriction></xs:simpleType></xs:element>
</xs:schema>
- totalDigits 指定允許的精確數字數。必須大于零
<?xml version="1.0" encoding='utf-8'?>
<!-- 年齡元素的值數字為2位 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name="age"><xs:simpleType><xs:restriction base="xs:integer"><xs:totalDigits value='2'/></xs:restriction></xs:simpleType></xs:element>
</xs:schema>
- whiteSpace 指定如何處理空白字符(換行符、制表符、空格和回車),有三個可能的值:
-
- preserve:保留所有空白字符。這是默認行為,如果不指定 whiteSpace,則XML解析器會保留輸入中的所有空白。
-
- replace:將所有空白字符替換為普通空格。這包括將制表符、換行符和回車符替換為空格。
-
- collapse:首先將所有空白字符替換為普通空格,然后合并連續的空格為一個空格,并刪除字符串開頭和結尾的空格。
-
<?xml version="1.0" encoding='utf-8'?>
<!-- 座右銘元素,最短為1個字符,最長字符數限制為100字符,并且限定前后不能有空格,中間不能換行 -->
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:element name='motto'><xs:simpleType><xs:restriction base="xs:string"><xs:minLength value='1'/><xs:maxLength value='100'/><xs:whiteSpace value='collapse'/></xs:restriction></xs:simpleType></xs:element>
</xs:schema>
1.3 高級XSD特性
繼承和多態:使用xs:extension和xs:restriction進行類型擴展和限制。
- xs:extension:在基礎類型上新增新的元素。eg: 在基礎c_student類型上,新增gender元素。
<?xml version="1.0" encoding='utf-8'?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:complexType name="c_student"><xs:sequence><xs:element name='name'><xs:simpleType><xs:restriction base="xs:string"><xs:pattern value='test\d{1,}'/></xs:restriction></xs:simpleType></xs:element><xs:element name="age" type="xs:integer"/></xs:sequence></xs:complexType><xs:element name='student'><xs:complexType><xs:complexContent><xs:extension base='c_student'><xs:sequence><xs:element name="gender"><xs:simpleType><xs:restriction base="xs:string"><xs:pattern value='[男|女]'/></xs:restriction></xs:simpleType></xs:element></xs:sequence></xs:extension></xs:complexContent></xs:complexType></xs:element>
</xs:schema>
- xs:restriction:修改已存在的元素的值,必須重新對所有元素定義。eg: 對基礎類型c_student的age設置默認值16.
<?xml version="1.0" encoding='utf-8'?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"><xs:complexType name="c_student"><xs:sequence><xs:element name='name'><xs:simpleType><xs:restriction base="xs:string"><xs:pattern value='test\d{1,}'/></xs:restriction></xs:simpleType></xs:element><xs:element name="age" type="xs:integer"/></xs:sequence></xs:complexType><xs:element name='student'><xs:complexType><xs:complexContent><xs:restriction base='c_student'><xs:sequence><xs:element name='name'><xs:simpleType><xs:restriction base="xs:string"><xs:pattern value='test\d{1,}'/></xs:restriction></xs:simpleType></xs:element><xs:element name="age" type="xs:integer" default='16'/></xs:sequence></xs:restriction></xs:complexContent></xs:complexType></xs:element>
</xs:schema>
- 文件引用:xs:import 和xs:include進行文件間的引用。
- xs:include:命名空間相同的兩個文件,可以使用include引用另一個xsd文件的定義元素和類型。
base.xsd
<?xml version="1.0" encoding='utf-8'?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" targetNamespace='basic.type'><xs:simpleType name="t_name"><xs:restriction base="xs:string"><xs:pattern value='test\d{1,}'/></xs:restriction></xs:simpleType><xs:simpleType name="t_gender"><xs:restriction base="xs:string"><xs:enumeration value='男'/><xs:enumeration value='女'/></xs:restriction></xs:simpleType><xs:simpleType name='t_studentid'><xs:restriction base="xs:string"><xs:length value='10'/></xs:restriction></xs:simpleType><xs:simpleType name='t_motto'><xs:restriction base="xs:string"><xs:minLength value='1'/><xs:maxLength value='100'/><xs:whiteSpace value='collapse'/></xs:restriction></xs:simpleType><xs:simpleType name="t_age"><xs:restriction base="xs:integer"><xs:totalDigits value='2'/></xs:restriction></xs:simpleType>
</xs:schema>
fat_student.xsd:命名空間設置成和basic.xsd一致。與base.xsd放在同一目錄下。
<?xml version="1.0" encoding='utf-8'?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:prd='basic.type' targetNamespace='basic.type'><xs:include schemaLocation="base.xsd"/><xs:element name="students"><xs:complexType><xs:sequence><xs:element name="student" maxOccurs='unbounded'><xs:complexType><xs:sequence><xs:element name="name" type="prd:t_name"/><xs:element name='age' type="prd:t_age"/><xs:element name='studentid' type="prd:t_studentid"/><xs:element name='gender' type="prd:t_gender"/><xs:element name='motto' type="prd:t_motto"/></xs:sequence></xs:complexType></xs:element></xs:sequence></xs:complexType></xs:element>
</xs:schema>
- xs:import:命名空間不相同的兩個文件,可以使用import引用,并使用namespace指明引用文件的命名空間名。
fat_student2.xsd:不指定該xsd的命名空間或命名空間設置成和base.xsd不一致。與base.xsd放在同一目錄下。
<?xml version="1.0" encoding='utf-8'?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:prd='basic.type'><xs:import namespace='basic.type' schemaLocation='base.xsd'/><xs:element name="students"><xs:complexType><xs:sequence><xs:element name="student" maxOccurs='unbounded'><xs:complexType><xs:sequence><xs:element name="name" type="prd:t_name"/><xs:element name='age' type="prd:t_age"/><xs:element name='studentid' type="prd:t_studentid"/><xs:element name='gender' type="prd:t_gender"/><xs:element name='motto' type="prd:t_motto"/></xs:sequence></xs:complexType></xs:element></xs:sequence></xs:complexType></xs:element>
</xs:schema>
注:如果需要引入多個xsd,可以加多幾個include或import節點。
1.4 python中使用XSD驗證XML
1.4.1 傳入xml文件的路徑:
import lxml.etree as ETdef validateXMLByXSD(file_xml, file_xsd):""" Verify that the XML compliance with XSDArguments:1. file_xml: Input xml file2. file_xsd: xsd file which needs to be validated against xmlReturn:No return value"""try:print("Validating:{0}".format(file_xml))print("xsd_file:{0}".format(file_xsd))xml_doc = ET.parse(file_xml)xsd_doc = ET.parse(file_xsd)xmlschema = ET.XMLSchema(xsd_doc)xmlschema.assert_(xml_doc)return Trueexcept ET.XMLSyntaxError as err:print("PARSING ERROR:{0}".format(err))return Falseexcept AssertionError as err:print("Incorrect XML schema: {0}".format(err))return Falseif __name__ == '__main__':print(validateXMLByXSD('xml文件路徑', 'xsd文件路徑'))
1.4.2 傳入xml字符串:
import lxml.etree as ETdef validateXMLByXSD(str_xml, file_xsd):""" Verify that the XML compliance with XSDArguments:1. str_xml: Input xml string2. file_xsd: xsd file which needs to be validated against xmlReturn:No return value"""try:print("Validating:{0}".format(str_xml))print("xsd_file:{0}".format(file_xsd))xml_doc = ET.fromstring(str_xml)xsd_doc = ET.parse(file_xsd)xmlschema = ET.XMLSchema(xsd_doc)xmlschema.assert_(xml_doc)return Trueexcept ET.XMLSyntaxError as err:print("PARSING ERROR:{0}".format(err))return Falseexcept AssertionError as err:print("Incorrect XML schema: {0}".format(err))return Falseif __name__ == '__main__':print(validateXMLByXSD('xml字符串', 'xsd文件路徑'))
1.5 實戰演練
①使用student.xsd驗證student.xml的正確性:
-
不修改上述student.xml和student.xsd文件內容,直接使用1.4.1中代碼驗證。
-
修改student.xml文件內容age為非數字:
-
刪掉student.xsd中maxOccurs的配置,故student元素僅能出現一次:
②使用fat_student2.xsd驗證student2.xml的正確性:
student2.xml
<students><student><name>test1</name><age>16</age><studentid>1000000001</studentid><gender>男</gender><motto>努力會有回報的。</motto></student><student><name>test2</name><age>17</age><studentid>1000000002</studentid><gender>女</gender><motto>勤奮。</motto></student>
</students>
studentid不符合長度要求
缺少gender節點:
其他:
1.當xml的根元素沒有設置命名空間時,對應的xsd也不能設置命名空間targetNamespace,不會assert時會報錯。
2.可以使用fixed固化某個元素的值,和default用法一致。
3.該方式驗證xml格式正確性,輕代碼重xsd配置,但也有好處,當xml格式發生改變時,無需修改代碼,只需要對應修改xsd即可,且相對代碼來說,易上手。