微服务

在上一篇我们已经演示了怎样快速创建一个单体服务,接下来我们来演示一下如何快速创建微服务, 在本小节中,api部分其实和单体服务的创建逻辑是一样的,只是在单体服务中没有服务间的通讯而已, 且微服务中api服务会多一些rpc调用的配置。

前言

本小节将以一个订单服务调用用户服务来简单演示一下,演示代码仅传递思路,其中有些环节不会一一列举。

情景提要

假设我们在开发一个商城项目,而开发者小明负责用户模块(user)和订单模块(order)的开发,我们姑且将这两个模块拆分成两个微服务①

[注意] ①:微服务的拆分也是一门学问,这里我们就不讨论怎么去拆分微服务的细节了。

演示功能目标

  • 订单服务(order)提供一个查询接口
  • 用户服务(user)提供一个方法供订单服务获取用户信息

服务设计分析

根据情景提要我们可以得知,订单是直接面向用户,通过http协议访问数据,而订单内部需要获取用户的一些基础数据,既然我们的服务是采用微服务的架构设计, 那么两个服务(user, order)就必须要进行数据交换,服务间的数据交换即服务间的通讯,到了这里,采用合理的通讯协议也是一个开发人员需要 考虑的事情,可以通过http,rpc等方式来进行通讯,这里我们选择rpc来实现服务间的通讯,相信这里我已经对”rpc服务存在有什么作用?”已经作了一个比较好的场景描述。 当然,一个服务开发前远不止这点设计分析,我们这里就不详细描述了。从上文得知,我们需要一个

  • user rpc
  • order api

两个服务来初步实现这个小demo。

创建mall工程

如果你跑了单体的示例,里面也叫 go-zero-demo,你可能需要换一个父目录。

  1. $ mkdir go-zero-demo
  2. $ cd go-zero-demo
  3. $ go mod init go-zero-demo

说明:如无 cd 改变目录的操作,所有操作均在 go-zero-demo 目录执行

创建user rpc服务

  • 创建user rpc服务

    1. $ mkdir -p mall/user/rpc
  • 添加user.proto文件,增加getUser方法

    1. $ vim mall/user/rpc/user.proto

    增加如下代码:

    1. syntax = "proto3";
    2. package user;
    3. // protoc-gen-go 版本大于1.4.0, proto文件需要加上go_package,否则无法生成
    4. option go_package = "./user";
    5. message IdRequest {
    6. string id = 1;
    7. }
    8. message UserResponse {
    9. // 用户id
    10. string id = 1;
    11. // 用户名称
    12. string name = 2;
    13. // 用户性别
    14. string gender = 3;
    15. }
    16. service User {
    17. rpc getUser(IdRequest) returns(UserResponse);
    18. }
  • 生成代码

    如未安装 protoc,请参考 https://github.com/protocolbuffers/protobuf/releases 自行安装。 如未安装 protoc-gen-go,请参考 https://grpc.io/docs/languages/go/quickstart/ 自行安装。

    注意:旧版本的 protoc-gen-go 不支持 --go-grpc_out

    1. $ cd mall/user/rpc
    2. $ goctl rpc protoc user.proto --go_out=./types --go-grpc_out=./types --zrpc_out=.
    3. Done.
  • 填充业务逻辑

    1. $ vim internal/logic/getuserlogic.go
    1. package logic
    2. import (
    3. "context"
    4. "go-zero-demo/mall/user/rpc/internal/svc"
    5. "go-zero-demo/mall/user/rpc/types/user"
    6. "github.com/zeromicro/go-zero/core/logx"
    7. )
    8. type GetUserLogic struct {
    9. ctx context.Context
    10. svcCtx *svc.ServiceContext
    11. logx.Logger
    12. }
    13. func NewGetUserLogic(ctx context.Context, svcCtx *svc.ServiceContext) *GetUserLogic {
    14. return &GetUserLogic{
    15. ctx: ctx,
    16. svcCtx: svcCtx,
    17. Logger: logx.WithContext(ctx),
    18. }
    19. }
    20. func (l *GetUserLogic) GetUser(in *user.IdRequest) (*user.UserResponse, error) {
    21. return &user.UserResponse{
    22. Id: "1",
    23. Name: "test",
    24. }, nil
    25. }

创建order api服务

  • 创建 order api服务

    1. # 回到 go-zero-demo/mall 目录
    2. $ mkdir -p order/api && cd order/api
  • 添加api文件

    1. $ vim order.api
    1. type(
    2. OrderReq {
    3. Id string `path:"id"`
    4. }
    5. OrderReply {
    6. Id string `json:"id"`
    7. Name string `json:"name"`
    8. }
    9. )
    10. service order {
    11. @handler getOrder
    12. get /api/order/get/:id (OrderReq) returns (OrderReply)
    13. }
  • 生成order服务

    1. $ goctl api go -api order.api -dir .
    2. Done.
  • 添加user rpc配置

    1. $ vim internal/config/config.go
    1. package config
    2. import (
    3. "github.com/zeromicro/go-zero/zrpc"
    4. "github.com/zeromicro/go-zero/rest"
    5. )
    6. type Config struct {
    7. rest.RestConf
    8. UserRpc zrpc.RpcClientConf
    9. }
  • 添加yaml配置

    1. $ vim etc/order.yaml
    1. Name: order
    2. Host: 0.0.0.0
    3. Port: 8888
    4. UserRpc:
    5. Etcd:
    6. Hosts:
    7. - 127.0.0.1:2379
    8. Key: user.rpc
  • 完善服务依赖

    1. $ vim internal/svc/servicecontext.go
    1. package svc
    2. import (
    3. "go-zero-demo/mall/order/api/internal/config"
    4. "go-zero-demo/mall/user/rpc/user"
    5. "github.com/zeromicro/go-zero/zrpc"
    6. )
    7. type ServiceContext struct {
    8. Config config.Config
    9. UserRpc user.User
    10. }
    11. func NewServiceContext(c config.Config) *ServiceContext {
    12. return &ServiceContext{
    13. Config: c,
    14. UserRpc: user.NewUser(zrpc.MustNewClient(c.UserRpc)),
    15. }
    16. }
  • 添加order演示逻辑

    getorderlogic 添加业务逻辑

    1. $ vim internal/logic/getorderlogic.go
    1. package logic
    2. import (
    3. "context"
    4. "errors"
    5. "go-zero-demo/mall/order/api/internal/svc"
    6. "go-zero-demo/mall/order/api/internal/types"
    7. "go-zero-demo/mall/user/rpc/types/user"
    8. "github.com/zeromicro/go-zero/core/logx"
    9. )
    10. type GetOrderLogic struct {
    11. logx.Logger
    12. ctx context.Context
    13. svcCtx *svc.ServiceContext
    14. }
    15. func NewGetOrderLogic(ctx context.Context, svcCtx *svc.ServiceContext) GetOrderLogic {
    16. return GetOrderLogic{
    17. Logger: logx.WithContext(ctx),
    18. ctx: ctx,
    19. svcCtx: svcCtx,
    20. }
    21. }
    22. func (l *GetOrderLogic) GetOrder(req types.OrderReq) (*types.OrderReply, error) {
    23. user, err := l.svcCtx.UserRpc.GetUser(l.ctx, &user.IdRequest{
    24. Id: "1",
    25. })
    26. if err != nil {
    27. return nil, err
    28. }
    29. if user.Name != "test" {
    30. return nil, errors.New("用户不存在")
    31. }
    32. return &types.OrderReply{
    33. Id: req.Id,
    34. Name: "test order",
    35. }, nil
    36. }

启动服务并验证

  • 启动etcd
    1. $ etcd
  • 下载依赖
    1. # 在 go-zero-demo 目录下
    2. $ go mod tidy
  • 启动user rpc

    1. # 在 mall/user/rpc 目录
    2. $ go run user.go -f etc/user.yaml
    3. Starting rpc server at 127.0.0.1:8080...
  • 启动order api

    1. # 在 mall/order/api 目录
    2. $ go run order.go -f etc/order.yaml
    3. Starting server at 0.0.0.0:8888...
  • 访问order api

    1. $ curl -i -X GET http://localhost:8888/api/order/get/1
    2. HTTP/1.1 200 OK
    3. Content-Type: application/json
    4. Date: Sun, 07 Feb 2021 03:45:05 GMT
    5. Content-Length: 30
    6. {"id":"1","name":"test order"}

注意:在演示中的提及的api语法,rpc生成,goctl,goctl环境等怎么使用和安装,快速入门中不作详细概述,我们后续都会有详细的文档进行描述,你也可以点击下文的【猜你想看】快速跳转的对应文档查看。

源码

mall源码

猜你想看