搜索

带你十天轻松搞定 Go 微服务系列（四）

Go语言精选

共 14081字，需浏览 29分钟

 ·

2022-02-21 21:03

序言

我们通过一个系列文章跟大家详细展示一个 go-zero 微服务示例，整个系列分十篇文章，目录结构如下：

  1. 环境搭建：带你十天轻松搞定 Go 微服务系列（一）
  2. 服务拆分：带你十天轻松搞定 Go 微服务系列（二）
  3. 用户服务：带你十天轻松搞定 Go 微服务系列（三）
  4. 产品服务（本文）
  5. 订单服务
  6. 支付服务
  7. RPC 服务 Auth 验证
  8. 服务监控
  9. 链路追踪
  10. 分布式事务

期望通过本系列带你在本机利用 Docker 环境利用 go-zero 快速开发一个商城系统，让你快速上手微服务。

完整示例代码：https://github.com/nivin-studio/go-zero-mall

首先，我们来看一下整体的服务拆分图：

4. 产品服务（product）

  • 进入服务工作区
$ cd mall/service/product

4.1 生成 product model 模型

  • 创建 sql 文件
$ vim model/product.sql
  • 编写 sql 文件
CREATE TABLE `product` (
 `id` bigint unsigned NOT NULL AUTO_INCREMENT,
 `name` varchar(255)  NOT NULL DEFAULT '' COMMENT '产品名称',
 `desc` varchar(255)  NOT NULL DEFAULT '' COMMENT '产品描述',
        `stock` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '产品库存',
 `amount` int(10) unsigned NOT NULL DEFAULT '0'  COMMENT '产品金额',
 `status` tinyint(3) unsigned NOT NULL DEFAULT '0' COMMENT '产品状态',
 `create_time` timestamp NULL DEFAULT CURRENT_TIMESTAMP,
 `update_time` timestamp NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
 PRIMARY KEY (`id`)
) ENGINE=InnoDB  DEFAULT CHARSET=utf8mb4;
  • 运行模板生成命令
$ goctl model mysql ddl -src ./model/product.sql -dir ./model -c

4.2 生成 product api 服务

  • 创建 api 文件
$ vim api/product.api
  • 编写 api 文件
type (
 // 产品创建
 CreateRequest {
  Name   string `json:"name"`
  Desc   string `json:"desc"`
  Stock  int64  `json:"stock"`
  Amount int64  `json:"amount"`
  Status int64  `json:"status"`
 }
 CreateResponse {
  Id int64 `json:"id"`
 }
 // 产品创建

 // 产品修改
 UpdateRequest {
  Id     int64  `json:"id"`
  Name   string `json:"name,optional"`
  Desc   string `json:"desc,optional"`
  Stock  int64  `json:"stock"`
  Amount int64  `json:"amount,optional"`
  Status int64  `json:"status,optional"`
 }
 UpdateResponse {
 }
 // 产品修改

 // 产品删除
 RemoveRequest {
  Id int64 `json:"id"`
 }
 RemoveResponse {
 }
 // 产品删除

 // 产品详情
 DetailRequest {
  Id int64 `json:"id"`
 }
 DetailResponse {
  Id     int64  `json:"id"`
  Name   string `json:"name"`
  Desc   string `json:"desc"`
  Stock  int64  `json:"stock"`
  Amount int64  `json:"amount"`
  Status int64  `json:"status"`
 }
 // 产品详情
)

@server(
 jwt: Auth
)
service Product {
 @handler Create
 post /api/product/create(CreateRequest) returns (CreateResponse)
 
 @handler Update
 post /api/product/update(UpdateRequest) returns (UpdateResponse)
 
 @handler Remove
 post /api/product/remove(RemoveRequest) returns (RemoveResponse)
 
 @handler Detail
 post /api/product/detail(DetailRequest) returns (DetailResponse)
}
  • 运行模板生成命令
$ goctl api go -api ./api/product.api -dir ./api

4.3 生成 product rpc 服务

  • 创建 proto 文件
$ vim rpc/product.proto
  • 编写 proto 文件
syntax = "proto3";

package productclient;

option go_package = "product";

// 产品创建
message CreateRequest {
    string Name = 1;
    string Desc = 2;
    int64 Stock = 3;
    int64 Amount = 4;
    int64 Status = 5;
}
message CreateResponse {
	int64 id = 1;
}
// 产品创建

// 产品修改
message UpdateRequest {
    int64 id = 1;
    string Name = 2;
    string Desc = 3;
    int64 Stock = 4;
    int64 Amount = 5;
    int64 Status = 6;
}
message UpdateResponse {
}
// 产品修改

// 产品删除
message RemoveRequest {
    int64 id = 1;
}
message RemoveResponse {
}
// 产品删除

// 产品详情
message DetailRequest {
    int64 id = 1;
}
message DetailResponse {
    int64 id = 1;
    string Name = 2;
    string Desc = 3;
    int64 Stock = 4;
    int64 Amount = 5;
    int64 Status = 6;
}
// 产品详情

service Product {
    rpc Create(CreateRequest) returns(CreateResponse);
    rpc Update(UpdateRequest) returns(UpdateResponse);
    rpc Remove(RemoveRequest) returns(RemoveResponse);
    rpc Detail(DetailRequest) returns(DetailResponse);
}
  • 运行模板生成命令
$ goctl rpc proto -src ./rpc/product.proto -dir ./rpc

4.4 编写 product rpc 服务

4.4.1 修改配置文件

  • 修改 product.yaml 配置文件
$ vim rpc/etc/product.yaml
  • 修改服务监听地址，端口号为0.0.0.0:9001，Etcd 服务配置，Mysql 服务配置，CacheRedis 服务配置
Name: product.rpc
ListenOn: 0.0.0.0:9001

Etcd:
  Hosts:
  - etcd:2379
  Key: product.rpc

Mysql:
  DataSource: root:123456@tcp(mysql:3306)/mall?charset=utf8mb4&parseTime=true&loc=Asia%2FShanghai

CacheRedis:
- Host: redis:6379
  Type: node # node可以不写，可以设为cluster
  # Pass: xxx # 如果有密码

4.4.2 添加 product model 依赖

  • 添加 Mysql 服务配置，CacheRedis 服务配置的实例化
$ vim rpc/internal/config/config.go
package config

import (
 "github.com/tal-tech/go-zero/core/stores/cache"
 "github.com/tal-tech/go-zero/zrpc"
)

type Config struct {
 zrpc.RpcServerConf

 Mysql struct {
  DataSource string
 }
  
 CacheRedis cache.CacheConf
}
  • 注册服务上下文 product model 的依赖
$ vim rpc/internal/svc/servicecontext.go
package svc

import (
 "mall/service/product/model"
 "mall/service/product/rpc/internal/config"

 "github.com/tal-tech/go-zero/core/stores/sqlx"
)

type ServiceContext struct {
 Config config.Config
    
 ProductModel model.ProductModel
}

func NewServiceContext(c config.Config) *ServiceContext {
 conn := sqlx.NewMysql(c.Mysql.DataSource)
 return &ServiceContext{
  Config:       c,
  ProductModel: model.NewProductModel(conn, c.CacheRedis),
 }
}

4.4.3 添加产品创建逻辑 Create

$ vim rpc/internal/logic/createlogic.go
package logic

import (
 "context"

 "mall/service/product/model"
 "mall/service/product/rpc/internal/svc"
 "mall/service/product/rpc/product"

 "github.com/tal-tech/go-zero/core/logx"
 "google.golang.org/grpc/status"
)

type CreateLogic struct {
 ctx    context.Context
 svcCtx *svc.ServiceContext
 logx.Logger
}

func NewCreateLogic(ctx context.Context, svcCtx *svc.ServiceContext) *CreateLogic {
 return &CreateLogic{
  ctx:    ctx,
  svcCtx: svcCtx,
  Logger: logx.WithContext(ctx),
 }
}

func (l *CreateLogic) Create(in *product.CreateRequest) (*product.CreateResponse, error) {
 newProduct := model.Product{
  Name:   in.Name,
  Desc:   in.Desc,
  Stock:  in.Stock,
  Amount: in.Amount,
  Status: in.Status,
 }

 res, err := l.svcCtx.ProductModel.Insert(&newProduct)
 if err != nil {
  return nil, status.Error(500, err.Error())
 }

 newProduct.Id, err = res.LastInsertId()
 if err != nil {
  return nil, status.Error(500, err.Error())
 }

 return &product.CreateResponse{
  Id: newProduct.Id,
 }, nil
}

4.4.4 添加产品详情逻辑 Detail

$ vim rpc/internal/logic/detaillogic.go
package logic

import (
 "context"

 "mall/service/product/model"
 "mall/service/product/rpc/internal/svc"
 "mall/service/product/rpc/product"

 "github.com/tal-tech/go-zero/core/logx"
 "google.golang.org/grpc/status"
)

type DetailLogic struct {
 ctx    context.Context
 svcCtx *svc.ServiceContext
 logx.Logger
}

func NewDetailLogic(ctx context.Context, svcCtx *svc.ServiceContext) *DetailLogic {
 return &DetailLogic{
  ctx:    ctx,
  svcCtx: svcCtx,
  Logger: logx.WithContext(ctx),
 }
}

func (l *DetailLogic) Detail(in *product.DetailRequest) (*product.DetailResponse, error) {
 // 查询产品是否存在
 res, err := l.svcCtx.ProductModel.FindOne(in.Id)
 if err != nil {
  if err == model.ErrNotFound {
   return nil, status.Error(100, "产品不存在")
  }
  return nil, status.Error(500, err.Error())
 }

 return &product.DetailResponse{
  Id:     res.Id,
  Name:   res.Name,
  Desc:   res.Desc,
  Stock:  res.Stock,
  Amount: res.Amount,
  Status: res.Status,
 }, nil
}

4.4.5 添加产品更新逻辑 Update

$ vim rpc/internal/logic/updatelogic.go
package logic

import (
 "context"

 "mall/service/product/model"
 "mall/service/product/rpc/internal/svc"
 "mall/service/product/rpc/product"

 "github.com/tal-tech/go-zero/core/logx"
 "google.golang.org/grpc/status"
)

type UpdateLogic struct {
 ctx    context.Context
 svcCtx *svc.ServiceContext
 logx.Logger
}

func NewUpdateLogic(ctx context.Context, svcCtx *svc.ServiceContext) *UpdateLogic {
 return &UpdateLogic{
  ctx:    ctx,
  svcCtx: svcCtx,
  Logger: logx.WithContext(ctx),
 }
}

func (l *UpdateLogic) Update(in *product.UpdateRequest) (*product.UpdateResponse, error) {
 // 查询产品是否存在
 res, err := l.svcCtx.ProductModel.FindOne(in.Id)
 if err != nil {
  if err == model.ErrNotFound {
   return nil, status.Error(100, "产品不存在")
  }
  return nil, status.Error(500, err.Error())
 }

 if in.Name != "" {
  res.Name = in.Name
 }
 if in.Desc != "" {
  res.Desc = in.Desc
 }
 if in.Stock != 0 {
  res.Stock = in.Stock
 }
 if in.Amount != 0 {
  res.Amount = in.Amount
 }
 if in.Status != 0 {
  res.Status = in.Status
 }

 err = l.svcCtx.ProductModel.Update(res)
 if err != nil {
  return nil, status.Error(500, err.Error())
 }

 return &product.UpdateResponse{}, nil
}

4.4.6 添加产品删除逻辑 Remove

$ vim rpc/internal/logic/removelogic.go
package logic

import (
 "context"

 "mall/service/product/model"
 "mall/service/product/rpc/internal/svc"
 "mall/service/product/rpc/product"

 "github.com/tal-tech/go-zero/core/logx"
 "google.golang.org/grpc/status"
)

type RemoveLogic struct {
 ctx    context.Context
 svcCtx *svc.ServiceContext
 logx.Logger
}

func NewRemoveLogic(ctx context.Context, svcCtx *svc.ServiceContext) *RemoveLogic {
 return &RemoveLogic{
  ctx:    ctx,
  svcCtx: svcCtx,
  Logger: logx.WithContext(ctx),
 }
}

func (l *RemoveLogic) Remove(in *product.RemoveRequest) (*product.RemoveResponse, error) {
 // 查询产品是否存在
 res, err := l.svcCtx.ProductModel.FindOne(in.Id)
 if err != nil {
  if err == model.ErrNotFound {
   return nil, status.Error(100, "产品不存在")
  }
  return nil, status.Error(500, err.Error())
 }

 err = l.svcCtx.ProductModel.Delete(res.Id)
 if err != nil {
  return nil, status.Error(500, err.Error())
 }

 return &product.RemoveResponse{}, nil
}

4.5 编写 product api 服务

4.5.1 修改配置文件

  • 修改 product.yaml 配置文件
$ vim api/etc/product.yaml
  • 修改服务地址，端口号为0.0.0.0:8001，Mysql 服务配置，CacheRedis 服务配置，Auth 验证配置
Name: Product
Host: 0.0.0.0
Port: 8001

Mysql:
  DataSource: root:123456@tcp(mysql:3306)/mall?charset=utf8mb4&parseTime=true&loc=Asia%2FShanghai

CacheRedis:
- Host: redis:6379
  Type: node # node可以不写，可以设为cluster
  # Pass: xxx # 如果有密码

Auth:
  AccessSecret: uOvKLmVfztaXGpNYd4Z0I1SiT7MweJhl
  AccessExpire: 86400

4.5.2 添加 product rpc 依赖

  • 添加 product rpc 服务配置
$ vim api/etc/product.yaml
Name: Product
Host: 0.0.0.0
Port: 8001
...
ProductRpc:
  Etcd:
    Hosts:
    - etcd:2379
    Key: product.rpc
  • 添加 product rpc 服务配置的实例化
$ vim api/internal/config/config.go
package config

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

type Config struct {
 rest.RestConf

 Auth struct {
  AccessSecret string
  AccessExpire int64
 }

 ProductRpc zrpc.RpcClientConf
}
  • 注册服务上下文 product rpc 的依赖
$ vim api/internal/svc/servicecontext.go
package svc

import (
 "mall/service/product/api/internal/config"
 "mall/service/product/rpc/productclient"

 "github.com/tal-tech/go-zero/zrpc"
)

type ServiceContext struct {
 Config config.Config
    
 ProductRpc productclient.Product
}

func NewServiceContext(c config.Config) *ServiceContext {
 return &ServiceContext{
  Config:     c,
  ProductRpc: productclient.NewProduct(zrpc.MustNewClient(c.ProductRpc)),
 }
}

4.5.3 添加产品创建逻辑 Create

$ vim api/internal/logic/createlogic.go
package logic

import (
 "context"

 "mall/service/product/api/internal/svc"
 "mall/service/product/api/internal/types"
 "mall/service/product/rpc/product"

 "github.com/tal-tech/go-zero/core/logx"
)

type CreateLogic struct {
 logx.Logger
 ctx    context.Context
 svcCtx *svc.ServiceContext
}

func NewCreateLogic(ctx context.Context, svcCtx *svc.ServiceContext) CreateLogic {
 return CreateLogic{
  Logger: logx.WithContext(ctx),
  ctx:    ctx,
  svcCtx: svcCtx,
 }
}

func (l *CreateLogic) Create(req types.CreateRequest) (resp *types.CreateResponse, err error) {
 res, err := l.svcCtx.ProductRpc.Create(l.ctx, &product.CreateRequest{
  Name:   req.Name,
  Desc:   req.Desc,
  Stock:  req.Stock,
  Amount: req.Amount,
  Status: req.Status,
 })
 if err != nil {
  return nil, err
 }

 return &types.CreateResponse{
  Id: res.Id,
 }, nil
}

4.5.4 添加产品详情逻辑 Detail

$ vim api/internal/logic/detaillogic.go
package logic

import (
 "context"

 "mall/service/product/api/internal/svc"
 "mall/service/product/api/internal/types"
 "mall/service/product/rpc/product"

 "github.com/tal-tech/go-zero/core/logx"
)

type DetailLogic struct {
 logx.Logger
 ctx    context.Context
 svcCtx *svc.ServiceContext
}

func NewDetailLogic(ctx context.Context, svcCtx *svc.ServiceContext) DetailLogic {
 return DetailLogic{
  Logger: logx.WithContext(ctx),
  ctx:    ctx,
  svcCtx: svcCtx,
 }
}

func (l *DetailLogic) Detail(req types.DetailRequest) (resp *types.DetailResponse, err error) {
 res, err := l.svcCtx.ProductRpc.Detail(l.ctx, &product.DetailRequest{
  Id: req.Id,
 })
 if err != nil {
  return nil, err
 }

 return &types.DetailResponse{
  Id:     res.Id,
  Name:   res.Name,
  Desc:   res.Desc,
  Stock:  res.Stock,
  Amount: res.Amount,
  Status: res.Status,
 }, nil
}

4.5.5 添加产品更新逻辑 Update

$ vim api/internal/logic/updatelogic.go
package logic

import (
 "context"

 "mall/service/product/api/internal/svc"
 "mall/service/product/api/internal/types"
 "mall/service/product/rpc/product"

 "github.com/tal-tech/go-zero/core/logx"
)

type UpdateLogic struct {
 logx.Logger
 ctx    context.Context
 svcCtx *svc.ServiceContext
}

func NewUpdateLogic(ctx context.Context, svcCtx *svc.ServiceContext) UpdateLogic {
 return UpdateLogic{
  Logger: logx.WithContext(ctx),
  ctx:    ctx,
  svcCtx: svcCtx,
 }
}

func (l *UpdateLogic) Update(req types.UpdateRequest) (resp *types.UpdateResponse, err error) {
 _, err = l.svcCtx.ProductRpc.Update(l.ctx, &product.UpdateRequest{
  Id:     req.Id,
  Name:   req.Name,
  Desc:   req.Desc,
  Stock:  req.Stock,
  Amount: req.Amount,
  Status: req.Status,
 })
 if err != nil {
  return nil, err
 }

 return &types.UpdateResponse{}, nil
}

4.5.6 添加产品删除逻辑 Remove

$ vim api/internal/logic/removelogic.go
package logic

import (
 "context"

 "mall/service/product/api/internal/svc"
 "mall/service/product/api/internal/types"
 "mall/service/product/rpc/product"

 "github.com/tal-tech/go-zero/core/logx"
)

type RemoveLogic struct {
 logx.Logger
 ctx    context.Context
 svcCtx *svc.ServiceContext
}

func NewRemoveLogic(ctx context.Context, svcCtx *svc.ServiceContext) RemoveLogic {
 return RemoveLogic{
  Logger: logx.WithContext(ctx),
  ctx:    ctx,
  svcCtx: svcCtx,
 }
}

func (l *RemoveLogic) Remove(req types.RemoveRequest) (resp *types.RemoveResponse, err error) {
 _, err = l.svcCtx.ProductRpc.Remove(l.ctx, &product.RemoveRequest{
  Id: req.Id,
 })
 if err != nil {
  return nil, err
 }

 return &types.RemoveResponse{}, nil
}

4.6 启动 product rpc 服务

提示：启动服务需要在 golang 容器中启动

$ cd mall/service/product/rpc
$ go run product.go -f etc/product.yaml
Starting rpc server at 127.0.0.1:9001...

4.7 启动 product api 服务

提示：启动服务需要在 golang 容器中启动

$ cd mall/service/product/api
$ go run product.go -f etc/product.yaml
Starting server at 0.0.0.0:8001...

项目地址

https://github.com/zeromicro/go-zero

欢迎使用 go-zero 并 star 支持我们！


推荐阅读


福利

我为大家整理了一份从入门到进阶的Go学习资料礼包，包含学习建议：入门看什么，进阶看什么。关注公众号 「polarisxu」，回复 ebook 获取；还可以回复「进群」，和数万 Gopher 交流学习。

浏览 19
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报
评论
图片
表情
推荐
Go chassis 微服务开发框架实战系列（一）
GoCN
0
「2022 版」轻松搞定 Go 开发环境
polarisxu
0
《Go 开源说 2022》预告「微服务框架」系列之第二期：轻量级 Go 微服务框架——Kratos
GoCN
0
"服务不可用"怎么排查？5招教你轻松搞定！
测试开发技术
0
图解 Go 微服务熔断器
polarisxu
0
室内5G？轻松搞定！
物联网智库
0
带你轻松入门Nginx
Java技术迷
0
Java微服务 vs Go微服务，究竟谁更强！？
公众号程序猿DD
0
「免费」微服务容器化系列视频
JAVA架构日记
0
《Go 开源说 2022》预告「微服务框架」系列之第三期：面向微服务开发场景——Tars-go
GoCN
0
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报