php+go實現grpc

1.先安裝編譯器:https://github.com/google/protobuf/releases把bin下的exe放到環境PATH目錄。做成環境變量.

2.獲取go支持庫的插件:

  // gRPC運行時接口編解碼支持庫
  go get -u github.com/golang/protobuf/proto
  // 從 Proto文件(gRPC接口描述文件) 生成 go文件 的編譯器插件
  go get -u github.com/golang/protobuf/protoc-gen-go

3.編寫test.proto( protocol buffers 文件)

  syntax = "proto3";
  // 定義包名
  package test;
  
  // 可以定義多個服務，每個服務內可以定義多個接口
  service Waiter {
    // 定義接口 (結構體可以複用)
    // 方法 (請求消息結構體) returns (返回消息結構體) {}
    rpc DoMD5 (Req) returns (Res) {}
  }

  // 定義 Req 消息結構
  message Req {
    // 類型 字段 = 標識號
    string jsonStr = 1;
  }

  // 定義 Res 消息結構
  message Res {
    string backJson = 1;
  }
// PS：jsonStr和backJson只是隨手寫的名字，並沒有用json

這裏面其實就是聲明相關服務和請求響應參數之類的相關規範.

4.然後就要用第一步安裝的編譯器來編譯這個規範文件:

  // protoc --go_out=plugins=grpc:{輸出目錄}  {proto文件}
  protoc --go_out=plugins=grpc:./test/ ./test.proto

會在test目錄下生成一個test.pb.go文件.

現在我們在項目根目錄下建一個a目錄用來存放服務端文件server.go:

package main
import (
	"log"
	"net"
	"golang.org/x/net/context"
	"google.golang.org/grpc"
	"gtest/test"
	"google.golang.org/grpc/reflection"
	"fmt"
	"crypto/md5"
)

// 業務實現方法的容器
type server struct{}

// 爲server定義 DoMD5 方法 內部處理請求並返回結果
// 參數 (context.Context[固定], *test.Req[相應接口定義的請求參數])
// 返回 (*test.Res[相應接口定義的返回參數，必須用指針], error)
func (s *server) DoMD5(ctx context.Context, in *test.Req) (*test.Res, error) {
	fmt.Println("MD5方法請求JSON:"+in.JsonStr)
	return &test.Res{BackJson: "MD5 :" + fmt.Sprintf("%x", md5.Sum([]byte(in.JsonStr)))}, nil
}

func main() {
	lis, err := net.Listen("tcp", ":8028")  //監聽所有網卡8028端口的TCP連接
	if err != nil {
		log.Fatalf("監聽失敗: %v", err)
	}
	s := grpc.NewServer() //創建gRPC服務

	/**註冊接口服務
	 * 以定義proto時的service爲單位註冊，服務中可以有多個方法
	 * (proto編譯時會爲每個service生成Register***Server方法)
	 * 包.註冊服務方法(gRpc服務實例，包含接口方法的結構體[指針])
	 */
	test.RegisterWaiterServer(s, &server{})
	/**如果有可以註冊多個接口服務,結構體要實現對應的接口方法
	 * user.RegisterLoginServer(s, &server{})
	 * minMovie.RegisterFbiServer(s, &server{})
	 */
	// 在gRPC服務器上註冊反射服務
	reflection.Register(s)
	// 將監聽交給gRPC服務處理
	err = s.Serve(lis)
	if  err != nil {
		log.Fatalf("failed to serve: %v", err)
	}
}

然後在根目錄下建一個b目錄來存放客戶端文件client.go:

package main
import (
	"log"
	"os"
	"golang.org/x/net/context"
	"google.golang.org/grpc"
	"gtest/test"
)


func main() {
	// 建立連接到gRPC服務
	conn, err := grpc.Dial("127.0.0.1:8028", grpc.WithInsecure())
	if err != nil {
		log.Fatalf("did not connect: %v", err)
	}
	// 函數結束時關閉連接
	defer conn.Close()

	// 創建Waiter服務的客戶端
	t := test.NewWaiterClient(conn)

	// 模擬請求數據
	res := "test123"
	// os.Args[1] 爲用戶執行輸入的參數 如：go run ***.go 123
	if len(os.Args) > 1 {
		res = os.Args[1]
	}

	// 調用gRPC接口
	tr, err := t.DoMD5(context.Background(), &test.Req{JsonStr: res})
	if err != nil {
		log.Fatalf("could not greet: %v", err)
	}
	log.Printf("服務端響應: %s", tr.BackJson)
}

我們看到，無論是服務端和客戶端，都要用到之前用編譯器編譯生成的test包。

現在文件夾結構如下:

根目錄下運行go mod init gtest

然後運行服務端文件go run ./a/server.go

然後運行客戶端文件go run ./b/client.go

打印:2020/07/05 14:01:34 服務端響應: MD5 :cc03e747a6afbbcbf8be7668acfebee5

上面我們分別完成了go之前的grpc調用.現在我們來編寫php的客戶端.

新建目錄gtest2.把之前建的proto文件拷過來。然後執行如下命令編譯:

protoc --php_out=. test.proto

會編譯生成Res.php和Req.php文件，看名思義.

然後編寫composer.json

{
  "name": "grpc-go-php",
  "require": {
    "grpc/grpc": "^v1.3.0",
    "google/protobuf": "^v3.3.0"
  },
  "autoload":{
    "psr-4":{
      "GPBMetadata\\":"GPBMetadata/",
      "Test\\":"Test/"
    }
  }
}

composer install

在Test目錄下建立客戶端文件Client.php

<?php
namespace Test;

/**
 * service Xuexitest{}
 * 編寫 (gprc 定義 Xuexitest 服務)的客戶端
 */
class Client extends \Grpc\BaseStub{

    public function __construct($hostname, $opts, $channel = null) {
        parent::__construct($hostname, $opts, $channel);
    }

    /**
     * rpc SayTest(TestRequest) returns (TestReply) {}
     * 方法名儘量和 (gprc 定義 Xuexitest 服務)的方法一樣
     * 用於請求和響應該服務
     */
    public function SayTest(\Test\Req $argument,$metadata=[],$options=[]){
        // (/xuexitest.Xuexitest/SayTest) 是請求服務端那個服務和方法，基本和 proto 文件定義一樣
        // (\Xuexitest\TestReply) 是響應信息（那個類），基本和 proto 文件定義一樣
        return $this->_simpleRequest('/test.Waiter/DoMD5',
            $argument,
            ['\Test\Req', 'decode'],
            $metadata, $options);
    }

}

然後在根目錄下創建test.php文件進行驗證:

<?php
//引入 composer 的自動載加
require __DIR__ . '/vendor/autoload.php';

//用於連接 服務端
$client = new \Test\Client('127.0.0.1:8028', [
    'credentials' => \Grpc\ChannelCredentials::createInsecure()
]);

//實例化 TestRequest 請求類
$request = new \Test\Req();
$request->setJsonStr("test123");

//調用遠程服務
$get = $client->SayTest($request)->wait();


//返回數組
//$reply 是 TestReply 對象
//$status 是數組
list($reply, $status) = $get;


//數組
var_dump($reply->getJsonStr());

參考鏈接:

https://www.jianshu.com/p/20ed82218163

https://blog.csdn.net/uisoul/article/details/90483050