如果还没有安装/配置好Golang开发环境的小伙伴,可以先参考下Golang环境搭建:准备工作
安装框架工具
工具地址:https://github.com/gogf/gf/releases
您可能会遇到以下常见问题:
- 如果当前系统没有安装
wget
命令,那么请使用brew install wget
安装后继续执行该命令。 - 如果您使用的是
zsh
终端,可能会存在gf
别名冲突(git fetch
快捷指令),那么安装后请新开终端或者标签来继续使用。
wget -O gf "https://github.com/gogf/gf/releases/latest/download/gf_$(go env GOOS)_$(go env GOARCH)" && chmod +x gf && ./gf install -y && rm ./gf
如果系统没有安装wget
命令:
Ubuntu/Debian
系统请使用apt-get install wget -y
CentOS/RedHat
系统请使用
手动下载对应的二进制文件,双击按照终端指令安装即可。如果双击安装失败,请采用最后万能的手动编译安装方式。
$ gf -v
GoFrame CLI Tool v2.1.3, https://goframe.org
GoFrame Version: cannot find goframe requirement in go.mod
CLI Installed At: /Users/john/Workspace/Go/GOPATH/bin/gf
Go Version: go1.17.13
GF Version: v2.1.3
Git Commit: 2022-08-22 14:40:48 91d8d71821012aef4a35b5f9e7b4fbfc04f3ffe7
Build Time: 2022-08-22 14:48:37
注意其中的Go/GF Version
是当前编译的二进制文件使用的Golang
及GoFrame
框架版本,其中的GoFrame Version
是当前项目使用的GoFrame
框架版本(自动检测当前目录下的go.mod
)。
创建项目模板
该命令创建一个项目模板,项目名称是,其中的-u
参数用户指定是否更新项目中使用的goframe
框架为最新版本。框架有独特的项目工程结构,工程目录结构介绍具体请参考:工程目录设计 。
项目模板中提供了一些make
命令,用于更便捷地使用框架工具,特别是make cli
及make dao
命令在项目开发中比较常用。具体命令介绍请参考项目中的README.MD
。
运行项目模板
项目模板可以执行以下命令运行:
cd demo && gf run main.go
执行后,终端输出:
默认情况下项目会设置Web服务端口为8000
、开启OpenAPI
接口文档、展示Swagger
接口文档页面,这些关键信息都会展示到终端。默认情况下,会打印所有的路由信息到终端,该项目模板只会添加一个仅供演示的路由:/hello
。
默认路由: http://127.0.0.1:8000/hello
Swagger
接口文档页面:
升级框架版本
随时可以在项目根目录下(目录下有go.mod
),执行以下命令更新使用最新的框架版本:
go get -u github.com/gogf/gf/v2