使用go-chassis框架开发gRPC服务全指南

孔旭澜Renata

于 2025-06-20 09:58:43 发布

阅读量216

点赞数 3

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00073/article/details/148783229

使用go-chassis框架开发gRPC服务全指南

go-chassis a cloud native application framework for Go with rich eco-system 项目地址: https://gitcode.com/gh_mirrors/goc/go-chassis

前言

在现代微服务架构中，gRPC因其高性能、跨语言支持和强类型接口等优势，已成为服务间通信的重要选择。本文将详细介绍如何使用go-chassis框架开发gRPC服务，涵盖从协议定义到服务实现的全过程。

环境准备

在开始之前，请确保已安装以下工具：

Go语言环境（建议1.13+版本）
Protocol Buffer编译器（protoc）
Go语言的protobuf插件

一、定义gRPC协议

1. 项目结构规划

推荐采用以下目录结构组织gRPC协议定义文件：

schemas
`-- helloworld
    `-- helloworld.proto

这种结构清晰地将协议定义文件组织在独立的目录中，便于管理和维护。

2. 编写Protocol Buffer文件

创建helloworld.proto文件，定义服务接口：

syntax = "proto3";

package helloworld;

// 问候服务定义
service Greeter {
  // 发送问候
  rpc SayHello (HelloRequest) returns (HelloReply) {}
}

// 包含用户名的请求消息
message HelloRequest {
  string name = 1;
}

// 包含问候语的响应消息
message HelloReply {
  string message = 1;
}

3. 生成Go代码

使用protoc工具生成Go语言代码：

protoc --go_out=plugins=grpc:. helloworld.proto

执行后会生成helloworld.pb.go文件，将其放入协议目录：

schemas
`-- helloworld
    |-- helloworld.pb.go
    `-- helloworld.proto

4. 修改生成代码

需要将生成的_Greeter_serviceDesc变量名改为Greeter_serviceDesc，以便后续注册服务时使用：

var Greeter_serviceDesc = grpc.ServiceDesc{
    ServiceName: "helloworld.Greeter", // 作为schemaID供消费者调用
    HandlerType: (*GreeterServer)(nil),
    Methods: []grpc.MethodDesc{
        {
            MethodName: "SayHello",
            Handler:    _Greeter_SayHello_Handler,
        },
    },
    Streams:  []grpc.StreamDesc{},
    Metadata: "helloworld.proto",
}

二、服务提供方实现

1. 项目结构

服务提供方推荐采用以下结构：

server
|-- conf
|   |-- chassis.yaml
|   `-- microservice.yaml
`-- main.go

2. 实现服务接口

type Server struct{}

// SayHello 实现helloworld.GreeterServer接口
func (s *Server) SayHello(ctx context.Context, in *pb.HelloRequest) (*pb.HelloReply, error) {
    return &pb.HelloReply{Message: "Hello " + in.Name}, nil
}

3. 注册服务

chassis.RegisterSchema("grpc", &Server{}, server.WithRPCServiceDesc(&pb.Greeter_serviceDesc))

参数说明：

第一个参数指定注册的协议类型
第二个参数是服务实现实例
第三个参数使用生成的gRPC服务描述符

4. 配置文件

chassis.yaml配置：

servicecomb:
  registry:
      address: http://127.0.0.1:30100  # 服务注册中心地址
  protocols:
    grpc:
      listenAddress: 127.0.0.1:5000    # gRPC服务监听地址

microservice.yaml配置：

servicecomb:
  service:
    name: RPCServer  # 微服务名称

5. 主程序

import _ "github.com/go-chassis/go-chassis-extension/grpc/server"

func main() {
    if err := chassis.Init(); err != nil {
        lager.Logger.Errorf("初始化失败: %s", err)
        return
    }
    chassis.Run()
}

三、服务消费方实现

1. 项目结构

client
|-- conf
|   |-- chassis.yaml
|   `-- microservice.yaml
`-- main.go

2. 配置文件

chassis.yaml配置：

servicecomb:
  registry:
      address: http://127.0.0.1:30100  # 服务注册中心地址

microservice.yaml配置：

servicecomb:
  service:
    name: Client  # 消费者服务名称

3. 主程序

import _ "github.com/go-chassis/go-chassis-extension/grpc/client"

func main() {
    // 初始化框架
    if err := chassis.Init(); err != nil {
        lager.Logger.Error("初始化失败: " + err.Error())
        return
    }
    
    // 声明响应结构
    reply := &helloworld.HelloReply{}
    
    // 调用远程服务
    if err := core.NewRPCInvoker().Invoke(
        context.Background(), 
        "RPCServer",                  // 服务提供方名称
        "helloworld.Greeter",         // schema ID
        "SayHello",                   // 操作ID
        &helloworld.HelloRequest{Name: "Peter"},  // 请求参数
        reply,                       // 响应接收变量
        core.WithProtocol("grpc"));  // 指定协议类型
        err != nil {
        lager.Logger.Error("调用错误: " + err.Error())
    }
    lager.Logger.Info(reply.Message)
}