go 项目构建

zhaoqiang1980 / 2024-02-06 / 原文

Go

准备

依赖环境：

golang 参考官网地址：https://golang.google.cn/dl/

开发工具：

可使用jetbrian 的 Go，但是需要付费，免费也就30天试用，没有社区版。
Idea 安装Go-plugin 插件。插件地址：https://plugins.jetbrains.com/plugin/9568-go/versions/stable

以Module形式导入应用

因Go项目非Java项目不能使用MVN，Gradle

GoRoot设置

GoPath设置

启用Go Module整合

项目构建

初始化

帮助

go help [command] // help帮助查看

初始化mod。在项目根目录下运行go mod init 项目名,初始化go.mod文件,用于记录依赖包信息

go mod init git-hub.com/go/[my-project] //初始化go项目mod

安装依赖包。根据项目需求,使用go get命令安装所需的第三方包。并将依赖写入go.mod文件中。

go get github.com/gorilla/mux@v1.6.2

- -u 表示更新到最新版本。go get -u 会将依赖包更新到最新的次要版本或修订版本(semver)。
- -t 表示同时下载依赖包的测试代码。默认情况下go get只下载生产代码,不会下载测试代码。如果需要运行依赖包的测试,需要加上-t。
- -d 表示只下载包,不安装。可以用来只获取包的源码到本地,但不编译安装。
- -f 表示如果包下载有错误,则强制删除后重新获取整个包。
- -fix 表示在获取源码后,先运行fix工具修复源码,然后再安装。
- -insecure 允许下载的依赖包使用不安全的 SSL 证书。
- -v 表示打印下载详情信息。

go 开发环境

go env // 查看go的环境地址
go env -w GOPROXY=https://goproxy.cn //设置代理地址默认地址为：https://proxy.golang.org
go env -w "GONOSUMDB=XXX.com"

设置 GONOSUMDB 环境变量的作用是禁用 Go 模块校验和数据库的使用。
Go 模块在下载时,会通过校验和数据库来验证模块文件的内容是否完整和未被篡改。默认的校验和数据库地址是 sum.golang.org。但是某些国内用户可能无法访问这个校验和数据库。将 GONOSUMDB 设置为任意非空值,即可禁用校验和数据库。这会使得 go get、go mod 等命令不再尝试访问校验和数据库,可以加速模块下载,但也降低了安全性。另外,也可以设置 GONOSUMDB 指向一个可用的第三方校验和数据库。

go mod tidy 是 Go 语言的一个命令，用于清理和整理项目所使用的依赖关系。它会检测您项目中所需要的依赖包，然后删除项目中已经不需要的包及其依赖关系，同时还会为您自动添加项目中缺失的包及其依赖项

go mod tidy //整理，即下载相关的依赖包

main 启动函数
cmd/main.go 创建 main启动函数

go run main.go

Web框架 GIN

go get github.com/gin-gonic/gin

Gin 是一个用 Go (Golang) 编写的 HTTP Web 框架。 GIN 官网地址：https://gin-gonic.com/zh-cn/docs/

DB访问链接框架 GORM

go get -u gorm.io/gorm
go get -u gorm.io/driver/mysql

The fantastic ORM library for Golang aims to be developer friendly.官方网址：https://gorm.io/zh_CN/docs/

日志框架 zap

go get -u go.uber.org/zap

logger, _ := zap.NewDevelopment()
logger.Info("web zapdsfdsfdsfdsfdsfdsfds started---------------------------")

apiDoc swag

Go语言有类似java的swagger 做apiDoc。参见官网：
https://github.com/swaggo/swag
对于gin作为web框架，参见官网：https://github.com/swaggo/gin-swagger

使用前下载安装

go install github.com/swaggo/swag/cmd/swag@latest

使用 swag init 创建 docs文档，默认会去在当前文件夹下查找main.go
如果遇到main.go 并不在项目跟目录下，举例在cmd下，需要使用命令，则在项目下生成一个docs文件夹，所有的api文档信息在这个文件夹下。

swag init -g cmd/main.go

然后在main.go 中添加3个import

import ginSwagger "github.com/swaggo/gin-swagger" // gin-swagger middleware
import swagFile "github.com/swaggo/files" // swagger embed files
import _ "应用项目地址/docs"  //指定docs地址，否则会出现页面无法找到docs.json的错误

在gin的地址中添加以下主要代码：

 r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))

其它参照官网的写法即可。
API参照：

// @BasePath /api/v1

// PingExample godoc
// @Summary ping example
// @Schemes
// @Description do ping
// @Tags example
// @Accept json
// @Produce json
// @Success 200 {string} Helloworld
// @Router /example/helloworld [get]
func Helloworld(g *gin.Context)  {
   g.JSON(http.StatusOK,"helloworld")
}

循环依赖检查

循环依赖查找

go vet ./...

pprof 自带的性能分析工具

使用说明

swag 生成命令 swag init -g ./cmd/main.go --pd,然后在浏览器访问:
http://127.0.0.1:8080/swagger/index.html

循环依赖查找

go vet ./...

pprof使用

在main方法内首行添加以下命令，开启pprof监听

import (
    _ "net/http/pprof"
)
go func() {
    log.Println(http.ListenAndServe(":6060", nil))
}()

页面访问地址：http://localhost:6060/debug/pprof/

踩坑点：

每次有添加新的接口doc都需要重新执行swag init，因为这是静态生成运行。
swag init 会从当前文件夹下扫描带有特定注释的函数(否则扫描不到)，因此如果main.go 在cmd下，注释函数在api文件夹下，执行命令为swag init -g cmd/main.go
对于函数中返回对象情况，会出现找不到类的情况，需要在执行时额外增加依赖加载--parseDependency, --pd，可使用swag init -h查看。执行为 swag init -g cmd/main.go --pd
如果其它非Http函数也用了@param注释，也会被误扫为http请求，提示参数不规范，因此需要去掉@符号。
页面展示我在edge dev版本下，有字符拥挤（看着像乱码）的情况，换浏览器即可。