调试源码时免不了动到配置文件，结果有次加个配置文件发现报错，以前没注意过，这次就来好好扒一扒原因。
先上错误截图
error
- 提示告诉我们
configuration必须符合下面那个规则
XML这种配置文件的自由度太高了，而解析又是固定的代码，所以一旦解析出错，定位问题效率高低都要看你的代码与配置熟练度了
因此除了XML配置文件，还对应有一种约束文件 *.dtd
所以我就去学习了一下这个 *.dtd
一、*.xml文件格式
开头会有一个声明
<?xml version="1.0" encoding="UTF-8" ?>
然后会有一个
<!DOCTYPE ...>
接下来就是主体配置了(以mybatis配置为例)
<configuration>
...
<configuration/>
我的配置文件长这样
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
...
<configuration/>
注意到第二部分有一个URL
http://mybatis.org/dtd/mybatis-3-config.dtd
打开网页发现是一个下载链接，下载后打开看下
<!ELEMENT configuration (properties?, settings?, typeAliases?, typeHandlers?, objectFactory?, objectWrapperFactory?, reflectorFactory?, plugins?, environments?, databaseIdProvider?, mappers?)>
<!ELEMENT databaseIdProvider (property*)>
<!ATTLIST databaseIdProvider
type CDATA #REQUIRED
>
<!ELEMENT properties (property*)>
<!ATTLIST properties
resource CDATA #IMPLIED
url CDATA #IMPLIED
>
...
好的，这就是我们要找的XML约束文件 mybatis-3-config.dtd了
二、*.dtd文件格式
dtd - Document Type Definition (文档类型定义)
首先我们明确一下 元素 和 属性 的说法
举个例子
<objectFactory type="com.hy.test.factory.MyObjectFactory" >
<property name="name" value="hy" />
</objectFactory>
这里面
-
objectFactory就是一个元素, 它有一个子元素property, 还有一个属性type - 同理, 元素
property有两个属性namevalue
在*.dtd文件里面
-
ELEMENT声明元素 -
ATTLIST声明属性
方式如下
<!ELEMENT [元素名称] [子元素列表]>
<!ATTLIST [元素名称]
[属性名称] [属性类型] [约束条件]
>
- 子元素列表
这里配置当前元素可以有哪些子元素，比如上面的configuration
<!ELEMENT configuration (properties?, settings?, typeAliases?, typeHandlers?, objectFactory?, objectWrapperFactory?, reflectorFactory?, plugins?, environments?, databaseIdProvider?, mappers?)>
后面一串都是子元素，注意几点
子元素列表以逗号隔开，表示出现的顺序
子元素用
|隔开，表示只能出现一个-
子元素后面跟的符号表示其可出现次数
-
+一次及一次以上 -
*任意次数 -
?一次或零次 - 什么都没带，就一次
-
如果没有子元素就用
EMPTY
比如最底层的property元素
<!ELEMENT property EMPTY>
<!ATTLIST property
name CDATA #REQUIRED
value CDATA #REQUIRED
>
其没有子元素，只有两个属性name value
- 属性类型
-
CDATA字符串类型 -
ID只能以 字母 或 下划线 开头 - 枚举类型 (XX|XX|XX) 只能在一定的范围内出现值,而且值只能出现一次
- 约束条件
-
#REQUIRED属性必须存在 -
#IMPLIED属性可有可无 -
#FIXED表示一个固定值 #FIXED "ABC" (没有#FIXED就表示默认)
三、*.dtd文件声明方式
有三种声明方式
- 内部声明，只有当前 xml 有效
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE hy[
<!-- ......具体语法 -->
]>
<hy></hy>
- 本地声明
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!-- SYSTEM [文件路径] -->
<!DOCTYPE hy SYSTEM "com/.../hy-config.dtd">
<hy></hy>
文件路径
- 外部声明 (网络, 常见)
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!-- PUBLIC [文件名称] [文件URL] -->
<!DOCTYPE hy PUBLIC "hy-config.dtd" "http://.../hy-config.dtd">
<hy></hy>
文件名称文件URL
很明显mybatis配置文件的声明是第三种
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
给一个内部测试的例子
<?xml version="1.0" encoding="utf-8" ?>
<!-- 自定义 -->
<!DOCTYPE
hy[
<!ELEMENT hy (one, two)> <!-- 元素名称、个数及顺序 -->
<!ATTLIST hy
name CDATA #REQUIRED>
<!ELEMENT one EMPTY>
<!ATTLIST one
hello CDATA #IMPLIED>
<!ELEMENT two EMPTY>
<!ATTLIST two
hello CDATA #IMPLIED>
]>
<hy name="abc" >
<!-- ID 要求 值唯一 -->
<!-- CDATA 不做要求 -->
<one hello="a" />
<two hello="a" />
</hy>
只要提取约束部分出来，再以路径引用就是 SYSTEM / PUBLIC
因为约束文件在mybatis源码中带了，我们可以把约束文件路径换成本地的
<!DOCTYPE configuration
SYSTEM "org/apache/ibatis/builder/xml/mybatis-3-config.dtd">
简单总结下，肯定有更多玩法，后面有兴趣再继续啃。
以前看这玩意死活看不懂，现在清楚了~
