Unity中检测xml是否带BOM头（XmlException Text node cannot appear in this state）

前言

项目中的xml配置表，一般编码格式建议使用utf 8，可以使用notpad++查看编码和设置编码：

不要使用带BOM编码格式，否则在真机上解析xml的时候会报错：

XmlException: Text node cannot appear in this state.  Line 1, position 1.

 

什么是BOM头

BOM是用来判断文本文件是哪一种Unicode编码的标记，其本身是一个Unicode字符（"\uFEFF"），位于文本文件头部。

在不同的Unicode编码中，对应的bom的二进制字节如下：

Bytes Encoding

0xfe 0xff	UTF16BE
0xff 0xfe	UTF16LE
0xef 0xbb 0xbf	UTF8

所以我们可以根据文件头部的几个字节和上面的表格对应来判断该文件是哪种编码形式。

在utf-8编码文件中BOM在文件头部，占用三个字节，用来标示该文件属于utf-8编码，现在已经有很多软件识别bom头，但是还有些不能识别bom头，比如PHP就不能识别bom头，这也是用记事本编辑utf-8编码后执行就会出错的原因了。

---

看是否带Bom，可以用notepad++，但是如果有一大批文件，要挨个查看编码，就有点恶心了，所以这事交给代码来做吧，例子如下：

using UnityEngine;
using System.Collections;
using UnityEditor;
using System.IO;

public class CfgBomCheckTools
{
    [MenuItem("GameTools/检测配置表BOM头")]
    public static void CheckCfgBom()
    {
        CheckBom(GetConfigFiles());
    }

    //获取目录中的所有配置表文件, .bytes结尾的文件，内容其实是xml
    static string[] GetConfigFiles()
    {
        string dir_name = Application.dataPath + "/ConfigDir/";
        return System.IO.Directory.GetFiles(dir_name, "*.bytes", SearchOption.AllDirectories);
    }

    static void CheckBom(string[] files)
    {
        foreach (var f in files)
        {
            using (FileStream fs = new FileStream(f, FileMode.Open, FileAccess.Read))
            {
                using (BinaryReader rd = new BinaryReader(fs))
                {
                    byte[] bs = rd.ReadBytes(3);
                    if (bs[0] == 0xef && bs[1] == 0xbb && bs[2] == 0xbf)
                    {
                        DebugLog.LogError(string.Format("配置表有BOM头，文件：{0}", f));
                    }
                }
            }
        }
    }
}