Java : InflaterOutputStream (ZIP) - API使用例

InflaterOutputStream (Java SE 19 & JDK 19) の使用例まとめです。
だいたいのメソッドを網羅済みです。
API仕様のおともにどうぞ。

概要

deflate圧縮形式で格納されたデータを圧縮解除するための出力ストリーム・フィルタを実装します。

クラス構成

Deflate は ZIP でも使われている圧縮形式です。
InflaterOutputStream クラスを使うと、deflate 圧縮形式のデータを解凍して出力できます。

// --------
// 圧縮
final var b1 = new ByteArrayOutputStream();
try (final var dos = new DeflaterOutputStream(b1)) {
    dos.write("aaaaaaaaaa".getBytes());
    dos.write("ZZZZZZZZZZ".getBytes());
}

final var compressed = b1.toByteArray();

// [120, -100, 75, 76, -124, -127, 40, 56, 0, 0, 78, 37, 7, 79]
System.out.println(Arrays.toString(compressed));

// --------
// 解凍
final var b2 = new ByteArrayOutputStream();
try (final var ios = new InflaterOutputStream(b2)) {
    ios.write(compressed);
}

final var uncompressed = b2.toByteArray();

// [97, 97, 97, 97, 97, 97, 97, 97, 97, 97, 90, 90, 90, 90, 90, 90, 90, 90, 90, 90]
System.out.println(Arrays.toString(uncompressed));

// aaaaaaaaaaZZZZZZZZZZ
System.out.println(new String(uncompressed));

共通で使うメソッド

本記事のコード例では、利便性のために以下のメソッドを使います。

// 文字列を圧縮します。
public byte[] deflate(String str) throws IOException {
    final var out = new ByteArrayOutputStream();
    try (final var dos = new DeflaterOutputStream(out)) {
        dos.write(str.getBytes());
    }

    return out.toByteArray();
}

フィールド

protected final byte[] buf

圧縮解除データを書き込むための出力バッファです。

protectedです。
独自にサブクラスを作ることは少ないと思いますので、コード例は割愛します。

protected final Inflater inf

このストリームに使用するデコンプレッサです。

protectedです。
独自にサブクラスを作ることは少ないと思いますので、コード例は割愛します。

FilterOutputStreamで宣言されたフィールド

out

「Java API 使用例 : FilterOutputStream」をご参照ください。

コンストラクタ

InflaterOutputStream (OutputStream out)

デフォルトのデコンプレッサおよびバッファ・サイズで新しい出力ストリームを作成します。

deflate メソッドについてはこちら

final var bytes = deflate("aaaaaaaaaa");

// [120, -100, 75, 76, -124, 1, 0, 20, -31, 3, -53]
System.out.println(Arrays.toString(bytes));

final var out = new ByteArrayOutputStream();
try (final var ios = new InflaterOutputStream(out)) {
    ios.write(bytes);
}

final var uncompressed = out.toByteArray();

// [97, 97, 97, 97, 97, 97, 97, 97, 97, 97]
System.out.println(Arrays.toString(uncompressed));

// aaaaaaaaaa
System.out.println(new String(uncompressed));

InflaterOutputStream (OutputStream out, Inflater infl)

指定されたデコンプレッサおよびデフォルトのバッファ・サイズで新しい出力ストリームを作成します。

deflate メソッドについてはこちら

final var bytes = deflate("aaaaaaaaaa");

// [120, -100, 75, 76, -124, 1, 0, 20, -31, 3, -53]
System.out.println(Arrays.toString(bytes));

final var out = new ByteArrayOutputStream();
try (final var ios = new InflaterOutputStream(out, new Inflater())) {
    ios.write(bytes);
}

final var uncompressed = out.toByteArray();

// [97, 97, 97, 97, 97, 97, 97, 97, 97, 97]
System.out.println(Arrays.toString(uncompressed));

// aaaaaaaaaa
System.out.println(new String(uncompressed));

InflaterOutputStream (OutputStream out, Inflater infl, int bufLen)

指定されたデコンプレッサおよびバッファ・サイズで新しい出力ストリームを作成します。

out, infl パラメータについては InflaterOutputStream(OutputStream out, Inflater infl) の使用例をご参照ください。

class MyOutputStream extends InflaterOutputStream {
    public MyOutputStream(OutputStream out) {
        super(out, new Inflater());
    }

    public MyOutputStream(OutputStream out, int bufLen) {
        super(out, new Inflater(), bufLen);
    }

    int getSize() {
        return buf.length;
    }
}

try (final var os = new MyOutputStream(new ByteArrayOutputStream())) {
    System.out.println(os.getSize()); // 512
}

try (final var os = new MyOutputStream(new ByteArrayOutputStream(), 1024)) {
    System.out.println(os.getSize()); // 1024
}

メソッド

void close ()

残りの圧縮解除データを出力ストリームに書き込み、出力ストリームを閉じます。

可能であれば try-with-resources文を使うことをおすすめします。

deflate メソッドについてはこちら

final var file = Path.of("R:", "java-work", "aaa.data");
System.out.println(file); // R:\java-work\aaa.data

final var bytes = deflate("aaaaaaaaaa");

// [120, -100, 75, 76, -124, 1, 0, 20, -31, 3, -53]
System.out.println(Arrays.toString(bytes));

try (final var ios = new InflaterOutputStream(Files.newOutputStream(file))) {
    ios.write(bytes);
}

System.out.println(Files.readString(file)); // aaaaaaaaaa

try-with-resources文を使わない例です。

final var file = Path.of("R:", "java-work", "aaa.data");
System.out.println(file); // R:\java-work\aaa.data

final var bytes = deflate("aaaaaaaaaa");

// [120, -100, 75, 76, -124, 1, 0, 20, -31, 3, -53]
System.out.println(Arrays.toString(bytes));

final var ios = new InflaterOutputStream(Files.newOutputStream(file));
try {
    ios.write(bytes);
} finally {
    ios.close();
}

System.out.println(Files.readString(file)); // aaaaaaaaaa

void finish ()

出力ストリームへの圧縮解除データの書込みを終了します。このときストリームは閉じられません。

deflate メソッドについてはこちら

final byte[] bytes = deflate("aaaaaaaaaa");

// [120, -100, 75, 76, -124, 1, 0, 20, -31, 3, -53]
System.out.println(Arrays.toString(bytes));

final var out = new ByteArrayOutputStream();
try (final var ios = new InflaterOutputStream(out)) {
    ios.write(bytes);
    ios.finish();

    // ストリームはまだ閉じられていません。
    out.write("XYZ".getBytes());
}

final var uncompressed = out.toByteArray();

// [97, 97, 97, 97, 97, 97, 97, 97, 97, 97, 88, 89, 90]
System.out.println(Arrays.toString(uncompressed));

// aaaaaaaaaaXYZ
System.out.println(new String(uncompressed));

void flush ()

この出力ストリームをフラッシュし、バッファ内の保留状態のすべての出力バイトが強制的に書き込まれるようにします。

deflate メソッドについてはこちら

final byte[] bytes = deflate("aaaaaaaaaa");

// [120, -100, 75, 76, -124, 1, 0, 20, -31, 3, -53]
System.out.println(Arrays.toString(bytes));

final var div1 = Arrays.copyOfRange(bytes, 0, 5);
System.out.println(Arrays.toString(div1)); // [120, -100, 75, 76, -124]

final var div2 = Arrays.copyOfRange(bytes, 5, bytes.length);
System.out.println(Arrays.toString(div2)); // [1, 0, 20, -31, 3, -53]

final var out = new ByteArrayOutputStream();
try (final var ios = new InflaterOutputStream(new BufferedOutputStream(out))) {

    ios.write(div1);
    System.out.println(Arrays.toString(out.toByteArray())); // []

    ios.flush();
    System.out.println(Arrays.toString(out.toByteArray())); // [97, 97]

    ios.write(div2);
}

final var uncompressed = out.toByteArray();

// [97, 97, 97, 97, 97, 97, 97, 97, 97, 97]
System.out.println(Arrays.toString(uncompressed));

// aaaaaaaaaa
System.out.println(new String(uncompressed));

void write (byte[] b, int off, int len)

バイト配列を圧縮解除出力ストリームに書き込みます。

deflate メソッドについてはこちら

final byte[] bytes = deflate("aaaaaaaaaa");

// [120, -100, 75, 76, -124, 1, 0, 20, -31, 3, -53]
System.out.println(Arrays.toString(bytes));

final var out = new ByteArrayOutputStream();
try (final var ios = new InflaterOutputStream(out)) {
    ios.write(bytes, 0, 5);

    // [97, 97]
    System.out.println(Arrays.toString(out.toByteArray()));

    ios.write(bytes, 5, 6);

    // [97, 97, 97, 97, 97, 97, 97, 97, 97, 97]
    System.out.println(Arrays.toString(out.toByteArray()));
}

// aaaaaaaaaa
System.out.println(out);

void write (int b)

バイトを圧縮解除出力ストリームに書き込みます。

deflate メソッドについてはこちら

final byte[] bytes = deflate("aaaaaaaaaa");

// [120, -100, 75, 76, -124, 1, 0, 20, -31, 3, -53]
System.out.println(Arrays.toString(bytes));

final var out = new ByteArrayOutputStream();
try (final var ios = new InflaterOutputStream(out)) {
    for (final var b : bytes) {
        ios.write(b);
    }
}

final var uncompressed = out.toByteArray();

// [97, 97, 97, 97, 97, 97, 97, 97, 97, 97]
System.out.println(Arrays.toString(uncompressed));

// aaaaaaaaaa
System.out.println(new String(uncompressed));

FilterOutputStreamで宣言されたメソッド

write

「Java API 使用例 : FilterOutputStream」をご参照ください。

OutputStreamで宣言されたメソッド

nullOutputStream

「Java API 使用例 : OutputStream」をご参照ください。

API 使用例

Java : InflaterOutputStream (ZIP) - API使用例

概要

共通で使うメソッド

フィールド

protected final byte[] buf

protected final Inflater inf

FilterOutputStreamで宣言されたフィールド

out

コンストラクタ

InflaterOutputStream (OutputStream out)

InflaterOutputStream (OutputStream out, Inflater infl)

InflaterOutputStream (OutputStream out, Inflater infl, int bufLen)

メソッド

void close ()

void finish ()

void flush ()

void write (byte[] b, int off, int len)

void write (int b)

FilterOutputStreamで宣言されたメソッド

write

OutputStreamで宣言されたメソッド

nullOutputStream

関連記事