Golang项目代码组织的一些总结

import

  • import的是目录,import时会从GOROOT中搜索包(标准包)或从GOPATH/src下搜索包,如果GOPATH有多个,则从第一个开始,直到找到包。import也可以不依赖GOPATH,使用相对路径引入,相对于main包的路径。
  • package包名是调用包的时候使用,一般建议package包名与包所在的目录保持一致。

go get

  • go get 会下载包的代码包并编译包(.a文件)
  • 如果GOPATH有多个,go get 会将代码下载到第一个GOPATH的src目录,包编译到pkg目录

go instal与go build

  • go install 编译并安装包(包括main包),包名为包所在目录,main包(主程序)会安装到bin目录,其它包会安装到pkg目录。
  • go build 只能编译main包,包名默认为包所在目录,可通过-o参数指定包名。
  • 如果GOPATH中有同名的包,只会在GOPATH中的第一个能go install成功,其它的失败,报错:
    no install location for $GOPATH/go_2/src/myp: hidden by $GOPATH/go_1/src/myp

GOPATH

  • 允许设置多个路径,和各个系统环境多路径设置一样,windows用“;”,linux(macOS)用“:”分隔。
  • 如果你无需导入外部包且使用相对路径导入自己的代码,代码不一定非要放在GOPATH里,但不推荐这样做.
  • GOPATH的bin、pkg目录会自动创建,src目录放置源代码,也可不创建src,但需import的包能在GOPATH中找到,且go install时会报错:
    go install: no install location for directory GOPATH/m3 outside GOPATH
  • 从Go 1.8开始,将GOPATH设置为环境变量不是必需的。如果没有设置或设置为空,Go使用默认的GOPATH为 $HOME/go。

GOBIN

  • go install main包存放的路径,设置多个时,会被当成一个完整的路径(列如:/home/bin1:/home/bin2 被视为一个路径,也就是不请允许设置多个路径)。设置为空时,放在各自GOPATH目录的bin文件夹中(前提是:main包的代码文件不能直接放在GOPATH/src目录下)。
  • GOBIN为空,且main包的代码文件在GOPATH/src目录下时,go install时报错:
    go install: no install location for .go files listed on command line (GOBIN not set)
    go install: no install location for directory $GOPATH/src outside GOPATH For more details see: 'go help gopath'
  • 解决方法:1、设置GOBIN,编译后包名为src。2、将main包代码放在一个目录下,编译后包名为目录名。
  • GOBIN没有设置时,使用GOPATH/src/bin,有设置时使用设置。

Go Modules

  • Go modules 是 Go 语言的依赖解决方案,发布于 Go1.11,成长于 Go1.12,丰富于 Go1.13,正式于 Go1.14 推荐在生产上使用。
  • 相关命令
命令 作用
go mod init 生成 go.mod 文件
go mod download 下载 go.mod 文件中指明的所有依赖
go mod tidy 整理现有的依赖
go mod graph 查看现有的依赖结构
go mod edit 编辑 go.mod 文件
go mod vendor 导出项目所有的依赖到vendor目录
go mod verify 校验一个模块是否被篡改过
go mod why 查看为什么需要依赖某模块
  • 相关环境变量
变量 作用
GO111MODULE auto:项目包含了 go.mod 文件的话启用 Go modules。on:启用 Go modules,推荐设置,将会是未来版本中的默认值。off:禁用 Go modules,不推荐设置。
GOPROXY 设置 Go 模块代理,go env -w GOPROXY=https://goproxy.cn,direct
GONOPROXY/GONOSUMDB/GOPRIVATE 当前项目依赖了私有模块,比如私有 git 仓库,或是 github 中的私有库时,需要设置
  • go.mod文件结构
配置 作用
module 用于定义当前项目的模块路径。
go 用于标识当前模块的 Go 语言版本,值为初始化模块时的版本,目前来看还只是个标识作用。
require 用于设置一个特定的模块版本。
exclude 用于从使用中排除一个特定的模块版本。
replace 用于将一个模块版本替换为另外一个模块版本。
  • go module导入本地包的方法
    在一个项目下,直接导入。
    在不同的项目下,使用replace,并使用相对路径寻找包:
    require "p1" v0.0.0 (可省略)
    replace "p1" => "../p1"

参考:
Go Modules 终极入门

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,864评论 6 494
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,175评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,401评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,170评论 1 286
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,276评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,364评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,401评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,179评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,604评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,902评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,070评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,751评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,380评论 3 319
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,077评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,312评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,924评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,957评论 2 351

推荐阅读更多精彩内容