2. 程式人生 > >gRPC最佳入門教程，Golang/Python/PHP多語言講解

gRPC最佳入門教程，Golang/Python/PHP多語言講解

阿新 • • 發佈：2020-03-02

目錄

  • 一、gRPC是什麼？
  • 二、Protocol Buffers是什麼？
  • 三、需求：開發健身房服務
  • 四、最佳實踐
    • Golang
      • 1. 安裝protoc
      • 2. 安裝protoc-gen-go
      • 3. 安裝grpc包
      • 4. 生成程式碼
      • 5. 定義服務端
      • 6. 定義客戶端
      • 7. 執行程式碼
    • Python
      • 1. 安裝grpc包
      • 2. 安裝protobuf
      • 3. 安裝grpc的protobuf編譯工具
      • 4. 生成程式碼
      • 5. 定義服務端
      • 6. 定義客戶端
      • 7. 執行程式碼
    • PHP
      • 1. 安裝protoc
      • 2. 安裝grpc擴充套件
      • 3. 安裝protobuf擴充套件
      • 4. 安裝生成程式碼的外掛grpc_php_plugin
      • 5. 生成程式碼
      • 6. 定義客戶端
      • 7. 執行程式碼

一、gRPC是什麼？

gRPC，其實就是RPC框架的一種，前面帶了一個g，代表是RPC中的大哥，龍頭老大的意思，另外g也有global的意思，意思是全球化比較fashion，是一個高效能、開源和通用的 RPC 框架，面向服務端和移動端，基於 HTTP/2 設計。

什麼是RPC框架？
RPC 框架說白了就是讓你可以像呼叫本地方法一樣呼叫遠端服務提供的方法，而不需要關心底層的通訊細節。簡單地說就讓遠端服務呼叫更加簡單、透明。
RPC包含了客戶端（Client）和服務端（Server）。

常見的RPC框架有如下：

  1. gRPC。谷歌出品
  2. Thrift。Apache出品
  3. Dubbo。阿里出品，也是一個微服務框架

看官方文件的介紹，有以下4點特性：

  1. 使用Protocal Buffers這個強大的結構資料序列化工具
  2. grpc可以跨語言使用
  3. 安裝簡單，擴充套件方便（用該框架每秒可達到百萬個RPC）
  4. 基於HTTP2協議

二、Protocol Buffers是什麼？

谷歌開源的一種結構資料序列化的工具，比方說JSON、XML也是結構資料序列化的工具，不同的是，

  1. Protocol Buffers序列化後的資料是不可讀的，因為是二進位制流
  2. 使用Protocol Buffer需要事先定義資料的格式(.proto 協議檔案)，還原一個序列化之後的資料需要使用到這個資料格式
  3. Protocol Buffer 比 XML、JSON快很多，因為是基於二進位制流，比字串更省頻寬，傳輸速度快
    Protocol Buffer語法：檢視官方文件

下面演示根據需求開發專案，建議自己執行一下，加深印象

三、需求：開發健身房服務

定義了一個健身房(Gym)，然後提供一個叫健身(Bodybuilding)的服務
使用該服務，需要指定人(Person)，人有名字和動作兩個屬性，下面新建一個gym.proto檔案

syntax = "proto3";
//名稱空間
package lightweight;

//健身房
service Gym {
    rpc BodyBuilding (Person) returns (Reply) {

    }
}
//誰在健身
message Person {
    string name = 1;
    repeated string actions = 2;
}

//結果
message Reply {
    int32 code = 1;
    string msg = 2;
}

四、最佳實踐

下面以Golang、Python、PHP介紹該grpc的使用，程式碼已經上傳到了chenqionghe/grpc-demo
最終目錄結構如下圖

Golang

1. 安裝protoc

地址：protobuf/releases
我是mac，用的是這個地址:protoc-3.11.4-osx-x86_64.zip
解壓後放到了可以訪問的bin即可

2. 安裝protoc-gen-go

protoc依賴該工具生成程式碼

go get -u github.com/golang/protobuf/{proto,protoc-gen-go}

3. 安裝grpc包

這是要程式碼裡需要使用的，go get直接安裝不了，手動克隆

git clone https://github.com/grpc/grpc-go.git $GOPATH/src/google.golang.org/grpc
git clone https://github.com/golang/net.git $GOPATH/src/golang.org/x/net
git clone https://github.com/golang/text.git $GOPATH/src/golang.org/x/text
go get -u github.com/golang/protobuf/{proto,protoc-gen-go}
git clone https://github.com/google/go-genproto.git $GOPATH/src/google.golang.org/genproto
cd $GOPATH/src/
go install google.golang.org/grpc

4. 生成程式碼

# 生成服務端程式碼
protoDir="../protos"
outDir="../languages/golang/gym"
protoc -I ${protoDir}/ ${protoDir}/*proto --go_out=plugins=grpc:${outDir}

protoc工具引數解釋：

  • -I： 指定import路徑，可以指定多個-I引數，編譯時按順序查詢，不指定預設當前目錄
  • -go_out：指定og語言的訪問類
  • plugins：指定依賴的外掛

執行,然後我們會看到在golang目錄生成了該程式碼

5. 定義服務端

package main

import (
 "app/lightweight"
 "context"
 "fmt"
 "google.golang.org/grpc"
 "log"
 "net"
)

const (
 port = ":50051"
)

// server繼承自動生成的服務類
type server struct {
 lightweight.UnimplementedGymServer
}

// 服務端必須實現了相應的介面BodyBuilding
func (s *server) BodyBuilding(ctx context.Context, in *lightweight.Person) (*lightweight.Reply, error) {
 fmt.Printf("%s正在健身, 動作: %s\n", in.Name, in.Actions)
 return &lightweight.Reply{Code: 0, Msg: "ok",}, nil
}
func main() {
 lis, err := net.Listen("tcp", port)
 if err != nil {
  log.Fatalf("failed to listen: %v", err)
 }

 s := grpc.NewServer()
 lightweight.RegisterGymServer(s, &server{})

 if err := s.Serve(lis); err != nil {
  log.Fatalf("failed to serve: %v", err)
 }
}

6. 定義客戶端

package main

import (
 "app/lightweight"
 "context"
 "fmt"
 "google.golang.org/grpc"
 "log"
 "time"
)

const (
 address = "localhost:50051"
)

func main() {
 // Set up a connection to the server.
 conn, err := grpc.Dial(address, grpc.WithInsecure(), grpc.WithBlock())
 if err != nil {
  log.Fatalf("did not connect: %v", err)
 }
 defer conn.Close()
 c := lightweight.NewGymClient(conn)

 ctx, cancel := context.WithTimeout(context.Background(), time.Second)
 defer cancel()
 r, err := c.BodyBuilding(ctx, &lightweight.Person{
  Name: "chenqionghe",
  Actions: []string{"深蹲", "臥推", "硬拉"},
 })
 if err != nil {
  log.Fatalf("error: %v", err)
 }
 fmt.Printf("code: %d, msg: %s", r.Code, r.Msg)
}

7. 執行程式碼

golang目錄結果是現在是這樣的

.
├── client.go
├── go.mod
├── go.sum
├── lightweight
│ └── gym.pb.go
└── server.go

執行服務端和客戶端，效果如下

可以看到，chenqionghe去健身成功

Python

1. 安裝grpc包

pip install grpcio

2. 安裝protobuf

pip install protobuf

3. 安裝grpc的protobuf編譯工具

包含了protoc編譯器和生成程式碼的外掛

pip install grpcio-tools

4. 生成程式碼

#!/usr/bin/env bash

protoDir="../protos"
outDir="../languages/python/gym/"

python3 -m grpc_tools.protoc -I ${protoDir}/ --python_out=${outDir} --grpc_python_out=${outDir} ${protoDir}/*proto

5. 定義服務端

from concurrent import futures
import logging
import grpc

# 支援新的包
import sys
sys.path.append("lightweight")
import lightweight.gym_pb2_grpc as gym_pb2_grpc
import lightweight.gym_pb2 as gym_pb2


class Gym(gym_pb2_grpc.GymServicer):

    def BodyBuilding(self, request, context):
        print(f"{request.name}在健身, 動作: {list(request.actions)}")
        return gym_pb2.Reply(code=0, msg='ok')


def serve():
    server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
    gym_pb2_grpc.add_GymServicer_to_server(Gym(), server)
    server.add_insecure_port('[::]:50051')
    server.start()
    server.wait_for_termination()


if __name__ == '__main__':
    logging.basicConfig()
    serve()

6. 定義客戶端

from __future__ import print_function
import logging
import grpc

# 支援匯入新的包
import sys
sys.path.append("lightweight")
import lightweight.gym_pb2_grpc as gym_pb2_grpc
import lightweight.gym_pb2 as gym_pb2

def run():
    with grpc.insecure_channel('localhost:50051') as channel:
        stub = gym_pb2_grpc.GymStub(channel)
        response = stub.BodyBuilding(gym_pb2.Person(
            name='chenqionghe', actions=['深蹲', '臥推', '硬拉']
        ))
    print(f'code: {response.code}, msg:{response.msg}')


if __name__ == '__main__':
    logging.basicConfig()
    run()

7. 執行程式碼

目錄結構如下，分別執行

├── client.py
├── lightweight
│ ├── gym_pb2.py
│ └── gym_pb2_grpc.py
└── server.py


可以看到，chenqionghe去健身成功

PHP

1. 安裝protoc

地址：protobuf/releases
我是mac，用的是這個地址:protoc-3.11.4-osx-x86_64.zip
解壓後放到了可以訪問的bin即可

2. 安裝grpc擴充套件

方式一：pecl安裝

pecl install grpc

將擴充套件加入到php.ini

extension=grpc.so

3. 安裝protobuf擴充套件

pecl install protobuf

將擴充套件加入到php.ini

extension=protobuf.so

4. 安裝生成程式碼的外掛grpc_php_plugin

該外掛用來生成PHP的gRPC程式碼

git clone -b v1.27.0 https://github.com/grpc/grpc
cd grpc && git submodule update --init && make grpc_php_plugin

注意：這個過程耗時比較久，請做好心理準備（可以在.gitmodules檔案中看到依賴的倉庫比較多）

畫風是這樣的

如果grpc_php_plugin安裝不上，mac系統可以直接copy我已經編譯好的grpc_php_plugin

安裝完成畫風

最終會在bins/opt下生成grpc_php_plugin檔案，我們把它移動到/usr/local/bin下

5. 生成程式碼

#!/usr/bin/env bash

protoDir="../protos"
outDir="../languages/php/lightweight"
protoc -I ${protoDir}/ ${protoDir}/*proto --go_out=plugins=grpc:${outDir}

protoc --proto_path=${protoDir} \
  --php_out=${outDir} \
  --grpc_out=${outDir} \
  --plugin=protoc-gen-grpc=/usr/local/bin/grpc_php_plugin \
  ${protoDir}/*.proto

生成程式碼如下

6. 定義客戶端

1.建立composer.json檔案並執行

{
  "name": "gym",
  "require": {
    "grpc/grpc": "^v1.3.0",
    "google/protobuf": "^v3.3.0"
  },
  "autoload": {
    "psr-4": {
      "GPBMetadata\\": "lightweight/GPBMetadata/",
      "Lightweight\\": "lightweight/Lightweight/"
    }
  }
}

執行composer install
2.建立客戶端檔案client.php

<?php
/**
 * 客戶端使用示例
 * @author chenqionghe
 */

require dirname(__FILE__) . '/vendor/autoload.php';

//初始化要去的健身房
$client = new \Lightweight\GymClient('127.0.0.1:50051', [
    'credentials' => Grpc\ChannelCredentials::createInsecure(),
]);
//帶上自己的卡和運動計劃
$request = new \Lightweight\Person();
$request->setName("chenqionghe");
$request->setActions(['深蹲', '臥推', '硬拉']);
//去健身房健身
list($response, $status) = $client->BodyBuilding($request)->wait();
echo sprintf("code: %s, msg: %s \n", $response->getCode(), $response->getMsg());

注意：php不支援grpc的服務端，建議服務端起一個上面的golang或者python中的server
這裡我用的是golang的

7. 執行程式碼


可以看到，chenqionghe去健身成功，yes，就是這麼easy！

OK，到這裡，分別演示了Golang、Python、PHP使用gRPC的例子，相信你也已經學會

相關推薦

gRPC最佳入門教程，Golang/Python/PHP多語言講解

目錄 一、gRPC是什麼？ 二、Protocol Buffers是什麼？ 三、需求：開發健身房服務 四、最佳實踐 Golang 1. 安裝protoc 2. 安

Python基礎入門教程，Python學習路線圖

第一天 字符 語法 知識 國內 排序 inux 跟著 最好的 給大家整理的這套python學習路線圖，按照此教程一步步的學習來，肯定會對python有更深刻的認識。或許可以喜歡上python這個易學，精簡，開源的語言。此套教程，不但有視頻教程，還有源碼分享，讓大家能真正

2018最新Python小白入門教程，30天學會Python

隨著Python的技術的流行，Python在為人們帶來工作與生活上帶來了很多的便捷，因為Python簡單，學起來快，也是不少新手程式設計師入門的首選語言。作為一名Python愛好者，我也想跟大家分享分享我自學Python的一些小經驗。 Python是面向物件，高階語言，解釋，動態和多用途程式語言。Pytho

python入門教程，格式化輸出，檔案物件

Python格式化輸出： Python的字串格式化有兩種方式: 百分號方式、format方式 百分號的方式相對來說比較老，而format方式則是比較先進的方式，企圖替換古老的方式，目前兩者並存。[PEP-3101] (1)百分號格式化 %[(name)][flags][width][.

python入門教程，函式，lambda，遞迴

一、函式 函式的基礎概念：　　函式是python為了程式碼最大程度地重用和最小化程式碼冗餘而提供的基本結構　　函式是一種設計工具，它能讓程式設計師將複雜的系統分解為可管理的部件　　函式用於將相關功能打包並引數化　　在python中可以建立4種函式　　　　(1)全域性函式：定義在模組　　　　(2)區域性函式：

Python基礎入門教程，30萬年薪Python工程師帶你學

Python是一種計算機程式語言。計算機程式語言和我們日常使用的自然語言有所不同，最大的區別就是，自然語言在不同的語境下有不同的理解，而計算機要根據程式語言執行任務，就必須保證程式語言寫出的程式決不能有歧義，所以，任何一種程式語言都有自己的一套語法，編譯器或者直

Python爬蟲入門教程，突破煎蛋網反爬措施，妹子圖批量抓取！

  今天寫一個爬蟲愛好者特別喜歡的網站煎蛋網 ，這個網站其實還是有點意思的，網站很多人寫了N多的教程了，各種方式的都有，當然網站本身在爬蟲愛好者的不斷進攻下，也在不斷的完善，反爬措施也很多，今天我用 selenium 在揍他一波。    

Python爬蟲入門教程，多執行緒採集鬥圖啦表情包！

寫在前面 今天在CSDN部落格，發現好多人寫爬蟲都在爬取一個叫做鬥圖啦的網站，裡面很多表情包，然後瞅了瞅，各種實現方式都有，今天我給你實現一個多執行緒版本的。關鍵技術點 aiohttp ，你可以看一下我前面的文章，然後在學習一下。 https://github.com/wangde

Python安裝教程，入學Python第一步！

一、安裝Python因為Python是跨平臺的，它可以執行在Windows、Mac和各種Linux/Unix系統上。在Windows上寫Python程式，放到Linux上也是能夠執行的。 二、要開始學習Python程式設計，首先就得把Python安裝到你的電腦裡。安裝後，你會得到Python直譯器（就是負責

嵌入式程式設計入門教程，學習設計嵌入式工程師

俗話說萬事開頭難（然後中間難，最後難？），剛開始的時候，你是否根本就不知如何開始，上網查資料被一堆堆新名詞搞的找不到北，去看書也是找不到方向?又是arm，又是linux，又是uboot頭都大了。不知道自己究竟從哪裡開始? 下面就跟著我學習設計嵌入式工程師的修煉日

stylus入門教程，在webstorm中配置stylus

轉載：https://www.cnblogs.com/wenqiangit/p/9717715.html#undefined   stylus特點 富於表現力、具有健壯性、功能豐富、動態編碼 不需要寫CSS的冒號、分號、大括號 和LESS、SASS功能類似，

什麼是Markdown，Markdown的基本使用，Markdown入門教程，Markdown標記大全，Markdown語法

  對於一個程式設計師來說你除了寫程式碼之外，你可能還需要在CSDN或者部落格園上寫部落格，或者在GitHub上分享原始碼時寫README，那麼Markdown你瞭解嗎。它會大大的方便你的部落格或者文件寫作，並且讓文件看起來更加規整和脈絡清晰。如果你還不是很瞭解Markdown，接著看這

OHSCE入門教程（三）-PHP串列埠通訊、構建高可靠性的匯流排應用。

（寫於OHSCE_V0.1.25）    終於等到這篇文章了吧，其實之所以先寫了TCP/UDP的是因為在現在的環境下它倆是相輔相成的，其實在控制領域我們所說的TCP/UDP和串列埠匯流排應用非常接近，和普通的網際網路網路應用還是有著很大區別的，畢竟絕大部分網路控制產品都是從匯流排控制產品升級而來或沿襲了可靠

ubuntu安裝基礎入門教程，重啟黑屏（踩坑）

按照百度經驗裡面的流程一步一步做下來，在安裝啟動引導器裝置謹慎選擇！如果你只裝linux系統，切你只有一塊硬碟，那就使用預設選擇 /dev/sda作為引導分割槽如果你時win + linux 雙系統，如

HTML5新手入門教程，手把手教你使用記事本編寫一個網頁

· 背景    趁著處於學生狗時代又是在暑假期間，我們剛剛好利用這個時間來學習一下另一個對於我現在還沒接觸過的領域，那就是網頁程式設計。雖然說我想做一名Android工程師，但是現在Android開發的跨平臺性使得Android程式設計不再僅僅侷限於原生開發。我個人學習

Redux 入門教程，應用的狀態管理器

http://www.jianshu.com/p/d296a8c34936?hmsr=toutiao.io&utm_medium=toutiao.io&utm_source=toutiao.io Redux由Flux演變而來，提供幾個簡單的API來實現狀

Python爬蟲入門教程 58-100 python爬蟲高級技術之驗證碼篇4-極驗證識別技術之一

per 按鈕 ext ctu () 插入圖片 必須 sts c4c 目錄 驗證碼類型 官網最新效果 找個用極驗證的網站 拼接驗證碼圖片 編

Git入門教程，詳解Git檔案的四大狀態

大家好，歡迎來到週一git專題。 git clone 在上一篇文章當中我們聊了怎麼在github當中建立一個屬於自己的專案（repository），簡稱repo。除了建立自己的repo之外，我們更多的情況是拷貝別人的repo，這樣才可以獲得別人整理好的程式碼資料什麼的，也更符合開源（白嫖）精神嘛。 這也不

雖然不在前三，但是Python依舊程式語言中的頭牌

Apple為自己的開發人員構建的iOS應用程式程式語言Swift開發人員現在是第10大最流行的程式語言，而Python已經退出TIOBE索引的前三名排名。 在9月，Python位於排行榜中Java和C之後，進入前三名，但該公司的10月份索引將Python排在第四位，僅次

C++ 入門教程（三） Hello World 程式講解

上回講到第一個程式 Hello World，現在分析以下Hello World。。。開始進入無圖模式。。 把上回的程式碼搬過來： #include <iostream> int main(void) { std::cout << "He