Пакет zip
Обзор
Пакет zip предоставляет поддержку чтения и записи архивов ZIP.
Подробности см. в спецификации ZIP.
Этот пакет не поддерживает разбиение на разделы диска.
Примечание о ZIP64:
Для обратной совместимости FileHeader имеет поля размера 32 и 64 бита. Поля 64 бита всегда содержат правильное значение, и для обычных архивов оба поля будут одинаковыми. Для файлов, требующих формат ZIP64, поля 32 бита будут равны 0xffffffff, и вместо них необходимо использовать поля 64 бит.
Индекс
Примеры
Файлы пакета
reader.go register.go struct.go writer.go
Константы
Методы сжатия.
const (
Store uint16 = 0 // no compression
Deflate uint16 = 8 // DEFLATE compressed
) Переменные
var (
ErrFormat = errors.New("zip: not a valid zip file")
ErrAlgorithm = errors.New("zip: unsupported compression algorithm")
ErrChecksum = errors.New("zip: checksum error")
ErrInsecurePath = errors.New("zip: insecure file path")
) func RegisterCompressor 1.2
func RegisterCompressor(method uint16, comp Compressor)
RegisterCompressor регистрирует пользовательские компрессоры для указанного идентификатора метода. Общие методы Store и Deflate встроены.
func RegisterDecompressor 1.2
func RegisterDecompressor(method uint16, dcomp Decompressor)
RegisterDecompressor позволяет использовать пользовательские декомпрессоры для указанного идентификатора метода. Общие методы Store и Deflate встроены.
тип Compressor 1.2
Compressor возвращает новый компрессирующий writer, записывающий в w. Метод Close WriteCloser'а должен использоваться для сброса ожидающих данных в w. Сам Compressor должен быть безопасным для вызова из нескольких горутин одновременно, но каждый возвращаемый writer будет использоваться только одной горутиной за раз.
type Compressor func(w io.Writer) (io.WriteCloser, error)
тип Decompressor 1.2
Decompressor возвращает новый декомпрессирующий reader, читающий из r. Метод Close io.ReadCloser'а должен использоваться для освобождения связанных ресурсов. Сам Decompressor должен быть безопасным для вызова из нескольких горутин одновременно, но каждый возвращаемый reader будет использоваться только одной горутиной за раз.
type Decompressor func(r io.Reader) io.ReadCloser
тип File
File представляет собой один файл в архиве ZIP. Информация о файле находится во встроенном FileHeader. К содержимому файла можно получить доступ, вызвав File.Open.
type File struct {
FileHeader
// contains filtered or unexported fields
}
func (*File) DataOffset 1.2
func (f *File) DataOffset() (offset int64, err error)
DataOffset возвращает смещение данных файла, возможно сжатых, относительно начала файла zip.
Большинству вызывающих функций следует использовать File.Open, который прозрачно декомпримирует данные и проверяет контрольные суммы.
func (*File) Open
func (f *File) Open() (io.ReadCloser, error)
Open возвращает ReadCloser, который предоставляет доступ к содержимому File. Несколько файлов могут быть прочитаны одновременно.
func (*File) OpenRaw 1.17
func (f *File) OpenRaw() (io.Reader, error)
OpenRaw возвращает Reader, который предоставляет доступ к содержимому File без декомпрессии.
тип FileHeader
FileHeader описывает файл в файле ZIP. Подробности см. в спецификации ZIP.
type FileHeader struct {
// Name is the name of the file.
//
// It must be a relative path, not start with a drive letter (such as "C:"),
// and must use forward slashes instead of back slashes. A trailing slash
// indicates that this file is a directory and should have no data.
Name string
// Comment is any arbitrary user-defined string shorter than 64KiB.
Comment string
// NonUTF8 indicates that Name and Comment are not encoded in UTF-8.
//
// By specification, the only other encoding permitted should be CP-437,
// but historically many ZIP readers interpret Name and Comment as whatever
// the system's local character encoding happens to be.
//
// This flag should only be set if the user intends to encode a non-portable
// ZIP file for a specific localized region. Otherwise, the Writer
// automatically sets the ZIP format's UTF-8 flag for valid UTF-8 strings.
NonUTF8 bool // Go 1.10
CreatorVersion uint16
ReaderVersion uint16
Flags uint16
// Method is the compression method. If zero, Store is used.
Method uint16
// Modified is the modified time of the file.
//
// When reading, an extended timestamp is preferred over the legacy MS-DOS
// date field, and the offset between the times is used as the timezone.
// If only the MS-DOS date is present, the timezone is assumed to be UTC.
//
// When writing, an extended timestamp (which is timezone-agnostic) is
// always emitted. The legacy MS-DOS date field is encoded according to the
// location of the Modified time.
Modified time.Time // Go 1.10
// ModifiedTime is an MS-DOS-encoded time.
//
// Deprecated: Use Modified instead.
ModifiedTime uint16
// ModifiedDate is an MS-DOS-encoded date.
//
// Deprecated: Use Modified instead.
ModifiedDate uint16
// CRC32 is the CRC32 checksum of the file content.
CRC32 uint32
// CompressedSize is the compressed size of the file in bytes.
// If either the uncompressed or compressed size of the file
// does not fit in 32 bits, CompressedSize is set to ^uint32(0).
//
// Deprecated: Use CompressedSize64 instead.
CompressedSize uint32
// UncompressedSize is the uncompressed size of the file in bytes.
// If either the uncompressed or compressed size of the file
// does not fit in 32 bits, UncompressedSize is set to ^uint32(0).
//
// Deprecated: Use UncompressedSize64 instead.
UncompressedSize uint32
// CompressedSize64 is the compressed size of the file in bytes.
CompressedSize64 uint64 // Go 1.1
// UncompressedSize64 is the uncompressed size of the file in bytes.
UncompressedSize64 uint64 // Go 1.1
Extra []byte
ExternalAttrs uint32 // Meaning depends on CreatorVersion
}
func FileInfoHeader
func FileInfoHeader(fi fs.FileInfo) (*FileHeader, error)
FileInfoHeader создает частично заполненный FileHeader из fs.FileInfo. Поскольку метод Name fs.FileInfo возвращает только имя файла, который он описывает, может потребоваться изменить поле Name возвращаемого заголовка, чтобы предоставить полное имя файла. Если требуется сжатие, вызывающим функциям следует установить поле FileHeader.Method; оно не установлено по умолчанию.
func (*FileHeader) FileInfo
func (h *FileHeader) FileInfo() fs.FileInfo
FileInfo возвращает fs.FileInfo для FileHeader.
func (*FileHeader) ModTime
func (h *FileHeader) ModTime() time.Time
ModTime возвращает время изменения в UTC с использованием устаревших полей [ModifiedDate] и [ModifiedTime].
Устарело: Используйте [Modified] вместо этого.
func (*FileHeader) Mode
func (h *FileHeader) Mode() (mode fs.FileMode)
Mode возвращает биты разрешений и режима для FileHeader.
func (*FileHeader) SetModTime
func (h *FileHeader) SetModTime(t time.Time)
SetModTime устанавливает поля [Modified], [ModifiedTime] и [ModifiedDate] для заданного времени в UTC.
Устарело: Используйте [Modified] вместо этого.
func (*FileHeader) SetMode
func (h *FileHeader) SetMode(mode fs.FileMode)
SetMode изменяет биты разрешений и режима для FileHeader.
тип ReadCloser
ReadCloser — это Reader, который должен быть закрыт, когда больше не нужен.
type ReadCloser struct {
Reader
// contains filtered or unexported fields
}
func OpenReader
func OpenReader(name string) (*ReadCloser, error)
OpenReader откроет указанный файл zip по имени и вернет ReadCloser.
Если какой-либо файл внутри архива использует нелокальное имя (как определено в filepath.IsLocal) или имя, содержащее обратные слэши, и переменная среды GODEBUG содержит `zipinsecurepath=0`, OpenReader возвращает reader с ошибкой ErrInsecurePath. В будущей версии Go это поведение может быть введено по умолчанию. Программы, которые хотят принимать нелокальные имена, могут игнорировать ошибку ErrInsecurePath и использовать возвращаемый reader.
func (*ReadCloser) Close
func (rc *ReadCloser) Close() error
Close закрывает файл zip, делая его непригодным для операций ввода-вывода.
тип Reader
Reader обслуживает содержимое из архива ZIP.
type Reader struct {
File []*File
Comment string
// contains filtered or unexported fields
}
Пример
Код:
// Open a zip archive for reading.
r, err := zip.OpenReader("testdata/readme.zip")
if err != nil {
log.Fatal(err)
}
defer r.Close()
// Iterate through the files in the archive,
// printing some of their contents.
for _, f := range r.File {
fmt.Printf("Contents of %s:\n", f.Name)
rc, err := f.Open()
if err != nil {
log.Fatal(err)
}
_, err = io.CopyN(os.Stdout, rc, 68)
if err != nil {
log.Fatal(err)
}
rc.Close()
fmt.Println()
}
Вывод:
Contents of README: This is the source code repository for the Go programming language.
func NewReader
func NewReader(r io.ReaderAt, size int64) (*Reader, error)
NewReader возвращает новый Reader, читающий из r, который предполагается иметь указанный размер в байтах.
Если какой-либо файл внутри архива использует нелокальное имя (как определено в filepath.IsLocal) или имя, содержащее обратные слэши, и переменная среды GODEBUG содержит `zipinsecurepath=0`, NewReader возвращает reader с ошибкой ErrInsecurePath. В будущей версии Go это поведение может быть введено по умолчанию. Программы, которые хотят принимать нелокальные имена, могут игнорировать ошибку ErrInsecurePath и использовать возвращаемый reader.
func (*Reader) Open 1.16
func (r *Reader) Open(name string) (fs.File, error)
Open открывает указанный файл в архиве ZIP, используя семантику fs.FS.Open: пути всегда разделены слешами, без ведущих / или ../ элементов.
func (*Reader) RegisterDecompressor 1.6
func (r *Reader) RegisterDecompressor(method uint16, dcomp Decompressor)
RegisterDecompressor регистрирует или перезаписывает пользовательский декомпрессор для определенного идентификатора метода. Если декомпрессор для данного метода не найден, Reader по умолчанию будет искать декомпрессор на уровне пакета.
тип Writer
Writer реализует запись файла zip.
type Writer struct {
// contains filtered or unexported fields
}
Пример
Код:
// Create a buffer to write our archive to.
buf := new(bytes.Buffer)
// Create a new zip archive.
w := zip.NewWriter(buf)
// Add some files to the archive.
var files = []struct {
Name, Body string
}{
{"readme.txt", "This archive contains some text files."},
{"gopher.txt", "Gopher names:\nGeorge\nGeoffrey\nGonzo"},
{"todo.txt", "Get animal handling licence.\nWrite more examples."},
}
for _, file := range files {
f, err := w.Create(file.Name)
if err != nil {
log.Fatal(err)
}
_, err = f.Write([]byte(file.Body))
if err != nil {
log.Fatal(err)
}
}
// Make sure to check the error on Close.
err := w.Close()
if err != nil {
log.Fatal(err)
}
func NewWriter
func NewWriter(w io.Writer) *Writer
NewWriter возвращает новый Writer, записывающий файл zip в w.
func (*Writer) AddFS 1.22
func (w *Writer) AddFS(fsys fs.FS) errorEND_OF_DOCUMENT_MARKER
AddFS добавляет файлы из fs.FS в архив. Он обходит дерево каталогов, начиная с корня файловой системы, добавляя каждый файл в zip с использованием сжатия deflate, сохраняя структуру каталогов.
func (*Writer) Close
func (w *Writer) Close() error
Close завершает запись zip-файла, записав центральный каталог. Он не закрывает подлежащий записывающий объект.
func (*Writer) Copy 1.17
func (w *Writer) Copy(f *File) error
Copy копирует файл f (полученный из Reader) в w. Он копирует исходную форму непосредственно, минуя разархивирование, сжатие и проверку.
func (*Writer) Create
func (w *Writer) Create(name string) (io.Writer, error)
Create добавляет файл в zip-файл с указанным именем. Он возвращает Writer, в который следует записать содержимое файла. Содержимое файла будет сжато с помощью метода Deflate. Имя должно быть относительным путем: оно не должно начинаться с буквы диска (например, C:) или ведущей косой чертой, и разрешены только прямые косые черты. Чтобы создать каталог вместо файла, добавьте косую черту в конце имени. Повторные имена не перезапишут предыдущие записи и будут добавлены в zip-файл. Содержимое файла должно быть записано в io.Writer перед следующим вызовом Writer.Create, Writer.CreateHeader или Writer.Close.
func (*Writer) CreateHeader
func (w *Writer) CreateHeader(fh *FileHeader) (io.Writer, error)
CreateHeader добавляет файл в zip-архив, используя предоставленный FileHeader для метаданных файла. Writer берет на себя владение fh и может изменить его поля. Вызывающий метод не должен изменять fh после вызова Writer.CreateHeader.
Это возвращает Writer, в который следует записать содержимое файла. Содержимое файла должно быть записано в io.Writer перед следующим вызовом Writer.Create, Writer.CreateHeader, Writer.CreateRaw или Writer.Close.
func (*Writer) CreateRaw 1.17
func (w *Writer) CreateRaw(fh *FileHeader) (io.Writer, error)
CreateRaw добавляет файл в zip-архив, используя предоставленный FileHeader, и возвращает Writer, в который следует записать содержимое файла. Содержимое файла должно быть записано в io.Writer перед следующим вызовом Writer.Create, Writer.CreateHeader, Writer.CreateRaw или Writer.Close.
В отличие от Writer.CreateHeader, байты, передаваемые в Writer, не сжимаются.
Аргумент CreateRaw хранится в w. Если аргумент является указателем на встроенный FileHeader в File, полученном из Reader, созданного из данных в памяти, то w будет ссылаться на весь этот объём памяти.
func (*Writer) Flush 1.4
func (w *Writer) Flush() error
Flush сбрасывает все буферизованные данные в подлежащий записывающий объект. Обычно вызов Flush не требуется; достаточно вызова Close.
func (*Writer) RegisterCompressor 1.6
func (w *Writer) RegisterCompressor(method uint16, comp Compressor)
RegisterCompressor регистрирует или переопределяет пользовательский сжимающий модуль для определенного идентификатора метода. Если сжимающий модуль для данного метода не найден, Writer по умолчанию будет искать сжимающий модуль на уровне пакета.
Пример
Код:
// Override the default Deflate compressor with a higher compression level.
// Create a buffer to write our archive to.
buf := new(bytes.Buffer)
// Create a new zip archive.
w := zip.NewWriter(buf)
// Register a custom Deflate compressor.
w.RegisterCompressor(zip.Deflate, func(out io.Writer) (io.WriteCloser, error) {
return flate.NewWriter(out, flate.BestCompression)
})
// Proceed to add files to w.
func (*Writer) SetComment 1.10
func (w *Writer) SetComment(comment string) error
SetComment устанавливает поле комментария конца центрального каталога. Его можно вызвать только перед Writer.Close.
func (*Writer) SetOffset 1.5
func (w *Writer) SetOffset(n int64)
SetOffset устанавливает смещение начала zip-данных внутри подлежащего записывающего объекта. Следует использовать при добавлении zip-данных к существующему файлу, например, бинарному исполняемому файлу. Его необходимо вызвать перед записью любых данных.
© Google, Inc.
Licensed under the Creative Commons Attribution License 3.0.
http://golang.org/pkg/archive/zip/
