寫給公司新入職前端的protobuf介面調用方法

這隻是一篇針對公司內部的指引導性的文檔，不是一篇教程。

資料層面前段如何與後端對接

本篇包含以下內容：

1、介面技術簡介

2、如何與後端對接

一、介面技術簡介

我們使用的gRPC來進行前背景資料對接。看下官方介紹

gRPC is a modern open source high performance RPC framework that can run in any environment.

       ——-https://grpc.io/about/

gRPC 一開始由 google 開發，是一款語言中立、平台中立、開源的遠端程序呼叫(RPC)系統。

     ——-http://doc.oschina.net/grpc?t=58008

（沒有找到中文官網，如果找到請添加到這）

好了以上這些。。。瞭解一下，也可以就是看看，下面是我們日常使用的主角。

gRPC 預設使用 protocol buffers，這是 Google 開源的一套成熟的結構資料序列化機制，別緊張他就如同json一樣是一種資料序列化的協議，gRPC也可以使用json作為資料轉送格式。

是的，我們使用的就是protobuf，所以重點是要瞭解這個。

可以去官網或者其他地方找個教程看一下，總體來說比較簡單，需要重點關注的是protobuf協議下資料類型對應的js下的資料類型。

使用protobuf的方式也很簡單：

“你只需要將要被序列化的資料結構定義一次(譯註：使用.proto檔案定義)，便可以使用特別產生的原始碼(譯註：使用protobuf提供的產生工具)輕鬆的使用不同的資料流完成對這些結構資料的讀寫操作，即使你使用不同的語言（譯註：protobuf的跨語言支援特性）”

簡單講就是，在.proto 檔案中制定協議，然後使用編譯器產生特定語言的資料訪問類，這個類裡邊包含了序列化，還原序列化，toObject，設定/擷取參數，轉化成位元據等方法。

這些方法根據不同語言版本都有產生不同的檔案，使用時可以根據不同語言自身文法進行調用，使用起來相當方便。

教程參見文末“參考網址”

二、如何與後端對接

根據上面說的，對接基本步驟如下：

查看協議組裝參數>調用介面類的方法>發送請求>解析傳回值。

項目中協議檔案是後端已經寫好的，js的調用類也是編譯好的，我們只管用就好了

是proto庫的檔案目錄，go的是golang的，後端使用的，grpc-web和js檔案夾是js的，前端使用的。proto檔案夾裡邊是協議檔案。

我們需要查看的協議檔案如，api和common裡邊的協議檔案。 

如開啟api>v1>account.proto檔案，會看到這種

rpc後邊這些就都是方法名稱，在account.js內可以找到對應的方法名（通常是這個名字然後首字母小寫）

方法名稱後邊括弧緊跟的是參數，參數在檔案內有定義，或者在其他檔案內有定義，根據路徑可以查看。例如在accout.proto內尋找RegisterReq會找到下面的定義

參數有5個欄位，email，passkey，sig，passwd_level,verify。

前面三個都是字串或者位元組數群組類型，後邊的passwd_level是PasswdLevel類型，verify是VerifyReq類型，這倆類型是自訂的。 

再尋找這個類如下：

這就是PasswdLevel的定義，可以看到有這麼幾個值。前邊的enum顯示這是一個枚舉類型，根據相應的level選擇值就可以了。

Verify的類型定義如下，context欄位是後端返回結果帶過來的上下文，這個檔案當中也有定義，可以繼續再往下尋找查看具體內容。

根據上邊的查看步驟，層層組裝好參數就可以了。 

編譯器會根據proto檔案產生對應的類。

比如api>v1>account.proto編譯後會對應的產生 api>v1>account.js ，js裡邊會給出一個類，開啟account.js可以看到代碼第一行goog.provide('proto.biss.api.v1.account.AccountClient');

這貨就是產生的account的類，那麼以後調用account下的方法時就要執行個體化這個類了

account.proto中定義的方法也會出現在這個檔案中（通常是這個名字然後首字母小寫）

方法的請求參數和返回資料需要在 js>api>v1下對應的檔案內查看。比如registerReq這個類的定義。裡邊還會包含參數對應的操作方法（toObject，序列化這些）

調用介面類和發送請求在項目中已經封裝了send方法可以直接用。使用方法參見api的說明。

返回結果後根據不同的資料傳回型別調用不同的方法擷取就可以了。之前提到的反序列，toObject，這些方法。

參考地址：

      gRPC官網地址：https://grpc.io

      gRPC中文文檔地址：http://doc.oschina.net/grpc?t=58008

      protobuf協議git倉庫地址：  https://github.com/protocolbuffers/protobuf

     protobuf文檔地址：https://developers.google.com/protocol-buffers/