快速开始
cwgo 是 CloudWeGo All in one 代码生成工具,整合了各个组件的优势,提高开发者提体验。
准备 Golang 开发环境
- 如果您之前未搭建 Golang 开发环境, 可以参考 Golang 安装
- 推荐使用最新版本的 Golang,我们保证最新两个正式版本的兼容性(现在 >= v1.18)。
- 确保打开 go mod 支持 (Golang >= 1.15 时,默认开启)
- cwgo 暂时没有针对 Windows 做支持,如果本地开发环境是 Windows 建议使用 WSL2
在完成环境准备后,接下来将帮助你快速上手 cwgo。
安装 cwgo 工具
用 go 命令来安装是最简单的,你也可以选择自己从源码构建和安装。要查看 cwgo 的安装位置,可以用:
要使用 thrift 或 protobuf 的 IDL 生成代码,需要安装相应的编译器:thriftgo 或 protoc。
thriftgo 安装:
protoc 安装
首先,我们需要安装使用本示例所需要的命令行代码生成工具:
- 确保
GOPATH
环境变量已经被正确地定义(例如export GOPATH=~/go
)并且将$GOPATH/bin
添加到PATH
环境变量之中(例如export PATH=$GOPATH/bin:$PATH
);请勿将GOPATH
设置为当前用户没有读写权限的目录 - 安装 cwgo:
go install github.com/cloudwego/cwgo@latest
- 安装 thriftgo:
go install github.com/cloudwego/thriftgo@latest
安装成功后,执行 cwgo --version
和 thriftgo --version
应该能够看到具体版本号的输出(版本号有差异,以 x.x.x 示例):
确定代码放置位置
-
若将代码放置于
$GOPATH/src
下,需在$GOPATH/src
下创建额外目录,进入该目录后再获取代码: -
若将代码放置于 GOPATH 之外,可直接获取
注意事项
cwgo 底层使用 kitex、hz、gen 工具,所以其相应的工具规范也需要遵守,如 kitex 的注意事项和 hz 的注意事项。
使用
cwgo 的具体使用请参考命令行工具
下面以 thrift 为例
-
首先创建一个目录
-
创建一个 idl 目录
-
编写 idl/hello.thrift 文件
-
生成项目 layout
静态命令行
动态命令行
-
编译运行
-
发起调用
恭喜你!至此你成功编写了一个 Cwgo 的服务端,并完成了一次调用!
最后修改
December 1, 2023
: docs: translate multiple service guide (#870) (228621b)