基於微服務框架go-micro開發gRPC應用程序

Posted on by

go-micro是golang的一個微服務框架。這篇文章將介紹使用go-micro最新版本v4開發gRPC服務的方式。

1、安裝protoc

這個工具也稱為proto編譯器，可以用來生成各種開發語言使用proto協議的代碼。

下載地址：https://github.com/protocolbuffers/protobuf/releases

一般下載最新版本就行，註意要符合自己當前的操作系統。

解壓後裡邊有個 protoc.exe ，拷貝到 GOPATH 的 bin 目錄下，我這裡就是 C:/Users/PC-001/go/bin ，PC-001 是登錄當前操作系統的用戶名，需要換成你自己的。GOPATH 可以通過執行 go env 查看到。

一般都是把 GOPATH 的 bin 目錄添加到環境變量的 PATH 變量中，如果沒有，請自行添加上。

2、安裝protoc的go-micro插件

需要安裝兩個插件，它們用來生成 Golang 版本的 proto 協議代碼和 go-micro 的 gRPC 代理代碼。

執行如下命令，會在 GOPATH 的 bin 目錄下生成兩個可執行文件：protoc-gen-go.exe 和 protoc-gen-micro.exe。

go install google.golang.org/protobuf/cmd/protoc-gen-go
go install go-micro.dev/v4/cmd/protoc-gen-micro@v4

3、編寫proto文件

proto文件是符合Protocol Buffers語言規范的數據交換協議文件，就像以前WebService定義服務時使用的XML文件。現在一般都是用proto3瞭，這裡創建一個名為 hello.proto 的文件，放到項目的proto目錄下：

syntax = "proto3";

option go_package="/proto";

package Business;

service Hello {
  rpc Say (SayRequest) returns (SayResponse);
}

message SayResponse {
  string Message = 1;
}

message SayRequest {
  string Name = 1;
}

這個協議很簡單，有個名字為Hello的服務，提供一個名字為Say的rpc方法，這個方法有輸入輸出，輸入信息中有一個名為Name的參數，輸出信息中有一個名為Message的返回值。

4、生成gRPC代理代碼

在項目根目錄中執行如下命令，會在proto目錄下生成兩個文件：hello.pb.go 和 hello.pb.micro.go。

protoc --go_out=. --go_opt=paths=source_relative --micro_out=. --micro_opt=paths=source_relative proto/hello.proto

hello.pb.go 中是輸入輸出數據類型的Golang定義，hello.pb.micro.go 中是go-micro客戶端和服務端的gRPC代理程序。

也可以將文件生成到別的目錄中，比如修改 proto 文件中 go_package 的配置為：

option go_package="/business";

然後執行下面的命令，會生成到項目下的business目錄中：

protoc --go_out=.  --micro_out=. proto/hello.proto

具體這個命令還有哪些參數，可以執行 protoc -help 去探索下，這裡就不羅嗦瞭。

5、編寫gRPC服務端程序

這裡先上代碼：

package main

import (
	"context"
	"fmt"
	"grpchello/proto"
	"log"
	"time"

	"github.com/asim/go-micro/plugins/server/grpc/v4"
	"go-micro.dev/v4"
	"go-micro.dev/v4/server"
)

type Hello struct{}

func (s *Hello) Say(ctx context.Context, req *proto.SayRequest, rsp *proto.SayResponse) error {
	fmt.Println("request:", req.Name)
	rsp.Message = "Hello " + req.Name
	return nil
}

func main() {

	grpcServer := grpc.NewServer()

	service := micro.NewService(
		micro.Server(grpcServer),
		micro.Name("grpchello.service"),
		micro.Address("0.0.0.0:8001"),
		micro.RegisterTTL(time.Second*30),
		micro.RegisterInterval(time.Second*10),
	)

	// optionally setup command line usage
	service.Init()

	// Register Handlers
	proto.RegisterHelloHandler(service.Server(), &Hello{})

	// Run server
	if err := service.Run(); err != nil {
		log.Fatal(err)
	}
}

整個過程如下：

先定義一個名為 Hello 的類型，它去實現hello.pb.micro.go中生成的HelloHandler接口，也就是編寫具體的業務實現。

然後通過grpc.NewServer創建一個gRPC服務器，這裡決定go-micro底層通信使用gPRC；

然後通過micro.NewService創建一個micro服務，這裡需要傳入上面創建的grpc server，還要設置服務的名稱、監聽端口，以及保持服務健康用的TTL和上報周期。go-mico當前默認的服務發現機制是mdns，不用額外部署服務發現工具，不過一般隻建議在開發環境使用，生產環境建議使用etcd；

通過上面的步驟對服務進行一些初始化之後，再將Hello類型的實例註冊到grpc server；

最後啟動服務，就可以開始接客瞭。

如果直接粘貼這段代碼的話，會有很多包沒有引用進來，可以通過 go get 獲取這些包，也可以執行命令：go mod tidy 來引入需要的包。

這裡邊還import瞭一個 grpchello/proto ，這個是我這邊項目的mod是 grpchello，gRPC代理程序的package是proto，如果你的不一樣，需要修改下。

6、編寫gRPC客戶端程序

訪問gRPC服務也是通過 hello.pb.micro.go 中生成的方法，直接上代碼：

package main

import (
	"bufio"
	"context"
	"fmt"
	"grpchello/proto"
	"os"

	"github.com/asim/go-micro/plugins/client/grpc/v4"
	"go-micro.dev/v4"
)

func main() {

	service := micro.NewService(
		micro.Client(grpc.NewClient()),
	)

	service.Init()
	client := proto.NewHelloService("grpchello.service", service.Client())

	rsp, err := client.Say(context.TODO(), &proto.SayRequest{Name: "BOSSMA"})
	if err != nil {
		fmt.Println(err)
	}

	fmt.Println(rsp)

	fmt.Println("按回車鍵退出程序...")
	in := bufio.NewReader(os.Stdin)
	_, _, _ = in.ReadLine()
}

上面的程序使用瞭 grpc.NewClient , 這決定瞭底層通信采用gRPC；然後再使用生成的代碼 proto.NewHelloService 創建客戶端代理，這裡指定的服務名字必須是服務端註冊的名字；最後使用這個客戶端代理調用相應的方法。

7、運行程序

可以使用 go run xxx.go 來編譯並運行程序。這裡為瞭方便測試，先使用 go build 將它們編譯為exe，然後再雙擊運行。實際運行效果如下：

以上就是本文的主要內容瞭，完整代碼示例已經上傳到 Github：https://github.com/bosima/go-demo/tree/main/go-micro-grpc-hello

到此這篇關於go-micro開發gRPC程序的文章就介紹到這瞭。希望對大傢的學習有所幫助，也希望大傢多多支持WalkonNet。

推薦閱讀：