Golang 构建学习

如何搭建Golang开发环境

1. 下载GOlang包

https://golang.google.cn/dl/ 在地址上下载Golang

2. 配置包环境

修改全局环境变量，GOPROXY，GOPATH，GOROOT

GOPROXY=https://goproxy.cn,direct

GOROOT="" // go二进制文件的路径
mkdir project 创建项目文件
go mod init project 创建包模块
go get xxxxx 获取第三方包

如何让程序运行起来

复制代码

// main.go
package main

import "fmt"

func main(){
    fmt.Println("hello world")
}

go run main.go 执行程序运行
程序的入口，要使用package main表示为主要入口，入口函数为func main
import "fmt"在使用包需要引入，如果是自定义的包，则从自己初始化的模块project开始，例如:go mod init project
fmt.Println 打印日志，包中对外提供的接口，是要求首字母大写来表示的

如何编写函数

复制代码

func (file *File) Write(b []byte) (n int, err error){}  // 1 example
func Write(b []byte) (int, error) {return 0, nil} // 2 example
func nextInt(b []byte, pos int) (value, nextPos int) { return 0, 0} // 3 example
// ---------多值输入-----------------
func MyPrint(words ...string){
    for _, w := range words{
        fmt.Println(w)
    }
}
MyPrint("ab", "cd", "ef")
// ---------End----------------------
// ----------值传递和指针传递---------------
var a = 5
func changeWithValue(b int){
    b = 4
}
func changeWithPoint(b *int){
    *b = 4
}

changeWithValue(a)  // a is 5
changeWithPoint(&a) // a is 4

第一个例子:

第一个括号是类的实例句柄file，调用这个函数的只能是File类,首字母大写表示对外的接口。

第二个括号表示的输入参数，表示字节数组类型

第三个括号表示的输出参数，第一个输出参数为int类型，第二个输出参数为error类型

第二个例子:

没有第一个括号的类声明，函数首字母大写说明是模块对外的接口调用

第二个括号是输入参数的声明

第三个括号是输出参数的声明，注意这个没有向上面例子中提前声明返回值变量，需要在函数体中{}，声明返回值变量

第三个例子:

与以上雷同，区别在于返回值，如果两个相同类型的返回值，则可以采用省略的写法v1, v2 int

多值输入例子:

注意Myprint函数的定义与调用处。

函数定义: 2个以上的相同参数，可以使用...string声明类型，承载的是[]string数组

函数调用: (str1, str2, str3)

值传递和引用传递

值传递：函数中使用的是被复制的值，不影响外部数据

引用传递: 函数中使用的是指向值的指针地址，通过函数修改传递的数据

注意上面的用法: 指针声明*int和地址传递&a

如何导入函数

如果是创建的项目，执行go mod init project,项目内的模块引入，则通过project.module引入

函数如果是在模块内部，也就是同一个package目录下，则不同导入，直接调用就行

函数如果是要被外部模块调用，一律首字母要大写，并且模块先要被引入

import _ "net/http/pprof"不以模块的方式调用，模块下的对外函数全引入

如何构建多平台的二进制文件

复制代码

BINARY_NAME=myproject
VERSION=v2.1.0
BUILD_TIME=$(shell date +'%Y.%m.%d %H:%M:%S')
LDFLAGS="-s -w -X main.version=$(VERSION) -X 'main.buildTime=$(BUILD_TIME)'"

swag:
	swag init cmd/server.go -o docs
	# sed -i '/LeftDelim/d' ./docs/docs.go
	# sed -i '/RightDelim/d' ./docs/docs.go

build:        
	env GO111MODULE=on GOPROXY=https://proxy.golang.com.cn,direct go mod tidy
	env GO111MODULE=on GOPROXY=https://proxy.golang.com.cn,direct go mod vendor
	env GO111MODULE=on GOPROXY=https://goproxy.io,direct CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -ldflags $(LDFLAGS) -o bin/$(BINARY_NAME) cmd/server.go
	env GO111MODULE=on GOPROXY=https://goproxy.io,direct CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build -ldflags $(LDFLAGS) -o bin/$(BINARY_NAME).mac cmd/server.go
	env GO111MODULE=on GOPROXY=https://goproxy.io,direct CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -ldflags $(LDFLAGS) -o bin/$(BINARY_NAME).exe cmd/server.go
	upx -9 bin/yxapi
clean:
	rm bin/$(BINARY_NAME)
	rm bin/$(BINARY_NAME).mac
	rm bin/$(BINARY_NAME).exe

参考以上的代码，即可创建多个平台二进制文件

构建Web开发

Web开发虽然可以用多种不同的语言实现，但是基本的理论是一致的，比如鉴权，路由，数据库抽象，参数校验，mvc分层等等。

1. 如何组织代码

目录结构如下:

Project

bin go build构建的输出目录
cmd 二进制命令程序
- server.go 服务的启动程序
configs 配置目录
- *.sql 初始化的二进制文件
- config.yaml 配置文件
- mongo.go mongo的配置结构
- mysql.go mysql配置结构
- redis.go redis配置结构
- server.go 服务的配置结构
docker
- README.md
docs 此目录由swag init生成
internal 服务的内容模块
- controllers MVC结构的Controller
- middlewares 服务的中间件
  - auth.go
  - cors.go
  - errorHandle.go
- modles 数据模型 MVC结构的模型层
- pkg 业务之外的基础库,基础库不应该包含业务逻辑
  - logger
  - mongo
  - token
- router 项目的服务路由
  - router.go
- services 服务模块,通常是控制层调用此服务层，服务层调用模型层
  - devices.go
logs 日志输出文件
go.mod
Makefile
README.md

以上目录结构，主要参考的此作者的Githubsanjayheaven

2. 开发过程中的关键概念有哪些

参考Gin web Framework

罗列关键概念如下:

解析请求
1. form表单数据
2. body数据
3. 路由参数的设置
输入参数校验与模型化
多个路由组
使用中间件
响应处理
重定向
Cookie与Token处理
上传文件

3. 如何判定是否有必要创建模块

4. 如何设计模块

5. 如何使用swager模块

go install github.com/swaggo/swag/cmd/swag@latest 安装swag工具
swag init -g cmd/server.go -o docs 从主文件导入并初始化目录到docs目录下

如何进行描述呢

复制代码

// @Tags 设备
// @Summary 某一个设备类型下的所有设备
// @Description  某一个设备类型下的所有设备
// @Param l query int false "记录条数"
// @Param type query string false "设备类型"
// @Param online query string false "在线与否(只支持all)"
// @Param search_key query string false "搜索关键词(不支持)"
// @Success 200 {object} nil
// @Router /api/xxx/device [get]
func (dc *DeviceController) DeviceTypeList(c *gin.Context){
    return c.JSON(http.StatusOK, "hello world")
}

针对输入参数，由query，path,formData

router.go代码修改，导入docs模块(非常重要)

复制代码

swaggerFiles "github.com/swaggo/files"
ginSwagger "github.com/swaggo/gin-swagger"
_ "project/docs" // 此行非常重要,"项目名/docs",否则会出现没有doc.json的情况

func Init(){
    Router = gin.Default()
    Router.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
}

Token 生成

Token 生成

持续更新中...