在C#开发中，把对象序列化为XML是常见需求。但很多对外接口或日志存储只希望拿到纯粹的XML节点结构，不希望文件开头出现类似<?xml version="1.0" encoding="utf-8"?>这样的声明内容。通过XmlWriterSettings的OmitXmlDeclaration属性，我们可以精确控制是否输出该声明。
一、为什么默认会有XML声明
当我们使用XmlSerializer把对象转成字符串或文件时，.NET底层会借助XmlWriter来写数据。按照W3C的XML规范，文档可以带一个XML声明来描述版本和编码，而XmlWriter的默认行为是输出这行声明。对于程序间内部传递，这没有问题；但部分老旧系统用正则或简单字符串切割解析XML，声明反而会造成识别失败。
从设计角度看，声明本身是有用的，它告诉解析器编码格式。不过如果上下游已经约定好编码，或者接收方使用更健壮的XML解析器且自动忽略声明，我们就能主动省略它以减少干扰。理解这一点后，设置OmitXmlDeclaration才更有针对性，而不是盲目去掉。
二、使用XmlWriterSettings关闭声明
核心类型是System.Xml.XmlWriterSettings。它有一个布尔属性OmitXmlDeclaration，设为true后，写入器就不会产生声明行。我们还需要配合StringWriter或Stream来承接内容，并注意编码配置。下面是一段标准且安全的示例代码：
using System;
using System.IO;
using System.Text;
using System.Xml;
using System.Xml.Serialization;
public class User
{
public string Name { get; set; }
public int Age { get; set; }
}
class Program
{
static void Main()
{
var user = new User { Name = "张三", Age = 28 };
var serializer = new XmlSerializer(typeof(User));
// 使用不带BOM的UTF8编码
var utf8NoBom = new UTF8Encoding(false);
using (var stringWriter = new StringWriter())
{
var settings = new XmlWriterSettings
{
OmitXmlDeclaration = true, // 关键：去掉XML声明
Encoding = utf8NoBom,
Indent = true
};
using (var xmlWriter = XmlWriter.Create(stringWriter, settings))
{
serializer.Serialize(xmlWriter, user);
}
string xml = stringWriter.ToString();
Console.WriteLine(xml);
}
}
}
上面代码里，OmitXmlDeclaration = true直接禁用了声明。Encoding使用new UTF8Encoding(false)是为了避免StringWriter默认带入UTF8 BOM头，否则某些系统仍会报错。Indent设为true仅为了阅读方便，与声明无关。
需要注意的是，StringWriter本身有默认编码，如果不通过XmlWriterSettings明确指定Encoding，序列化内部可能采用UTF16，导致最终声明虽然隐藏了，但内容编码标记混乱。因此显式设置Encoding是最佳实践。
三、通过内存流直接拿到字节
如果接收方要的是字节数组而不是字符串，可以用MemoryStream配合XmlWriter，这样能完全掌控编码与声明。示例如下：
using System;
using System.IO;
using System.Text;
using System.Xml;
using System.Xml.Serialization;
public class Order
{
public string Id { get; set; }
public decimal Total { get; set; }
}
class Demo
{
static byte[] SerializeWithoutDecl(Order order)
{
var serializer = new XmlSerializer(typeof(Order));
var settings = new XmlWriterSettings
{
OmitXmlDeclaration = true,
Encoding = new UTF8Encoding(false),
Indent = false
};
using (var ms = new MemoryStream())
using (var writer = XmlWriter.Create(ms, settings))
{
serializer.Serialize(writer, order);
return ms.ToArray();
}
}
}
这种方式适合写文件或网络发送，因为直接得到UTF8字节，没有BOM也没有声明，对方按纯XML节点处理最省事。如果以后要加回声明，只需把OmitXmlDeclaration改成false。
在性能上，MemoryStream方案比先转字符串再取字节更高效，少一次编码拷贝。对于高频序列化服务，建议采用此模式并复用XmlSerializer实例，避免反射开销。
四、使用XDocument时的等价处理
有些项目用LINQ to XML的XDocument来拼装数据。XDocument本身有一个Declaration属性，设为null即可等效于省略声明。但若是把XDocument用XmlWriter写出，仍受XmlWriterSettings控制。
using System;
using System.Xml.Linq;
using System.Xml;
class XDemo
{
static string GetPureXml()
{
var doc = new XDocument(
new XElement("Root",
new XElement("Item", "A"),
new XElement("Item", "B")
)
);
// 不设置Declaration即无声明
var settings = new XmlWriterSettings
{
OmitXmlDeclaration = true,
Indent = true
};
using (var sw = new StringWriter())
using (var xw = XmlWriter.Create(sw, settings))
{
doc.Save(xw);
return sw.ToString();
}
}
}
这里即便XDocument没有Declaration，若XmlWriterSettings.OmitXmlDeclaration为false，某些情况下写入器也可能补声明，因此两边保持一致最稳妥。通常建议以XmlWriterSettings为准，因为它处在输出的最外层。
对比来看，XmlSerializer适合对象模型稳定、强类型的场景；XDocument适合动态拼XML。两者去掉声明的方法不同但思路一致：控制写入器或文档头。开发者应根据项目结构选择。
五、常见误区与注意事项
误区一是以为在XmlSerializer构造函数里能直接关声明，其实序列化器本身不负责声明，只负责对象映射，声明是写入器的职责。误区二是用StringWriter后不指定编码，结果在控制台看到乱码，便误以为是OmitXmlDeclaration没生效。
另外，若接收方明确依赖声明中的encoding信息做判断，去掉后可能让它用错编码解析。因此动手前先确认接口文档。若只是内部存储且用XElement或XDocument读取，无声明完全没问题。掌握OmitXmlDeclaration，你就能在C#里灵活输出干净XML。
C#XML序列化OmitXmlDeclaration修改时间：2026-08-08 19:18:14