UTF-8 file when bom exist

最新推荐文章于 2021-10-07 09:02:59 发布

jack_liu4Ye

最新推荐文章于 2021-10-07 09:02:59 发布

阅读量502

点赞数

java普通的文件读取方式对于bom是无法正常识别的。

使用普通的InputStreamReader，如果采用的编码正确，那么可以获得正确的字符，但bom仍然附带在结果中，很容易导致数据处理出错。
另外，对于存在BOM头的文件，无法猜测它使用的编码。

目标：

实现一种方式，可对BOM头进行捕捉和过滤

解决方案有二：

一、使用apache的工具类，以BOMStream为例：

BOMStream，api参考：http://commons.apache.org/io/apidocs/org/apache/commons/io/input/BOMInputStream.html

该类的构造方式：
BOMInputStream bomIn = new BOMInputStream(in) //仅能检测到UTF8的bom，且在流中exclude掉bom

BOMInputStream bomIn = new BOMInputStream(in, include); //同上，且指定是否包含

也可以指定检测多种编码的bom，但目前仅支持UTF-8/UTF-16LE/UTF-16BE三种，对于UTF32之类不支持。
BOMInputStream bomIn = new BOMInputStream(in, ByteOrderMark.UTF_16LE, ByteOrderMark.UTF_16BE);

有用的方法：
bomIn.hasBOM()、hasBOM(ByteOrderMask.**)可用于判断当前流中是否检测到了bom。

读取文件示例：

[java] view plain copy print ?

FileInputStream fis = new FileInputStream(file);
//可检测多种类型，并剔除bom
BOMInputStream bomIn = new BOMInputStream(in, false,ByteOrderMark.UTF-8, ByteOrderMark.UTF_16LE, ByteOrderMark.UTF_16BE);
String charset = "utf-8";
//若检测到bom，则使用bom对应的编码
if(bomIn.hasBOM()){
charset = bomIn.bs.getBOMCharsetName();
}
InputStreamReader reader = new InputStreamReader(bomIn, charset);
...

 FileInputStream fis = new FileInputStream(file);
   //可检测多种类型，并剔除bom
   BOMInputStream bomIn = new BOMInputStream(in, false,ByteOrderMark.UTF-8, ByteOrderMark.UTF_16LE, ByteOrderMark.UTF_16BE);
   String charset = "utf-8";
   //若检测到bom，则使用bom对应的编码
   if(bomIn.hasBOM()){
      charset = bomIn.bs.getBOMCharsetName();
   }
   InputStreamReader reader = new InputStreamReader(bomIn, charset);
   ...

二、使用一个更强大点的工具类（可以支持UTF-8/UTF-16LE/UTF-16BE/UTF-32LE/UTF-32BE）：

参考地址：http://koti.mbnet.fi/akini/java/unicodereader/，下载其中两个文件：UnicodeStream和UnicodeReader

以UnicodeReader为例：

[java] view plain copy print ?

FileInputStream fis = new FileInputStream(file);
UnicodeReader ur = new UnicodeReader(fis, "utf-8");
BufferedReader br = new BufferedReader(ur);
...

   FileInputStream fis = new FileInputStream(file);
   UnicodeReader ur = new UnicodeReader(fis, "utf-8");
   BufferedReader br = new BufferedReader(ur);
   ...

相较于Apache的工具类，这里的UnicodeReader 支持更多的BOM编码。

源码解读：

UnicodeReader 通过PushbackInputStream+InputStreamReader实现BOM的自动检测和过滤读取；

当没有检测到BOM时，pushback流将回退，并采用构造函数传入的编码进行读取。
否则使用BOM对应的编码进行读取。

相对来说，第二种方式更加轻量和强大；另外也更加透明，可以随便修改源码来实现自己的需求。

最近在处理文件时发现了同样类型的文件使用的编码可能是不同的。所以想将文件的格式统一一下(因为UTF-8的通用性，决定往UTF-8统一)，遇见的第一个问题是：如何查看现有文件的编码方式。

在java中，class文件采用utf8的编码方式，JVM运行时采用utf16。Java的字符串是永远都是unicode的，采用的是UTF-16的编码方式。

想测试一下，java对UTF-8文件的读写的能力，结果发现了一个很郁闷的问题，如果通过java写的UTF-8文件，使用Java可以正确的读，但是如果用记事本将相同的内容使用UTF-8格式保存，则在使用程序读取是会从文件中多读出一个不可见字符。

测试代码如下：

import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStreamReader;

public class UTF8Test {
public static void main(String[] args) throws IOException {
File f = new File("./utf.txt");
FileInputStream in = new FileInputStream(f);
// 指定读取文件时以UTF-8的格式读取
BufferedReader br = new BufferedReader(new InputStreamReader(in, "UTF-8"));

String line = br.readLine();
while(line != null)
{
System.out.println(line);
line = br.readLine();
}
}
}

utf.txt通过记事本创建，另存时使用指定utf-8编码，其内容为：

This is the first line.

This is second line.

正常的测试结果应该是直接输出utf.txt的文本内容。可是实际上却输出了下面的内容：

This is the first line.

This is second line.

第一行多出了一个问号。

通过上面的几篇文章应该可以想到是Java读取BOM（Byte Order　Mark）的问题，在使用UTF-8时，可以在文件的开始使用3个字节的"EF BB BF"来标识文件使用了UTF-8的编码，当然也可以不用这个3个字节。

上面的问题应该就是因为对开头3个字节的读取导致的。开始不太相信这个是JDK的Bug，后来在多次试验后，问题依然存在，就又狗狗了一下，果然找到一个如下的Bug:

Bug ID:4508058

不过在我关掉的一些页面中记得有篇文件说这个bug只在jdk1.5及之前的版本才有，说是1.6已经解决了，从目前来看1.6只是解决了读取带有BOM文件失败的问题，还是不能区别处理有BOM和无BOM的UTF-8编码的文件，从Bug ID:4508058里的描述可以看出，这个问题将作为一个不会修改的问题关闭，对于BOM编码的识别将由应用程序自己来处理，原因可从另处一个bug处查看到，因为Unicode对于BOM的编码的规定可能发生变化。也就是说对于一个UTF-8的文件，应用程序需要知道这个文件有没有写BOM，然后自己决定处理BOM的方式。

在上面的while循环中可加入下面的代码，测试一下读出内容：

byte[] allbytes = line.getBytes("UTF-8");
   for (int i=0; i < allbytes.length; i++)
   {
    int tmp = allbytes[i];
    String hexString = Integer.toHexString(tmp);
    // 1个byte变成16进制的，只需要2位就可以表示了，取后面两位，去掉前面的符号填充
    hexString = hexString.substring(hexString.length() -2);
    System.out.print(hexString.toUpperCase());
    System.out.print(" ");
   }

输出结果如下：

引用

EF BB BF 54 68 69 73 20 69 73 20 74 68 65 20 66 69 72 73 74 20 6C 69 6E 65 2E

?This is the first line.

54 68 69 73 20 69 73 20 73 65 63 6F 6E 64 20 6C 69 6E 65 2E

This is second line.

红色部分的"EF BB BF"刚好是UTF-8文件的BOM编码，可以看出Java在读文件时没能正确处理UTF-8文件的BOM编码，将前3个字节当作文本内容来处理了。

使用链接中提供的代码可以解决碰到的乱码问题：http://koti.mbnet.fi/akini/java/unicodereader/

修改测试代码中的输入流后：

BufferedReader br = new BufferedReader(new UnicodeReader(in, Charset.defaultCharset().name()));

执行，可以看到正确的结果。

将用到的测试代码及UTF-8读取乱码解决的源码放在了附件中