包的使用和管理

2019-04-07

6分钟阅读时长

开发技术 , 编程语言 , Golang

Golang包的使用和管理

Go语言是一门由Google开发的静态编译型编程语言，它因为其简洁、高效、安全和并发等特性而备受开发者们的喜爱。在Go语言中，与其他语言类似，包（package）是一个重要的概念。本文将主要介绍Golang包的使用和管理。

包的基础知识

包的定义

包（package）是一种代码组织方式，它能够将一些相关的代码文件放在一起，同时提供了对外的接口，方便别人使用。每个Go源码文件都必须属于一个包，而包名就是该文件所在目录的名称。例如，如果一个文件的路径为/path/to/my/package/foo.go，那么它就应该以package mypackage开始。

包的导入

在Go语言中，通过import关键字来导入其他包中的代码。在导入时，可以给包设置别名，也可以只导入包中的某些函数或变量。例如：

import (
    "fmt"                  // 导入整个包
    m "mypackage"          // 给包取别名
    . "anotherpackage"     // 不需要使用包前缀
    "github.com/user/repo" // 导入远程包
)

func main() {
    fmt.Println("Hello, world!")
}

包的访问控制

在Go语言中，只有首字母大写的函数、变量和常量才能被外部包访问。这是因为Go语言使用了基于约定的公有/私有属性控制方式。

包的使用

包的文档

Go语言提供了一种自动生成代码文档的方式，即在代码文件中添加注释。这些注释可以通过godoc工具生成HTML格式的文档，并且可以通过web浏览器查看。例如：

// Package mypackage provides some useful functions.
package mypackage

// Func1 does something interesting.
func Func1() {
    // ...
}

// Func2 does something even more interesting.
func Func2() {
    // ...
}

如果要生成文档，只需要运行以下命令：

$ godoc -http=:6060

然后在浏览器中打开http://localhost:6060/pkg/mypackage/即可查看文档。

包的测试

Go语言内置了测试框架testing，可以方便地进行单元测试和基准测试。在每个包中，可以添加一个名为*_test.go的文件来编写相应的测试代码。例如：

func TestFunc1(t *testing.T) {
    if Func1() != expectedValue {
        t.Errorf("Func1() = %v; want %v", Func1(), expectedValue)
    }
}

func BenchmarkFunc1(b *testing.B) {
    for i := 0; i < b.N; i++ {
        Func1()
    }
}

要运行测试，只需要在包目录下执行go test命令即可。例如：

$ go test
ok      mypackage       0.032s

包的发布

为了让别人方便地使用我们的代码，我们可以将其打包并上传到一个公共代码库中。Go语言内置的工具go提供了一种简单的方式来完成这个过程。

首先，需要设置好环境变量GOPATH和GOBIN。GOPATH指定了所有Go项目所在的根目录，而GOBIN指定了所有可执行文件的输出路径。例如：

export GOPATH=$HOME/go
export GOBIN=$HOME/bin

然后，我们就可以使用go get命令从远程代码库（例如GitHub）中下载代码并安装它了。例如：

$ go get github.com/user/repo/...

这个命令会将repo中所有的包和依赖库都下载到本地，并将可执行文件保存在GOBIN目录下。

包的管理

第三方包

Go语言拥有一个强大的第三方包生态系统，我们可以使用它们来加快开发速度。一般情况下，第三方包的安装方法有两种：手动安装和使用包管理工具。

使用包管理工具的好处是可以自动下载并管理依赖，从而简化了依赖包的安装过程。目前比较流行的包管理工具有dep、go modules和vgo等。

dep

dep是一个基于vendor目录的依赖管理工具，它会将依赖库的源代码放在项目的vendor目录下。使用dep进行依赖管理的步骤如下：

初始化项目：
```
$ dep init
```
添加依赖：
```
$ dep ensure -add github.com/user/repo
```
更新依赖：
```
$ dep ensure -update
```
清理依赖：
```
$ dep prune
```

go modules

go modules是Go 1.11及其以上版本的标准依赖管理工具。它可以自动下载并管理依赖库，同时提供了版本管理和语义化版本支持。使用go modules进行依赖管理的步骤如下：

打开模块功能（Go 1.11及以上版本已默认启用）：
```
$ export GO111MODULE=on
```
初始化模块：
```
$ go mod init github.com/user/repo
```
添加依赖：
```
$ go get github.com/user/repo@v1.0.0
```
更新依赖：
```
$ go get -u github.com/user/repo
```
清理依赖：
```
$ go mod tidy
```

vgo

vgo是一个实验性质的依赖管理工具，它提供了类似于dep和go modules的依赖管理功能，但更加注重版本控制和兼容性。使用vgo进行依赖管理的步骤如下：

初始化项目：
```
$ vgo init
```
添加依赖：
```
$ vgo get github.com/user/repo
```
更新依赖：
```
$ vgo get -u github.com/user/repo
```
清理依赖：
```
$ vgo tidy
```

私有包

对于一些涉及企业内部或个人开发的代码，我们需要将包放到私有仓库中进行管理。目前常用的私有仓库有GitLab和GitHub Enterprise等。

使用私有仓库的方法也很简单。首先，在本地创建一个与私有仓库对应的目录，并将项目代码放入其中。然后，使用go mod init命令初始化模块，指定私有仓库地址和项目名称，例如：

$ go mod init gitlab.com/user/repo

在添加依赖时，可以使用私有仓库的地址进行安装，例如：

$ go get gitlab.com/user/repo/otherpkg

包的版本控制

包的版本是一个非常重要的概念，它可以保证代码的兼容性和稳定性。在Go语言中，版本控制通常使用语义化版本控制（Semantic Versioning，SemVer）规范。这个规范定义了三个数字表示版本号，分别为主版本号、次版本号和修订号。其中：

主版本号：当你做了不兼容的 API 修改，
次版本号：当你做了向下兼容的功能性新增，
修订号：当你做了向下兼容的问题修正。

例如，一个版本号为1.2.3的包表示它是主版本号为1，次版本号为2，修订号为3的版本。

在Go语言中，我们可以使用标签（tag）来指定包的版本。在项目根目录下，运行以下命令即可打印当前包的版本信息：

$ git describe --tags

如果要添加新的标签，可以使用以下命令：

$ git tag -a v1.2.3 -m "Release version 1.2.3"

这个命令会给当前代码打上一个名为v1.2.3的标签，并添加一条注释。

包的安全性

在使用第三方包时，需要注意其安全性。一些不良开发者可能会在包中插入恶意代码，从而导致系统受到攻击。因此，我们需要对依赖包进行检查，以确保其来源可靠。

目前，Go语言社区已经开发了一些工具来帮助我们进行包的安全性检查。其中，比较流行的工具有GoSec和Gosecure等。

GoSec

GoSec是一个静态代码分析工具，可以检查Go代码中的安全漏洞。它支持多种规则，包括常见的注入攻击、命令注入、跨站点脚本（XSS）等。

使用GoSec的步骤如下：

安装GoSec：

$ go get github.com/securego/gosec/cmd/gosec

运行GoSec：
```
$ gosec ./...
```
这个命令会在当前目录及其子目录中搜索Go源代码，并对其进行扫描。

Gosecure

Gosecure是一款扫描工具，可以检查Go模块中的依赖关系并查找安全漏洞。它支持多种漏洞类型，包括SQL注入、XSS、CSRF等。

使用Gosecure的步骤如下：

安装Gosecure：

$ go get -u github.com/securego/gosecure

运行Gosecure：
```
$ gosecure check
```
这个命令会对所有依赖库进行扫描，并输出安全漏洞报告。

结论

包是Go语言中一个非常重要的概念，它可以方便地组织代码，并提供对外的接口。在使用和管理包时，我们需要注意其文档、测试、安全性和版本控制等方面。此外，私有包和第三方包的安装和管理方法也需要掌握。通过良好的包管理实践，我们可以更加高效地进行开发工作。