环境准备
-
go 版本
go version go1.22.2 linux/amd64
-
goctl 安装
goctl(官方建议读 go control)是 go-zero微服务框架下的代码生成工具。使用 goctl 可以显著提升开发效率,让开发人员将时间重点放在业务开发上,其功能有:- api 服务生成
- rpc 服务生成
- model 代码生成
- 模板管理
安装:
go install github.com/zeromicro/go-zero/tools/goctl@v1.4.4
这时候会在 gopath 的 bin 目录下生成 goctl 的执行进程
goctl --version
-
protoc & protoc-gen-go 安装
go-zero 提供了便捷的安装方式:goctl env check -i -f --verbose
HelloWorld
-
生成项目
mkdir helloworld cd helloworld goctl api new hello # 如果没有配置环境变量,那么在上一步中,可以用goland 打开helloworld目录,并在terminal下执行如下命令 cd hello go mod tidy # 下载依赖
-
使用goland 2022.1以上版本,打开 helloworld 目录
生成如下的代码结构示意图。 -
修改生成的代码
修改hellologic.go 中的代码,返回 “hello world”
func (l *HelloLogic) Hello(req *types.Request) (resp *types.Response, err error) {// todo: add your logic here and delete this linereturn &types.Response{Message: "hello world",}, nil }
-
启动应用,并访问 http://localhost:8888/from/me
微服务版本的 HelloWorld
场景
用户服务 user
订单服务 order
初始化工程
mkdir micorhelloworld
cd micorhelloworld
mkdir mall
cd mall
goctl api new order
goctl api new user# 为了用 workspace 模式,执行下面语句
go work init
go work use order
go work use user
goland 代开 mall 目录
grpc 服务使用
由于 user 服务给order服务提供 rpc服务,所有要做以下工作:
-
在 user 目录下创建 rpc 目录,并建立 user.proto文件
syntax = "proto3";package user;option go_package = "./user";message IdRequest {string id = 1; }message UserResponse {string id = 1;string name = 2;string gender = 3; }service User {rpc getUser(IdRequest) returns(UserResponse); }
-
删除 user 微服务下之前生成的代码
删除代码之后的目录结构。 -
使用命令生成 rpc 代码
cd user/rpc goctl rpc protoc user.proto --go_out=./types --go-grpc_out=./types --zrpc_out=.
-
将生成的代码,移动到 user 目录下,并且同步相关依赖
提供 user 的业务逻辑
在order目录下生成接口代码
- 修改 order.api 代码,添加如下代码
使用命令,生成代码
cd mall/order
goctl api go -api order.api -dir ./ # 当前目录下生成代码
如果是添加接口后生成代码,可以在新的文件目录下生成代码,防止代码覆盖。
代码修改
为了使用 user 的 grpc服务,我们修改代码。
- rpc 代码生成时候,用到了 etcd 组件(可以看 user/etc/user.yaml 文件中)。因此,我们在 order/etc/order-.yaml 文件中,需要加入 etcd 配置:
Name: order-api Host: 0.0.0.0 Port: 8888 UserRpc:Etcd:Hosts:- 127.0.0.1:2379Key: user.rpc
- 由于 user 是 grpc 的一个server,而 order 是 grpc的一个client,要想调用user的方法,需要先建立grpc的连接。
- 修改 order/internal/config/config.go 文件,增加 UserRpc 变量,与上一步增加的配置先呼应。为读取配置文件中的配置。
type Config struct {rest.RestConfUserRpc zrpc.RpcClientConf # 为了去etcd中获取User Rpc 的地址 }
- 建立连接,修改 order/internal/svc/servicecontext.go 文件
- 修改业务逻辑 order/internal/logic/getorderlogic.go 文件
- 修改 order/internal/config/config.go 文件,增加 UserRpc 变量,与上一步增加的配置先呼应。为读取配置文件中的配置。
安装并启动 etcd
wget get https://github.com/etcd-io/etcd/releases/download/v3.5.13/etcd-v3.5.13-linux-amd64.tar.gztar -xvf etcd-v3.5.13-linux-amd64.tar.gz
cd etcd-v3.5.13-linux-amd64.tar.gz
./etcd
goland 下启动微服务项目user, order,并访问order
http://localhost:8888/api/order/get/1