go微服務系列(四) – http api中引入protobuf

• 2020 年 8 月 27 日
• 筆記
• golang, 微服務

• 1. protobuf相關依賴安裝
• 2. 改造之前的client
  • 2.1 新建proto文件
  • 2.2 運行protoc命令生成go文件
  • 2.3 然後把原來的map修改成具體的類型就可以了
• 3. 處理json tag不一致的問題

1. protobuf相關依賴安裝

• 第一步：下載grpc通用編譯器

如下圖，解壓出來因平台而異會是一個protoc或者protoc.exe

//github.com/protocolbuffers/protobuf/releases

• 第二步：把下載的二進位文件路徑添加到環境變數中(為了能全局訪問protoc)
  • 這裡以為mac為例子

# 打開這個
vim /etc/paths 

# 把路徑添加進去
/Users/emm/others/protoc-3.12.4-osx-x86_64/bin/protoc

# 刷新環境變數
source /etc/paths

• 第三步: 安裝go專用的protoc的生成器

go get github.com/golang/protobuf/protoc-gen-go

安裝後會在GOPATH目錄下生成可執行文件，protobuf的編譯器插件protoc-gen-go，等下執行protoc命令會自動調用這個插件

• 第四步: 安裝go-micro對應的插件

go get github.com/micro/protoc-gen-micro

2. 改造之前的client

2.1 新建proto文件

• 新建models/protos文件夾
• 在上述文件夾下新建prod.proto文件，內容如下：

syntax = "proto3";
package Models;

message ProdModel {
  int32 Id = 1;
  string  Name = 2;
}

message ProdRequest {
  int32 Size = 1;
}

message ProdListResponse{
  repeated ProdModel data = 1;
}

2.2 運行protoc命令生成go文件

在models/protos文件夾下運行以下命令

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

2.3 然後把原來的map修改成具體的類型就可以了

package main

import (
	"context"
	"fmt"
	"gomicro-quickstart/goplugin_http_proto_invoker/models"
	"log"

	"github.com/micro/go-micro/client"
	"github.com/micro/go-micro/client/selector"
	"github.com/micro/go-micro/registry"
	"github.com/micro/go-plugins/client/http"
	"github.com/micro/go-plugins/registry/consul"
)

func main() {
	// 1. 註冊consul地址
	cr := consul.NewRegistry(registry.Addrs("47.100.220.174:8500"))

	// 2. 實例化selector
	mySelector := selector.NewSelector(
		selector.Registry(cr),                     // 傳入上面的consul
		selector.SetStrategy(selector.RoundRobin), // 指定獲取實例的演算法
	)

	// 3. 請求服務
	resp, err := callByGoPlugin(mySelector)
	if err != nil {
		log.Fatal("request API failed", err)
	}

	fmt.Printf("[服務調用結果]:\r\n %v", resp)
}

func callByGoPlugin(s selector.Selector) ([]*models.ProdModel, error) {
	// 1. 調用`go-plugins/client/http`包的函數獲取它們提供的httpClient
	gopluginClient := http.NewClient(
		client.Selector(s),                     // 傳入上面的selector
		client.ContentType("application/json"), // 指定contentType
	)

	// 2. 新建請求對象，傳入: (1)服務名 (2)endpoint (3)請求參數
	req := gopluginClient.NewRequest("ProductService", "/v1/list",
		models.ProdRequest{Size: 2})

	// 3. 新建響應對象，並call請求，獲取響應
	var resp models.ProdListResponse
	err := gopluginClient.Call(context.Background(), req, &resp)
	if err != nil {
		return nil, err
	}

	return resp.GetData(), nil
}

3. 處理json tag不一致的問題

如果服務端的model設置了json tag，如下

只有將客戶端的proto文件生成的pb.go文件中的model的tag修改成一樣的才可以

這裡可以使用插件修改

第一步：下載插件

go get -u github.com/favadi/protoc-go-inject-tag

第二步，在proto文件上加註釋

syntax = "proto3";
package models;

message ProdModel {
  // @inject_tag: json:"pid"
  int32 Id = 1;
  // @inject_tag: json:"pname"
  string  Name = 2;
}

message ProdRequest {
  int32 Size = 1;
}

message ProdListResponse{
  repeated ProdModel data = 1;
}

第三步：使用命令行批量修改

protoc-go-inject-tag -input=../prods.pb.go