Java : ZipInputStream - API使用例

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

概要

このクラスは、ZIPファイル形式でファイルを読み込む入力ストリーム・フィルタを実装します。圧縮データと圧縮解除データの両方をサポートします。

クラス構成

ZIP は Windows でよく使われる圧縮形式です。
ZipInputStream クラスを使うと、ZIP 圧縮形式のデータを解凍して読み込めます。

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

// --------
// 圧縮
try (final var zos = new ZipOutputStream(Files.newOutputStream(path))) {
    zos.putNextEntry(new ZipEntry("bbb.txt"));
    zos.write("YYYYY".getBytes());

    zos.putNextEntry(new ZipEntry("ccc.txt"));
    zos.write("ZZZZZ".getBytes());
}

// --- PowerShell ---
//PS R:\java-work> ls -name
//aaa.zip
//
//PS R:\java-work> Expand-Archive .\aaa.zip .
//PS R:\java-work> ls -name
//aaa.zip
//bbb.txt
//ccc.txt
//
//PS R:\java-work> cat .\bbb.txt
//YYYYY
//PS R:\java-work> cat .\ccc.txt
//ZZZZZ

// --------
// 解凍
try (final var zis = new ZipInputStream(Files.newInputStream(path))) {
    final var entry1 = zis.getNextEntry();
    if (entry1 != null) {
        System.out.println(entry1.getName()); // bbb.txt

        final var uncompressed = zis.readAllBytes();
        System.out.println(Arrays.toString(uncompressed)); // [89, 89, 89, 89, 89]
        System.out.println(new String(uncompressed)); // YYYYY
    }

    final var entry2 = zis.getNextEntry();
    if (entry2 != null) {
        System.out.println(entry2.getName()); // ccc.txt

        final var uncompressed = zis.readAllBytes();
        System.out.println(Arrays.toString(uncompressed)); // [90, 90, 90, 90, 90]
        System.out.println(new String(uncompressed)); // ZZZZZ
    }

    System.out.println(zis.getNextEntry()); // null
}

共通で使うメソッド

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

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

    return out.toByteArray();
}

フィールド

static final int CENATT

中央ディレクトリの(CEN)ヘッダー内部ファイル属性のフィールド・オフセット。

System.out.println(ZipInputStream.CENATT); // 36

static final int CENATX

中央ディレクトリの(CEN)ヘッダー外部ファイル属性フィールド・オフセット。

System.out.println(ZipInputStream.CENATX); // 38

static final int CENCOM

中央ディレクトリの(CEN)ヘッダー・コメント長フィールド・オフセット。

System.out.println(ZipInputStream.CENCOM); // 32

static final int CENCRC

中央ディレクトリの(CEN)ヘッダー非圧縮ファイルのcrc-32値フィールド・オフセット。

System.out.println(ZipInputStream.CENCRC); // 16

static final int CENDSK

中央ディレクトリの(CEN)ヘッダー・ディスク番号の開始フィールド・オフセット。

System.out.println(ZipInputStream.CENDSK); // 34

static final int CENEXT

中央ディレクトリの(CEN)ヘッダーの追加フィールド長フィールド・オフセット。

System.out.println(ZipInputStream.CENEXT); // 30

static final int CENFLG

中央ディレクトリの(CEN)ヘッダー暗号化、復号化フラグのフィールド・オフセット。

System.out.println(ZipInputStream.CENFLG); // 8

static final int CENHDR

中央ディレクトリの(CEN)ヘッダー・サイズ(バイト単位、(シグネチャを含む))。

System.out.println(ZipInputStream.CENHDR); // 46

static final int CENHOW

中央ディレクトリの(CEN)ヘッダー圧縮メソッドのフィールド・オフセット。

System.out.println(ZipInputStream.CENHOW); // 10

static final int CENLEN

中央ディレクトリの(CEN)ヘッダーの非圧縮サイズ・フィールド・オフセット。

System.out.println(ZipInputStream.CENLEN); // 24

static final int CENNAM

中央ディレクトリの(CEN)ヘッダーのファイル名の長さフィールド・オフセット。

System.out.println(ZipInputStream.CENNAM); // 28

static final int CENOFF

中央ディレクトリの(CEN)ヘッダーLOCヘッダーのオフセット・フィールドのオフセット。

System.out.println(ZipInputStream.CENOFF); // 42

static final long CENSIG

中央ディレクトリの(CEN)ヘッダー・シグネチャ。

System.out.printf("%#x", ZipInputStream.CENSIG); // 0x2014b50

static final int CENSIZ

中央ディレクトリの(CEN)ヘッダー圧縮サイズ・フィールド・オフセット。

System.out.println(ZipInputStream.CENSIZ); // 20

static final int CENTIM

中央ディレクトリの(CEN)ヘッダー変更時間フィールド・オフセット。

System.out.println(ZipInputStream.CENTIM); // 12

static final int CENVEM

フィールド・オフセットによって作成される中央ディレクトリ(CEN)ヘッダー・バージョン。

System.out.println(ZipInputStream.CENVEM); // 4

static final int CENVER

フィールド・オフセットの抽出に必要な中央ディレクトリ(CEN)ヘッダー・バージョン。

System.out.println(ZipInputStream.CENVER); // 6

static final int ENDCOM

中央ディレクトリの(END)ヘッダーzipファイルのコメント長フィールド・オフセットの終わり。

System.out.println(ZipInputStream.ENDCOM); // 20

static final int ENDHDR

中央ディレクトリの(END)ヘッダー・サイズの終了(バイト単位、(シグネチャを含む))。

System.out.println(ZipInputStream.ENDHDR); // 22

static final int ENDOFF

最初のCENヘッダー・フィールドのオフセットに対する中央ディレクトリ(END)ヘッダー・オフセットの終了。

System.out.println(ZipInputStream.ENDOFF); // 16

static final long ENDSIG

中央ディレクトリの(END)ヘッダー・シグネチャの終了。

System.out.printf("%#x", ZipInputStream.ENDSIG); // 0x6054b50

static final int ENDSIZ

中央ディレクトリの(END)ヘッダー中央ディレクトリ・サイズ(バイト単位)フィールド・オフセットの終了。

System.out.println(ZipInputStream.ENDSIZ); // 12

static final int ENDSUB

このディスク・フィールド・オフセット上のエントリの中央ディレクトリ(END)ヘッダー番号の終わり。

System.out.println(ZipInputStream.ENDSUB); // 8

static final int ENDTOT

中央ディレクトリの(END)ヘッダーの入力フィールド・オフセットの合計数。

System.out.println(ZipInputStream.ENDTOT); // 10

static final int EXTCRC

圧縮されていない余分なローカル(EXT)ヘッダーのcrc-32値フィールド・オフセット。

System.out.println(ZipInputStream.EXTCRC); // 4

static final int EXTHDR

追加のローカル(EXT)ヘッダー・サイズ(バイト数(シグネチャを含む))。

System.out.println(ZipInputStream.EXTHDR); // 16

static final int EXTLEN

余分なローカル(EXT)ヘッダーの非圧縮サイズ・フィールド・オフセット。

System.out.println(ZipInputStream.EXTLEN); // 12

static final long EXTSIG

追加のローカル(EXT)ヘッダー・シグネチャ。

System.out.printf("%#x", ZipInputStream.EXTSIG); // 0x8074b50

static final int EXTSIZ

追加のローカル(EXT)ヘッダー圧縮サイズ・フィールド・オフセット。

System.out.println(ZipInputStream.EXTSIZ); // 8

static final int LOCCRC

ローカル・ファイル(LOC)ヘッダー非圧縮ファイルcrc-32値フィールド・オフセット。

System.out.println(ZipInputStream.LOCCRC); // 14

static final int LOCEXT

ローカル・ファイル(LOC)ヘッダーの追加フィールド長フィールド・オフセット。

System.out.println(ZipInputStream.LOCEXT); // 28

static final int LOCFLG

ローカル・ファイル(LOC)ヘッダー汎用ビット・フラグ・フィールド・オフセット。

System.out.println(ZipInputStream.LOCFLG); // 6

static final int LOCHDR

ローカル・ファイルの(LOC)ヘッダー・サイズ(バイト単位、(シグネチャを含む))。

System.out.println(ZipInputStream.LOCHDR); // 30

static final int LOCHOW

ローカル・ファイル(LOC)ヘッダー圧縮メソッドのフィールド・オフセット。

System.out.println(ZipInputStream.LOCHOW); // 8

static final int LOCLEN

ローカル・ファイル(LOC)ヘッダーの非圧縮サイズ・フィールド・オフセット。

System.out.println(ZipInputStream.LOCLEN); // 22

static final int LOCNAM

ローカル・ファイル(LOC)ヘッダーのファイル名の長さフィールド・オフセット。

System.out.println(ZipInputStream.LOCNAM); // 26

static final long LOCSIG

ローカル・ファイル(LOC)ヘッダーのシグネチャ。

System.out.printf("%#x", ZipInputStream.LOCSIG); // 0x4034b50

static final int LOCSIZ

ローカル・ファイルの(LOC)ヘッダー圧縮サイズ・フィールドのオフセット。

System.out.println(ZipInputStream.LOCSIZ); // 18

static final int LOCTIM

ローカル・ファイル(LOC)ヘッダー変更時間フィールド・オフセット。

System.out.println(ZipInputStream.LOCTIM); // 10

static final int LOCVER

フィールド・オフセットの抽出に必要なローカル・ファイル(LOC)ヘッダー・バージョン。

System.out.println(ZipInputStream.LOCVER); // 4

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

buf, inf, len

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

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

in

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

コンストラクタ

ZipInputStream (InputStream in)

新しいZIP入力ストリームを作成します。

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

final var bytes = deflate("aaa.txt", "aaaaa");
System.out.println(bytes.length); // 133

try (final var zis = new ZipInputStream(new ByteArrayInputStream(bytes))) {
    final var entry = zis.getNextEntry();
    if (entry != null) {
        System.out.println(entry.getName()); // aaa.txt

        final var uncompressed = zis.readAllBytes();
        System.out.println(Arrays.toString(uncompressed)); // [97, 97, 97, 97, 97]
        System.out.println(new String(uncompressed)); // aaaaa
    }
}

ZipInputStream (InputStream in, Charset charset)

新しいZIP入力ストリームを作成します。

in パラメータについては ZipInputStream(InputStream in) の使用例をご参照ください。

final var charset = Charset.forName("Shift_JIS");

final var out = new ByteArrayOutputStream();
try (final var zos = new ZipOutputStream(out, charset)) {
    zos.putNextEntry(new ZipEntry("aaa.txt"));
    zos.putNextEntry(new ZipEntry("○△×.txt"));
}

final var compressed = out.toByteArray();
System.out.println(compressed.length); // 244

try (final var zis = new ZipInputStream(new ByteArrayInputStream(compressed), charset)) {
    final var entry1 = zis.getNextEntry();
    if (entry1 != null) {
        System.out.println(entry1.getName()); // aaa.txt
    }

    final var entry2 = zis.getNextEntry();
    if (entry2 != null) {
        System.out.println(entry2.getName()); // ○△×.txt
    }
}

メソッド

int available ()

現在の入力データのEOFに達したあとで呼び出した場合に0を返します。そうでない場合は常に1を返します。

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

final var bytes = deflate("aaa.txt", "aaaaa");
System.out.println(bytes.length); // 133

try (final var zis = new ZipInputStream(new ByteArrayInputStream(bytes))) {
    final var entry = zis.getNextEntry();
    if (entry != null) {
        System.out.println(entry.getName()); // aaa.txt

        System.out.println(zis.available()); // 1

        System.out.println(zis.read()); // 97
        System.out.println(zis.available()); // 1

        System.out.println(zis.read()); // 97
        System.out.println(zis.available()); // 1

        final var uncompressed = zis.readAllBytes();
        System.out.println(Arrays.toString(uncompressed)); // [97, 97, 97]
        System.out.println(new String(uncompressed)); // aaa

        System.out.println(zis.available()); // 0
    }
}

void close ()

この入力ストリームを閉じて、そのストリームに関連するすべてのシステム・リソースを解放します。

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

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

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

final var bytes = deflate("aaa.txt", "aaaaa");
System.out.println(bytes.length); // 133
Files.write(file, bytes);

try (final var zis = new ZipInputStream(Files.newInputStream(file))) {
    final var entry = zis.getNextEntry();
    if (entry != null) {
        System.out.println(entry.getName()); // aaa.txt

        final var uncompressed = zis.readAllBytes();
        System.out.println(Arrays.toString(uncompressed)); // [97, 97, 97, 97, 97]
        System.out.println(new String(uncompressed)); // aaaaa
    }
}

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

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

final var bytes = deflate("aaa.txt", "aaaaa");
System.out.println(bytes.length); // 133
Files.write(file, bytes);

final var zis = new ZipInputStream(Files.newInputStream(file));
try {
    final var entry = zis.getNextEntry();
    if (entry != null) {
        System.out.println(entry.getName()); // aaa.txt

        final var uncompressed = zis.readAllBytes();
        System.out.println(Arrays.toString(uncompressed)); // [97, 97, 97, 97, 97]
        System.out.println(new String(uncompressed)); // aaaaa
    }
} finally {
    zis.close();
}

void closeEntry ()

現在のZIPエントリを閉じ、次のエントリを読み込むためにストリームを配置します。

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

final var bytes = deflate("aaa.txt", "aaaaa");
System.out.println(bytes.length); // 133

try (final var zis = new ZipInputStream(new ByteArrayInputStream(bytes))) {
    final var entry = zis.getNextEntry();
    if (entry != null) {
        System.out.println(entry.getName()); // aaa.txt

        System.out.println(zis.available()); // 1
        System.out.println(zis.read()); // 97

        System.out.println(zis.available()); // 1
        System.out.println(zis.read()); // 97

        System.out.println(zis.available()); // 1
        zis.closeEntry();

        System.out.println(zis.available()); // 0
        System.out.println(zis.read()); // -1
    }
}

protected ZipEntry createZipEntry (String name)

指定されたエントリ名の新しいZipEntryオブジェクトを作成します。

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

ZipEntry getNextEntry ()

次のZIPファイル・エントリを読み取って、エントリ・データの先頭にストリームを配置します。

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

// --------
// 圧縮
try (final var zos = new ZipOutputStream(Files.newOutputStream(path))) {
    zos.putNextEntry(new ZipEntry("bbb.txt"));
    zos.write("YYYYY".getBytes());

    zos.putNextEntry(new ZipEntry("ccc.txt"));
    zos.write("ZZZZZ".getBytes());
}

// --------
// 解凍
try (final var zis = new ZipInputStream(Files.newInputStream(path))) {
    final var entry1 = zis.getNextEntry();
    if (entry1 != null) {
        System.out.println(entry1.getName()); // bbb.txt

        final var uncompressed = zis.readAllBytes();
        System.out.println(Arrays.toString(uncompressed)); // [89, 89, 89, 89, 89]
        System.out.println(new String(uncompressed)); // YYYYY
    }

    final var entry2 = zis.getNextEntry();
    if (entry2 != null) {
        System.out.println(entry2.getName()); // ccc.txt

        final var uncompressed = zis.readAllBytes();
        System.out.println(Arrays.toString(uncompressed)); // [90, 90, 90, 90, 90]
        System.out.println(new String(uncompressed)); // ZZZZZ
    }

    System.out.println(zis.getNextEntry()); // null
}

int read (byte[] b, int off, int len)

現在のZIPエントリからバイト配列に読み込みます。

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

final var str = "abcdef";
System.out.println(Arrays.toString(str.getBytes())); // [97, 98, 99, 100, 101, 102]

final var bytes = deflate("aaa.txt", str);
System.out.println(bytes.length); // 133

try (final var zis = new ZipInputStream(new ByteArrayInputStream(bytes))) {
    final var entry = zis.getNextEntry();
    if (entry != null) {
        final var b1 = new byte[5];
        System.out.println(zis.read(b1, 0, 3)); // 3
        System.out.println(Arrays.toString(b1)); // [97, 98, 99, 0, 0]

        final var b2 = new byte[5];
        System.out.println(zis.read(b2, 1, 2)); // 2
        System.out.println(Arrays.toString(b2)); // [0, 100, 101, 0, 0]

        final var b3 = new byte[5];
        System.out.println(zis.read(b3, 0, 5)); // 1
        System.out.println(Arrays.toString(b3)); // [102, 0, 0, 0, 0]
    }
}

long skip (long n)

現在のZIPエントリで指定したバイト数だけスキップします。

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

final var bytes = deflate("aaa.txt", "aaaaaaaaaaaaaa");
System.out.println(bytes.length); // 133

try (final var zis = new ZipInputStream(new ByteArrayInputStream(bytes))) {
    final var entry = zis.getNextEntry();
    if (entry != null) {
        final var uncompressed = zis.readAllBytes();
        System.out.println(uncompressed.length); // 14
    }
}

try (final var zis = new ZipInputStream(new ByteArrayInputStream(bytes))) {
    final var entry = zis.getNextEntry();
    if (entry != null) {
        System.out.println(zis.skip(5)); // 5

        final var uncompressed = zis.readAllBytes();
        System.out.println(uncompressed.length); // 9
    }
}

Java : ZipInputStream - API使用例

概要

共通で使うメソッド

フィールド

static final int CENATT

static final int CENATX

static final int CENCOM

static final int CENCRC

static final int CENDSK

static final int CENEXT

static final int CENFLG

static final int CENHDR

static final int CENHOW

static final int CENLEN

static final int CENNAM

static final int CENOFF

static final long CENSIG

static final int CENSIZ

static final int CENTIM

static final int CENVEM

static final int CENVER

static final int ENDCOM

static final int ENDHDR

static final int ENDOFF

static final long ENDSIG

static final int ENDSIZ

static final int ENDSUB

static final int ENDTOT

static final int EXTCRC

static final int EXTHDR

static final int EXTLEN

static final long EXTSIG

static final int EXTSIZ

static final int LOCCRC

static final int LOCEXT

static final int LOCFLG

static final int LOCHDR

static final int LOCHOW

static final int LOCLEN

static final int LOCNAM

static final long LOCSIG

static final int LOCSIZ

static final int LOCTIM

static final int LOCVER

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

buf, inf, len

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

in

コンストラクタ

ZipInputStream (InputStream in)

ZipInputStream (InputStream in, Charset charset)

メソッド

int available ()

void close ()

void closeEntry ()

protected ZipEntry createZipEntry (String name)

ZipEntry getNextEntry ()

int read (byte[] b, int off, int len)

long skip (long n)

InflaterInputStreamで宣言されたメソッド

fill, mark, markSupported, read, reset

FilterInputStreamで宣言されたメソッド

read

InputStreamで宣言されたメソッド

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

関連記事