在C#中生成XML文件时,XmlWriter是常用的写入工具,而XmlWriterSettings类用于配置XmlWriter的输出行为,通过它可以灵活控制XML的最终输出格式,满足不同的业务场景需求。

XmlWriterSettings核心格式控制属性
XmlWriterSettings提供了多个和输出格式相关的属性,以下是常用的几个:
- Indent:布尔类型,设置是否对XML内容进行缩进,默认值为false,开启后会让XML层级更清晰。
- IndentChars:字符串类型,设置缩进时使用的字符,默认是两个空格,可以自定义为制表符或其他字符。
- NewLineChars:字符串类型,设置换行时使用的字符,默认是系统当前的换行符,可自定义为n或rn。
- Encoding:设置输出XML的编码格式,默认是UTF-8,可指定为UTF-16、GBK等编码。
- OmitXmlDeclaration:布尔类型,设置是否省略XML声明(<?xml version="1.0" encoding="utf-8"?>),默认值为false。
- CloseOutput:布尔类型,设置当XmlWriter关闭时是否同时关闭底层流,默认值为false。
不同配置的输出效果对比
我们通过不同的XmlWriterSettings配置,生成相同的XML内容,观察输出格式的差异。
默认配置输出
不设置任何XmlWriterSettings属性,使用默认配置生成XML:
using System;
using System.IO;
using System.Xml;
class Program
{
static void Main()
{
// 创建默认配置的XmlWriterSettings
XmlWriterSettings settings = new XmlWriterSettings();
// 创建内存流保存XML内容
using (MemoryStream ms = new MemoryStream())
using (XmlWriter writer = XmlWriter.Create(ms, settings))
{
writer.WriteStartDocument();
writer.WriteStartElement("Root");
writer.WriteStartElement("User");
writer.WriteElementString("Name", "张三");
writer.WriteElementString("Age", "25");
writer.WriteEndElement();
writer.WriteEndElement();
writer.WriteEndDocument();
writer.Flush();
// 将流内容转换为字符串输出
ms.Position = 0;
using (StreamReader sr = new StreamReader(ms))
{
Console.WriteLine("默认配置输出:");
Console.WriteLine(sr.ReadToEnd());
}
}
}
}
默认配置下输出内容没有缩进和换行,所有内容挤在一行:
<?xml version="1.0" encoding="utf-8"?><Root><User><Name>张三</Name><Age>25</Age></User></Root>开启缩进配置输出
设置Indent为true,使用默认缩进字符:
using System;
using System.IO;
using System.Xml;
class Program
{
static void Main()
{
XmlWriterSettings settings = new XmlWriterSettings();
// 开启缩进
settings.Indent = true;
using (MemoryStream ms = new MemoryStream())
using (XmlWriter writer = XmlWriter.Create(ms, settings))
{
writer.WriteStartDocument();
writer.WriteStartElement("Root");
writer.WriteStartElement("User");
writer.WriteElementString("Name", "张三");
writer.WriteElementString("Age", "25");
writer.WriteEndElement();
writer.WriteEndElement();
writer.WriteEndDocument();
writer.Flush();
ms.Position = 0;
using (StreamReader sr = new StreamReader(ms))
{
Console.WriteLine("开启缩进配置输出:");
Console.WriteLine(sr.ReadToEnd());
}
}
}
}
输出内容会自动缩进,层级清晰:
<?xml version="1.0" encoding="utf-8"?>
<Root>
<User>
<Name>张三</Name>
<Age>25</Age>
</User>
</Root>
自定义缩进和换行配置
设置缩进字符为制表符,换行字符为n:
using System;
using System.IO;
using System.Xml;
class Program
{
static void Main()
{
XmlWriterSettings settings = new XmlWriterSettings();
settings.Indent = true;
// 设置缩进字符为制表符
settings.IndentChars = "t";
// 设置换行字符为n
settings.NewLineChars = "n";
using (MemoryStream ms = new MemoryStream())
using (XmlWriter writer = XmlWriter.Create(ms, settings))
{
writer.WriteStartDocument();
writer.WriteStartElement("Root");
writer.WriteStartElement("User");
writer.WriteElementString("Name", "张三");
writer.WriteElementString("Age", "25");
writer.WriteEndElement();
writer.WriteEndElement();
writer.WriteEndDocument();
writer.Flush();
ms.Position = 0;
using (StreamReader sr = new StreamReader(ms))
{
Console.WriteLine("自定义缩进换行配置输出:");
Console.WriteLine(sr.ReadToEnd());
}
}
}
}
输出内容会使用制表符缩进,换行符为n:
<?xml version="1.0" encoding="utf-8"?> <Root> <User> <Name>张三</Name> <Age>25</Age> </User> </Root>
省略XML声明配置
设置OmitXmlDeclaration为true,省略XML声明:
using System;
using System.IO;
using System.Xml;
class Program
{
static void Main()
{
XmlWriterSettings settings = new XmlWriterSettings();
settings.Indent = true;
// 省略XML声明
settings.OmitXmlDeclaration = true;
using (MemoryStream ms = new MemoryStream())
using (XmlWriter writer = XmlWriter.Create(ms, settings))
{
writer.WriteStartDocument();
writer.WriteStartElement("Root");
writer.WriteElementString("Name", "测试");
writer.WriteEndElement();
writer.WriteEndDocument();
writer.Flush();
ms.Position = 0;
using (StreamReader sr = new StreamReader(ms))
{
Console.WriteLine("省略XML声明配置输出:");
Console.WriteLine(sr.ReadToEnd());
}
}
}
}
输出内容不会包含XML声明:
<Root> <Name>测试</Name> </Root>
注意事项
在使用XmlWriterSettings时需要注意,当把XmlWriter输出到文件时,如果指定的编码和Encoding属性不一致,可能会出现乱码,建议保持文件流编码和XmlWriterSettings的Encoding属性一致。另外,Indent属性只会影响元素节点的缩进,不会对属性节点的换行做特殊处理,如果需要属性换行需要额外自定义处理逻辑。
XmlWriterSettingsC#XML输出格式IndentEncoding修改时间:2026-07-01 02:12:35