当前位置：首页 > 开源项目 > 微服务电商 > 正文内容

go-zero 成长之路—微服务电商实战系列（五、RPC定义）

3年前 (2022-10-08)微服务电商7890

> 该系列源码已开源：[micro-shop](https://gitee.com/jobhandsome/micro-shop)

# 1. 概述

在`第三章`讲到：表结构划分，共`8`个表，分别对应以下版块：

* 用户服务版块：`user` 表
* 产品服务版块：`product`、`category` 表
* 购物车服务版块：`cart` 表
* 订单服务版块：`orders`、`order_record`、`order_address` 表
* 支付服务版块：`pay_info` 表

总共`5`个服务。在咱们原先的构想中，远不止远不止以上这 `5` 个服务版块。

但是对于电商系统来说，这`5`个版块是重中之重的，是必不可少的。

在`第四章`讲到：`API定义`，针对`5`个服务进行接口定义。有了`API`那自然就要说到`RPC`了。

所以咱们该篇文章就针对重中之重的`5`个版块进行`RPC`的定义，用于对`API数据依赖`的开发。

如果以上设计构想不是很清楚的，可通过如下传送门查看该系列其他文章：

- [go-zero 成长之路—微服务电商实战系列（四、API定义）](https://juejin.cn/post/7142848286330880014)
- [go-zero 成长之路—微服务电商实战系列（三、表结构篇）](https://juejin.cn/post/7139717722782466084)
- [go-zero 成长之路—微服务电商实战系列（二、划分篇）](https://juejin.cn/post/7138610986612686856)
- [go-zero 成长之路—微服务电商实战系列（一、需求篇）](https://juejin.cn/post/7137280656912384036)

# 2. RPC定义

不同的微服务间需要做数据的隔离，每个微服务独占数据库资源，通过`RPC`调用来获取数据依赖，整体架构如下图所示：

![image](https://p6-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/c0cf40744c0841c882d88426f528d101~tplv-k3u1fbpfcp-zoom-in-crop-mark:3024:0:0:0.awebp?)

通过以上对`API`的定义我们大致了解了需要定义哪些服务的`RPC`，下面开始`RPC`的定义。

这里采用 `rpc.proto` 文件的形式进行构建`RPC`服务。

## 用户服务

> 主要功能：用户登录、用户注册、用户信息、...

* `account.proto` 文件如下：

```go
syntax = "proto3";

package account;

option go_package = "./account";

message RegisterReq{
  string UserName = 1;
  string PassWord = 2;
  string UserNick = 3;
  string UserFace = 4;
  int64 UserSex = 5;
  string UserEmail = 6;
}

message LoginReq{
  string UserName = 1;
  string PassWord = 2;
}

message CommonResply{
  int64 Code = 1;
  string Message = 2;
  string Data = 3;
}

message UserInfoReq{
  string UserIdentity = 1;
}

service user{
  rpc Register(RegisterReq) returns(CommonResply);
  rpc Login(LoginReq) returns(CommonResply);
  rpc UserInfo(UserInfoReq) returns (CommonResply);
}
```

* 生成命令如下：

```shell
goctl rpc protoc account.proto --go_out=./types --go-grpc_out=./types --zrpc_out=. -style go-zero 
```

* 生成后的目录结构：

```text
├── Dockerfile
├── account.go 
├── account.proto                  // proto描述文件
├── etc
│   └── account.yaml               // 配置文件
├── internal
│   ├── config
│   │   └── config.go              // 配置声明type
│   ├── logic                      // 业务逻辑
│   │   ├── login-logic.go
│   │   ├── register-logic.go
│   │   └── user-info-logic.go
│   ├── server
│   │   └── user-server.go
│   └── svc                        // logic所依赖的资源池
│       └── service-context.go
├── model                          // 数据库表模型生成
│   ├── user_model.go
│   ├── user_model_gen.go
│   ├── user_receive_address_model.go
│   ├── user_receive_address_model_gen.go
│   └── vars.go
├── types                          // request、response的struct，根据api自动生成，不建议编辑
│   └── account
│       ├── account.pb.go
│       └── account_grpc.pb.go
└── user                           // main函数入口
    └── user.go
```

## 首页服务

> 主要功能：首页banner图、人气推荐、商品推荐列表、...

* `home.proto` 文件如下：

```go
syntax = "proto3";

package home;

option go_package = "./home";

message BannerReq{}
message RecommendReq{}
message RankingListReq{}

message CommonResply{
  int64 Code = 1;
  string Message = 2;
  string Data = 3;
}

service home{
  rpc Banner(BannerReq) returns(CommonResply);
  rpc Recommend(RecommendReq) returns(CommonResply);
  rpc RankingList(RankingListReq) returns(CommonResply);
}
```

* 生成命令如下：

```shell
goctl rpc protoc home.proto --go_out=./types --go-grpc_out=./types --zrpc_out=. -style go-zero 
```

* 生成后的目录结构：

```text
├── etc
│   └── home.yaml
├── home.go
├── home.proto
├── homeclient
│   └── home.go
├── internal
│   ├── config
│   │   └── config.go
│   ├── logic
│   │   ├── banner-logic.go
│   │   ├── ranking-list-logic.go
│   │   └── recommend-logic.go
│   ├── server
│   │   └── home-server.go
│   └── svc
│       └── service-context.go
├── model
│   ├── banner.sql
│   ├── banner_model.go
│   ├── banner_model_gen.go
│   └── vars.go
└── types
    └── home
        ├── home.pb.go
        └── home_grpc.pb.go
```

## 产品服务

> 主要功能：产品列表、产品详情、分类列表、...

* `product.proto` 文件如下：

```go
syntax = "proto3";

package product;

option go_package = "./product";

message GetProductsReq {
  int64 Page = 1;
  int64 PageSize = 2;
  string Search = 3;
}

message ProductReq {
  string productIds = 1;
}

message GetCateoryReq {
  int64 Pid = 1;
}

message CommonResply{
  int64 Code = 1;
  string Message = 2;
  string Data = 3;
}

service product{
  rpc Products (GetProductsReq) returns (CommonResply);
  rpc Product (ProductReq) returns (CommonResply);
  rpc Category (GetCateoryReq) returns (CommonResply);
}
```

* 生成命令如下：

```shell
goctl rpc protoc product.proto --go_out=./types --go-grpc_out=./types --zrpc_out=. -style go-zero 
```

* 生成后的目录结构：

```text
├── etc
│   └── product.yaml
├── internal
│   ├── config
│   │   └── config.go
│   ├── logic
│   │   ├── category-logic.go
│   │   ├── product-logic.go
│   │   └── products-logic.go
│   ├── server
│   │   └── product-server.go
│   └── svc
│       └── service-context.go
├── product.go
├── product.proto
├── productclient
│   └── product.go
└── types
    └── product
        ├── product.pb.go
        └── product_grpc.pb.go
```

> 说到这里：剩下的几个服务咱们就暂时不说了，有兴趣的朋友可以自行补齐：`购物车服务`、`支付服务`、`订单服务`这几个版块。

# 3. 结束语

本篇文章介绍说明了：

- 如何构建一个`RPC`服务？
- 如何编写 `rpc.proto` 文件？
- 构建后的每个目录和文件是做什么的？

另外，如果你感兴趣，非常欢迎你加入，我们一起来完成这个项目，为社区献出自己的一份力。

希望本篇文章对你有所帮助，谢谢。

随机文章
热门文章
热评文章

扫描二维码推送至手机访问。

本文链接：https://www.qsjob.fun/post/33.html

分享给朋友：

返回列表

上一篇：go-zero 成长之路—微服务电商实战系列（四、API定义）

下一篇：go-zero 成长之路—微服务电商实战系列（六、条件查询）

“go-zero 成长之路—微服务电商实战系列（五、RPC定义）” 的相关文章

go-zero 成长之路—微服务电商实战系列（二、划分篇）3年前 (2022-09-02)

go-zero 成长之路—微服务电商实战系列（三、表结构篇） 3年前 (2022-09-05)

go-zero 成长之路—微服务电商实战系列（四、API定义）3年前 (2022-09-13)

go-zero 成长之路—微服务电商实战系列（六、条件查询）3年前 (2022-10-18)

go-zero 成长之路—微服务电商实战系列（七、并发处理工具MapReduce的使用）3年前 (2022-10-20)

go-zero 成长之路—微服务电商实战系列（五、RPC定义）

“go-zero 成长之路—微服务电商实战系列（五、RPC定义）” 的相关文章

京ICP备2021021334号

Powered By Z-BlogPHP. Theme by TOYEAN.

go-zero 成长之路—微服务电商实战系列（五、RPC定义）

“go-zero 成长之路—微服务电商实战系列（五、RPC定义）” 的相关文章

京ICP备2021021334号var _hmt = _hmt || [];(function() { var hm = document.createElement("script"); hm.src = "https://hm.baidu.com/hm.js?b63854c12c937e8f0e109978f0f10b08"; var s = document.getElementsByTagName("script")[0]; s.parentNode.insertBefore(hm, s);})();

Powered By Z-BlogPHP. Theme by TOYEAN.

京ICP备2021021334号