C# XML字符串包含特殊字符的處理轉換方法小結

更新時間：2020年07月01日 12:39:51 作者：webkaka

今天用C#輸出XML文件時，發(fā)現報錯，經過反復檢查調試，發(fā)現是因為某處內容含有某些特殊字符，這些特殊字符是在XML里不被允許的

為了能正常輸出XML格式的內容，必須要對不被XML允許的那些特殊字符進行轉換。本文介紹的正是如何使用C#判斷XML字符串是否含特殊字符并進行轉換。

以下是幾個特殊字符的對應實體。

<	<	小于號
>	>	大于號
&	&	和
'	'	單引號
"	"	雙引號

在C#中，直接調用C#提供的方法，保存之后就會自動將特殊字符轉為對應實體：

string s =System.Security.SecurityElement.Escape(s);

或者

將內容放在<![CDATA[ ]]>中，例如<![CDATA[2]]> ，CDATA里面的內容在XmlDocument 解析時會自動忽略掉

如果是很多有區(qū)域都有特殊內容，可以參考下面的代碼通過函數來實現替換。

其實挺簡單，只需用下面的這個函數，即可判斷及轉換XML字符串里的特殊字符。

核心代碼

/// <summary>
/// Turns a string into a properly XML Encoded string.
/// Uses simple string replacement.
/// 
/// Also see XmlUtils.XmlString() which uses XElement
/// to handle additional extended characters.
/// </summary>
/// <param name="text">Plain text to convert to XML Encoded string</param>
/// <param name="isAttribute">
/// If true encodes single and double quotes, CRLF and tabs.
/// When embedding element values quotes don't need to be encoded.
/// When embedding attributes quotes need to be encoded.
/// </param>
/// <returns>XML encoded string</returns>
/// <exception cref="InvalidOperationException">Invalid character in XML string</exception>
public static string XmlString(string text, bool isAttribute = false)
{
 var sb = new StringBuilder(text.Length);

 foreach (var chr in text)
 {
  if (chr == '<')
   sb.Append("&lt;");
  else if (chr == '>')
   sb.Append("&gt;");
  else if (chr == '&')
   sb.Append("&amp;");

  // special handling for quotes
  else if (isAttribute && chr == '\"')
   sb.Append("&quot;");
  else if (isAttribute && chr == '\'')
   sb.Append("&apos;");

  // Legal sub-chr32 characters
  else if (chr == '\n')
   sb.Append(isAttribute ? "&#xA;" : "\n");
  else if (chr == '\r')
   sb.Append(isAttribute ? "&#xD;" : "\r");
  else if (chr == '\t')
   sb.Append(isAttribute ? "&#x9;" : "\t");

  else
  {
   if (chr < 32)
    throw new InvalidOperationException("Invalid character in Xml String. Chr " +
             Convert.ToInt16(chr) + " is illegal.");
   sb.Append(chr);
  }
 }

 return sb.ToString();
}

被XML視為特殊字符的字符并不多，只有三個：<、&、>，因此只需把這三個字符進行轉換即可，而對單雙引號和換行符可轉換也可不轉換。

使用方法：

1、首先要導入命名空間System.Text;，因為要用到StringBuilder方法。

2、判斷及轉換字符串時直接使用函數XmlString()，如：