与其他语言一样,内置标准库默认支持文件压缩功能。本文介绍Golang如何创建压缩文件,增加一个或多个文件生成压缩文件。也可以在压缩文件中创建文件夹,用于对文件进行分类管理。Golang标准库
archive/zip
提供了创建和读取压缩文件功能。
首先需要创建归档文件,与其他普通文件一样。使用os
包的os.Create
函数:
func Create(name string) (*File, error)
该方法创建或删除给定名称文件。如果文件已存在则删除重新创建,如果不存在,创建文件,模式为0666。创建成功返回File用于读写,关联文件描述符为O_RDWR
,反之报错,类型为*PathError
。
使用 archive/zip 包 中的zip.NewWriter
函数,用于写数据(文件或目录)至最终的压缩文件。
语法如下:
func NewWriter(w io.Writer) *Writer
NewWriter 返回Writer写
上面已创建了zip.Writer,可以增加文件和目录至压缩文件,使用zip.Writer.Create函数:
func (w *Writer) Create(name string) (io.Writer, error)
方法通过文件名称增加文件至压缩文件,返回Writer用于写文件内容,文件内容将被压缩。文件名称必须为相对路径,不能以驱动器字母(C:)或斜杠开头,仅允许正斜杠。如果增加目录,需要在名称后面增加尾斜杠。在下一次调用Create, CreateHeader, 或 Close方法之前,文件内容必须被写入io.Writer.
zip.Writer.Create返回io.Writer,用于写数据,所以任何文件内容可以流入或写入该Writer,也可以使用io.Copy函数。
func Copy(dst Writer, src Reader) (written int64, err error)
Copy函数从src至dst,直达EOF或遇到错误。返回拷贝的字节数以及错误(如果有错误发生)。
所有文件和目录写入至压缩文件后,需要通过zip.Writer.Close方法关闭写生成压缩文件,即写所有数据至底层数据流。
func (w *Writer) Close() error
下面示例压缩两个文件(txt和csv文件)生成单个压缩文件。这两个文件分别在压缩文件的不同子目录中。
package main
import (
"archive/zip"
"fmt"
"io"
"os"
)
func main() {
fmt.Println("creating zip archive...")
archive, err := os.Create("archive.zip")
if err != nil {
panic(err)
}
defer archive.Close()
zipWriter := zip.NewWriter(archive)
fmt.Println("opening first file...")
f1, err := os.Open("test.csv")
if err != nil {
panic(err)
}
defer f1.Close()
fmt.Println("writing first file to archive...")
w1, err := zipWriter.Create("csv/test.csv")
if err != nil {
panic(err)
}
if _, err := io.Copy(w1, f1); err != nil {
panic(err)
}
fmt.Println("opening second file")
f2, err := os.Open("test.txt")
if err != nil {
panic(err)
}
defer f2.Close()
fmt.Println("writing second file to archive...")
w2, err := zipWriter.Create("txt/test.txt")
if err != nil {
panic(err)
}
if _, err := io.Copy(w2, f2); err != nil {
panic(err)
}
fmt.Println("closing zip archive...")
zipWriter.Close()
}
运行程序,生成日志:
creating zip archive...
opening first file...
writing first file to archive...
opening second file
writing second file to archive...
closing zip archive...
最后解压压缩文件,和我们期望的一致:
$ unzip -l archive.zip
Archive: archive.zip
Length Date Time Name
--------- ---------- ----- ----
50 1980-00-00 00:00 csv/test.csv
16 1980-00-00 00:00 txt/test.txt
--------- -------
66 2 files