Bootstrap

Go语言压缩文件处理

Go 语言压缩文件处理

在现代的应用开发中,处理压缩文件(如 .zip 格式)是常见的需求。Go 语言提供了内置的 archive/zip 包来处理 .zip 文件的读写,但有时我们需要封装一些常用操作,使得代码更加简洁、易用。本文将介绍如何使用 Go 语言封装一个 ziputil 包,来处理文件的压缩和解压操作。

1. 压缩文件:Zip函数

在 Go 语言中,压缩文件通常需要使用 archive/zip 包。我们将对文件夹或文件进行遍历,创建一个新的 .zip 文件,并将文件或文件夹逐个添加到压缩包中。

package ziputil

import (
	"archive/zip"
	"go-admin/app/brush/utils"
	"sync"
	"io"
	"os"
	"path/filepath"
	log "github.com/go-admin-team/go-admin-core/logger"
)

// Zip 将指定的文件夹或文件压缩为 .zip 文件
func Zip(source, zipFile string) error {
	// 创建一个新的 zip 文件
	zipFileWriter, err := os.Create(zipFile)
	if err != nil {
		return err
	}
	defer func(zipFileWriter *os.File) {
		err := zipFileWriter.Close()
		if err != nil {
			log.Errorf("关闭 zip 文件失败: %s", err)
		}
	}(zipFileWriter)

	// 创建 zip 写入器
	zipWriter := zip.NewWriter(zipFileWriter)
	defer func(zipWriter *zip.Writer) {
		err := zipWriter.Close()
		if err != nil {
			log.Errorf("关闭 zip 写入器失败: %s", err)
		}
	}(zipWriter)

	// 获取源文件的绝对路径
	absSource, err := filepath.Abs(source)
	if err != nil {
		return err
	}

	// 遍历文件夹并添加到 zip 文件中
	return filepath.Walk(absSource, func(path string, info os.FileInfo, err error) error {
		if err != nil {
			return err
		}

		// 计算文件相对路径
		relPath, err := filepath.Rel(absSource, path)
		if err != nil {
			return err
		}

		// 如果是目录,则在 zip 文件中创建一个目录项
		if info.IsDir() {
			if relPath != "." {
				_, err := zipWriter.Create(relPath + "/")
				if err != nil {
					return err
				}
			}
			return nil
		}

		// 否则将文件添加到 zip 文件
		return addFileToZip(zipWriter, path, relPath)
	})
}

// addFileToZip 将单个文件添加到 zip 写入器
func addFileToZip(zipWriter *zip.Writer, file string, relPath string) error {
	f, err := os.Open(file)
	if err != nil {
		return err
	}
	defer func(f *os.File) {
		err := f.Close()
		if err != nil {
			log.Errorf("关闭文件失败: %s", err)
		}
	}(f)

	// 在 zip 文件中创建该文件
	writer, err := zipWriter.Create(relPath)
	if err != nil {
		return err
	}

	// 将文件内容写入 zip
	_, err = io.Copy(writer, f)
	if err != nil {
		return err
	}

	return nil
}

2. 解压文件:UnZip 函数

解压 .zip 文件时,我们需要将 .zip 文件中的每个文件提取到指定的目录中。UnZip 函数不仅能够提取文件,还能够处理文件夹结构,保证提取后的目录结构不丢失。

// UnZip 解压 zip 文件到目标目录
func UnZip(zipFile, destDir string) error {
	log.Debugf("解压文件: %s 到 %s", zipFile, destDir)
	r, err := zip.OpenReader(zipFile)
	if err != nil {
		return err
	}

	defer func(r *zip.ReadCloser) {
		err := r.Close()
		if err != nil {
			log.Errorf("关闭 zip 文件失败: %s", err)
		}
	}(r)

	log.Debugf("总共 %d 个文件", len(r.File))

	// 并发解压每个文件
	wg := sync.WaitGroup{}
	for _, f := range r.File {
		wg.Add(1)
		go func(rf *zip.File, w *sync.WaitGroup) {
			defer w.Done()
			if err := unzipFile(rf, destDir); err != nil {
				log.Errorf("解压文件 [%s] 失败: %v", rf.Name, err)
			}
		}(f, &wg)
	}

	wg.Wait()

	return nil
}

// unzipFile 解压单个文件到目标目录
func unzipFile(f *zip.File, destDir string) error {
	// 将文件名转换为 UTF-8
	filename := utils.ConvertToUTF8([]byte(f.Name))
	filePath := filepath.Join(destDir, filename)

	// 创建文件夹
	if f.FileInfo().IsDir() {
		return os.MkdirAll(filePath, os.ModePerm)
	}

	// 创建文件的父目录
	if err := os.MkdirAll(filepath.Dir(filePath), os.ModePerm); err != nil {
		log.Errorf("创建目录 [%s] 失败: %v", filepath.Dir(filePath), err)
		return err
	}

	// 打开文件
	file, err := f.Open()
	if err != nil {
		log.Errorf("打开文件 [%s] 失败: %v", filePath, err)
		return err
	}

	defer func(file io.ReadCloser) {
		err := file.Close()
		if err != nil {
			log.Errorf("关闭文件 [%s] 失败: %v", filePath, err)
		}
	}(file)

	// 创建文件
	outFile, err := os.OpenFile(filePath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, f.Mode())
	if err != nil {
		log.Errorf("创建文件 [%s] 失败: %v", filePath, err)
		return err
	}

	defer func(outFile *os.File) {
		err := outFile.Close()
		if err != nil {
			log.Errorf("关闭文件 [%s] 失败: %v", filePath, err)
		}
	}(outFile)

	// 将文件内容写入
	_, err = io.Copy(outFile, file)
	if err != nil {
		log.Errorf("复制文件 [%s] 失败: %v", filePath, err)
		return err
	}

	return nil
}

3. 小结

通过 ziputil 包,我们可以方便地进行文件和文件夹的压缩和解压操作。该包使用了 Go 内置的 archive/zip 包来处理 .zip 文件,并通过 sync.WaitGroup 实现了解压过程的并发处理,提高了解压效率。对于较大的压缩文件或包含大量文件的压缩包,使用并发处理可以显著提升性能。

;