Go-Zero技能提升：深度探究goctl的妙用，轻松应对微服务开发挑战！（三）

ops/2024/9/25 11:18:00/

前言

有位同学在群里说：“Go-Zero官方文档太简洁了，对小白有点不友好。好奇你们是怎么学习的？项目是怎么封装的？有什么提高开发效率的技巧吗？”。

来来来，这期内容给你安排上，先教你goctl的妙用！

前两篇文章分享了 Go-Zero微服务快速入门和最佳实践（一） 和 Go-Zero从0到1实现微服务项目开发（二）。

本文将继续深入探讨Go-Zero的强大，并带你从0到1学会使用goctl。

通过本文的教程，你将能够亲自实践并完成goctl生成模板代码，进一步提升你的开发效率。

概述

goctl 是 go-zero 的内置脚手架，是提升开发效率的一大利器，可以一键生成代码、文档、部署 k8s yaml、dockerfile 等。

官方文档：goctl 安装 | go-zero Documentation

goctl_17">goctl安装

go install github.com/zeromicro/go-zero/tools/goctl@latest

验证

goctl --version

goctl_28">goctl使用实战

接下来和我使用goctl实现快速搭建api服务、rpc服务脚手架以及model代码的生成：

goctl_api_30">goctl api

goctl api是goctl中的核心模块之一，通过该命令可以快速生成一个api演示项目。

我们可以通过goctl api --help查看goctl api的所有指令。

goctl api --help

goctl_api_new_37">goctl api new

用于快速生成 Go HTTP 服务，需要指定服务名称，输出目录为当前工作目录。

  • 创建demo服务
goctl api new demo

这样在当前目录下就能够生成demo的api服务了。

下图为生成的项目目录结构:

  • 在logic下面的demologic.go编写逻辑
func (l *DemoLogic) Demo(req *types.Request) (resp *types.Response, err error) {// todo: add your logic here and delete this linereturn &types.Response{Message: "hello world",}, nil
}
  • 启动服务
# 跳到demo服务根目录
cd demo
# 启动服务（默认8888端口，可在etc/demo-api.yaml配置）
go run demo.go -f etc/demo-api.yaml
  • 访问服务
http://localhost:8888/from/you

至此一个Go-Zero的单体服务就完成啦。

goctl_api_doc_74">goctl api doc

  • 根据 api 文件生成 markdown 文档。
  • -dir表示文档输出目录
goctl api doc -dir ./

goctl_api_go_83">goctl api go

根据api文件生成Go HTTP代码。-api表示api文件路径，-dir表示代码输出目录，–style表示输出文件和目录的命名风格格式化符号。

详情见 文件风格

–home表示自定义模板文件目录（自定义模板我们会在后续进行讲解，别忘了关注我）

  • 修改demo.api文件内容，增加一个post接口
type PostDemoReq {Message string `json:"message"`
}type PostDemoResp {Message string `json:"message"`
}service demo-api {@handler PostDemoHandlerpost /postDemo(PostDemoReq) returns (PostDemoResp)
}
  • 重新生成代码
cd demo
goctl api go -api demo.api -dir . -style gozero

会生成这两个文件

  • 修改logic逻辑
func (l *PostDemoLogic) PostDemo(req *types.PostDemoReq) (resp *types.PostDemoResp, err error) {// todo: add your logic here and delete this linereturn &types.PostDemoResp{Message: req.Message,}, nil
}
  • 重新启动服务
go run demo.go -f etc/demo-api.yaml
  • 使用ApiFox发起请求

至此我们已经学会怎么创建单体服务，并创建get和post接口啦，已经能应对大多数单体项目的开发需求。

当然我们做接口测试的时候一个个手动输入到ApiFox十分麻烦，这时候我们可以借助goctl api的插件生成swagger导入到ApiFox当中。

生成swagger文档

goctl-swagger 用于一键生成 api 的 swagger 文档

安装goctl-swagger

  1. 编译goctl-swagger插件
GOPROXY=https://goproxy.cn/,direct go install github.com/zeromicro/goctl-swagger@latest
  1. 配置环境
    将$GOPATH/bin中的goctl-swagger添加到环境变量

使用goctl-swagger生成swagger.json

goctl api plugin -plugin goctl-swagger="swagger -filename demo.json" -api demo.api -dir .

生成如下文档

  1. 导入ApiFox

  1. 导入demo.json

  1. 配置开发环境路由前缀

6.进行接口测试

goctl_rpc_178">goctl rpc

goctl rpc 是 goctl 中的核心模块之一，其可以通过 .proto 文件一键快速生成一个 rpc 服务，如果仅仅是启动一个 go-zero 的 rpc 演示项目， 你甚至都不用编码，就可以完成一个 rpc 服务开发及正常运行。

goctl_rpc_new_180">goctl rpc new

  • 快速生成一个 rpc 服务，其接收一个终端参数来指定服务名称。
goctl rpc new RPCDemo
  • 生成项目目录结构如下图所示

goctl_rpc_o_189">goctl rpc -o

用于快速生成一个 proto 模板文件，其接收一个 proto 文件名称参数。

goctl rpc -o demoProto.proto
  • 会在相同目录下生成proto模板文件

goctl_rpc_protoc_198">goctl rpc protoc

  • 根据 protobufer 文件生成 rpc 服务。
cd .\RPCDemo
goctl rpc protoc RPCDemo.proto --go_out=./ --go-grpc_out=./  --zrpc_out=./ --style=goZero

  • 由于没安装Etcd，因此我们把etc/rpcdemo.yaml的Etcd相关配置注释掉

  • 在logic/pingLogic.go修改为如下逻辑
func (l *PingLogic) Ping(in *rPCDemo.Request) (*rPCDemo.Response, error) {// todo: add your logic here and delete this linereturn &rPCDemo.Response{Pong: in.Ping,}, nil
}
  • 运行服务
cd .\RPCDemo
go run .
  • 项目默认跑在8080端口，可根据需求修改

将proto导入ApiFox进行测试

  • 新建项目

  • 新建gRPC项目

  • 添加项目中的RPCDemo.proto

  • 右上角选择环境

  • 测试接口

  • 至此，我们已经能够根据proto文件生成gRPC接口并进行测试啦。

goctl_model_255">goctl model

goctl model 为 goctl 提供的数据库模型代码生成指令，目前支持 MySQL、PostgreSQL、Mongo 的代码生成，MySQL 支持从 sql 文件和数据库连接两种方式生成，PostgreSQL 仅支持从数据库连接生成。

本文主要以MySQL为数据表来源生成代码，其他数据库类似。

  • 创建genModel文件夹

  • 生成代码。对应位置的MySQL连接参数改为你的即可。-table表示你的表名，-dir表示生成代码的输出目录 -cache表示是否生成带缓存的代码
goctl model mysql datasource -url="root:PXDN93VRKUm8TeE7@tcp(127.0.0.1:33069)/lottery" -table="lottery" -dir="./genModel" -cache=true --style=goZero
  • 显示Done.说明成功。

至此我们成功使用goctl model根据数据库中的数据表生成了model 代码。

后续通过修改模板代码我们可以实现生成代码的定制化需求，记得关注我！

总结

这篇文章相比官方文档，详细介绍了如何使用Go-Zero的goctl工具进行api服务、rpc服务和model层代码的生成，以及生成swagger文件，并提供了Demo进行实际操作。

我将继续更新Go-Zero系列文章，如果你对Go语言或者微服务感兴趣，欢迎关注我，也欢迎直接私信我。

微信：wangzhongyang1993


http://www.ppmy.cn/ops/35766.html

相关文章

计算机系列之数据结构

计算机系列之数据结构

19、数据结构（重点、考点） 1、线性结构 线性结构：每个元素最多只有一个出度和一个入读，表现为一条线状。线性表按存储方式分为顺序表和链表。 1、顺序存储和链式存储 存储结构： 顺序存储：用一组地址连续…
阅读更多...
11个值得关注的文本转语音AI大模型

11个值得关注的文本转语音AI大模型

语言模型，尤其是大型语言模型（LLM），本质上已经成为人工智能的代表。然而，他们有一个隐秘的问题。到目前为止，人工智能社区主要在文本数据上训练人工智能，而忽略了音频数据。结果，我们…
阅读更多...
面试集中营—Spring篇

面试集中营—Spring篇

Spring 框架的好处 1、轻量：spring是轻量的，基本的版本大约2MB； 2、IOC：控制反转，Spring的IOC机制使得对象之间的依赖不再需要我们自己来控制了，而是由容易来控制，一个字：爽&#xf…
阅读更多...
常用的预编码算法学习

常用的预编码算法学习

一、概况 预编码算法的常用实现方式有以下几种： 1. 间隔预编码（Interval Pre-coding）：该算法将原始数据分成若干个间隔，然后对每个间隔内的数据进行编码。间隔的长度可以根据具体情况进行选择，常见的间隔长度有固定长度和可变长度两种方式。 2. 迭代预编码（Iterative…
阅读更多...
C#知识|上位机UI设计-详情窗体设计思路及流程（实例）

C#知识|上位机UI设计-详情窗体设计思路及流程（实例）

哈喽，你好啊，我是雷工！ 上两节练习记录了登录窗体和主窗体的实现过程，本节继续练习内容窗体的实现，以下为练习笔记。 01 详情窗体效果展示： 02 添加窗体并设置属性 在之前练习项目的基础上添加一个Windows窗体，设置名称为：FrmIPManage.cs 设置窗体的边框和标题栏的外…
阅读更多...
linux/windows安装Tomcat

linux/windows安装Tomcat

安装tomcat 注意版本一致问题 Tomcat 10.1.0-M15(alpha)Tomcat 10.0.x-10.0.21Tomcat 9.0.x-9.0.63Tomcat 8.5.x-8.0.53规范版本 Servlet 6.0,JSP 3.1, EL 5.0 WebSocket 2.1，JASPIC 3.0 Servlet 5.0,JSP 3.0, EL 4.0 WebSocket 2.0，JASPIC 2.0 Serv…
阅读更多...
数据结构九：线性表之链式队列的设计

数据结构九：线性表之链式队列的设计

目录 一、链式队列的基本概念和结构 1.1 链式队列的基本概念 1.2 链式队列的优点 1.3 链式队列的实现方式及结构 二、链式队列的接口函数实现 2.1 链式队列的接口函数 2.2 链式队列的设计（结构体） 2.3 链式队列的初始化 2.4 入队 2.5 出队 …
阅读更多...
数据结构-树概念基础知识

数据结构-树概念基础知识

根结点：非空树中无前驱节点的结点 结点度：结点拥有的子树数或子节点数或后继节点数 树的度：树内各结点的度的最大值 叶子：终端节点，度为0 祖先：从根到该节点所经分支上的所有结点 子孙：以某结点…
阅读更多...
最新文章

Copyright @ 2022~2023