在C#中使用LINQ to XML的XDocument处理XML文档时，默认生成的XML不会包含DTD声明，若业务需要符合特定DTD规范的XML文件，就需要手动为XDocument添加对应的DTD声明信息。
基础DTD声明的添加方法
XDocument提供了DocumentType属性，通过创建XDocumentType对象并赋值给该属性，就可以为文档添加DTD声明。XDocumentType的构造函数需要传入四个参数，分别是名称、公共标识符、系统标识符、内部子集，其中内部子集可以为空。
以下是一个添加基础DTD声明的示例代码，该DTD声明指向一个外部的系统DTD文件：
using System;
using System.Xml.Linq;
class Program
{
static void Main()
{
// 创建XDocument对象
XDocument doc = new XDocument();
// 创建DTD声明，参数依次为：根元素名称、公共标识符、系统标识符、内部子集
XDocumentType docType = new XDocumentType("bookstore", null, "bookstore.dtd", null);
// 将DTD声明添加到文档中
doc.AddFirst(docType);
// 添加根元素
XElement root = new XElement("bookstore",
new XElement("book",
new XElement("title", "C#编程入门"),
new XElement("author", "张三")
)
);
doc.Add(root);
// 输出XML内容
Console.WriteLine(doc.Declaration == null ? "无XML声明" : doc.Declaration.ToString());
Console.WriteLine(doc.ToString());
}
}
上述代码中，我们为XML文档添加了指向bookstore.dtd的DTD声明，根元素为bookstore，公共标识符设置为null，内部子集也为空。运行后会生成包含对应DTD声明的XML文档。
添加带公共标识符的DTD声明
如果DTD声明需要包含公共标识符，只需要在创建XDocumentType时传入对应的公共标识符即可，通常公共标识符用于标识标准的DTD规范，系统标识符用于指定DTD文件的位置。
以下示例添加了带公共标识符的DTD声明：
using System;
using System.Xml.Linq;
class Program
{
static void Main()
{
XDocument doc = new XDocument();
// 添加带公共标识符的DTD声明，公共标识符为"-//W3C//DTD XHTML 1.0 Transitional//EN"
XDocumentType docType = new XDocumentType(
"html",
"-//W3C//DTD XHTML 1.0 Transitional//EN",
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd",
null
);
doc.AddFirst(docType);
// 添加根元素
XElement root = new XElement("html",
new XElement("head",
new XElement("title", "示例页面")
),
new XElement("body",
new XElement("p", "这是一个带DTD声明的XHTML文档")
)
);
doc.Add(root);
Console.WriteLine(doc.ToString());
}
}
添加带内部子集的DTD声明
DTD的内部子集是定义在XML文档内部的DTD规则，需要放在方括号中。创建XDocumentType时，第四个参数就是内部子集的内容，不需要手动添加方括号，XDocument会自动处理格式。
以下示例添加了包含内部子集的DTD声明：
using System;
using System.Xml.Linq;
class Program
{
static void Main()
{
XDocument doc = new XDocument();
// 内部子集定义book元素包含title和author子元素，title为必填字符串，author为必填字符串
string internalSubset = "book (title, author)ntitle (#PCDATA)nauthor (#PCDATA)";
XDocumentType docType = new XDocumentType("bookstore", null, null, internalSubset);
doc.AddFirst(docType);
XElement root = new XElement("bookstore",
new XElement("book",
new XElement("title", "LINQ to XML实战"),
new XElement("author", "李四")
)
);
doc.Add(root);
Console.WriteLine(doc.ToString());
}
}
注意事项
- DTD声明需要添加在XDocument的最前面，因此建议使用
AddFirst方法将XDocumentType对象插入到文档的开头位置，避免顺序错误导致XML格式不合法。 - 如果同时需要XML声明，需要手动创建
XDeclaration对象并赋值给XDocument的Declaration属性，XDocument不会自动生成XML声明。 - 内部子集的内容需要符合DTD语法规范，否则生成的XML文档在解析时会出现校验错误。
- 当系统标识符指向外部DTD文件时，如果要验证XML的合法性，需要确保解析器能够访问到对应的DTD文件，否则可能会校验失败。
总结
给XDocument添加DTD声明的核心是通过XDocumentType类创建对应的DTD对象，再将其赋值给XDocument的DocumentType属性或者通过AddFirst方法添加到文档开头。根据需求不同，可以灵活配置公共标识符、系统标识符和内部子集，满足不同的DTD规范需求。在实际使用时注意DTD声明的顺序和格式规范，就能正确生成带DTD声明的XML文档。