【Java】FileInputStreamクラスを使ってファイルにデータを読み込む！

ファイルにデータを読み込むにはFileInputStreamクラスを使用します。

FileInputStreamクラスは、ファイルのバイト単位のデータを読み込むときに使用する入力ストリームのクラスです。

ストリームとはホースのようなもので、ホースの中に水が流れるように、ストリームの中をデータが流れていくイメージです。

そのため、FileInputStreamクラスを使用すること作成したファイルのデータ内容を読み込むことができます。

今回はFileクラスのFileInputStreamクラスを使って、ファイルのデータを読み込む方法について解説していきます。

FileInputStreamクラスとは
- FileInputStreamクラスの書き方
ファイルにデータを読み込むサンプルコード
FileChannelクラスを使用してファイルにデータを読み込む場合
今回のポイント
- FileOutputStreamクラスでファイルにデータを書き込む
関連記事

FileInputStreamクラスとは

FileInputStreamクラスとは、ファイルにバイト単位のデータを読み込むときに使用する入力ストリームのクラスです。

FileInputStreamクラスの書き方

FileInputStreamクラスの構文は下記となります。

import java.io.FileInputStream;

1	import java.io.FileInputStream;

FileInputStreamクラスが使用できるようにFileInputStreamをインポートする必要があります。

インポートすることで、FileInputStreamクラスで準備されているメソッドを使用できるようになります。

ファイルにデータを読み込むサンプルコード

ファイルにデータを書き込むサンプルコードを紹介します。

Stream.txt

北海道
青森県岩手県秋田県宮城県山形県福島県

1 2	北海道青森県岩手県秋田県宮城県山形県福島県

Stream.txtは、文字コードをUTF-8、改行コードをCR+LFで、「C:¥study」以下に用意します。
また、末尾に改行を入れています。

その状態でMain.javaを実行します。

Main.java

// ファイルからデータを読み込む
import java.io.BufferedInputStream; 
import java.io.FileInputStream; 
import java.nio.ByteBuffer; 
import java.nio.channels.FileChannel;


public class Main {
    public static void main(String[] args) throws Exception {
        
        // 読み込み対象ファイル名 
        String fileName = "c:/study/Stream.txt";
        
        System.out.println("ストリームを使ってファイルを読み込む"); 
        Main.stream(fileName);
        
        System.out.println("チャネルを使ってファイルを読み込む");
        Main.channel(fileName);
    }
    
    // ストリームを使ってファイルを読み込むメソッド 
    static void stream(String fileName) throws Exception {
        
        // バッファを使った入力ストリームを作成
        BufferedInputStream input = new BufferedInputStream(
            new FileInputStream(fileName));
            
        // 読み込みバッファとして使用するバイト配列
        byte[] barray = new byte[64];
        
        //入カストリームから読み込んだバイト数 
        int size = 0;
        
        // ファイルの終端まで繰り返し読み込む
        while (-1 != (size = in.read(barray, 0, barray.length))) {

        // 読み込んだ内容をダンプ出力 
        Main.dump(barray, size);
        }
        // 入力ストリームを閉じる 
        input.close();
    }
    
    // チャネルを使ってファイルを読み込むメソッド
    static void channel(String fileName) throws Exception {
        
        // 入力ストリームを作り、そこからファイルチャネルを作成する
        FileInputStream input = new FileInputStream(fileName); 
        FileChannel channel = input.getChannel();
        
        // バッファサイズ 
        final int bufferSize = 64;
        
        ByteBuffer byteBuf = ByteBuffer.allocateDirect(bufferSize);
        
        // ByteBufferの内容を出力するバイト配列 
        byte[] barray = new byte[bufferSize];
        
        // チャネルから読み込んだバイト数 
        int size = 0;
        
        // チャネルの終端まで繰り返し読み込む 
        while (-1 != (size = channel.read(byteBuf))) {
            
            // バッファのリミットを現時点のポジションに、ポジションを
            // バッファの先頭に移動させる 
            byteBuf.flip();
            
            // ByteBufferの内容をバイト配列に出力する 
            byteBuf.get(barray, 0, byteBuf.limit());
            
            // 読み込んだ内容をダンプ出力
            Main.dump(barray, size);
            
            // ByteBufferをクリアする 
            byteBuf.clear();
        }
        // チャネルを閉じる
        channel.close();
    }
        
    // バイト配列をダンプ表示するメソッド
    static void dump (byte[] bytes, int size) {

        for (int i = 0; i < Math.min(bytes.length, size); i++) {
            byte b = bytes[i];
            
            String hex = Integer.toHexString(b < 0 ? 256 + b : b);
            
            System.out.print(hex.length() == 1 ? "0x0" : "0x"); 
            System.out.print(hex); 
            System.out.print(" ");
            
            if ((i + 1) % 8 == 0){
                System.out.println();
            }
        }
    }
}

// ファイルからデータを読み込む

import java.io.BufferedInputStream;

import java.io.FileInputStream;

import java.nio.ByteBuffer;

import java.nio.channels.FileChannel;

public class Main {

public static void main(String[] args) throws Exception {

// 読み込み対象ファイル名

String fileName = "c:/study/Stream.txt";

System.out.println("ストリームを使ってファイルを読み込む");

Main.stream(fileName);

System.out.println("チャネルを使ってファイルを読み込む");

Main.channel(fileName);

}

// ストリームを使ってファイルを読み込むメソッド

static void stream(String fileName) throws Exception {

// バッファを使った入力ストリームを作成

BufferedInputStream input = new BufferedInputStream(

new FileInputStream(fileName));

// 読み込みバッファとして使用するバイト配列

byte[] barray = new byte[64];

//入カストリームから読み込んだバイト数

int size = 0;

// ファイルの終端まで繰り返し読み込む

while (-1 != (size = in.read(barray, 0, barray.length))) {

// 読み込んだ内容をダンプ出力

Main.dump(barray, size);

}

// 入力ストリームを閉じる

input.close();

}

// チャネルを使ってファイルを読み込むメソッド

static void channel(String fileName) throws Exception {

// 入力ストリームを作り、そこからファイルチャネルを作成する

FileInputStream input = new FileInputStream(fileName);

FileChannel channel = input.getChannel();

// バッファサイズ

final int bufferSize = 64;

ByteBuffer byteBuf = ByteBuffer.allocateDirect(bufferSize);

// ByteBufferの内容を出力するバイト配列

byte[] barray = new byte[bufferSize];

// チャネルから読み込んだバイト数

int size = 0;

// チャネルの終端まで繰り返し読み込む

while (-1 != (size = channel.read(byteBuf))) {

// バッファのリミットを現時点のポジションに、ポジションを

// バッファの先頭に移動させる

byteBuf.flip();

// ByteBufferの内容をバイト配列に出力する

byteBuf.get(barray, 0, byteBuf.limit());

// 読み込んだ内容をダンプ出力

Main.dump(barray, size);

// ByteBufferをクリアする

byteBuf.clear();

}

// チャネルを閉じる

channel.close();

}

// バイト配列をダンプ表示するメソッド

static void dump (byte[] bytes, int size) {

for (int i = 0; i < Math.min(bytes.length, size); i++) {

byte b = bytes[i];

String hex = Integer.toHexString(b < 0 ? 256 + b : b);

System.out.print(hex.length() == 1 ? "0x0" : "0x");

System.out.print(hex);

System.out.print(" ");

if ((i + 1) % 8 == 0){

System.out.println();

}

出力結果

ストリームを使ってファイルを読み込む
0xe5 0x8c 0×97 0xe6 0xb5 0xb7 0xe9 0x81
0x93 0x0d 0x0a 0xe9 0x9d 0x92 0xe6 0xa3
0xae 0xe7 0x9c 0x8c 0xe5 0xb2 0xa9 0xe6
0x89 0x8b 0xe7 0x9c 0x8c 0xe7 0xa7 0x8b
0xe7 0x94 0xb0 0xe7 0x9c 0x8c 0xe5 0xae
0xae 0xe5 0x9f 0x8e 0xe7 0x9c 0x8c 0xes
0x01 0xb1 0xe5 0xbd 0xa2 0xe7 0x9C 0x8c
0xe7 0xa6 0x8f 0xe5 0xb3 0xb6 0xe7 0x9c

0x8c 0x0d 0x0a

チャネルを使ってファイルを読み込む
0xe5 0x8c 0×97 0xe6 0xb5 0xb7 0xe9 0x81
0x93 0x0d 0x0a 0xe9 0x9d 0x92 0xe6 0xa3
0xae 0xe7 0x9c 0x8c 0xe5 0xb2 0xa9 0xe6
0x89 0x8b 0xe7 0x9c 0x8c 0xe7 0xa7 0x8b
0xe7 0x94 0xb0 0xe7 0x9c 0x8c 0xe5 0xae
0xae 0xe5 0x9f 0x8e 0xe7 0x9c 0x8c 0xes
0x01 0xb1 0xe5 0xbd 0xa2 0xe7 0x9C 0x8c
0xe7 0xa6 0x8f 0xe5 0xb3 0xb6 0xe7 0x9c

0x8c 0x0d 0x0a

FileInputStreamクラスよってファイルの内容を読み込んでいます。
そして、dumpメソッドによって、byte配列を16進数ダンプ表示しています。

FileChannelクラスを使用してファイルにデータを読み込む場合

サンプルコードのMain.javaにあるもう1つの「channel」メソッドでは、チャネルを使ってファイルを読み込んでいます。
チャネルはストリームに比べ単純なことしかできませんがその分、高速に処理を行うことができます。
ファイルを扱うチャネルとして、「FileChannel」クラスが用意されています。

チャネルは既存のストリームから作成するため、publicなコンストラクタがありません。
「FileChannel|クラスのインスタンスは、FileInputStreamクラスのgetChannelメソッドで取得しています。

次に、読み込みに使うバッファを用意します。
ここでは、「Buffer」クラスのサブクラスである「ByteBuffer」を使います。

Bufferクラスは、「ポジション」「リミット」「キャパシティ」の3つのプロパティを持っています。
「ポジション」はBuffer内のどこを操作しているかを、「リミット」はBuffer内のどこまでデータを格納しているかを、「キャパシティ」はBufferの容量をそれぞれ示します。

バッファを操作すると、これらの値は次のように変化します。

処理内容	説明
バッファの初期化を行う ByteBuffer b = ByteBuffer.allocateDirect(8);	8バイトの容量でバッファを生成する。ポジションは先頭、リミットとキャパシティは最後になる。
バッファに値を書き込む b.put((byte) Ox01): b.put((byte) Ox02);	バッファに値を書き込むと、その分だけ b.put((byte) Ox01):ポジションがずれる。ポジションがリミットの位置にある状態でさらに書き込もうとすると例外が発生する。
flipメソッドを呼び出す b.flip();	flipメソッドを呼び出すとリミットをポジションの位置に移動し、ポジションをバッファの先頭に移動する。
getメソッドを呼び出す byte[] bytes = new byte[8]; b.get(bytes, 0, b.limit());	getメソッドを呼び出すと、ポジションの位置から「第3パラメーター第2パラメータ」の数だけを1パラメータのバイト配列に出力する。 bytesの中身は\|01,02,00,00,00,00,00.00\|となる。
clearメソッドを呼び出す b.clear();	clearメソッドを呼び出すと、ポジションとリミットが初期状態に戻る。バッファ内はそのまま。

「channel」メソッドでは、これらの処理を繰り返してファイルを読み込んでいます。
「ByteBuffer」インスタンスを作成するメソッドには、ByteBufferクラスのallocateメソッドとByteBufferクラスのallocateDirectメソッドがあります。

allocateDirectメソッドは、Javaのヒープ外のメモリを確保できればヒープ外に、できなければallocateDirectメソッドでJavaのヒープ内にメモリを確保します。

ヒープ外のメモリの方が高速に処理を行うことができます。

今回のポイント

FileOutputStreamクラスでファイルにデータを書き込む

ファイルからデータを読み込むにはFileInputStreamクラスを使用する。

⚫︎ リソースからデータを読み込むには、入力ストリームを使用し、リソースがファイルの場合は、FileInputStreamクラスを使用する

⚫︎ BufferedInputStreamクラスでラップしてバッファリングしながら読み込むことで、データの読み込みの効率を上げることができる

⚫︎ 読み込みが終わったらリソースを解放する必要がありますが、BufferedInputStreamクラスのcloseメソッドを呼び出すことで「FileInputStream」インスタンスのリソースも解放されます。

⚫︎ データを読み込むには、BufferedInputStreamクラスのreadメソッドを使います。

⚫︎ readメソッドの第1パラメータは、読み込んだデータを格納するバイト配列であり、第2パラメータはバイト配列のどこからデータを格納し始めるか、第3パラメータはバイト配列のどこまでデータを格納するかを指定する(特に理由がなければ、配列の最初から最後まで読み込むようにする)

⚫︎ readメソッドでファイルの終端まで読み込んだときは、バイト配列の大きさ以下の値を返し、その状態でさらに読み込もうとすると「-1」を返す

⚫︎ FileChannelクラスではチャネルを使ってファイルを読み込む

FileOutputStreamクラスでファイルにデータを書き込む方法ついてはこちらをご参考ください。

【Java】FileOutputStreamクラスを使ってファイルにデータを書き込む！

https://flytech.work/blog/14853

Writer

株式会社flyhawkのSTです。フライテックメディア事業部でのメディア運営・ライター業務なども担当。愛機はMac Book AirとThinkPad。好きな言語：swift、JS系(Node.js等)。好きなサーバー：AWS。受託開発やプログラミングスクールの運営をしております。ご気軽にお問い合わせください。

【Java】FileWriterクラスを使ってテキストファイルを書き込む！

【Java】ZipOutputStreamクラスを使ってzipファイルを圧縮する！