如何从0开始配置一个GO项目
比如一个项目为:git@github.com:fatedier/frp.git
下载源码:
- 推荐直接使用
go get github.com/fatedier/frp
下载源代码安装,执行命令后代码将会拷贝到$GOPATH/src/github.com/fatedier/frp
目录下。 - 可以使用
git clone https://github.com/fatedier/frp.git $GOPATH/src/github.com/fatedier/frp
拷贝到相应目录下。
编译
进入下载后的源码根目录,执行 make
命令,等待编译完成。
编译完成后, bin 目录下是编译好的可执行文件,conf 目录下是示例配置文件。
依赖管理
godep不用了 1.13之后只用go mod。所有的项目都迁移到go mod管理
迁移步骤:
1.在顶层目录输入:go mod init 会自动生成go.mod文件 如果是godep或者是vendor管理依赖的方式,go mod也会根据其相关文件生成合适的go mod文件
2.本地包也需要进入包所在目录进行go init 包名
3.在依赖本地包的目录的go.mod当中要replace本地包名到本地路径
Vscode:go 环境配置
command + `进入设置
搜索go 修改go的设置文件:settings.json
{ "terminal.integrated.fontFamily": "Meslo LG M for Powerline", "C_Cpp.updateChannel": "Insiders", "window.zoomLevel": 1, "go.useLanguageServer": true, "go.gopath":"/Users/zhuhaochuan/code/gopath", "go.goroot": "/usr/local/go", "http.proxySupport": "off", "explorer.confirmDelete": false, "go.coverOnSave": true }
关键点是gopath 和 gotoot
然后按照vscode的提示安装go插件
GOPROXY
Go1.11之后设置GOPROXY命令为:
export GOPROXY=https://goproxy.cn
Go1.13之后GOPROXY
默认值为https://proxy.golang.org
,在国内是无法访问的,所以十分建议大家设置GOPROXY,这里我推荐使用goproxy.cn。
go env -w GOPROXY=https://goproxy.cn
解决go get 缓慢或者无反应的问题
go mod
Golang使用go.mod配置加载本地模块:
- replace
加载远程依赖库:
- require
代码规范 codereview
https://github.com/golang/go/wiki/CodeReviewComments
注释
每个程序包都应该有一个包注释,一个位于package子句之前的块注释。对于有多个文件的程序包,包注释只需要出现在一个文件中,任何一个文件都可以。包注释应该用来介绍该程序包,并且提供与整个程序包相关的信息。
Go不提供对Get方法和Set方法的自动支持。你自己提供Get方法和Set方法是没有错的,通常这么做是合适的。但是,在Get方法的名字中加上Get
,是不符合语言习惯的,并且也没有必要。如果你有一个域叫做owner
(小写,不被导出),则Get方法应该叫做Owner
(大写,被导出),而不是GetOwner
。对于要导出的,使用大写名字,提供了区别域和方法的钩子。Set方法,如果需要,则可以叫做SetOwner
。
错误日志输出最好都是小写 因为会和其他日志拼接
项目组织
项目下面需要有三个文件夹
- bin
- pkg
- src
所有的代码需要放在src下面
Vscode 打开src上层的目录即可