Go常用命令之go mod

Go mod

Go mod 的三种开启模式

  • GO111MODULE
    • on:支持Go mod模式
    • off:不支持Go mod模式
    • auto (默认模式):如果代码在gopath下,则自动使用gopath模式;如果代码不在gopath下,则自动使用GO mod模式。
  • 开启方式:
    • Windows中,在环境变量中添加变量即可,变量名为 GO111MODULE ,变量值可设置为 on、off、auto。
    • Linux中,只要在 /etc/profile 中添加 export GO111MODULE=on 或 export GO111MODULE=off 或 export GO111MODULE=auto。然后执行 source /etc/profile 刷新即可。

范式

go mod <command> [arguments]

command命令

download

范式: go download [-x] [-json] [modules]

作用:下载指定名字的模块,可为选择主模块依赖的模块匹配模式,或path@version形式的模块查询。如果download不带参数则代表英语与是主模块的所有依赖。

go命令将在常规执行(编译、调试等等)期间根据需要自动下载模块。go mod download的作用主要是预填充本地缓存或者计算Go模块代理的结果。

默认情况下go mod download 不向标准输出写入内容(可能会打印进度信息和错误日志)。

标志:

  • -json:打印一系列JSON对象至标准输出,描述每个下载的模块。
  • -x:打印实际需要执行的命令,并运行。

edit

范式:go mod edit [editing flags] [go.mod]

作用:edit提供一个编辑go.mod的命令行接口,主要提供给工具或脚本使用。它只读取go.mod;不查找涉及模块的信息。默认情况下,edit读写主模块的go.mod文件,但也可以在标志后指定不同的目标文件。

标志:

  • -dropexclude=path@version:删除给定模块路径和版本的排除项。

  • -dropreplace=old[@v]:删除给定模块路径和版本的替代。如果@v省略,删除该模块不带版本的替代。

  • -droprequire=path:删除给定的模块路径依赖要求的模块。该标志主要提供给工具用以理解模块图。用户应该使用“go get path@none”,可令其它go.mod根据需要调整来满足其它模块施加的限制。

  • -exclude=path@version:添加给定模块路径和版本的排除项。注意如果排除项已经存在-exclude=path@version是无操作的。

  • -fmt:重新格式化go.mod文件,不作其他改变。使用或重写go.mod文件的任何其他修改也意味着这种重新格式化。需要该标志的唯一情形是没有指定其它标志,如“go mod edit -fmt”。

  • -go=version:设置期望的Go语言版本。

  • -json:以JSON格式打印最终的go.mod,而不是将其写回go.mod。JSON输出对应于这些Go类型:

    type Module struct {
      Path string
      Version string
    }
    
    type GoMod struct {
      Module  Module
      Go      string
      Require []Require
      Exclude []Module
      Replace []Replace
    }
    
    type Require struct {
      Path string
      Version string
      Indirect bool
    }
    
    type Replace struct {
      Old Module
      New Module
    }
    
  • -module:修改模块路径(go.mod文件的模块行)。

  • -print:以其文本格式打印最终的go.mod,而不是将其写回go.mod。

  • -replace=old[@v]=new[@v]:添加给定模块路径和版本对的替代。如果old@v中的@v省略,则左侧不带版本的替代将被添加,应用于old模块路径的所有版本。如果new@v中的@v省略,新路径应为本地模块根目录,而不是模块路径。注意-replace覆盖old[@v]任何冗余的替代,因此省略@v将删除对特定版本的现有替代。

  • -require=path@version:添加给定的模块路径和版本依赖要求的模块。注意-require覆盖该路径任何已存在的依赖要求的模块。该标志主要提供给工具用以理解模块图。用户应该使用“go get path@version”,其可令其它go.mod根据需要调整来满足其它模块施加的限制。

-require-droprequire-exclude-dropexclude-replace-dropreplace标志可以重复,根据给定的顺序应用修改。

注意这只描述go.mod文件自身,不描述其他间接引用的模块。对于构建可使用的的模块的完整集合,使用“go list -m -json all”。

例如,工具可以通过解析“go mod edit -json”的输出以数据结构体的方式获取go.mod,然后可通过使用-require-exclude等调用“go mod edit”来作出修改,等等。

graph

范式:go mod graph

作用:以文本形式打印模块间的依赖关系图。输出的每一行行有两个字段(通过空格分割);模块和其所有依赖中的一个。每个模块都被标记为path@version形式的字符串(除了主模块,因其没有@version后缀)。

init

范式: go mod init [module]

作用:初始化并写入一个新的go.mod至当前目录中,实际上是创建一个以当前目录为根的新模块。文件go.mod必须不存在。如果可能,init会从import注释(参阅“go help importpath”)或从版本控制配置猜测模块路径。要覆盖此猜测,提供模块路径作为参数 module为当前项目名

tidy

范式:go mod tidy [-v]

作用:确保go.mod与模块中的源代码一致。它添加构建当前模块的包和依赖所必须的任何缺少的模块,删除不提供任何有价值的包的未使用的模块。它也会添加任何缺少的条目至go.mod并删除任何不需要的条目。

标志

  • -v:打印被删除的模块的信息至标准错误输出。

vendor

范式:go mod vendor [-v]

作用:重置主模块的vendor目录,使其包含构建和测试所有主模块的包所需要的所有包。不包括vendor中的包的测试代码。

标志:

  • -v:打印vendor的模块和包的名字至标准错误输出。

verify

范式:go mod verify

作用:检查存储在本地下载源代码缓存中的当前模块的依赖,是否自从下载之后未被修改。如果所有模块都未被修改,打印“all modules verified”。否则,报告哪个模块已经被修改并令“go mod”以非0状态退出。

why

范式:go mod why [-m] [-vendor] packages...

作用:输出每个包或者模块的引用块,每个块以注释行“# package”或“# module”开头,给出目标包或模块。随后的行通过导入图给出路径,一个包一行。每个块之间通过一个空行分割,如果包或模块没有被主模块引用,该小节将显示单独一个带圆括号的提示信息来表明该事实。

标志:

  • -m:默认情况下,why在导入图中展示从主模块到每个列出的包的最短路径。如果给出-m标志,why将参数视为一个模块的列表并找出每个模块中的所有包的路径。
  • -vendor:默认情况下,why查询与“go list all”匹配的包图,包括对可达包的测试相关的包。-vendor标志令why将依赖包的测试相关的包排除在外。

go.mod文件

​ 模块版本是由源文件树定义的,在其根目录中有一个go.mod文件。当go命令运行时,它查找当前目录然后查找相继的父目录来找出go.mod,go.mod标记主模块的根。

go.mod文件自身是面向行的,带有//注释但没有/**/注释。每行包含单个指令,有一个动词后跟参数组成。

动词类型:

  • module:定义模块路径。
  • go:设置期望的语言版本。
  • require:依赖要求一个给定版本或者之后的特定模块。
  • exclude:从使用中排除特定模块版本。
  • replace:以一个不同的,模块版呢嘛提到另一个模块版本。

exclude和replace只应用在主模块的go.mod中,并且在依赖中会被忽略。

常见错误汇总

go: modules disabled inside GOPATH/src by GO111MODULE=auto; see 'go help modules'

go mod init

go: modules disabled inside GOPATH/src by GO111MODULE=auto; see 'go help modules'

开启go module:

  1. set GO111MODULE=on //windows
  2. export GO111MODULE=on //linux

$GOPATH/go.mod exists but should not

GO 1.11或之后模块遇到这个问题:

$GOPATH/go.mod exists but should not

开启模块支持后(set GO111MODULE=on),并不能与GOPATH共存,所以把GOPATH从env中移出即可(unset GOPATH),可运行“unset GOPATH && make”

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 143,201评论 1 300
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 61,387评论 1 257
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 94,683评论 0 213
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 41,080评论 0 179
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 48,865评论 1 255
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 38,810评论 1 177
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 30,440评论 2 271
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,200评论 0 167
  • 想象着我的养父在大火中拼命挣扎,窒息,最后皮肤化为焦炭。我心中就已经是抑制不住地欢快,这就叫做以其人之道,还治其人...
    爱写小说的胖达阅读 29,019评论 6 231
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 32,540评论 0 213
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,337评论 2 215
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 30,658评论 1 231
  • 白月光回国,霸总把我这个替身辞退。还一脸阴沉的警告我。[不要出现在思思面前, 不然我有一百种方法让你生不如死。]我...
    爱写小说的胖达阅读 24,255评论 0 32
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,145评论 2 214
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 31,535评论 3 206
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,626评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,028评论 0 166
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 33,555评论 2 230
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 33,652评论 2 231

推荐阅读更多精彩内容