我的Go gRPC之旅、01 初识gRPC，感受gRPC的强大魅力

微服务架构

微服务是一种开发软件的架构和组织方法，其中软件由通过明确定义的API 进行通信的小型独立服务组成。 这些服务由各个小型独立团队负责。 微服务架构使应用程序更易于扩展和更快地开发，从而加速创新并缩短新功能的上市时间。

将软件应用程序构建为一组独立、自治（独立开发、部署和扩展）、松耦合、面向业务能力（强调能力，而不是完成任务）的服务。

为什么微服务软件系统需要借助进程间（服务间，应用程序间）通信技术？

传统软件系统被进一步拆分为一组细粒度，自治和面向业务能力的实体，也就是微服务。

强、弱类型接口

服务API接口有强、弱类型之分。
强类型接口
 传统的RPC服务（定制二进制协议 ，对消息进行编码和解码），采用TCP传输消息。RPC服务通常有严格的契约，开发服务前需要使用IDL（Interface description language）定义契约，最终通过契约自动生成强类型的服务器端、客户端的接口。服务调用直接使用强类型的客户端。（GRPC、Thrift）

• 优点：不需要手动的编码和解码、接口规范、自动代码生成、编译器自动类型检查。
• 缺点：服务端和客户端强耦合、任何一方升级改动可能会造成另一方break。自动代码生成需要工具支持，开发这些工具的成本比较高。强类型接口开发测试不友好、浏览器、Postman这些工具无法直接访问这些强类型接口。

弱类型接口
 Restful服务通常采用JSON作为传输消息，使用HTTP作为传输协议，没有严格契约的概念，使用普通的HTTP Client即可调用。调用方需要对JSON消息进行手动的编码和解码工作。（Springboot）

• 优点：服务端和客户端非强耦合、开发测试友好。
• 缺点：调用方手动编码解码，没有自动代码生成、没有编译期接口类型检查、相对不规范、容易出现运行期错误。

Rest

描述性状态转移架构，是面向资源架构的基础。将分布式应用程序建模为资源集合，访问这些资源的客户端可以变更这些资源的状态。有三大局限性。

• 基于文本的低效消息协议

• 应用程序之间缺乏强类型接口

• 架构风格难以强制实施

gRPC

gRPC 是一项进程间通信技术，用来连接、调用、操作和调试分布式异构应用程序。

定义服务接口

开发gRPC应用需要先定义服务接口，使用的语言叫做 接口定义语言

• 确定消费者消费服务的方式
• 消费者远程调用的方法和传入的参数和消息格式

优势

• 提供高效的进程间通信。不使用json、xml，基于在HTTP/2之上的protocol buffers的二进制协议
• 简单且定义良好的服务接口和模式
• 属于强类型接口。构建跨团队、技术类型的云原生应用程序，对于其所产生的的大多数运行时错误和互操作错误们可以通过静态类型来克服
• 支持多语言
• 支持双工流。同时构建传统请求-响应风格的消息以及客户端流和服务端流
• 商业化特性内置支持
• 与云原生生态系统进行了集成

劣势

• 不太适合面向外部服务
• 巨大的服务定义变更是复杂的开发流程
• 生态系统相对较小

编写gRPC服务

创建 client、service 目录，分别用指令生成 go.mod 文件

go mod init productinfo/client
go mod init productinfo/service

目录结构

PS C:\Users\小能喵喵喵\Desktop\Go\gRPC\chapter2\productinfo> tree /f
├─client
│  │  client.go
│  │  go.mod
│  │  go.sum
│  │
│  ├─bin
│  │      client.exe
│  │
│  └─ecommerce
│          product_info.pb.go
│          product_info.proto
│          product_info_grpc.pb.go
│
└─service
    │  go.mod
    │  go.sum
    │  server.go
    │  service.go
    │
    ├─bin
    │      server.exe
    │
    └─ecommerce
            product_info.pb.go
            product_info.proto
            product_info_grpc.pb.go

product_info.proto 接口定义

syntax = "proto3";

package ecommerce;
option go_package = ".";

service ProductInfo {
  rpc addProduct (Product) returns (ProductID);
  rpc getProduct (ProductID) returns (Product);
}

message Product{
  string id = 1;
  string name = 2;
  string description = 3;
  float price = 4;
}

message ProductID {
  string value = 1;
}

编译工具

安装：Release Protocol Buffers v21.6 · protocolbuffers/protobuf (github.com)

教程：Go Generated Code | Protocol Buffers | Google Developers

注： $GOPATH/bin要添加到系统环境变量里

protoc-gen-go-grpc: program not found or is not executable 解决方案

go get -u google.golang.org/protobuf/cmd/protoc-gen-go
go install google.golang.org/protobuf/cmd/protoc-gen-go
go get -u google.golang.org/grpc/cmd/protoc-gen-go-grpc
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc

---

Please specify either:
  • a "go_package" option in the .proto source file, or
  • a "M" argument on the command line.

解决方案 在syntax=”proto3″;下一行增加option go_package配置项。

编译方法

protoc [opt...] file.proto
/* 例如 */ 
protoc --proto_path=src --go_out=out --go_opt=paths=source_relative foo.proto 

• 当前版本编译时，之前的方法protoc --go_out=plugins=grpc:. *.proto不再使用，转而用protoc --go_out=. --go-grpc_out=. ./hello.proto代替。
• go_out=. 指定生成的pb.go文件所在目录(如果没有该目录，需要手动提前创建)，.代表当前protoc执行目录，结合.proto文件中的option go_package，其最终的生成文件目录为go_out指定目录/go_package指定目录，go-grpc_out针对_grpc.pb.go文件，同理。
• --go_opt=paths=source_relative，其含义代表生成的.pb.go文件路径不依赖于.proto文件中的option go_package配置项，直接在go_out指定的目录下生成.pb.go文件（.pb.go文件的package名还是由option go_package决定）。--go-grpc_opt=paths=source_relative，针对_grpc.pb.go文件，同理。

PS C:\Users\小能喵喵喵\Desktop\Go\gRPC\chapter2\productinfo\service\ecommerce>
protoc --go_out=. --go-grpc_out=. --go_opt=paths=source_relative --go-grpc_opt=paths=source_relative ./product_info.proto

Product和ProductID结构体定义在product_info.pb.go文件中，通过product_info.proto自动生成。

service.go 业务逻辑代码

package main

import (
	"context"
	pb "productinfo/service/ecommerce" // ^ 导入 protobuf编译器生成代码的包

	"github.com/google/uuid"
	"google.golang.org/grpc/codes"
	"google.golang.org/grpc/status"
)

// ^ 实现 service/ecommerce 服务
type service struct {
	pb.UnimplementedProductInfoServer
	productMap map[string]*pb.Product
}

// ^ 实现方法逻辑、添加商品
// ^ ctx 对象包含一些元数据，比如终端用户授权令牌标识和请求的截止时间
func (s *service) AddProduct(ctx context.Context, in *pb.Product) (*pb.ProductID, error) {
	out, err := uuid.NewUUID() // ^ 通用唯一标示符
	if err != nil {
		return nil, status.Errorf(codes.Internal, "生成产品编码时出错", err)
	}
	in.Id = out.String()
	if s.productMap == nil {
		s.productMap = make(map[string]*pb.Product)
	}
	s.productMap[in.Id] = in
	return &pb.ProductID{Value: in.Id}, status.New(codes.OK, "").Err()
}

func (s *service) GetProduct(ctx context.Context, in *pb.ProductID) (*pb.Product, error) {
	value, exists := s.productMap[in.Value]
	if exists {
		return value, status.New(codes.OK, "").Err()
	}
	return nil, status.Errorf(codes.NotFound, "商品条目不存在", in.Value)
}

server.go 托管服务的gRPC服务器

前向兼容

前向兼容一般指向上兼容。 向上兼容（Upward Compatible）又称向前兼容（Forward Compatible），在某一平台的较低版本环境中编写的程序可以在较高版本的环境中运行。

无法传递给RegisterXXXService方法

新版protoc-gen-go不支持grpc服务生成，需要通过protoc-gen-go-grpc生成grpc服务接口，但是生成的Server端接口中会出现一个mustEmbedUnimplemented***方法，为了解决前向兼容问题（现在的兼容未来的），如果不解决，就无法传递给RegisterXXXService方法。

• 在grpc server实现结构体中匿名嵌入Unimplemented***Server结构体
• 使用protoc生成server代码时命令行加上关闭选项，protoc --go-grpc_out=require_unimplemented_servers=false

package main

import (
	"fmt"
	"log"
	"net"
	pb "productinfo/service/ecommerce"

	"google.golang.org/grpc"
)

const (
	ip   = "127.0.0.1"
	port = "23333"
)

func main() {
	lis, err := net.Listen("tcp", fmt.Sprintf("%v:%v", ip, port))
	if err != nil {
		log.Fatalf("无法监听端口 %v %v", port, err)
	}
	s := grpc.NewServer()
	pb.RegisterProductInfoServer(s, &service{})
	log.Println("gRPC服务器开始监听", port)
	if err := s.Serve(lis); err != nil {
		log.Fatalf("提供服务失败: %v", err)
	}
}

2022/09/18 17:17:30 gRPC服务器开始监听 23333

client.go 客户端代码

重新编译proto

创建一个client目录，并重新之前mod init、编译proto的操作。

PS C:\Users\小能喵喵喵\Desktop\Go\gRPC\chapter2\productinfo\client\ecommerce> 
protoc --go_out=. --go-grpc_out=. --go_opt=paths=source_relative --go-grpc_opt=paths=source_relative ./product_info.proto

grpc.WithInsecure已弃用

grpc.WithInsecure is Deprecated: use WithTransportCredentials and insecure.NewCredentials() instead. Will be supported throughout 1.x.

The function insecure.NewCredentials returns an implementation of credentials.TransportCredentials.

grpc.Dial(":9950", grpc.WithTransportCredentials(insecure.NewCredentials()))

代码

package main

import (
	"context"
	"log"
	"time"

	"google.golang.org/grpc"
	"google.golang.org/grpc/credentials/insecure"

	pb "productinfo/client/ecommerce"
)

const (
	address = "localhost:23333"
)

func main() {
	conn, err := grpc.Dial(address, grpc.WithTransportCredentials(insecure.NewCredentials())) // ^ 不安全地创建端到端连接
	if err != nil {
		log.Fatalf("did not connect: %v", err)
	}
	c := pb.NewProductInfoClient(conn) // ^ 传递连接并创建存根实例,包含所有远程调用方法
	name := "小米 10 Pro"
	description := "雷军说:Are you ok?"
	price := float32(2000.0)
	ctx, cancel := context.WithTimeout(context.Background(), time.Second) // ^ 用于传递元数据:用户标识,授权令牌,请求截止时间
	defer cancel()
	r, err := c.AddProduct(ctx, &pb.Product{
		Name: name, Price: price, Description: description,
	})
	if err != nil {
		log.Fatalf("无法添加商品 %v", err)
	}
	log.Printf("添加商品成功 %v", r.Value)
	/* -------------------------------------------------------------------------- */
	product, err := c.GetProduct(ctx, &pb.ProductID{Value: r.Value})
	if err != nil {
		log.Fatalf("获取不到商品 %v", err)
	}
	log.Println("Product: ", product.String())
}

构建运行

分别进入service，client文件夹执行如下命令。构建二进制文件并运行（可以交叉编译运行在其他操作系统上）。

PS C:\Users\小能喵喵喵\Desktop\Go\gRPC\chapter2\productinfo\service> 
go build -o bin/server.exe   
PS C:\Users\小能喵喵喵\Desktop\Go\gRPC\chapter2\productinfo\client> 
go build -o bin/client.exe   

参考资料

• 《Go语言并发之道》Katherine CoxBuday

• 《Go语言核心编程》李文塔

• 《Go语言高级编程》柴树彬、曹春辉

• 《Grpc 与云原生应用开发》卡山·因德拉西里、丹尼什·库鲁普

• 使用protoc编译.proto文件_田土豆的博客-CSDN博客_protoc 编译

• Go Generated Code | Protocol Buffers | Google Developers

• 微服务架构
• 强、弱类型接口
• Rest
• gRPC
•         定义服务接口
•         优势
•         劣势
• 编写gRPC服务
•     目录结构
•     product_info.proto 接口定义
•     编译工具
•     编译方法
•     service.go 业务逻辑代码
•     server.go 托管服务的gRPC服务器
•         前向兼容
•         无法传递给RegisterXXXService方法
•     client.go 客户端代码
•         重新编译proto
•         grpc.WithInsecure已弃用
•         代码
• 构建运行
• 参考资料

__EOF__