使用go-zero快速构建微服务

news2024/11/25 4:30:11

本文是对 使用go-zero快速构建微服务[1]的亲手实践


编写API Gateway代码


mkdir bookstore && cd bookstore
go mod init bookstore

mkdir api && goctl api -o api/bookstore.api

syntax = "v1"

info(
    title: "xx使用go-zero"
    desc: "xx用来上手go-zero"
    author: "xxxx"
    email: "xxxx@gmail.com"
)

type (
    addReq struct {
        book string `form:"book"`
        price int64 `form:"price"`
    }

    addResp struct {
        ok bool `json:"ok"`
    }
)

type (
    checkReq struct {
        book string `form:"book"`
    }

    checkResp struct {
        found bool `json:"found"`
        price int64 `json:"price"`
    }
)


service bookstore-api {
    @handler AddHandler
    get /add (addReq) returns (addResp)

    @handler CheckHandler
    get /check (checkReq) returns (checkResp)
}

cd api && goctl api go -api bookstore.api -dir .

alt 
api
├── bookstore.api                  // api定义
├── bookstore.go                   // main入口定义
├── etc
│   └── bookstore-api.yaml         // 配置文件
└── internal
    ├── config
    │   └── config.go              // 定义配置
    ├── handler
    │   ├── addhandler.go          // 实现addHandler
    │   ├── checkhandler.go        // 实现checkHandler
    │   └── routes.go              // 定义路由处理
    ├── logic
    │   ├── addlogic.go            // 实现AddLogic
    │   └── checklogic.go          // 实现CheckLogic
    ├── svc
    │   └── servicecontext.go      // 定义ServiceContext
    └── types
        └── types.go               // 定义请求、返回结构体


go run bookstore.go -f etc/bookstore-api.yaml

启动API Gateway服务，默认侦听在8888端口

因为默认生成的api/etc/bookstore-api.yml为:

Name: bookstore-api
Host: 0.0.0.0
Port: 8888
alt

按提示下载，再次运行:

alt
alt 
{"@timestamp":"2023-02-16T16:31:09.658+08:00","caller":"stat/usage.go:61","content":"CPU: 0m, MEMORY: Alloc=2.5Mi, TotalAlloc=2.5Mi, Sys=14.5Mi, NumGC=0","level":"stat"}
{"@timestamp":"2023-02-16T16:31:09.662+08:00","caller":"load/sheddingstat.go:61","content":"(api) shedding_stat [1m], cpu: 0, total: 0, pass: 0, drop: 0","level":"stat"}
{"@timestamp":"2023-02-16T16:31:15.044+08:00","caller":"stat/metrics.go:210","content":"(bookstore-api) - qps: 0.0/s, drops: 0, avg time: 0.0ms, med: 0.0ms, 90th: 0.0ms, 99th: 0.0ms, 99.9th: 0.0ms","level":"stat"}

会定时(默认一分钟)输出cpu，内存等的统计信息，可以通过 logx.DisableStat()禁用 (可以做到自定义模板.tpl里)
alt

返回的是null，并不是预期的{"found":false,"price":0}

这是因为：

alt

resp是一个指针，这样直接return会是nil，需要如下显式声明

alt

重启服务，再次发起请求，这样的response就符合预期了~

alt

目前只返回了个空值，接下来会在rpc服务里实现业务逻辑

可以修改internal/svc/servicecontext.go来传递服务依赖（如果需要,比如Config，Auth，后续用到的RPC等）

实现逻辑可以修改internal/logic下的对应文件(如果接口较多，可以在.api里定义不同的group，使用goctl生成代码时，会自动在logic下根据group名称创建不同的文件夹)

可以通过goctl生成各种客户端语言的api调用代码(供客户端同学使用；支持多种语言)


编写RPC代码


编写add rpc服务


切到bookstore目录下

mkdir -p rpc/add && cd rpc/add

goctl rpc template -o add.proto

修改后文件内容如下：

syntax = "proto3";

package add;

option go_package = "./pb";

message addReq {
  string book = 1;
  int64 price = 2;
}

message addResp {
  bool ok = 1;
}

service adder {
  rpc add(addReq) returns(addResp);
}

goctl rpc protoc add.proto --go_out=./pb --go-grpc_out=./pb --zrpc_out=.

alt 
rpc/add
├── add.go                      // rpc服务main函数
├── add.proto                   // rpc接口定义
├── adder
│   ├── adder.go                // 提供了外部调用方法，无需修改
│   ├── adder_mock.go           // mock方法，测试用
│   └── types.go                // request/response结构体定义
├── etc
│   └── add.yaml                // 配置文件
├── internal
│   ├── config
│   │   └── config.go           // 配置定义
│   ├── logic
│   │   └── addlogic.go         // add业务逻辑在这里实现
│   ├── server
│   │   └── adderserver.go      // 调用入口, 不需要修改
│   └── svc
│       └── servicecontext.go   // 定义ServiceContext，传递依赖
└── pb
    └── add.pb.go

go run add.go -f etc/add.yaml 可运行该服务

默认每隔一分钟输出cpu和内存信息

{"@timestamp":"2023-02-16T20:02:10.640+08:00","caller":"stat/usage.go:61","content":"CPU: 0m, MEMORY: Alloc=3.3Mi, TotalAlloc=6.2Mi, Sys=15.9Mi, NumGC=3","level":"stat"}
{"@timestamp":"2023-02-16T20:02:10.656+08:00","caller":"load/sheddingstat.go:61","content":"(rpc) shedding_stat [1m], cpu: 0, total: 0, pass: 0, drop: 0","level":"stat"}

编写check rpc服务

切到bookstore目录下

mkdir -p rpc/check && cd rpc/check

goctl rpc template -o check.proto

修改后文件内容如下：

syntax = "proto3";

package check;

option go_package = "./pb";

message checkReq {
  string book = 1;
}

message checkResp {
  bool found = 1;
  int64 price = 2;
}

service checker {
  rpc check(checkReq) returns(checkResp);
}

goctl rpc protoc check.proto --go_out=./pb --go-grpc_out=./pb --zrpc_out=.

alt 
rpc/check
├── check.go                    // rpc服务main函数
├── check.proto                 // rpc接口定义
├── checker
│   ├── checker.go              // 提供了外部调用方法，无需修改
│   ├── checker_mock.go         // mock方法，测试用
│   └── types.go                // request/response结构体定义
├── etc
│   └── check.yaml              // 配置文件
├── internal
│   ├── config
│   │   └── config.go           // 配置定义
│   ├── logic
│   │   └── checklogic.go       // check业务逻辑在这里实现
│   ├── server
│   │   └── checkerserver.go    // 调用入口, 不需要修改
│   └── svc
│       └── servicecontext.go   // 定义ServiceContext，传递依赖
└── pb
    └── check.pb.go

go run check.go -f etc/check.yaml 可运行该服务

修改etc/check.yaml的端口为8081（因为8080已经被add服务使用了）


再回去修改API Gateway代码，调用add/check rpc服务


api/etc/bookstore-api.yaml，增加如下内容

Add:
  Etcd:
    Hosts:
      - localhost:2379
    Key: add.rpc
Check:
  Etcd:
    Hosts:
      - localhost:2379
    Key: check.rpc

通过etcd自动去发现可用的add和check服务

alt

修改api/internal/config/config.go如下，增加add&check服务依赖

alt

修改api/internal/svc/servicecontext.go，如下：

alt

通过ServiceContext在不同业务逻辑之间传递依赖

(问：怎么解决依赖注入问题)


修改api/internal/logic/addlogic.go里的Add方法，如下：

alt alt

通过调用adder的Add方法实现添加图书到bookstore系统


修改api/internal/logic/checklogic.go里的Check方法，如下：

alt

通过调用checker的Check方法实现从bookstore系统中查询图书的价格


定义数据库表结构，并生成CRUD+cache代码


bookstore下创建rpc/model目录

mkdir -p rpc/model （不过一般习惯把这个model文件夹抽出来，和api，rpc在一层）

在rpc/model目录下编写创建book表的sql文件book.sql，如下：

CREATE TABLE `book`
(
  `book` varchar(255) NOT NULL COMMENT 'book name',
  `price` int NOT NULL COMMENT 'book price',
  PRIMARY KEY(`book`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

进入mysql命令行，创建DB和table

create database gozero;
source book.sql;

在rpc/model目录下执行如下命令生成CRUD+cache代码，-c表示使用redis cache

goctl model mysql ddl -c -src book.sql -dir .

alt

修改add rpc和check rpc，调用crud+cache代码


修改rpc/add/etc/add.yaml和rpc/check/etc/check.yaml，均增加如下内容：

DataSource: root:123456@@tcp(xxx.xxx.xx.xx:3306)/gozero
#DataSource: root:123456@@tcp(localhost:3306)/gozero?charset=utf8mb4&parseTime=true&loc=Asia%2FShanghai #可以这样指定一些其他信息
Table: book
Cache:
  - Host: localhost:6379

alt

可以使用多个redis作为cache，支持redis单点或者redis集群


修改rpc/add/internal/config.go和rpc/check/internal/config.go，如下：

alt
alt

修改rpc/add/internal/svc/servicecontext.go和rpc/check/internal/svc/servicecontext.go，如下：

alt
alt

修改rpc/add/internal/logic/addlogic.go，如下

alt
alt

修改rpc/check/internal/logic/checklogic.go，如下：

alt

项目使用


需要先全部启动api服务所依赖的rpc服务。如果先启动api，则会报错：

error: context deadline exceeded, make sure rpc service "add.rpc" is already started

全部启动：

alt
alt
alt

(后面可以 -f指定不同环境的xxx.yaml)

调用add api,新增图书

curl -i "http://localhost:8888/add?book=Bible&price=10"

alt

此时看数据库，book表里新增了一行数据


调用check api,检查某本图书的价格

curl -i "http://localhost:8888/check?book=Bible"

alt
alt

重启check rpc，再次执行curl -i "http://localhost:8888/check?book=Bible"

alt

完整项目代码[2]

参考资料

[1]

使用go-zero快速构建微服务: http://www.jikejiaocheng.com/c/gozero-microservices.html

 [2]

完整项目代码: https://github.com/cuishuang/bookstore

本文由 mdnice 多平台发布

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/848519.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

springboot(6)

springboot(6)

Fastclass机制： 为一个对象创建对应的Fastclass对象，对象的各个方法会创建索引index关联到fastclass对象，每个index对应一个方法，之后只需要通过对象实例以及index，调用invoke(instance,index,args)，即可调…
阅读更多...
今天面了个00后测试员，让我见识到什么才是内卷届的天花板...

今天面了个00后测试员，让我见识到什么才是内卷届的天花板...

深耕IT行业多年，我们发现，对于一个程序员而言，能去到一线互联网公司，会给我们以后的发展带来多大的影响。 很多人想说，这个我也知道，但是进大厂实在是太难了，简历投出去基本石沉大海&#xff0…
阅读更多...
【软件工程】3 ATM系统的设计

【软件工程】3 ATM系统的设计

目录 3 ATM系统的设计 3.1体系结构设计 3.2 设计模式选择 3.3 补充、完善类图 3.4 数据库设计 3.4.1 类与表的映射关系 3.4.2 数据库设计规范 3.4.3 数据库表 3.5 界面设计 3.5.1 界面结构设计 3.5.2 界面设计 3.5.2.1 功能界面设计 3.5.2.2 交互界面 总博客&…
阅读更多...
【性能类】—浏览器渲染机制

【性能类】—浏览器渲染机制

一、什么是DOCTYPE及作用 DTD（文档类型定义）：是一系列的语法规则，用来定义XML或HTML的文档类型。浏览器会使用它来判断文档类型，决定使用何种协议来解析，以及切换浏览器模式 解释：DTD就定义DOC…
阅读更多...
【13】SAP ABAP性能优化 - 共享对象 （Shared Objects）

【13】SAP ABAP性能优化 - 共享对象 （Shared Objects）

1. 背景 “共享对象”是NetWeaver 6.40以上版本ABAP编程中的一个技术，在"共享对象"概念出来之前，在ABAP中可以通过EXPORT和IMPORT这样的关键字去访问服务器上的共享内存，实现不同进程中的数据交互。有关这方面的概念，我…
阅读更多...
5分钟，带你了解低代码开发

5分钟，带你了解低代码开发

在传统的理解中，企业内数字化应用的开发和迭代应该是 IT 部门的工作，但事实并非如此。一方面，激烈的市场竞争和反复出现的疫情给数字化提出了新的要求；另一方面，五花八门的零代码、低代码工具正如雨后春笋一般出现&…
阅读更多...
【设计模式】——模板模式

【设计模式】——模板模式

什么是模板模式？ 模板方法模式（Template Method Pattern），又叫模板模式(Template Pattern)，在一个抽象类公开定义了执行它的方法的模板。它的子类可以按需要重写方法实现，但调用将以抽象类中定义的方式进行…
阅读更多...
代码审计-RCE命令执行漏洞审计

代码审计-RCE命令执行漏洞审计

代码审计必备知识点： 1、代码审计开始前准备： 环境搭建使用，工具插件安装使用，掌握各种漏洞原理及利用,代码开发类知识点。 2、代码审计前信息收集： 审计目标的程序名，版本，当前环境(系统,中间件…
阅读更多...
通达信上涨回调选股公式，趋势指标和摆动指标结合使用

通达信上涨回调选股公式，趋势指标和摆动指标结合使用

在前面的文章中，介绍了赫尔均线 (HMA)和随机RSI(StochRSI)，这两个指标分别属于趋势指标和摆动指标。趋势指标和摆动指标是技术分析中常用的两类指标，用于分析市场的走势和波动，它们的计算方法、应用场景都是有区别的。今天利用两类…
阅读更多...
架构实践方法

架构实践方法

一、识别复杂度 将主要的复杂度问题列出来，然后根据业务、技术、团队等综合情况进行排序，优先解决当前面临的最主要的复杂度问题。对于按照复杂度优先级解决的方式，存在一个普遍的担忧：如果按照优先级来解决复杂度，可…
阅读更多...
从安装 Seata 开始的分布式事务之旅 springboot集成seata

从安装 Seata 开始的分布式事务之旅 springboot集成seata

从安装 Seata 开始的分布式事务之旅 介绍什么是 Seata？ 安装 Seata Server下载 Seata Server 发行版配置Seata解压文件配置Seata的yml文件把配置文件config.txt加载到nacos上修改config.txt文件加载到nacos上 启动Seata服务正常启动查看启动日志打开控制台页面 启动…
阅读更多...
使用 PowerShell 将 Excel 中的每个工作表单独另存为独立的文件

使用 PowerShell 将 Excel 中的每个工作表单独另存为独立的文件

导语：在日常工作中，我们经常需要处理 Excel 文件。本文介绍了如何使用 PowerShell 脚本将一个 Excel 文件中的每个工作表单独另存为独立的 Excel 文件，以提高工作效率。 1. 准备工作 在开始之前，请确保已经安装了 Microsoft Exc…
阅读更多...
IMV7.0

IMV7.0

一、背景 经历了多个版本，基础内容在前面，可以使用之前的基础环境： v1： https://blog.csdn.net/wtt234/article/details/132139454 v2： https://blog.csdn.net/wtt234/article/details/132144907 v3： https…
阅读更多...
Vue调用硬件 接口报错

Vue调用硬件 接口报错

谷歌浏览器调用硬件报错 报错原因 调用身份证读卡器，使用谷歌浏览器 读卡器硬件的接口 有几率是被谷歌拦截 所以报错 在谷歌地址栏输入 chrome://flags/ 搜索 block 找到这个选项 切换状态之后重启浏览器即可 当时找的这篇文章 解决问题 参考链接 如果大家的问题没…
阅读更多...
2023集成电路产业发展与产教融合高峰论坛会议顺利举行

2023集成电路产业发展与产教融合高峰论坛会议顺利举行

8月5日，由中国半导体行业协会和市政府共同主办，天水师范学院、天水华天科技股份有限公司、杭州加速科技有限公司承办的2023集成电路产业发展与产教融合高峰论坛在天水举行。天水市委书记冯文戈，教育部学生服务与素质发展中心副主任方伟&#…
阅读更多...
untiy 连接两个UI或一段固定一段跟随鼠标移动的线段

untiy 连接两个UI或一段固定一段跟随鼠标移动的线段

注意，仅适用于UI，且Canvas必须是Camera模式，不能用在3D物体上，3D物体请使用LineRenender 先创建一个图片，将锚点固定在左边 然后在脚本中添加如下内容 public RectTransform startObj;//起点物体public RectTransfor…
阅读更多...
软件测试基本准侧与方法摘录

软件测试基本准侧与方法摘录

软件测试基本准侧与方法的摘录（应用实例待补充） 写在最开始：“测试是为发现错误而执行程序的过程”。————《软件测试的艺术》 🤩 本文中很多概念描述摘抄自还有很多概念没有列举。已写的部分概念缺少相应的实例，尚…
阅读更多...
Java课题笔记~ Spring事务的程序举例环境搭建

Java课题笔记~ Spring事务的程序举例环境搭建

举例：购买商品 trans_sale 项目 本例要实现购买商品，模拟用户下订单，向订单表添加销售记录，从商品表减少库存。 实现步骤： Step0：创建数据库表 创建两个数据库表 sale , goods sale 销售表：…
阅读更多...
2021年03月 Python（一级）真题解析#中国电子学会#全国青少年软件编程等级考试

2021年03月 Python（一级）真题解析#中国电子学会#全国青少年软件编程等级考试

一、单选题（共25题，每题2分，共50分） 第1题 下列哪个操作不能退出IDLE环境？ A：AltF4 B：CtrlQ C：按ESC键 D：exit() 正确的答案是：B：CtrlQ 解…
阅读更多...
LM2596S-adj电源芯片应用电路

LM2596S-adj电源芯片应用电路

手边有两块降压电源模块，使用芯片为LM2596S-adj，手册中给的使用电路为： 市面上买到的模块为： 电路为： 对比后发现苏守坤博客中存在错误，原博客中实物图应为输出可调的电源模块，博主所画原理…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023