Gin项目的初始化步骤和常见错误记录

相信很多人对Go的环境安装和Gin项目的初始化都已经手拿把攥很是熟练了，本节介绍一个自己新建Go项目时非常好用的设置以及记录一下Gin项目的初始化过程和常能遇到的错误。

一个容易忽略的Go ENV

在安装了Go的电脑中，我们可以在命令行执行 go env 命令，查看当前的 go 环境变量：

GO111MODULE=""
GOARCH="amd64"

GOPATH="/usrs/local/go"
GOROOT="/usr/local/go"
....

接下来，我说一个容易忽略的Go环境变量，它就是 GOPATH 。

虽然有了 Go Modules 后，可以把Go 项目放在任何地方，但我还是习惯把它们统一放在一个专门的目录里，比如/Users/xxx/Code/Go 里，所以在这里执行下面的命令把 GOPATH 设置成 /Users/xxx/Code/Go

go env -w GOPATH="/Users/xxx/Code/Go"

这样做有一个好处，就是你在开发中使用 go get 安装的都会自动统一放到 $GOPATH/pkg 目录中，即与Go相关的所有资源包和项目都能收拢在 /Users/xxx/Code/Go 这个目录中，这样的话会让你自己的电脑的目录管理更整洁一些，不至于未来找东西都不知道去哪里找。

除了这里提到的收益外，这么安排目录和GOPATH在我们新建项目时也会更便捷，具体大家可以往下面接着看。

Gin项目的初始化

首先如果你跟着专栏学习，我推荐你在Github 上创建个项目跟着一步步做，复现专栏中的开发过程，这样学习效果会更好一些。

专栏订阅可以扫码或者复制链接在浏览器中打开：https://xiaobot.net/p/golang 进行阅读和订阅。‍‍‍

初始化项目

你可以像下图这样自己创建一个项目名叫go-mall的私有项目

在GitHub上创建好项目后，我们先在命令行终端中把当前目录切换到刚才约定的GOPATH目录中，如果此时你的GOPATH目录是个空目录，那么按照咱们上一部分目录结构与项目名的约定，你需要先创建下面这些目录

• src目录，未来Go项目源码都在此目录

  • src 下创建组织机构的目录，这里我们是在github上创建的项目，所以就在此创建一个github.com的目录。

  • 这里多说一句，一般公司里都有自己的Git站点，如果要存在你公司里的项目就先在这里一个code.xxxx.com之类的目录，这个目录名与项目的组织前缀保持一致。

• 切换到 src/githun.com 目录

  • 按照项目名称，创建一个go-study-lab的目录，这个用来存放专栏中我提供给大家让大家学习参考的项目

  • 如果你自己创建了新项目跟着做，这里记得创建一个你的Git用户名的目录 {$yourgitname}

• 拉取项目

  • cd /Users/xxx/CodeBase/Go/src/github.com/go-study-lab

  • git clone git@github.com:go-study-lab/go-mall.git

  • 拉取自己的Git项目请按照相同步骤切换到自己的 {$yourgitname} 目录后进行操作。

• 初始化Go 项目

go mod init，Go Module会自己检索目录结构，在go.mod中声明好项目的module名称

如果不是按照咱们上面这么安排的目录，比如就想把项目放在桌面，那初始化命令执行时需要指定好 module name

• go mod init github.com/go-study-lab/go-mall

注意以上步骤，包括在项目中安装Gin，都是在你自己的项目中操作的，咱们专栏提供的项目大家下载下来，打开就能用，不需要再重复上面的操作。

安装Gin

安装Gin，我们直接在命令行终端中切换到项目所在的目录然后使用go get 下载安装Gin

go get -u github.com/gin-gonic/gin

上面这样安装的是Gin的最新可用版本，如果你想安装指定版本，像下面这样添加版本参数

go get github.com/gin-gonic/gin@v1.7.0

安装完成后我们用 Gin 官网的例子，写个start程序，先测试一下安装效果。

package main
import (
 "net/http"
 "github.com/gin-gonic/gin"
)
func main() {
 r := gin.Default()
 r.GET("/ping", func(c *gin.Context) {
  c.JSON(http.StatusOK, gin.H{
   "message": "pong",
  })
 })
 r.Run() // listen and serve on 0.0.0.0:8080 (for windows "localhost:8080")
}

如果是在Mac上执行后有可能会报错

# golang.org/x/sys/unix
../../../../pkg/mod/golang.org/x/sys@v0.0.0-20200116001909-b77594299b42/unix/syscall_darwin.1_13.go:25:3: //go:linkname must refer to declared function or variable
../../../../pkg/mod/golang.org/x/sys@v0.0.0-20200116001909-b77594299b42/unix/zsyscall_darwin_amd64.1_13.go:27:3: //go:linkname must refer to declared function or variable
../../../../pkg/mod/golang.org/x/sys@v0.0.0-20200116001909-b77594299b42/unix/zsyscall_darwin_amd64.1_13.go:40:3: //go:linkname must refer to declared function or variable
../../../../pkg/mod/golang.org/x/sys@v0.0.0-20200116001909-b77594299b42/unix/zsyscall_darwin_amd64.go:28:3: //go:linkname must refer to declared function or variable
../../../../pkg/mod/golang.org/x/sys@v0.0.0-20200116001909-b77594299b42/unix/zsyscall_darwin_amd64.go:43:3: //go:linkname must refer to declared function or variable
../../../../pkg/mod/golang.org/x/sys@v0.0.0-20200116001909-b77594299b42/unix/zsyscall_darwin_amd64.go:59:3: //go:linkname must refer to declared function or variable
../../../../pkg/mod/golang.org/x/sys@v0.0.0-20200116001909-b77594299b42/unix/zsyscall_darwin_amd64.go:75:3: //go:linkname must refer to declared function or variable
../../../../pkg/mod/golang.org/x/sys@v0.0.0-20200116001909-b77594299b42/unix/zsyscall_darwin_amd64.go:90:3: //go:linkname must refer to declared function or variable
../../../../pkg/mod/golang.org/x/sys@v0.0.0-20200116001909-b77594299b42/unix/zsyscall_darwin_amd64.go:105:3: //go:linkname must refer to declared function or variable
../../../../pkg/mod/golang.org/x/sys@v0.0.0-20200116001909-b77594299b42/unix/zsyscall_darwin_amd64.go:121:3: //go:linkname must refer to declared function or variable
../../../../pkg/mod/golang.org/x/sys@v0.0.0-20200116001909-b77594299b42/unix/zsyscall_darwin_amd64.go:121:3: too many errors

这是因为项目使用了老版本的 golang.org/x/sys包导致的。

需要我们更新一下电脑本地依赖库中这个包的版本。

执行命令：

go get -u golang.org/x/sys

执行命令后终端会显示类似下面的更新过程：

go: downloading golang.org/x/sys v0.20.0
go: upgraded golang.org/x/sys v0.0.0-20200116001909-b77594299b42 => v0.20.0

关于Gin项目初始化过程中还会遇到哪些错误，Windows上的一些错误怎么解决，欢迎订阅专栏，加入我们的项目，项目中会通过Github Issue来记录和解答项目开发过程中大家提的各种问题，也有专属的读者群，欢迎加入一起学习。

项目是用Go语言从零开始搭建项目和做需求开发的实战项目，使用的技术栈均为实际开发所常用的组件和框架如：Gin、Viper、Zap、GORM、go-redis 、lo 等等。

课程分为五大部分：

• 第一部分介绍让框架变得好用的诸多实战技巧，比如通过自定义日志门面让项目日志更简单易用、支持自动记录请求的追踪信息和程序位置信息、通过自定义Error在实现Go error接口的同时支持给给错误添加错误链，方便追溯错误源头。

• 第二部分：讲解项目分层架构的设计和划分业务模块的方法和标准，让你以后无论遇到什么项目都能按这套标准自己划分出模块和逻辑分层。后面几个部分均是该部分所讲内容的实践。

• 第三部分：设计实现一个套支持多平台登录，Token泄露检测、同平台多设备登录互踢功能的用户认证体系，这套用户认证体系既可以在你未来开发产品时直接应用

• 第四部分：商城app C端接口功能的实现，强化分层架构实现的讲解，这里还会讲解用责任链、策略和模版等设计模式去解决订单结算促销、支付方式支付场景等多种多样的实际问题。

• 第五部分：单元测试、项目Docker镜像、K8s部署和服务保障相关的一些基础内容和注意事项

具体的章节可扫码下方的海报二维码或者访问 https://xiaobot.net/p/golang

点击下方阅读原文即可跳转。