Класс ZipInputStream

java.util.zip.ZipInputStream

Все реализуемые интерфейсы:: Closeable, AutoCloseable

Непосредственные известные подклассы:: JarInputStream

public class ZipInputStream extends InflaterInputStream

Поток ввода для чтения сжатых и несжатых записей ZIP-файла из потока байтов в формате ZIP-файла.

Если не указано иное, передача аргумента null в конструктор или метод в этом классе приведет к выбрасыванию NullPointerException.

Чтение записей ZIP-файла

Метод getNextEntry() используется для чтения следующей записи ZIP-файла (запись локального файла (LOC) в формате ZIP) и позиционирования потока в данных файла записи. Данные файла можно читать с помощью одного из методов ZipInputStream чтения, таких как read или readAllBytes(). Например:

  Path jar = Path.of("foo.jar");
  try (InputStream is = Files.newInputStream(jar);
       ZipInputStream zis = new ZipInputStream(is)) {
      ZipEntry ze;
      while ((ze = zis.getNextEntry()) != null) {
         var bytes = zis.readAllBytes();
         System.out.printf("Entry: %s, bytes read: %s%n", ze.getName(),
                 bytes.length);
      }
  }

Примечание API:: Заголовок LOC содержит метаданные о записи ZIP-файла. ZipInputStream не читает центральный каталог (CEN) для записи и, следовательно, не будет иметь доступа к его метаданным, таким как внешние атрибуты файла. ZipFile может быть использован, когда необходима информация, хранящаяся в заголовке CEN.
С:: 1.1

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final int`	`CENATT`	Смещение поля атрибутов внутреннего файла в заголовке центрального каталога (CEN).
`static final int`	`CENATX`	Смещение поля внешних атрибутов файла в заголовке центрального каталога (CEN).
`static final int`	`CENCOM`	Смещение поля длины комментария в заголовке центрального каталога (CEN).
`static final int`	`CENCRC`	Смещение поля значения crc-32 нескомпрессированного файла в заголовке центрального каталога (CEN).
`static final int`	`CENDSK`	Смещение поля начального номера диска в заголовке центрального каталога (CEN).
`static final int`	`CENEXT`	Смещение поля длины дополнительного поля в заголовке центрального каталога (CEN).
`static final int`	`CENFLG`	Смещение поля флагов шифрования/дешифрования в заголовке центрального каталога (CEN).
`static final int`	`CENHDR`	Размер заголовка центрального каталога (CEN) в байтах (включая подпись).
`static final int`	`CENHOW`	Смещение поля метода сжатия в заголовке центрального каталога (CEN).
`static final int`	`CENLEN`	Смещение поля размера нескомпрессированного файла в заголовке центрального каталога (CEN).
`static final int`	`CENNAM`	Смещение поля длины имени файла в заголовке центрального каталога (CEN).
`static final int`	`CENOFF`	Смещение поля смещения заголовка LOC в заголовке центрального каталога (CEN).
`static final long`	`CENSIG`	Подпись заголовка центрального каталога (CEN).
`static final int`	`CENSIZ`	Смещение поля размера сжатого файла в заголовке центрального каталога (CEN).
`static final int`	`CENTIM`	Смещение поля времени модификации в заголовке центрального каталога (CEN).
`static final int`	`CENVEM`	Смещение поля версии, создавшей файл, в заголовке центрального каталога (CEN).
`static final int`	`CENVER`	Смещение поля версии, необходимой для извлечения файла, в заголовке центрального каталога (CEN).
`static final int`	`ENDCOM`	Смещение поля длины комментария к файлу ZIP в заголовке конца центрального каталога (END).
`static final int`	`ENDHDR`	Размер заголовка конца центрального каталога (END) в байтах (включая подпись).
`static final int`	`ENDOFF`	Смещение поля смещения первого заголовка CEN в заголовке конца центрального каталога (END).
`static final long`	`ENDSIG`	Подпись заголовка конца центрального каталога (END).
`static final int`	`ENDSIZ`	Смещение поля размера центрального каталога в байтах в заголовке конца центрального каталога (END).
`static final int`	`ENDSUB`	Смещение поля количества записей на этом диске в заголовке конца центрального каталога (END).
`static final int`	`ENDTOT`	Смещение поля общего количества записей в заголовке конца центрального каталога (END).
`static final int`	`EXTCRC`	Смещение поля значения crc-32 нескомпрессированного файла в заголовке дополнительного локального файла (EXT).
`static final int`	`EXTHDR`	Размер заголовка дополнительного локального файла (EXT) в байтах (включая подпись).
`static final int`	`EXTLEN`	Смещение поля размера нескомпрессированного файла в заголовке дополнительного локального файла (EXT).
`static final long`	`EXTSIG`	Подпись заголовка дополнительного локального файла (EXT).
`static final int`	`EXTSIZ`	Смещение поля размера сжатого файла в заголовке дополнительного локального файла (EXT).
`static final int`	`LOCCRC`	Смещение поля значения crc-32 нескомпрессированного файла в заголовке локального файла (LOC).
`static final int`	`LOCEXT`	Смещение поля длины дополнительного поля в заголовке локального файла (LOC).
`static final int`	`LOCFLG`	Смещение поля флага общего назначения в заголовке локального файла (LOC).
`static final int`	`LOCHDR`	Размер заголовка локального файла (LOC) в байтах (включая подпись).
`static final int`	`LOCHOW`	Смещение поля метода сжатия в заголовке локального файла (LOC).
`static final int`	`LOCLEN`	Смещение поля размера нескомпрессированного файла в заголовке локального файла (LOC).
`static final int`	`LOCNAM`	Смещение поля длины имени файла в заголовке локального файла (LOC).
`static final long`	`LOCSIG`	Подпись заголовка локального файла (LOC).
`static final int`	`LOCSIZ`	Смещение поля размера сжатого файла в заголовке локального файла (LOC).
`static final int`	`LOCTIM`	Смещение поля времени модификации в заголовке локального файла (LOC).
`static final int`	`LOCVER`	Смещение поля версии, необходимой для извлечения файла, в заголовке локального файла (LOC).

Поля, объявленные в классе java.util.zip.InflaterInputStream

buf, inf, len

Поля, объявленные в классе java.io.FilterInputStream

in

Краткое описание конструкторов

Конструктор	Описание
`ZipInputStream(InputStream in)`	Создаёт новый поток ввода ZIP.
`ZipInputStream(InputStream in, Charset charset)`	Создаёт новый поток ввода ZIP.

Краткое описание методов

Модификатор и тип	Метод	Описание
`int`	`available()`	Возвращает 0, когда обнаружен конец потока для текущей ZIP-записи или метод `closeEntry()` был вызван для текущей ZIP-записи, в противном случае возвращает 1.
`void`	`close()`	Закрывает этот поток ввода и освобождает все системные ресурсы, связанные с потоком.
`void`	`closeEntry()`	Закрывает текущую ZIP-запись и позиционирует поток для чтения следующей записи.
`protected ZipEntry`	`createZipEntry(String name)`	Создаёт новый `ZipEntry` объект для указанного имени записи.
`ZipEntry`	`getNextEntry()`	Читает следующую запись ZIP-архива и позиционирует поток в начале данных записи.
`int`	`read()`	Читает следующий байт данных из потока ввода для текущей ZIP-записи.
`int`	`read(byte[] b, int off, int len)`	Читает запрошенное количество байтов из потока ввода в заданный массив байтов для текущей ZIP-записи, возвращая количество распакованных байтов.
`byte[]`	`readAllBytes()`	Читает все оставшиеся байты из потока ввода для текущей ZIP-записи.
`int`	`readNBytes(byte[] b, int off, int len)`	Читает запрошенное количество байтов из потока ввода в заданный массив байтов для текущей ZIP-записи, возвращая количество распакованных байтов.
`byte[]`	`readNBytes(int len)`	Читает до указанного количества байтов из потока ввода для текущей ZIP-записи.
`long`	`skip(long n)`	Пропускает и отбрасывает `n` байт данных из этого потока ввода для текущей ZIP-записи.
`void`	`skipNBytes(long n)`	Пропускает и отбрасывает ровно `n` байта данных из этого потока ввода для текущей ZIP-записи.
`long`	`transferTo(OutputStream out)`	Читает все байты из этого потока ввода для текущей ZIP-записи и записывает байты в указанный поток вывода в порядке их чтения.

Методы, объявленные в классе java.util.zip.InflaterInputStream

fill, mark, markSupported, reset

Методы, объявленные в классе java.io.FilterInputStream

read

Методы, объявленные в классе java.io.InputStream

nullInputStream

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Подробное описание полей

LOCSIG

static final long LOCSIG

Подпись заголовка локального файла (LOC).

См. также:

EXTSIG

static final long EXTSIG

Подпись дополнительного заголовка локального файла (EXT).

См. также:

CENSIG

static final long CENSIG

Подпись заголовка центрального каталога (CEN).

См. также:

ENDSIG

static final long ENDSIG

Подпись заголовка конца центрального каталога (END).

См. также:

LOCHDR

static final int LOCHDR

Размер заголовка локального файла (LOC) в байтах (включая подпись).

См. также:

EXTHDR

static final int EXTHDR

Размер дополнительного заголовка локального файла (EXT) в байтах (включая подпись).

См. также:

CENHDR

static final int CENHDR

Размер заголовка центрального каталога (CEN) в байтах (включая подпись).

См. также:

ENDHDR

static final int ENDHDR

Размер заголовка конца центрального каталога (END) в байтах (включая подпись).

См. также:

LOCVER

static final int LOCVER

Смещение поля требуемой версии заголовка локального файла (LOC) для извлечения.

См. также:

LOCFLG

static final int LOCFLG

Смещение поля флага общего назначения заголовка локального файла (LOC).

См. также:

LOCHOW

static final int LOCHOW

Смещение поля метода сжатия заголовка локального файла (LOC).

См. также:

LOCTIM

static final int LOCTIM

Смещение поля времени изменения заголовка локального файла (LOC).

См. также:

LOCCRC

static final int LOCCRC

Смещение поля значения crc-32 нескомпрессированного файла заголовка локального файла (LOC).

См. также:

LOCSIZ

static final int LOCSIZ

Смещение поля сжатого размера заголовка локального файла (LOC).

См. также:

LOCLEN

static final int LOCLEN

Смещение поля размера нескомпрессированного размера заголовка локального файла (LOC).

См. также:

LOCNAM

static final int LOCNAM

Смещение поля длины имени файла заголовка локального файла (LOC).

См. также:

LOCEXT

static final int LOCEXT

Смещение поля длины дополнительного поля заголовка локального файла (LOC).

См. также:

EXTCRC

static final int EXTCRC

Смещение поля значения crc-32 нескомпрессированного файла дополнительного локального заголовка (EXT).

См. также:

EXTSIZ

static final int EXTSIZ

Смещение поля сжатого размера дополнительного локального заголовка (EXT).

См. также:

EXTLEN

static final int EXTLEN

Смещение поля размера нескомпрессированного размера дополнительного локального заголовка (EXT).

См. также:

CENVEM

static final int CENVEM

Смещение поля версии, созданной заголовком центрального каталога (CEN).

См. также:

CENVER

static final int CENVER

Смещение поля требуемой версии заголовка центрального каталога (CEN) для извлечения.

См. также:

CENFLG

static final int CENFLG

Смещение поля флагов шифрования/расшифрования заголовка центрального каталога (CEN).

См. также:

CENHOW

static final int CENHOW

Смещение поля метода сжатия заголовка центрального каталога (CEN).

См. также:

CENTIM

static final int CENTIM

Смещение поля времени изменения заголовка центрального каталога (CEN).

См. также:

CENCRC

static final int CENCRC

Смещение поля значения crc-32 нескомпрессированного файла заголовка центрального каталога (CEN).

См. также:

CENSIZ

static final int CENSIZ

Смещение поля сжатого размера заголовка центрального каталога (CEN).

См. также:

CENLEN

static final int CENLEN

Смещение поля размера нескомпрессированного заголовка центрального каталога (CEN).

См. также:

CENNAM

static final int CENNAM

Смещение поля длины имени файла заголовка центрального каталога (CEN).

См. также:

CENEXT

static final int CENEXT

Смещение поля длины дополнительного поля заголовка центрального каталога (CEN).

См. также:

CENCOM

static final int CENCOM

Смещение поля длины комментария к заголовку центрального каталога (CEN).

См. также:

CENDSK

static final int CENDSK

Смещение поля номера начального диска в заголовке центрального каталога (CEN).

См. также:

CENATT

static final int CENATT

Смещение поля атрибутов внутреннего файла в заголовке центрального каталога (CEN).

См. также:

CENATX

static final int CENATX

Смещение поля атрибутов внешнего файла в заголовке центрального каталога (CEN).

См. также:

CENOFF

static final int CENOFF

Смещение поля смещения заголовка LOC в заголовке центрального каталога (CEN).

См. также:

ENDSUB

static final int ENDSUB

Смещение поля количества записей на этом диске в заголовке конца центрального каталога (END).

См. также:

ENDTOT

static final int ENDTOT

Смещение поля общего количества записей в заголовке конца центрального каталога (END).

См. также:

ENDSIZ

static final int ENDSIZ

Смещение поля размера центрального каталога в байтах в заголовке конца центрального каталога (END).

См. также:

ENDOFF

static final int ENDOFF

Смещение поля смещения первого заголовка CEN в заголовке конца центрального каталога (END).

См. также:

ENDCOM

static final int ENDCOM

Смещение поля длины комментария к ZIP-архиву в заголовке конца центрального каталога (END).

См. также:

Детали конструкторов

ZipInputStream

public ZipInputStream(InputStream in)

Создает новый поток ввода ZIP.

Используется UTF-8 для декодирования имён записей.

Параметры:: in - фактический поток ввода

ZipInputStream

public ZipInputStream(InputStream in, Charset charset)

Создает новый поток ввода ZIP.

Параметры:: in - фактический поток ввода; charset - Используемый кодек для декодирования имени ZIP-записи (игнорируется, если установлен бит кодировки языка в флагах универсального назначения ZIP-записи).
С:: 1.7

Детали методов

getNextEntry

public ZipEntry getNextEntry() throws IOException

Читает следующую запись ZIP-файла и устанавливает поток в начало данных записи.

Возвращает:: следующую запись ZIP-файла или null, если больше нет записей
Исключения:: ZipException - если произошла ошибка в ZIP-файле; IOException - если произошла ошибка ввода/вывода

closeEntry

public void closeEntry() throws IOException

Закрывает текущую ZIP-запись и устанавливает поток для чтения следующей записи.

Исключения:: ZipException - если произошла ошибка в ZIP-файле; IOException - если произошла ошибка ввода/вывода

available

public int available() throws IOException

Возвращает 0, когда обнаружен конец потока для текущей ZIP-записи или метод closeEntry() был вызван для текущей ZIP-записи; в противном случае возвращает 1.

Программы не должны полагаться на этот метод для возврата фактического количества байтов, которые можно прочитать без блокировки.

Переопределяет:: available в классе InflaterInputStream
Возвращает:: 0, когда обнаружен конец потока для текущей ZIP-записи или closeEntry() был вызван для текущей ZIP-записи; в противном случае 1.
Исключения:: IOException - если произошла ошибка ввода/вывода.

read

public int read() throws IOException

Читает следующий байт данных из потока ввода для текущей ZIP-записи. Этот метод будет блокировать, пока не будут доступны достаточные данные для декомпрессии.

Переопределяет:

read в классе InflaterInputStream

Возвращает:

прочитанный байт или -1, если достигнут конец потока

Исключения:

IOException - если произошла ошибка ввода/вывода

См. также:

readAllBytes

public byte[] readAllBytes() throws IOException

Считывает все оставшиеся байты из входного потока для текущей записи ZIP. Этот метод блокируется до тех пор, пока все оставшиеся байты не будут прочитаны и не будет обнаружен конец потока или не будет выброшено исключение. Этот метод не закрывает входной поток.

Когда этот поток достигает конца потока, последующие вызовы этого метода будут возвращать пустой массив байтов.

Обратите внимание, что этот метод предназначен для простых случаев, когда удобно считать все байты в массив байтов. Он не предназначен для чтения входных потоков с большими объемами данных.

Если при чтении из входного потока произошла ошибка ввода-вывода, то это может произойти после чтения некоторых, но не всех байтов. Следовательно, входной поток может не быть в конце потока и может находиться в несогласованном состоянии. Сильно рекомендуется немедленно закрыть поток, если произошла ошибка ввода-вывода.

Overrides:: readAllBytes в классе InputStream
Returns:: массив байтов, содержащий прочитанные из этого входного потока байты
Throws:: OutOfMemoryError - если нельзя выделить массив требуемого размера.; IOException - если произошла ошибка ввода-вывода
Since:: 9

readNBytes

public byte[] readNBytes(int len) throws IOException

Считывает до заданного количества байтов из входного потока для текущей записи ZIP. Этот метод блокируется до тех пор, пока не будет прочитано затребованное количество байтов, не будет обнаружен конец потока или не будет выброшено исключение. Этот метод не закрывает входной поток.

Длина возвращаемого массива равна количеству байтов, прочитанных из потока. Если len равно нулю, то байты не считываются, и возвращается пустой массив байтов. В противном случае из потока считывается до len байтов. Может быть прочитано меньше len байтов, если обнаружен конец потока.

Обратите внимание, что этот метод предназначен для простых случаев, когда удобно считать указанное количество байтов в массив байтов. Общий объем памяти, выделенный этим методом, пропорционален количеству байтов, прочитанных из потока, который ограничен len. Следовательно, метод можно безопасно вызывать с очень большими значениями len при условии наличия достаточной памяти.

Overrides:: readNBytes в классе InputStream
Implementation Note:: Этот метод вызывает super.readNBytes(int len).
Parameters:: len - максимальное количество байтов для чтения
Returns:: массив байтов, содержащий прочитанные из этого входного потока байты
Throws:: OutOfMemoryError - если нельзя выделить массив требуемого размера.; IOException - если произошла ошибка ввода-вывода
Since:: 11

readNBytes

public int readNBytes(byte[] b, int off, int len) throws IOException

Считывает запрошенное количество байтов из входного потока в заданный массив байтов для текущей записи ZIP, возвращая количество распакованных байтов. Этот метод блокируется до тех пор, пока len байтов входных данных не будут прочитаны, не будет обнаружен конец потока или не будет выброшено исключение. Возвращается количество фактически прочитанных байтов, возможно, ноль. Этот метод не закрывает входной поток.

В случае, если конец потока достигнут до того, как будет прочитано len байтов, то фактическое количество прочитанных байтов будет возвращено. Когда этот поток достигает конца потока, последующие вызовы этого метода будут возвращать ноль.

Если len равно нулю, то байты не считываются, и возвращается 0; в противном случае есть попытка прочитать до len байтов.

Первый прочитанный байт сохраняется в элементе b[off], следующий - в b[off+1] и так далее. Количество прочитанных байтов, самое большое, равно len. Пусть k будет количеством фактически прочитанных байтов; эти байты будут сохранены в элементах b[off] до b[off+k-1], оставляя элементы b[off+k ] до b[off+len-1] неизменными.

Если при чтении из входного потока произошла ошибка ввода-вывода, то это может произойти после того, как некоторые, но не все байты b были обновлены данными из входного потока. В результате входной поток и b могут находиться в несогласованном состоянии. Сильно рекомендуется немедленно закрыть поток, если произошла ошибка ввода-вывода.

Overrides:: readNBytes в классе InputStream
Parameters:: b - массив байтов, в который считываются данные; off - начальный смещение в b, в котором записываются данные; len - максимальное количество байтов для чтения
Returns:: фактическое количество байтов, прочитанных в буфер
Throws:: IndexOutOfBoundsException - если off отрицательно, len отрицательно или len больше b.length - off; IOException - если произошла ошибка ввода-вывода
Since:: 9

skipNBytes

public void skipNBytes(long n) throws IOException

Пропускает и отбрасывает ровно n байтов данных из этого входного потока для текущей записи ZIP. Если n равно нулю, то байты не пропускаются. Если n отрицательно, то байты не пропускаются. Подклассы могут обрабатывать отрицательное значение по-разному.

Этот метод блокируется до тех пор, пока не будет пропущено затребованное количество байтов, не будет достигнут конец файла или не будет выброшено исключение.

Если конец потока достигнут до того, как поток достигнет желаемой позиции, то выбрасывается EOFException.

Если произошла ошибка ввода-вывода, то входной поток может находиться в несогласованном состоянии. Сильно рекомендуется немедленно закрыть поток, если произошла ошибка ввода-вывода.

Overrides:

skipNBytes в классе InputStream

Parameters:

n - количество байтов, которые нужно пропустить.

Throws:

IOException - если поток не может быть переместить или если произошла ошибка ввода-вывода.

Since:

See Also:

transferTo

public long transferTo(OutputStream out) throws IOException

Считывает все байты из этого входного потока для текущей записи ZIP и записывает байты в заданный выходной поток в порядке их чтения. По возвращении этот входной поток будет в конце потока. Этот метод не закрывает ни один из потоков.

Этот метод может блокироваться неопределённо, читая из входного потока или записывая в выходной поток. Поведение в случае, когда входной и/или выходной поток асинхронно закрывается или поток прерывается во время передачи, зависит от входного и выходного потоков и поэтому не определено.

Если общее количество переданных байтов больше Long.MAX_VALUE, то возвращается Long.MAX_VALUE.

Если при чтении из входного потока или записи в выходной поток произошла ошибка ввода-вывода, то это может произойти после чтения или записи некоторых байтов. Следовательно, входной поток может не быть в конце потока, и один или оба потока могут быть в несогласованном состоянии. Сильно рекомендуется немедленно закрыть оба потока, если произошла ошибка ввода-вывода.

Overrides:: transferTo в классе InputStream
Parameters:: out - выходной поток, не null
Returns:: количество переданных байтов
Throws:: IOException - если произошла ошибка ввода-вывода при чтении или записи
Since:: 9

read

public int read(byte[] b, int off, int len) throws IOException

Считывает запрошенное количество байтов из входного потока в заданный массив байтов для текущей записи ZIP, возвращая количество распакованных байтов. Если len не равно нулю, метод блокируется, пока некоторые входные данные не станут доступны; в противном случае байты не считываются, и возвращается 0.

Если текущая запись сжата, и этот метод возвращает ненулевое целое число n, то buf[off] до buf[off+n-1] содержат нескомпрессированные данные. Содержимое элементов buf[off+n] до buf[off+len-1] не определено, в отличие от спецификации суперкласса InputStream, поэтому реализация свободна изменять эти элементы во время операции распаковки. Если этот метод возвращает -1 или выбрасывает исключение, то содержимое buf[off] до buf[off+len-1] не определено.

Overrides:

read в классе InflaterInputStream

Parameters:

b - буфер, в который считываются данные

off - начальный смещение в целевом массиве b

len - максимальное количество считанных байтов

Returns:

фактическое количество прочитанных байтов или -1, если достигнут конец записи

Throws:

IndexOutOfBoundsException - если off отрицательно, len отрицательно или len больше b.length - off

ZipException - если произошла ошибка в ZIP-файле

IOException - если произошла ошибка ввода-вывода

See Also:

skip

public long skip(long n) throws IOException

Пропускает и отбрасывает n байт данных из этого потока ввода для текущей записи ZIP.

Overrides:

skip в классе InflaterInputStream

Parameters:

n - количество байт, которые нужно пропустить

Returns:

фактическое количество пропущенных байт

Throws:

ZipException - если произошла ошибка в файле ZIP

IOException - если произошла ошибка ввода-вывода

IllegalArgumentException - если n < 0

See Also:

close

public void close() throws IOException

Закрывает этот поток ввода и освобождает все системные ресурсы, связанные с потоком.

Specified by:

close в интерфейсе AutoCloseable

Specified by:

close в интерфейсе Closeable

Overrides:

close в классе InflaterInputStream

Throws:

IOException - если произошла ошибка ввода-вывода

See Also:

createZipEntry

protected ZipEntry createZipEntry(String name)

Создает новый объект ZipEntry для указанного имени записи.

Parameters:: name - имя записи файла ZIP
Returns:: созданная запись ZipEntry

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://download.java.net/java/early_access/jdk24/docs/api/java.base/java/util/zip/ZipInputStream.html