Golang项目打包的最佳实践

Golang项目打包的最佳实践 在我的Go项目中获取新包的过程之一可以通过运行命令 go get *my-package* 来实现，该命令会将一个zip文件下载到我的本地缓存中。 有没有人知道如何自己创建相同的zip文件？或者是否有外部库可以帮助我像goproxy那样压缩我的项目文件？

1 回复

更多关于Golang项目打包的最佳实践的实战系列教程也可以访问 https://www.itying.com/category-94-b0.html


在Go项目中，你可以使用go mod vendor命令来创建vendor目录，但如果你需要生成与go get下载的相同格式的zip包，可以使用Go内置的archive/zip包。以下是一个示例代码，展示如何将当前项目目录打包成与go get兼容的zip文件：

package main

import (
    "archive/zip"
    "io"
    "os"
    "path/filepath"
    "strings"
)

func createModuleZip(modulePath, outputPath string) error {
    zipFile, err := os.Create(outputPath)
    if err != nil {
        return err
    }
    defer zipFile.Close()

    zipWriter := zip.NewWriter(zipFile)
    defer zipWriter.Close()

    baseDir := filepath.Base(modulePath)
    
    err = filepath.Walk(modulePath, func(path string, info os.FileInfo, err error) error {
        if err != nil {
            return err
        }

        // 跳过.git目录和zip文件本身
        if info.IsDir() && (info.Name() == ".git" || strings.HasSuffix(info.Name(), ".zip")) {
            return filepath.SkipDir
        }

        // 跳过非Go模块文件
        if !info.IsDir() && !isGoModuleFile(path) {
            return nil
        }

        relPath, err := filepath.Rel(modulePath, path)
        if err != nil {
            return err
        }

        // 创建zip中的路径，格式为module@version/...
        zipPath := filepath.Join(baseDir, relPath)
        
        if info.IsDir() {
            zipPath += "/"
            _, err := zipWriter.Create(zipPath)
            return err
        }

        // 创建文件头
        header, err := zip.FileInfoHeader(info)
        if err != nil {
            return err
        }
        header.Name = zipPath
        header.Method = zip.Deflate

        writer, err := zipWriter.CreateHeader(header)
        if err != nil {
            return err
        }

        if !info.Mode().IsRegular() {
            return nil
        }

        file, err := os.Open(path)
        if err != nil {
            return err
        }
        defer file.Close()

        _, err = io.Copy(writer, file)
        return err
    })

    return err
}

func isGoModuleFile(path string) bool {
    ext := filepath.Ext(path)
    return ext == ".go" || 
           ext == ".mod" || 
           ext == ".sum" ||
           filepath.Base(path) == "go.mod" ||
           filepath.Base(path) == "go.sum"
}

func main() {
    // 示例：打包当前目录到module.zip
    err := createModuleZip(".", "module.zip")
    if err != nil {
        panic(err)
    }
}

对于更接近Go代理服务器行为的打包，可以使用golang.org/x/mod包中的功能：

package main

import (
    "fmt"
    "golang.org/x/mod/modfile"
    "golang.org/x/mod/module"
    "golang.org/x/mod/zip"
)

func createGoProxyZip(modulePath, version, outputPath string) error {
    // 解析go.mod文件获取模块路径
    goModPath := filepath.Join(modulePath, "go.mod")
    data, err := os.ReadFile(goModPath)
    if err != nil {
        return err
    }

    modPath := modfile.ModulePath(data)
    if modPath == "" {
        return fmt.Errorf("invalid go.mod file")
    }

    // 创建模块版本
    m := module.Version{
        Path:    modPath,
        Version: version,
    }

    // 使用golang.org/x/mod/zip创建标准格式的zip
    err = zip.CreateFromDir(outputPath, m, modulePath, zip.OmitSubmodules)
    return err
}

func main() {
    err := createGoProxyZip(".", "v1.0.0", "mymodule.zip")
    if err != nil {
        panic(err)
    }
}

golang.org/x/mod/zip包实现了Go模块zip格式的规范，生成的zip文件与Go代理服务器和go get命令使用的格式完全兼容。

回到顶部