Go编程之相关命令工具记录

全栈工程师修炼指南

发布于 2022-09-29 17:13:03

5870

发布于 2022-09-29 17:13:03

文章被收录于专栏：全栈工程师修炼之路

[TOC]

0x00 Go工具命令

get 命令

该命令可以借助代码管理工具通过远程拉取或更新代码包及其依赖包，并自动完成编译和安装,整个过程类似安装App一样;

目前支持的动态获取远程代码包的有BitBucket、GitHub、Google Code 和 Launchpad,所以为了 go get 命令能正常工作您需要安装与远程包仓库匹配的代码管理工具，如 Git、SVN、HG 等，由于它自动根据不同的域名调用不同的源码工具，对应关系如下：

BitBucket (Mercurial Git)
GitHub (Git)
Google Code Project Hosting (Git, Mercurial, Subversion)
Launchpad (Bazaar)

该命令内部实际上分成了两步操作:

第一步是下载源码包假设远程包的路径格式github.com/golang/go

#比如github网站的项目包路径都有一个共同的标准
github.com - 网站域名：表示代码托管的网站，类似于电子邮件 @ 后面的服务器地址。
golang - 作者或机构: 表明这个项目的归属，一般为网站的用户名，如果需要找到这个作者下的所有项目，可以直接在网站上通过搜索“域名/作者”进行查看。( 似于电子邮件 @ 前面的部分。)
go - 项目名称 :每个网站下的作者或机构可能会同时拥有很多的项目，图中标示的部分表示项目名称。

第二步是执行 go instal

参数介绍：

$go get [options]
* -d 只下载不安装
* -f 只有在你包含了 -u 参数的时候才有效，不让 -u 去验证 import 中已经获取了的包(`对于本地 fork 的包特别有用`)
* -fix 在获取源码之后先运行 fix，然后再去做其他的事情
* -t 同时也下载需要为运行测试所需要的包
* -u 下载丢失的包，但不会更新已经存在的包
* -v 显示操作流程的日志及信息，方便检查错误
* -insecure	允许使用不安全的 HTTP 方式进行下载操作

test 命令

doc 命令

mod 命令 - 包依赖管理

描述: 为什么需要依赖管理?

答: 最早的时候Go所依赖的所有的第三方库都放在$GOPATH环境变量的这个目录下面, 导致了同一个库只能保存一个版本的代码，如果不同的项目依赖同一个第三方的库的不同版本，应该怎么解决？起初是采用vendor模式，而现在是采用module模式。

(1) Vendor 模式

从v1.5开始开始引入vendor模式，如果项目目录下有vendor目录，那么go工具链会优先使用vendor内的包进行编译、测试等。

其中godep是由vendor模式实现的Go语言的第三方依赖管理工具，它是在go module出现前广泛使用的方式，其类似的还有由社区维护准官方包管理工具dep。

Tips：vender 的机制能够控制Go语言程序编译时依赖包搜索路径的优先级, 例如: 查找项目的某个依赖包, 首先会在项目根目录下的vender文件夹中查找, 如果没有找到就会去$GOAPTH/src目录下查找。

简单安装使用：

# 安装godep工具
$ go get github.com/tools/godep

# 了解godep命令
> 在终端输入 `godep help` 查看支持的所有命令
godep save     将依赖项输出并复制到Godeps.json文件中
godep go       使用保存的依赖项运行go工具
godep get      下载并安装具有指定依赖项的包
godep path     打印依赖的GOPATH路径
godep restore  在GOPATH中拉取依赖的版本
godep update   更新选定的包或go版本
godep diff     显示当前和以前保存的依赖项集之间的差异
godep version  查看版本信息

# 使用godep操作
在项目目录下执行`godep save`命令，会在当前项目中创建`Godeps`和`vender`两个文件夹,
* Godeps文件夹: 下有一个Godeps.json的文件，里面记录了项目所依赖的包信息。
* vender文件夹: 下是项目依赖的包的源代码文件。

使用godep后的开发流程:

保证程序能够正常编译
执行godep save保存当前项目的所有第三方依赖的版本信息和代码
提交Godeps目录和vender目录到代码库。
如果要更新依赖的版本，可以直接修改Godeps.json文件中的对应项

(2) Module 模式

在Go1.11版本之后官方推出版本管理工具(go module)，并从Go1.13版本开始它是Go语言默认的依赖管理工具。

首先要启用go module支持就需要设置GO111MODULE环境变量,通过它可以开启或关闭模块支持，它有三个可选值：off、on、auto(默认值)。

# 1.禁用模块支持，编译时会从GOPATH和vendor文件夹中查找包。
export GO111MODULE=off

# 2.启用模块支持，编译时会忽略GOPATH和vendor文件夹，只根据go.mod下载依赖。
export GO111MODULE=on

# 3.当项目在`$GOPATH/src`外且项目根目录有go.mod文件时，开启模块支持。
export GO111MODULE=auto

简单来说,设置GO111MODULE=on之后就可以使用go module了,以后就没有必要在GOPATH中创建项目了，并且还能够很好的管理项目依赖的第三方包信息。

在 go.mod 文件记录了项目所有的依赖信息，其结构大致如下：

module github.com/Q1mi/studygo/blogger  // # 定义包名
go 1.12  // # 定义依赖包及版本
require (
  github.com/DeanThompson/ginpprof v0.0.0-20190408063150-3be636683586
  github.com/gin-gonic/gin v1.4.0
  github.com/go-sql-driver/mysql v1.4.1
  github.com/jmoiron/sqlx v1.2.0
  github.com/satori/go.uuid v1.2.0
  google.golang.org/appengine v1.6.1 // indirect # 表示间接引用
)

命令介绍:

# 启用 go module支持
$ export GO111MODULE=auto 

# 了解 go mod 命令
go mod download    # 下载依赖的module到本地cache（默认为$GOPATH/pkg/mod目录）
go mod edit        # 编辑go.mod文件
go mod graph       # 打印模块依赖图
go mod init        # 初始化当前文件夹, 创建go.mod文件
go mod tidy        # 增加缺少的module，删除无用的module
go mod vendor      # 将依赖复制到vendor下
go mod verify      # 校验依赖
go mod why         # 解释为什么需要依赖

# 使用 go module 管理依赖后会在项目根目录下生成两个文件go.mod和go.sum。
$ go mod init

依赖的版本go mod支持语义化版本号比如go get foo@v1.2.3，也可以跟git的分支或tag比如go get foo@master，当然也可以跟git提交哈希比如go get foo@e3702bed2，依赖的版本支持以下几种格式：

gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7
gopkg.in/vmihailenco/msgpack.v2 v2.9.1
gopkg.in/yaml.v2 <=v2.2.1
github.com/tatsushid/go-fastping v0.0.0-20160109021039-d7bb493dee3e
latest

我们可以在go.mod 文件中替换(replace)指定包的镜像源: 在国内访问golang.org/x的各个包都需要FQ, 此时你可以在go.mod中使用replace替换成github上对应的库。

replace (
  golang.org/x/crypto v0.0.0-20180820150726-614d502a4dac => github.com/golang/crypto v0.0.0-20180820150726-614d502a4dac
  golang.org/x/net v0.0.0-20180821023952-922f4815f713 => github.com/golang/net v0.0.0-20180826012351-8a410e7b638d
  golang.org/x/text v0.3.0 => github.com/golang/text v0.3.0
)

依赖下载 描述: 如果下载所有依赖可以使用go mod download命令, 当然如果是单个依赖下载便可采用go get命令。

例如: 在项目中执行go get命令可以下载依赖包，并且还可以指定下载的版本。

运行 go get -u 将会升级到最新的次要版本或者修订版本(x.y.z, z是修订版本号， y是次要版本号)
运行 go get -u=patch 将会升级到最新的修订版本
运行 go get package@version 将会升级到指定的版本号version

依赖整理 描述: 在代码中删除不使用的依赖代码后，相关的依赖库并不会在go.mod文件中自动移除,此种情况下我们可以使用go mod tidy命令更新go.mod中的依赖关系。

依赖编辑 描述: 在实际开发中我们可以使用下面两种方式进行依赖包的添加和删除。

手动修改 go.mod 文件后有些时候需要格式化该文件，此时使用go mod edit -fmt命令进行格式化go.mod文件
手动添加依赖项: 例如 go mod edit -require=golang.org/x/text
手动移除依赖项: 例如 go mod edit -droprequire=golang.org/x/text

Q: 如何在项目中使用go module?

答: 一般来说有两种情况第一种是既有项目,第二种是新项目。

如果需要对一个已经存在的项目启用go module可以按照以下步骤操作：

在项目目录下执行go mod init便会生成一个go.mod文件。
执行go get命令查找并记录当前项目的依赖，同时生成一个go.sum记录每个依赖库的版本和哈希值。

如果对一个新创建的项目，我们可以在项目文件夹下按照以下步骤操作：

执行go mod init 项目名命令，在当前项目文件夹下创建一个go.mod文件。
手动编辑go.mod文件中的require依赖项或执行go tidy自动发现、维护依赖。

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

原始发表：2020-04-25，如有侵权请联系 cloudcommunity@tencent.com 删除

http

编程算法

打包

本文分享自作者个人站点/博客前往查看

如有侵权，请联系 cloudcommunity@tencent.com 删除。

本文参与腾讯云自媒体同步曝光计划，欢迎热爱写作的你一起参与！

http

编程算法

打包

登录后参与评论

0 条评论

热度