バイトオーダーマークはJavaでファイルの読み取りを台無しにします


107

Javaを使用してCSVファイルを読み込もうとしています。一部のファイルでは、最初にバイトオーダーマークが付いている場合がありますが、すべてではありません。存在する場合、バイトオーダーは最初の行の残りと一緒に読み込まれるため、文字列の比較で問題が発生します。

存在する場合にバイトオーダーマークをスキップする簡単な方法はありますか?

ありがとう!


回答:


114

編集:私はGitHubで適切なリリースをしました:https//github.com/gpakosz/UnicodeBOMInputStream


これは私が少し前にコーディングしたクラスです。貼り付ける前にパッケージ名を編集しました。特別なことは何もありません。これは、SUNのバグデータベースに投稿されたソリューションと非常に似ています。それをコードに組み込んで問題はありません。

/* ____________________________________________________________________________
 * 
 * File:    UnicodeBOMInputStream.java
 * Author:  Gregory Pakosz.
 * Date:    02 - November - 2005    
 * ____________________________________________________________________________
 */
package com.stackoverflow.answer;

import java.io.IOException;
import java.io.InputStream;
import java.io.PushbackInputStream;

/**
 * The <code>UnicodeBOMInputStream</code> class wraps any
 * <code>InputStream</code> and detects the presence of any Unicode BOM
 * (Byte Order Mark) at its beginning, as defined by
 * <a href="http://www.faqs.org/rfcs/rfc3629.html">RFC 3629 - UTF-8, a transformation format of ISO 10646</a>
 * 
 * <p>The
 * <a href="http://www.unicode.org/unicode/faq/utf_bom.html">Unicode FAQ</a>
 * defines 5 types of BOMs:<ul>
 * <li><pre>00 00 FE FF  = UTF-32, big-endian</pre></li>
 * <li><pre>FF FE 00 00  = UTF-32, little-endian</pre></li>
 * <li><pre>FE FF        = UTF-16, big-endian</pre></li>
 * <li><pre>FF FE        = UTF-16, little-endian</pre></li>
 * <li><pre>EF BB BF     = UTF-8</pre></li>
 * </ul></p>
 * 
 * <p>Use the {@link #getBOM()} method to know whether a BOM has been detected
 * or not.
 * </p>
 * <p>Use the {@link #skipBOM()} method to remove the detected BOM from the
 * wrapped <code>InputStream</code> object.</p>
 */
public class UnicodeBOMInputStream extends InputStream
{
  /**
   * Type safe enumeration class that describes the different types of Unicode
   * BOMs.
   */
  public static final class BOM
  {
    /**
     * NONE.
     */
    public static final BOM NONE = new BOM(new byte[]{},"NONE");

    /**
     * UTF-8 BOM (EF BB BF).
     */
    public static final BOM UTF_8 = new BOM(new byte[]{(byte)0xEF,
                                                       (byte)0xBB,
                                                       (byte)0xBF},
                                            "UTF-8");

    /**
     * UTF-16, little-endian (FF FE).
     */
    public static final BOM UTF_16_LE = new BOM(new byte[]{ (byte)0xFF,
                                                            (byte)0xFE},
                                                "UTF-16 little-endian");

    /**
     * UTF-16, big-endian (FE FF).
     */
    public static final BOM UTF_16_BE = new BOM(new byte[]{ (byte)0xFE,
                                                            (byte)0xFF},
                                                "UTF-16 big-endian");

    /**
     * UTF-32, little-endian (FF FE 00 00).
     */
    public static final BOM UTF_32_LE = new BOM(new byte[]{ (byte)0xFF,
                                                            (byte)0xFE,
                                                            (byte)0x00,
                                                            (byte)0x00},
                                                "UTF-32 little-endian");

    /**
     * UTF-32, big-endian (00 00 FE FF).
     */
    public static final BOM UTF_32_BE = new BOM(new byte[]{ (byte)0x00,
                                                            (byte)0x00,
                                                            (byte)0xFE,
                                                            (byte)0xFF},
                                                "UTF-32 big-endian");

    /**
     * Returns a <code>String</code> representation of this <code>BOM</code>
     * value.
     */
    public final String toString()
    {
      return description;
    }

    /**
     * Returns the bytes corresponding to this <code>BOM</code> value.
     */
    public final byte[] getBytes()
    {
      final int     length = bytes.length;
      final byte[]  result = new byte[length];

      // Make a defensive copy
      System.arraycopy(bytes,0,result,0,length);

      return result;
    }

    private BOM(final byte bom[], final String description)
    {
      assert(bom != null)               : "invalid BOM: null is not allowed";
      assert(description != null)       : "invalid description: null is not allowed";
      assert(description.length() != 0) : "invalid description: empty string is not allowed";

      this.bytes          = bom;
      this.description  = description;
    }

            final byte    bytes[];
    private final String  description;

  } // BOM

  /**
   * Constructs a new <code>UnicodeBOMInputStream</code> that wraps the
   * specified <code>InputStream</code>.
   * 
   * @param inputStream an <code>InputStream</code>.
   * 
   * @throws NullPointerException when <code>inputStream</code> is
   * <code>null</code>.
   * @throws IOException on reading from the specified <code>InputStream</code>
   * when trying to detect the Unicode BOM.
   */
  public UnicodeBOMInputStream(final InputStream inputStream) throws  NullPointerException,
                                                                      IOException

  {
    if (inputStream == null)
      throw new NullPointerException("invalid input stream: null is not allowed");

    in = new PushbackInputStream(inputStream,4);

    final byte  bom[] = new byte[4];
    final int   read  = in.read(bom);

    switch(read)
    {
      case 4:
        if ((bom[0] == (byte)0xFF) &&
            (bom[1] == (byte)0xFE) &&
            (bom[2] == (byte)0x00) &&
            (bom[3] == (byte)0x00))
        {
          this.bom = BOM.UTF_32_LE;
          break;
        }
        else
        if ((bom[0] == (byte)0x00) &&
            (bom[1] == (byte)0x00) &&
            (bom[2] == (byte)0xFE) &&
            (bom[3] == (byte)0xFF))
        {
          this.bom = BOM.UTF_32_BE;
          break;
        }

      case 3:
        if ((bom[0] == (byte)0xEF) &&
            (bom[1] == (byte)0xBB) &&
            (bom[2] == (byte)0xBF))
        {
          this.bom = BOM.UTF_8;
          break;
        }

      case 2:
        if ((bom[0] == (byte)0xFF) &&
            (bom[1] == (byte)0xFE))
        {
          this.bom = BOM.UTF_16_LE;
          break;
        }
        else
        if ((bom[0] == (byte)0xFE) &&
            (bom[1] == (byte)0xFF))
        {
          this.bom = BOM.UTF_16_BE;
          break;
        }

      default:
        this.bom = BOM.NONE;
        break;
    }

    if (read > 0)
      in.unread(bom,0,read);
  }

  /**
   * Returns the <code>BOM</code> that was detected in the wrapped
   * <code>InputStream</code> object.
   * 
   * @return a <code>BOM</code> value.
   */
  public final BOM getBOM()
  {
    // BOM type is immutable.
    return bom;
  }

  /**
   * Skips the <code>BOM</code> that was found in the wrapped
   * <code>InputStream</code> object.
   * 
   * @return this <code>UnicodeBOMInputStream</code>.
   * 
   * @throws IOException when trying to skip the BOM from the wrapped
   * <code>InputStream</code> object.
   */
  public final synchronized UnicodeBOMInputStream skipBOM() throws IOException
  {
    if (!skipped)
    {
      in.skip(bom.bytes.length);
      skipped = true;
    }
    return this;
  }

  /**
   * {@inheritDoc}
   */
  public int read() throws IOException
  {
    return in.read();
  }

  /**
   * {@inheritDoc}
   */
  public int read(final byte b[]) throws  IOException,
                                          NullPointerException
  {
    return in.read(b,0,b.length);
  }

  /**
   * {@inheritDoc}
   */
  public int read(final byte b[],
                  final int off,
                  final int len) throws IOException,
                                        NullPointerException
  {
    return in.read(b,off,len);
  }

  /**
   * {@inheritDoc}
   */
  public long skip(final long n) throws IOException
  {
    return in.skip(n);
  }

  /**
   * {@inheritDoc}
   */
  public int available() throws IOException
  {
    return in.available();
  }

  /**
   * {@inheritDoc}
   */
  public void close() throws IOException
  {
    in.close();
  }

  /**
   * {@inheritDoc}
   */
  public synchronized void mark(final int readlimit)
  {
    in.mark(readlimit);
  }

  /**
   * {@inheritDoc}
   */
  public synchronized void reset() throws IOException
  {
    in.reset();
  }

  /**
   * {@inheritDoc}
   */
  public boolean markSupported() 
  {
    return in.markSupported();
  }

  private final PushbackInputStream in;
  private final BOM                 bom;
  private       boolean             skipped = false;

} // UnicodeBOMInputStream

そしてあなたはそれをこのように使っています:

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

public final class UnicodeBOMInputStreamUsage
{
  public static void main(final String[] args) throws Exception
  {
    FileInputStream fis = new FileInputStream("test/offending_bom.txt");
    UnicodeBOMInputStream ubis = new UnicodeBOMInputStream(fis);

    System.out.println("detected BOM: " + ubis.getBOM());

    System.out.print("Reading the content of the file without skipping the BOM: ");
    InputStreamReader isr = new InputStreamReader(ubis);
    BufferedReader br = new BufferedReader(isr);

    System.out.println(br.readLine());

    br.close();
    isr.close();
    ubis.close();
    fis.close();

    fis = new FileInputStream("test/offending_bom.txt");
    ubis = new UnicodeBOMInputStream(fis);
    isr = new InputStreamReader(ubis);
    br = new BufferedReader(isr);

    ubis.skipBOM();

    System.out.print("Reading the content of the file after skipping the BOM: ");
    System.out.println(br.readLine());

    br.close();
    isr.close();
    ubis.close();
    fis.close();
  }

} // UnicodeBOMInputStreamUsage

2
長いスクロールエリアで申し訳ありませんが、残念ながらアタッチメント機能がありません
グレゴリーパコス2009

グレゴリーに感謝します。それがまさに私が探しているものです。
トム

3
これはコアJava API内にある必要があります
Denis Kniazhev

7
10年が経過しましたが、私はこのカルマを受けています:D Javaを探しています!
Gregory Pakosz

1
回答は、ファイル入力ストリームがデフォルトでBOMを破棄するオプションを提供しない理由に関する履歴を提供するため、賛成です。
MxLDevs

94

ApacheのCommonsのIOのライブラリがありInputStream:部品表を検出して廃棄できるBOMInputStream(Javadocを)

BOMInputStream bomIn = new BOMInputStream(in);
int firstNonBOMByte = bomIn.read(); // Skips BOM
if (bomIn.hasBOM()) {
    // has a UTF-8 BOM
}

異なるエンコーディングも検出する必要がある場合は、さまざまな異なるバイトオーダーマークを区別することもできます。たとえば、UTF-8とUTF-16ビッグ+リトルエンディアン-詳細については、上記のドキュメントリンクをご覧ください。次に、検出されたByteOrderMarkを使用してCharset、ストリームをデコードするを選択できます。(この機能がすべて必要な場合、おそらくこれを行うためのより効率的な方法があるでしょう-おそらくBalusCの答えのUnicodeReader?)。一般に、一部のバイトのエンコーディングを検出するための適切な方法はありませんが、ストリームがBOMで始まる場合は、これが役立つ場合があることに注意してください。

編集:BOMをUTF-16、UTF-32などで検出する必要がある場合、コンストラクターは次のようになります。

new BOMInputStream(is, ByteOrderMark.UTF_8, ByteOrderMark.UTF_16BE,
        ByteOrderMark.UTF_16LE, ByteOrderMark.UTF_32BE, ByteOrderMark.UTF_32LE)

@ martin-charlesworthさんのコメントに賛成してください:)


BOMをスキップするだけです。ユースケースの99%に最適なソリューションである必要があります。
アタマンロマン

7
私はこの答えをうまく使いました。ただし、booleanBOMを含めるか除外するかを指定するための引数を丁重に追加します。例:BOMInputStream bomIn = new BOMInputStream(in, false); // don't include the BOM
ケビンメレディス

19
また、これはUTF-8 BOMのみを検出することも付け加えておきます。すべてのutf-X BOMを検出する場合は、それらをBOMInputStreamコンストラクターに渡す必要があります。BOMInputStream bomIn = new BOMInputStream(is, ByteOrderMark.UTF_8, ByteOrderMark.UTF_16BE, ByteOrderMark.UTF_16LE, ByteOrderMark.UTF_32BE, ByteOrderMark.UTF_32LE);
マーティンチャールズワース2014年

:@KevinMeredithのコメントに関しては、私はブール値を持つコンストラクタが明確ですが、javadocが示唆するように、デフォルトコンストラクタがすでに、UTF-8 BOMを処分したしたことを強調したいBOMInputStream(InputStream delegate) Constructs a new BOM InputStream that excludes a ByteOrderMark.UTF_8 BOM.
WesternGun

スキップは私の問題のほとんどを解決します。ファイルがBOM UTF_16BEで始まる場合、BOMをスキップしてファイルをUTF_8として読み取ることにより、InputReaderを作成できますか?これまでのところ機能しますが、エッジケースがあるかどうかを知りたいですか?前もって感謝します。
バスカー

31

より簡単な解決策:

public class BOMSkipper
{
    public static void skip(Reader reader) throws IOException
    {
        reader.mark(1);
        char[] possibleBOM = new char[1];
        reader.read(possibleBOM);

        if (possibleBOM[0] != '\ufeff')
        {
            reader.reset();
        }
    }
}

使用例:

BufferedReader input = new BufferedReader(new InputStreamReader(new FileInputStream(file), fileExpectedCharset));
BOMSkipper.skip(input);
//Now UTF prefix not present:
input.readLine();
...

5つのUTFエンコーディングすべてで動作します!


1
とても素敵なアンドレイ。しかし、それが機能する理由を説明できますか?パターン0xFEFFは、パターンが異なり、2バイトではなく3バイトであるように見えるUTF-8ファイルとどのように一致しますか?そして、そのパターンはどのようにUTF16とUTF32の両方のエンディアンに一致させることができますか?
Vahid Pazirandeh 2014年

1
ご覧のとおり、バイトストリームは使用していませんが、予期した文字セットで開かれた文字ストリームを使用しています。したがって、このストリームの最初の文字がBOMの場合は、スキップします。BOMはエンコーディングごとに異なるバイト表現を持つことができますが、これは1文字です。この記事を読んでください、それが私に役立ちます:joelonsoftware.com/articles/Unicode.html

良い解決策は、ファイルが空でないかどうかを確認して、読み取る前にskipメソッドでIOExceptionを回避することです。if(reader.ready()){reader.read(possibleBOM)...}を呼び出すことでそれを行うことができます
Snow

UTF-16BEのバイトオーダーマークである0xFE 0xFFをカバーしたようです。しかし、最初の3バイトが0xEF 0xBB 0xEFの場合はどうなりますか?(UTF-8のバイトオーダーマーク)。これはすべてのUTF-8形式で機能すると主張しています。これは真実かもしれません(私はあなたのコードをテストしていません)が、それはどのように機能しますか?
bvdb 16

1
Vahidへの私の回答を参照してください。私はバイトストリームではなく文字ストリームを開いて、そこから1文字を読み取ります。ファイルに使用されているutfエンコーディングを気にしないでください

24

Google Data APIにUnicodeReader、エンコーディングを自動的に検出するがあります。

の代わりに使用できますInputStreamReader。これはそのソースの-ややコンパクト化された-抜粋です。

public class UnicodeReader extends Reader {
    private static final int BOM_SIZE = 4;
    private final InputStreamReader reader;

    /**
     * Construct UnicodeReader
     * @param in Input stream.
     * @param defaultEncoding Default encoding to be used if BOM is not found,
     * or <code>null</code> to use system default encoding.
     * @throws IOException If an I/O error occurs.
     */
    public UnicodeReader(InputStream in, String defaultEncoding) throws IOException {
        byte bom[] = new byte[BOM_SIZE];
        String encoding;
        int unread;
        PushbackInputStream pushbackStream = new PushbackInputStream(in, BOM_SIZE);
        int n = pushbackStream.read(bom, 0, bom.length);

        // Read ahead four bytes and check for BOM marks.
        if ((bom[0] == (byte) 0xEF) && (bom[1] == (byte) 0xBB) && (bom[2] == (byte) 0xBF)) {
            encoding = "UTF-8";
            unread = n - 3;
        } else if ((bom[0] == (byte) 0xFE) && (bom[1] == (byte) 0xFF)) {
            encoding = "UTF-16BE";
            unread = n - 2;
        } else if ((bom[0] == (byte) 0xFF) && (bom[1] == (byte) 0xFE)) {
            encoding = "UTF-16LE";
            unread = n - 2;
        } else if ((bom[0] == (byte) 0x00) && (bom[1] == (byte) 0x00) && (bom[2] == (byte) 0xFE) && (bom[3] == (byte) 0xFF)) {
            encoding = "UTF-32BE";
            unread = n - 4;
        } else if ((bom[0] == (byte) 0xFF) && (bom[1] == (byte) 0xFE) && (bom[2] == (byte) 0x00) && (bom[3] == (byte) 0x00)) {
            encoding = "UTF-32LE";
            unread = n - 4;
        } else {
            encoding = defaultEncoding;
            unread = n;
        }

        // Unread bytes if necessary and skip BOM marks.
        if (unread > 0) {
            pushbackStream.unread(bom, (n - unread), unread);
        } else if (unread < -1) {
            pushbackStream.unread(bom, 0, 0);
        }

        // Use given encoding.
        if (encoding == null) {
            reader = new InputStreamReader(pushbackStream);
        } else {
            reader = new InputStreamReader(pushbackStream, encoding);
        }
    }

    public String getEncoding() {
        return reader.getEncoding();
    }

    public int read(char[] cbuf, int off, int len) throws IOException {
        return reader.read(cbuf, off, len);
    }

    public void close() throws IOException {
        reader.close();
    }
}

リンクはGoogle Data APIが廃止予定であると言っているようです?Google Data APIはどこにあるのでしょうか。
SOUser 2016

1
@XichenLi:GData APIは、その意図された目的のために廃止されました。GData APIを直接使用することを提案するつもりはありませんでした(OPはGDataサービスを使用していません)。独自の実装の例として、ソースコードを引き継ぐつもりです。コピーペーストの準備ができているので、それも私の回答に含めました。
BalusC 2016

これにはバグがあります。UTF-32LEのケースに到達できません。(bom[0] == (byte) 0xFF) && (bom[1] == (byte) 0xFE) && (bom[2] == (byte) 0x00) && (bom[3] == (byte) 0x00)がtrueになるためには、UTF-16LEのケース((bom[0] == (byte) 0xFF) && (bom[1] == (byte) 0xFE))がすでに一致しているはずです。
ジョシュアテイラー

このコードはGoogle Data APIからのものなので、私はそれについて問題471を投稿しました。
ジョシュアテイラー

13

Apache Commons IO図書館のBOMInputStreamはすでに@rescdskで言及されてきたが、私はそれを取得する方法を言及表示されませんでしたInputStream なし BOM。

Scalaでこれを実行した方法を次に示します。

 import java.io._
 val file = new File(path_to_xml_file_with_BOM)
 val fileInpStream = new FileInputStream(file)   
 val bomIn = new BOMInputStream(fileInpStream, 
         false); // false means don't include BOM

単一の引数コンストラクタがそれを行いますpublic BOMInputStream(InputStream delegate) { this(delegate, false, ByteOrderMark.UTF_8); }UTF-8 BOMデフォルトでは除外されます。
Vladimir Vagaytsev 16

良い点は、ウラジミール。-私は、そのドキュメントでいることがわかりcommons.apache.org/proper/commons-io/javadocs/api-2.2/org/...Constructs a new BOM InputStream that excludes a ByteOrderMark.UTF_8 BOM.
ケビン・メレディス

4

ファイルからBOM文字を単純に削除するには、Apache Common IOを使用することをお勧めします

public BOMInputStream(InputStream delegate,
              boolean include)
Constructs a new BOM InputStream that detects a a ByteOrderMark.UTF_8 and optionally includes it.
Parameters:
delegate - the InputStream to delegate to
include - true to include the UTF-8 BOM or false to exclude it

includeをfalseに設定すると、BOM文字は除外されます。



1

同じ問題があり、大量のファイルを読み取っていなかったため、より簡単な解決策を実行しました。このページの助けを借りて問題のある文字を出力したとき、エンコーディングはUTF-8だったと思います。文字のUnicode値を取得しました\ufeff。コードを使用しSystem.out.println( "\\u" + Integer.toHexString(str.charAt(0) | 0x10000).substring(1) );て、問題のあるUnicode値を出力しました。

問題のあるUnicode値を取得したら、ファイルの最初の行を置き換えてから、読み取りを続けました。そのセクションのビジネスロジック:

String str = reader.readLine().trim();
str = str.replace("\ufeff", "");

これで問題が解決しました。その後、問題なくファイルを処理することができました。trim()先頭または末尾の空白の場合に備えて、特定のニーズに基づいてそれを行うかどうかを追加しました。


1
それは私にはうまくいきませんでしたが、私は.replaceFirst( "\ u00EF \ u00BB \ u00BF"、 "")を使いました。
StackUMan 2018
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.