第19篇 Protocol Buffers 編譯器生成proto檔案

似梦亦非梦發表於2024-09-09
Protocol編譯

1.下載 Protocol Buffers 編譯器（protoc）

前往 Protocol Buffers GitHub Releases 頁面。在 "Assets" 下找到適合您系統的壓縮檔案，通常為 protoc-{version}-win32.zip 或 protoc-{version}-win64.zip，其中 {version} 是版本號。

image

2.解壓縮 Protoc 編譯器

建立一個空資料夾，用於存放 protoc 編譯器，將下載的壓縮檔案解壓到該資料夾。找到 bin 檔案所在目錄，將路徑複製下來。
image

3.設定環境變數

滑鼠點選桌面左下角的搜尋框，然後輸入“環境變數”，搜尋出來後雙擊滑鼠點進去。
在彈出的視窗中選擇“高階->環境變數”按鈕。在“使用者變數”裡找到 path，雙擊開啟。
點選“新建”並新增 protoc 編譯器的路徑，將剛才下載地址的 bin 路徑貼上進去即可。
image

4.驗證安裝

我們現在開啟控制檯看一下變數是否配置成功，Win+R然後輸入 cmd，在命令列中執行命令protoc --version，如果看到版本資訊，說明配置成功。
image

5.使用 protoc 編譯 .proto 檔案 轉成C#，.cs檔案

  1. 檢查 .NET SDK 安裝

     dotnet --version

  2. 重新安裝 gRPC C# 工具，先執行解除安裝，再裝

     dotnet tool uninstall -g dotnet-grpc
 dotnet tool install -g dotnet-grpc

image

  1. 手動下載和安裝【如果以上步驟無法安裝】
    如果透過 dotnet tool install 命令無法安裝 grpc_csharp_plugin.exe，你可以嘗試手動下載和安裝。

訪問 gRPC GitHub 倉庫。
導航到 grpc/src/csharp/Grpc.Tools 目錄。
下載適用於你作業系統的 Grpc.Tools 包。

  1. 手動安裝
    解壓下載的 Grpc.Tools 包。
    將解壓後的資料夾中的 tools 目錄複製到你希望安裝外掛的位置。
    將外掛路徑新增到系統的 PATH 環境變數中。

  2. 檢查環境變數
    確保 grpc_csharp_plugin.exe 的路徑已新增到系統的 PATH 環境變數中。你可以透過以下步驟檢查和配置環境變數：

Windows
右鍵點選“此電腦”或“計算機”，選擇“屬性”。
點選“高階系統設定”。
在“系統屬性”視窗中，點選“環境變數”按鈕。
在“系統變數”部分，找到並選擇 Path 變數，然後點選“編輯”。
確保 C:\Users<YourUsername>.dotnet\tools 路徑已新增到 Path 變數中。如果沒有，請點選“新建”並新增該路徑。

Linux/macOS
開啟終端。
編輯 ~/.bashrc 或 ~/.zshrc 檔案，新增以下行：

	export PATH="$PATH:$HOME/.dotnet/tools"

儲存檔案並執行以下命令使更改生效：

source ~/.bashrc

或

source ~/.zshrc
  1. 使用絕對路徑
    如果你找到了 grpc_csharp_plugin.exe 的路徑，可以使用絕對路徑來執行 protoc 命令：

example.proto檔案內容
image

生成C#類檔案的命令：

	protoc --proto_path=D:\Project\GrpcServiceDemo\protocolbuffers\protos --csharp_out=D:\Project\GrpcServiceDemo\protocolbuffers\codes --grpc_out=D:\Project\GrpcServiceDemo\protocolbuffers\codes --plugin=protoc-gen-grpc=D:\Project\GrpcServiceDemo\protocolbuffers\tools\windows_x64\grpc_csharp_plugin.exe example.proto

執行成功後，會生成這兩個檔案：
image

6.如果透過git倉庫程式碼無法找到外掛grpc_csharp_plugin.exe ，可以透過以下方式

  1. 手動下載
    訪問 NuGet 官方網站。
    搜尋 Grpc.Tools 包。
    下載適用於你作業系統的包（例如 Grpc.Tools.2.41.0.nupkg）。

  2. 解壓 Grpc.Tools 包
    下載完成後，解壓 Grpc.Tools 包。你可以使用以下命令解壓 .nupkg 檔案：

     mkdir Grpc.Tools
 unzip Grpc.Tools.2.41.0.nupkg -d Grpc.Tools

  3. 配置環境變數
    將 grpc_csharp_plugin.exe 的路徑新增到系統的 PATH 環境變數中。

Windows
右鍵點選“此電腦”或“計算機”，選擇“屬性”。
點選“高階系統設定”。
在“系統屬性”視窗中，點選“環境變數”按鈕。
在“系統變數”部分，找到並選擇 Path 變數，然後點選“編輯”。
確保 Grpc.Tools/tools/windows_x64 路徑已新增到 Path 變數中。如果沒有，請點選“新建”並新增該路徑。
image

Linux/macOS
開啟終端。
編輯 ~/.bashrc 或 ~/.zshrc 檔案，新增以下行：

export PATH="$PATH:/path/to/Grpc.Tools/tools/linux_x64"

或

export PATH="$PATH:/path/to/Grpc.Tools/tools/macosx_x64"

儲存檔案並執行以下命令使更改生效：

source ~/.bashrc

或

source ~/.zshrc

相關文章