为了账号安全,请及时绑定邮箱和手机立即绑定

为你的XML做个架构

2018.10.30 22:55 2256浏览

XML Schema 介绍

  • 项目使用XML格式文件记录实体模型,但是没有注释和提示,很不方便,于是为它做个结构

  • 第一次接触,难免错漏,欢迎指出。文中大部分抄自http://www.w3school.com.cn/schema/index.asp

  • 先看一个相关例子


<?xml version="1.0"?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"

targetNamespace="http://www.w3school.com.cn"

xmlns="http://www.w3school.com.cn"

elementFormDefault="qualified">



<xs:element name="note">

<xs:complexType>

<xs:sequence>

<xs:element name="to" type="xs:string"/>

<xs:element name="from" type="xs:string"/>

<xs:element name="heading" type="xs:string"/>

<xs:element name="body" type="xs:string"/>

</xs:sequence>

</xs:complexType>

</xs:element>



</xs:schema>

XSD - schema 元素


<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"

targetNamespace="http://www.w3school.com.cn"

xmlns="http://www.w3school.com.cn"

elementFormDefault="qualified">

...

...

</xs:schema>

  • schema元素是每一个 XML Schema 的根元素

  • 下面是schema元素相关属性的解释

xmlns:xs

  • xmlns:xs="http://www.w3.org/2001/XMLSchema"

  • 显示 schema 中用到的元素和数据类型来自命名空间 http://www.w3.org/2001/XMLSchema。同时它还规定了来自命名空间 http://www.w3.org/2001/XMLSchema 的元素和数据类型应该使用前缀 xs:

  • xs:schema元素使用了xs:前缀,表明schema元素来自xmlns:xs指定的命名空间。类似C#命名空间,using处引入并使用别名。

targetNamespace

  • targetNamespace="http://www.w3school.com.cn"

  • 显示被此 schema 定义的元素 (note, to, from, heading, body) 来自命名空间: http://www.w3school.com.cn

  • 这样其它XML文档需要使用这些元素时,就需要指定http://www.w3school.com.cn这个命名空间,类似xmlns:xs这样,指明前缀,使用的时候加上前缀即可。或者使用xmlns。就像C#开发类的时候,指定当前类所在命名空间。

xmlns

  • xmlns="http://www.w3school.com.cn"

  • 指出当前XML文档默认的命名空间是 http://www.w3school.com.cn

  • 由于这个XML Schema本身就是XML,所以也可以有个命名空间,而targetNamespace是定义那些元素应该处于什么命名空间。

  • 指定了命名空间,如果直接指定了http://www.w3.org/2001/XMLSchema,当前文档就不需要使用xmlns:xs这样的形式导入命名空间了。

elementFormDefault

  • elementFormDefault="qualified"

  • 指出任何 XML 实例文档所使用的且在此 schema 中声明过的元素必须被命名空间限定。

  • 大概意思是,你要使用这些元素,必须带上命名空间,否则不给你用。如果声明为unqualified,就是不严格限定,在其他文档随意使用那些元素而无限制。

在 XML 文档中引用 Schema


<?xml version="1.0"?>



<note xmlns="http://www.w3school.com.cn"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://www.w3school.com.cn note.xsd">



<to>George</to>

<from>John</from>

<heading>Reminder</heading>

<body>Don't forget the meeting!</body>

</note>

  • 以上是XML文档中包含XML Schema 的引用,以下是解释

xmlns - 命名空间

  • xmlns="http://www.w3school.com.cn"

  • 规定了默认命名空间的声明。此声明会告知 schema 验证器,在此 XML 文档中使用的所有元素都被声明于 http://www.w3school.com.cn 这个命名空间。

  • 相当于C#中的包名、命名空间,如果处于同一命名空间,则无需再引入,可直接使用在同一命名空间的元素。

xmlns:xsi - XML Schema 实例命名空间

  • xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

  • 实例命名空间,声明之后才可以使用schemaLocation属性。

  • 相当于C#中的using+命名空间,这样才可以使用命名空间里面的类。

schemaLocation

  • xsi:schemaLocation="http://www.w3school.com.cn note.xsd"

  • 该属性可以指定XML schema 来自于哪里。它有两个字值。第一个值是需要使用的命名空间。第二个值是供命名空间使用的 XML schema 的位置。

  • xsd文件的位置也是可以网络上位置,比如,还可以这样http://www.w3school.com.cn http://127.0.0.1/note.xsd

设计自己的XML Schema

  • 具备上述基础,就可以看得懂一个XML Schema了,先看一个实例,后面再具体讲解

  • 实例链接http://www.w3school.com.cn/schema/schema_example.asp

实例

  • 有一份XML,格式如下

<?xml version="1.0" encoding="utf-8"?>

<Tables Version="9.6.6663.16294" NameSpace="XCode.Membership" ConnName="Membership" Output="" BaseClass="Entity">

<Table Name="User" Description="用户" DbType="SqlServer" RenderGenEntity="true">

<Columns>

<Column Name="ID" DataType="Int32" Identity="True" PrimaryKey="True" Description="编号" />

<Column Name="Name" DataType="String" Master="True" Nullable="False" Description="名称。登录用户名" />

<Column Name="Password" DataType="String" Description="密码" />

<Column Name="DisplayName" DataType="String" Description="昵称" />

</Columns>

<Indexes>

<Index Columns="Name" Unique="True" />

<Index Columns="RoleID" />

</Indexes>

</Table>

<Table Name="Role" Description="角色" RenderGenEntity="true">

<Columns>

<Column Name="ID" DataType="Int32" Identity="True" PrimaryKey="True" Description="编号" />

<Column Name="Name" DataType="String" Master="True" Nullable="False" Description="名称" />

<Column Name="Remark" DataType="String" Description="说明" />

</Columns>

<Indexes>

<Index Columns="Name" Unique="True" />

</Indexes>

</Table>

</Tables>

  • 为上述XML设计一份Schema

<?xml version="1.0" encoding="utf-8"?>

<xs:schema id="ModelSchema"

targetNamespace="http://www.newlifex.com/ModelSchema.xsd"

elementFormDefault="qualified"

xmlns="http://www.newlifex.com/ModelSchema.xsd"

xmlns:mstns="http://www.newlifex.com/ModelSchema.xsd"

xmlns:xs="http://www.w3.org/2001/XMLSchema"

>

<xs:annotation>

<xs:documentation xml:lang="zh-cn">

新生命模型XML架构说明

</xs:documentation>

</xs:annotation>



<xs:element name="Tables" type="TablesType"></xs:element>



<xs:complexType name="TablesType">

<xs:sequence>

<xs:element name="Table" type="TableType" maxOccurs="unbounded" ></xs:element>

</xs:sequence>

<xs:attribute name="Version" type="xs:string"></xs:attribute>

<xs:attribute name="NameSpace" type="xs:string"></xs:attribute>

<xs:attribute name="ConnName" type="xs:string"></xs:attribute>

<xs:attribute name="Output" type="xs:string"></xs:attribute>

<xs:attribute name="BaseClass" type="xs:string"></xs:attribute>

</xs:complexType>



<xs:complexType name="TableType">

<xs:annotation>

<xs:documentation xml:lang="zh-cn">

一个Table对应一个数据库表

</xs:documentation>

</xs:annotation>

<xs:sequence>

<xs:element name="Columns" type="ColumnsType"></xs:element>

</xs:sequence>

<xs:attribute name="Name" type="xs:string" use="required"></xs:attribute>

<xs:attribute name="TableName" type="xs:string">

<xs:annotation>

<xs:documentation xml:lang="zh-cn">

数据库表名,为空则默认为Name

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="Description" type="xs:string">

<xs:annotation>

<xs:documentation xml:lang="zh-cn">

表描述

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="DbType" type="xs:string"></xs:attribute>

<xs:attribute name="RenderGenEntity" type="xs:string"></xs:attribute>

</xs:complexType>



<xs:complexType name="ColumnsType">

<xs:sequence>

<xs:element name="Column" type="ColumnType" maxOccurs="unbounded"></xs:element>

</xs:sequence>

</xs:complexType>



<xs:complexType name="ColumnType">

<xs:attribute name="Name" type="xs:string"></xs:attribute>

<xs:attribute name="DataType" type="xs:string">

<xs:annotation>

<xs:documentation xml:lang="zh-cn">

数据类型

</xs:documentation>

</xs:annotation>

</xs:attribute>

<xs:attribute name="Identity" type="xs:string"></xs:attribute>

<xs:attribute name="PrimaryKey" type="xs:string"></xs:attribute>

<xs:attribute name="Description" type="xs:string"></xs:attribute>

<xs:attribute name="Type" type="xs:string"></xs:attribute>

<xs:attribute name="Length" type="xs:string"></xs:attribute>

<xs:attribute name="Master" type="xs:string"></xs:attribute>

<xs:attribute name="Nullable" type="xs:string"></xs:attribute>

</xs:complexType>

</xs:schema>

实际效果

  • 注释提示,属性提示

  • 不合法元素提示

总结

  • 通过动手实践,写出一份自己的XML Schema,既方便了工作,又增加了个技能。

  • 只要动手去做,总会有收获的!

点击查看更多内容

本文首次发布于慕课网 ,转载请注明出处,谢谢合作

3人点赞

若觉得本文不错,就分享一下吧!

评论

相关文章推荐

正在加载中
意见反馈 帮助中心 APP下载
官方微信

举报

0/150
提交
取消