go zero入门

已于 2024-07-08 10:18:24 修改
阅读量545 收藏 7
点赞数 4
分类专栏： go语言 文章标签： golang go 微服务
于 2024-07-05 13:42:25 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Ricardo2/article/details/140188194
版权

一、goctl安装

goctl 是 go-zero 的内置脚手架，可以一键生成代码、文档、部署 k8s yaml、dockerfile 等。

# Go 1.16 及以后版本
go install github.com/zeromicro/go-zero/tools/goctl@latest

检查是否安装成功

$ goctl -v
goctl version 1.6.6 darwin/amd64

vscode安装插件goctl

二、简单的http服务请求

2.1 通过goctl生成api项目

下面利用goctl实现一个单体服务，通过订单id获取订单信息（id、名称、价格）
在order目录下

go mod init order
touch order.api

结构如下

    go-zero
    └── order
        ├── go.mod
        └── order.api

order.api的代码

syntax = "v2"

type (
    // 定义请求体
    OrderInfoReq {
        OrderId int64 'json:"order_id"' // 订单ID  
    }
    // 定义响应体
    OrderInfoResp {
        OrderId int64 'json:"order_id"' // 订单ID
        GoodsName string 'json:"goods_name"' // 商品名称
        Price int64 'json:"price"' // 商品价格
    }
)

// 定义 HTTP 服务
// 微服务名称为 order-api
service order-api {
    // 标记了订单信息查询接口的文档注释。
    @doc(
        summary: "获取订单信息"
    )
    // 指定处理该请求的处理器为orderInfo。
    @handler orderInfo
    // 定义接口
    // 请求方法是post，路径是/order/info，参数是OrderInfoReq，返回值是OrderInfoResp
    post /oder/info (OrderInfoReq) returns (OrderInfoResp)
}

在当前目录下执行

$ goctl api go -api *.api -dir ./  --style=goZero    
Done.

// 下载所需要的依赖
$ go mod tidy

该指令的作用是使用 goctl 工具生成 Go 语言的 API 代码项目

  • api go: 指定生成 Go 语言的 API 代码。
  • -api *.api: 指定输入的 API 描述文件，*.api 表示所有的 .api 文件，可以生成多个 API。
  • -dir ./: 指定输出目录为当前目录 (./)，生成的代码将会放置在当前目录中。
  • --style=goZero: 指定生成代码的风格为 goZero

当前目录生成的api项目结构如下

.
├── etc							// 配置文件
│   └── order-api.yaml
├── go.mod
├── internal
│   ├── config					// 配置对应的数据结构
│   │   └── config.go
│   ├── handler					// http部分的代码
│   │   ├── orderInfoHandler.go
│   │   └── routes.go
│   ├── logic					// 需要自己写的代码逻辑
│   │   └── orderInfoLogic.go
│   ├── svc						// 上下文相关依赖
│   │   └── serviceContext.go
│   └── types
│       └── types.go
├── order.api
└── order.go					// 启动代码

2.2 实现业务逻辑

根据路由追踪到OrderInfo方法，实现业务逻辑
在这里插入图片描述

func (l *OrderInfoLogic) OrderInfo(req *types.OrderInfoReq) (resp *types.OrderInfoResp, err error) {
	// todo: add your logic here and delete this line
	resp  = &types.OrderInfoResp{
		OrderId: req.OrderId,
		GoodsName: "车",
		Price: 100000,
	}
	return resp, nil
}

2.3 执行

// 启动服务
$ go run order.go -f etc/order-api.yaml

etc/order-api.yaml文件定义了启动的端口号和ip

$ curl -X POST -H "Content-Type: application/json" http://localhost:8888/order/info -d '{"order_id":34}'

{"order_id":34,"goods_name":"车","price":100000}%

三、集成Gorm

基于上面的基础，再增加一个功能：记录订单信息（id、名称、价格）到数据库

3.1 配置Gorm

在etc/order-api.yaml文件中配置参数DataSourceName

Name: order-api
Host: 0.0.0.0
Port: 8888
DataSourceName: root:zxm123578@(127.0.0.1:3306)/MING_DB?charset=utf8

在这里插入图片描述
在internal/config/config.go中添加DataSourceName

type Config struct {
	rest.RestConf
	DataSourceName string
}

3.2 启动Gorm支持

在internal目录下新建模型文件models\models.go

package models

import (
	"gorm.io/gorm"
)

type Order struct {
	gorm.Model
	OrderId   int64   `gorm:"index:order_id"`
	GoodsName string  `gorm:"type:varchar(64)"`
	Price     float64 `gorm:"type:decimal(10,2);default:0"`
}

修改svc/servicecontext.go代码如下

package svc

import (
	"order/internal/config"
	"order/internal/models"

	"gorm.io/driver/mysql"
	"gorm.io/gorm"
	"gorm.io/gorm/schema"
)

type ServiceContext struct {
	Config config.Config
	// DbEngin 数据库引擎
	DbEngin *gorm.DB
}

func NewServiceContext(c config.Config) *ServiceContext {
	// 启动Gorm支持
	db, err := gorm.Open(mysql.Open(c.DataSourceName), &gorm.Config{
		NamingStrategy: schema.NamingStrategy{
			TablePrefix:   "o_", // 表名前缀
			SingularTable: true, // 使用单数表名
		},
	})

	if err != nil {
		panic(err)
	}
	//自动同步更新表结构
	db.AutoMigrate(&models.Order{})

	return &ServiceContext{
		Config:  c,
		DbEngin: db,
	}
}

3.3 实现业务逻辑

在logic/orderRecordLogic.go文件实现业务逻辑

func (l *OrderRecordLogic) OrderRecord(req *types.OrderRecordReq) (resp *types.OrderRecordResp, err error) {
	// todo: add your logic here and delete this line
	order := models.Order{
		GoodsName: req.GoodsName,
		Price:     float64(req.Price),
		OrderId:   req.OrderId,
	}

	result := l.svcCtx.DbEngin.Create(&order)
	return &types.OrderRecordResp{
		OrderId: order.OrderId,
	}, result.Error
}

3.4 执行

先启动mysql，再启动服务

// 启动服务
$ go run order.go -f etc/order-api.yaml

$ curl -X POST -H "Content-Type: application/json" http://localhost:8888/order/record -d '{"order_id":34,"goods_name":"手机","price":5000}'

{"order_id":34}%

四、通过api调用rpc服务

上面例子的商品名称是写死的，下面通过调用商品的rpc服务来获取商品信息。

安装protoc
安装etcd

4.1 通过goctl生成rpc服务

在go-zero下新建目录goods

go mod init goods
touch goods.proto

    go-zero
    └── goods
        ├── go.mod
        └── goods.proto
    └── order

goods.proto代码如下

syntax = "proto3";
package goods;
option go_package = "./goods";

// 定义请求体
message GoodsRequest {
  int64 goods_id = 1;
}

// 定义响应体
message GoodsResponse {
    int64 goods_id = 1;
    string goods_name = 2;
    double price = 3;
}

service Goods {
    rpc GetGoods(GoodsRequest) returns (GoodsResponse);
}

在当前目录下使用goctl生成一个rpc项目

goctl rpc protoc *.proto --go_out=./types --go-grpc_out=./types --zrpc_out=.

.
├── etc
│   └── goods.yaml
├── go.mod
├── goods.go
├── goods.proto
├── goodsclient
│   └── goods.go
├── internal
│   ├── config
│   │   └── config.go
│   ├── logic
│   │   └── getgoodslogic.go
│   ├── server
│   │   └── goodsserver.go
│   └── svc
│       └── servicecontext.go
└── types
    └── goods
        ├── goods.pb.go
        └── goods_grpc.pb.go

4.2 实现业务逻辑

在logic/getgoodslogic.go中实现业务逻辑

func (l *GetGoodsLogic) GetGoods(in *goods.GoodsRequest) (*goods.GoodsResponse, error) {
	// todo: add your logic here and delete this line
	resp := &goods.GoodsResponse{
		GoodsId: in.GoodsId,
		GoodsName: "乐高",
		Price: 500,
	}
	return resp, nil
}

4.3 api调用rpc服务

不管是rpc之间的互相调用，还是api调用rpc，我们都需要知道rpc的proto文件。本文通过go work来实现

$ go work init order
$ go work use goods

接下来需要对order的api项目进行修改

1. 修改配置文件order/etc/order-api.yaml

Name: order-api
Host: 0.0.0.0
Port: 8888

DataSourceName: root:zxm123578@(127.0.0.1:3306)/MING_DB?charset=utf8

Etcd:
  Hosts:
  - 127.0.0.1:2379
  Key: goods.rpc

2. 修改order/internal/config/config.go文件

package config

import (
	"github.com/zeromicro/go-zero/rest"
	"github.com/zeromicro/go-zero/zrpc"
)

type Config struct {
	rest.RestConf
	DataSourceName string
	//定义rpc服务
	GoodsRpc zrpc.RpcClientConf
}

3. 修改order/internal/svc/serviceContext.go

package svc

import (
	"goods/goodsclient"

	"order/internal/config"
	"order/internal/models"

	"github.com/zeromicro/go-zero/zrpc"
	"gorm.io/driver/mysql"
	"gorm.io/gorm"
	"gorm.io/gorm/schema"
)

type ServiceContext struct {
	Config config.Config
	// DbEngin 数据库引擎
	DbEngin *gorm.DB
	//定义rpc类型
	Goods goodsclient.Goods
}

func NewServiceContext(c config.Config) *ServiceContext {
	// 启动Gorm支持
	db, err := gorm.Open(mysql.Open(c.DataSourceName), &gorm.Config{
		NamingStrategy: schema.NamingStrategy{
			TablePrefix:   "o_", // 表名前缀
			SingularTable: true, // 使用单数表名
		},
	})

	if err != nil {
		panic(err)
	}
	//自动同步更新表结构
	db.AutoMigrate(&models.Order{})

	return &ServiceContext{
		Config:  c,
		DbEngin: db,
		//引入gprc服务
		Goods: goodsclient.NewGoods(zrpc.MustNewClient(c.GoodsRpc)),
	}
}

4. 修改order/internal/logic/orderInfoLogic.go

func (l *OrderInfoLogic) OrderInfo(req *types.OrderInfoReq) (resp *types.OrderInfoResp, err error) {
	// todo: add your logic here and delete this line
	goodRequest := new(goods.GoodsRequest)
	goodRequest.GoodsId = req.OrderId
	goodsInfo, err := l.svcCtx.Goods.GetGoods(l.ctx, goodRequest)
	if err != nil {
		return nil, err
	}

	resp = &types.OrderInfoResp{
		OrderId:   req.OrderId,
		GoodsName: goodsInfo.GoodsName,
		Price:     goodsInfo.Price,
	}
	return resp, nil
}

4.4 执行

依次启动mysqll、etcd 、rpc和api

$ mysql -u root -p

# goods目录下
$ etcd

# goods目录下
$ go run goods.go -f etc/goods.yaml

# order目录下
$ go run order.go -f etc/order.yaml

通过curl进行post请求，查看结果

$  curl -X POST -H "Content-Type: application/json" http://localhost:8888/order/info -d '{"order_id":34}' 

{"order_id":34,"goods_name":"乐高","price":500}%

五、规范化

上述为了好理解，忽略了一些规范性。实际项目开发中，需要修改的地方：

  1. 应该把数据库的model，放在rpc工程项目下
  2. api调用rpc，除了利用go work，也可以把api和rpc项目都放在xxx文件夹下，然后在xxx文件夹下用go mod init
  3. api对外，rpc对内

具体规范的项目例子，可参考官网的
快速构建微服务-多RPC版

闲谈社
关注
  • 4
    点赞
  • 踩
  • 7
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
go-zero入门教程搭配源码
02-22
go-zero入门教程搭配源码
Go入门到精通-手动整理.pdf
09-06
Go语言，也称为Golang，是由Google开发的一种静态类型的、编译式的、并发型且具有垃圾回收功能的编程语言。它的设计受到了C语言的影响，同时引入了许多现代编程语言的特性，如内置并发机制、垃圾回收、类型安全性...
go-zero入门
qq_47997583的博客
03-05 1088
本文简单介绍了go-zero，以及go-zero相关的安装配置。通过go-zero的hello world级别的一个的单体应用和一个包含两个服务的微服务应用，以实践的方式展示了go-zero项目的入门级搭建。
go-zero微服务入门教程
宋发元
02-22 2130
本教程主要模拟实现用户注册和用户信息查询两个接口。本文源码：https://gitee.com/songfayuan/go-zero-demo （教程源码分支：1.zero入门）这里采用GoLand开发工具，请自行搜索安装插件Goctl。这里采用开发工具GoLand，File > New > Project创建api目录、rpc目录、common目录。 在api目录下创建新目录doc/sys。在api/doc/sys下创建user.api。user.api文件内容如下： 用goctl生成API Gatew
go-zero入门学习教程（看了就会）
最新发布
宋发元
06-12 341
这算是比较完整的入门教程，跟着教程，照葫芦画瓢，多练习几次，自然就记住了。教程源码分支：6.zero整合Excelize操作Excel。教程源码分支：5.zero整合单机ClickHouse。教程源码分支：4.zero整合asynq定时任务。教程源码分支：2.zero整合单机Redis。教程源码分支：3.zero整合单机kafka。新手的话，你得把这个刷完了再继续刷其他的。教程源码分支：1.zero入门。
go-zero学习 — 基础
Mr_XiMu的博客
03-20 2648
go-zero学习 — 基础
go-zero学习 第一章 基础
Mr_XiMu的博客
06-20 3401
go-zero学习 第一章 基础
Go语言入门教程之Arrays、Slices、Maps、Range操作简明总结
01-21
在go语言中数组array是一组特定长度的有序的元素集合。 代码如下: package main import “fmt” func main() {  //这里我们创建了一个长度为5的数组. 这一组数组的初值是zero-valued。整型就是0  var a [5]int  ...
Go语言官方文档学习笔记（第三季）
07-01
Go语言官方文档学习笔记是基于官方文档及个人学习Go的笔记，整理完成的Go语言快速入门课程。   第三季内容包括以下十个部分： 1-Short variable declarations 2-Basic types 3-Zero values 4-Type conversions 5-...
gomr:Golang的MapReduce框架
05-24
入门 要为GoMR编写作业，我们首先需要创建和满足gomr.go找到的接口的对象。 即： type Mapper interface { Map ( in <- chan interface {}, out chan <- interface {}) } type Partitioner interface { ...
go-zero标准的项目结构,以及如何使用docker-compose部署道linux服务器上
c0210g的博客
02-19 801
go-zero标准的项目结构,以及如何使用docker-compose部署道linux服务器上。
推荐开源项目：Go-Zero - 微服务框架与实战指南
gitblog_00090的博客
03-19 474
推荐开源项目：Go-Zero - 微服务框架与实战指南 项目地址:https://gitcode.com/tal-tech/go-zero Go-Zero 是由 TalTech 开发的一个强大且高效的微服务框架，旨在帮助开发者快速构建稳定、可扩展的分布式系统。该项目以其丰富的功能、完善的文档和活跃的社区支持，成为了 Go 语言开发者的热门选择。 项目概述 Go-Zero 提供了全面的微服务基础设施...
go 进阶 go-zero相关: 一. go-zero 基础
qq_29799655的博客
05-10 3252
├── etc│ └── core-api.yaml // 配置文件├── go.mod // mod文件├── greet.api // api描述文件├── core.go // main函数入口├── config│ └── config.go // 配置声明type├── handler // 路由及handler转发├── logic // 业务逻辑├── middleware // 中间件文件├── svc // logic所依赖的资源池。
【go零基础】go-zero从零基础学习到实战教程 - 2项目初始化
van先生的博客
04-25 843
go-zero 0-1实战教程第三弹之项目初始化
goZero入门使用及注意事项
ckckckcckckc的博客
04-01 1454
介绍了gozero框架的入门使用方式，以及在环境配置，网络搭建中的一些常见的注意事项。
go-zero入门1
robinfoxnan的专栏
10-27 1280
go-zero生成一个RPC的测试，测试一下GRPC
golang微服务框架go-zero系列-1:适合创业的golang微服务框架go-zero + 金光灿灿的gorm V2实践
imwinlion && 我是胡文林
09-02 6615
为什么使用go-zero 可以有第三个选择 golang圈子不大,微服务框架框架屈指可数:除了go-micro、go-kit,几乎没有其他选择。go-zero为此提供第三个可能。 go-micro 对webapi支持并不友好，需要运行micro指令,难以定制 创业产品需要一款支持业务成长的框架 我们到底需要什么样的框架?我们需要一款可以支持业务成长的框架!产品运营初期,比如需求验证阶段，我们并不需要采取微服务架构，因为运营成本太高。一款单体应用足以应付。随着业务发展,微服务成为必要,此时我们希望不进行太
Go-Zero实战项目
04-18
Go-Zero是一款基于Golang开发的微服务框架，它提供了一系列的工具和组件，帮助开发者快速构建高性能、可扩展的微服务应用。Go-Zero的设计理念是简单、高效、易用，它采用了一些优秀的开源组件，如gin、gorm等，同时还提供了一些自研的组件，如rpcx、logx等。 Go-Zero实战项目是一个基于Go-Zero框架开发的示例项目，旨在帮助开发者更好地理解和使用Go-Zero框架。该项目包含了常见的微服务应用场景，如用户管理、订单管理等，涵盖了从数据库操作、接口设计到服务调用等方面的内容。 Go-Zero实战项目的特点包括： 1. 结构清晰：项目按照领域驱动设计（DDD）的思想进行组织，将不同的业务模块划分为独立的子域。 2. 组件丰富：项目使用了Go-Zero提供的各种组件，如rpcx、logx、token等，帮助开发者快速搭建微服务应用。 3. 高性能：Go-Zero框架本身就具备高性能的特点，通过合理的设计和优化，可以进一步提升应用的性能。 4. 可扩展：Go-Zero框架支持水平扩展，可以根据实际需求进行集群部署，提高系统的可用性和容错性。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

闲谈社

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值