目前,Hertz 支持 Linux、macOS、Windows 系统
在完成环境准备后,本章节将帮助你快速上手 Hertz。
首先,我们需要安装使用本示例所需要的命令行工具 hz:
GOPATH
环境变量已经被正确地定义(例如 export GOPATH=~/go
)并且将$GOPATH/bin
添加到 PATH
环境变量之中(例如 export PATH=$GOPATH/bin:$PATH
);请勿将 GOPATH
设置为当前用户没有读写权限的目录go install github.com/cloudwego/hertz/cmd/hz@latest
更多 hz 使用方法可参考: hz
$GOPATH/src
下,需在$GOPATH/src
下创建额外目录,进入该目录后再获取代码: $ mkdir -p $(go env GOPATH)/src/github.com/cloudwego
$ cd $(go env GOPATH)/src/github.com/cloudwego
hz new
$ go mod tidy
如果当前使用的是 Windows 环境,可以编写如下的示例代码:
main.go
文件main.go
文件中添加以下代码package main
import (
"context"
"github.com/cloudwego/hertz/pkg/app"
"github.com/cloudwego/hertz/pkg/app/server"
"github.com/cloudwego/hertz/pkg/common/utils"
"github.com/cloudwego/hertz/pkg/protocol/consts"
)
func main() {
h := server.Default()
h.GET("/ping", func(c context.Context, ctx *app.RequestContext) {
ctx.JSON(consts.StatusOK, utils.H{"message": "pong"})
})
h.Spin()
}
go.mod
文件$ go mod init hertz_demo
$ go mod tidy
完成以上操作后,我们可以直接编译并启动 Server
$ go build -o hertz_demo && ./hertz_demo
如果成功启动,你将看到以下信息
2022/05/17 21:47:09.626332 engine.go:567: [Debug] HERTZ: Method=GET absolutePath=/ping --> handlerName=main.main.func1 (num=2 handlers)
2022/05/17 21:47:09.629874 transport.go:84: [Info] HERTZ: HTTP server listening on address=[::]:8888
接下来,我们可以对接口进行测试
$ curl http://127.0.0.1:8888/ping
如果不出意外,我们可以看到类似如下输出
$ {"message":"pong"}
到现在,我们已经成功启动了 Hertz Server,并完成了一次调用。更多 API 示例请参考 API 示例
关于项目目录结构组织,这里有一个目录结构可供参考,具体可以根据业务的实际情况进行组织