C#的XmlWriterSettings怎么控制输出格式

13次阅读

xmlWriterSettings 通过 Indent、IndentChars、NewLineChars 等属性控制 XML 格式化输出,启用 Indent=true 是前提,需配合 IndentChars 指定缩进符、NewLineChars 设置换行符,并注意编码与声明一致性及避免手动插入干扰格式的空白。

C#的XmlWriterSettings怎么控制输出格式

XmlWriterSettings 主要通过几个关键属性控制 XML 输出的格式,核心是让生成的 XML 更易读(带缩进)或更紧凑(无格式),同时兼顾编码、换行、空白处理等细节。

启用缩进美化输出

设置 Indent = true 是实现“格式化输出”的前提。但仅设这个还不够,还需配合 IndentChars 指定缩进符号(如空格或制表符),否则默认用两个空格,可能不符合你的风格。

  • Indent = true:开启缩进逻辑(默认 false)
  • IndentChars = ” “:用两个空格缩进(可改为 “t” 或 ” “)
  • NewLineChars = “rn”:指定换行符(windows 常用,linux/macOS 可用 “n”)
  • NewLineOnAttributes = false:避免每个属性换一行(设为 true 会强制换行,通常不推荐)

控制空白与换行行为

XML 内容中的空白(如文本节点前后的空格、换行)是否保留,取决于 IgnoreWhitespace(这是 读取时 的设置,不适用于 XmlWriter)。对 XmlWriter 来说,真正影响输出空白的是:

  • OmitXmlDeclaration = false(默认 true):设为 false 才输出
  • NewLineHandling = NewLineHandling.Replace:写入时把文本中的 rn、n、r 统一替换成 NewLineChars 指定的换行符
  • 注意:ConformanceLevel 设为 autoDocument 才支持根元素外的空白;若设为 Fragment,则忽略顶层空白

编码与声明一致性

Encoding 属性不仅决定写入流使用的编码,还会自动更新 XML 声明里的 encoding 值(前提是 OmitXmlDeclaration = false)。

  • 例如:设置 Encoding = Encoding.UTF8 → 输出声明为 encoding="utf-8"
  • 如果 Encoding 是 UTF-16,声明中会是 encoding="utf-16"(注意:实际写入流必须匹配该编码)
  • 不建议手动修改声明字符串——让 XmlWriter 自动生成更安全

避免意外格式破坏的小技巧

即使设置了 Indent=true,某些写法仍会导致格式错乱,比如:

  • WriteRawWriteString 插入含换行/缩进的自定义内容,会干扰自动缩进逻辑
  • WriteStartElement 后立刻调用 WriteString(“n “),容易和自动缩进叠加,造成多余空行
  • 推荐做法:靠 Indent + NewLineChars 驱动整体格式,内容文本尽量保持“干净”,让 XmlWriter 全权管理结构缩进

基本上就这些。不需要手动拼接换行或空格,XmlWriterSettings 的设计就是让你声明意图,它来执行细节。

text=ZqhQzanResources