| この記事の要点 |
|
protoc とは
protoc は Protocol Buffers(protobuf)の公式コンパイラで、.proto 形式のスキーマ定義から、各種プログラミング言語のシリアライズ / デシリアライズコードを自動生成するコマンドラインツールです。gRPC のスタブコード生成にも使われます。
インストール
| OS | コマンド |
|---|---|
| macOS(Homebrew) | brew install protobuf |
| Ubuntu / Debian | apt install -y protobuf-compiler |
| Fedora / RHEL | dnf install protobuf-compiler |
| Windows | 公式 Releases から zip を取得し PATH を通す |
| 各 OS(手動) | github.com/protocolbuffers/protobuf/releases からダウンロード |
# バージョン確認
protoc --version
# libprotoc 3.21.12
基本的な使用法
protoc [オプション] [.proto ファイル...]
シンプルな例
// helloworld.proto
syntax = "proto3";
package helloworld;
option go_package = "example.com/hello/pb";
message HelloRequest { string name = 1; }
message HelloResponse { string message = 1; }
service Greeter {
rpc SayHello(HelloRequest) returns (HelloResponse);
}# Go コードを生成
protoc \
--proto_path=. \
--go_out=. --go_opt=paths=source_relative \
helloworld.proto
# gRPC サーバ / クライアントスタブも生成
protoc \
--proto_path=. \
--go_out=. --go_opt=paths=source_relative \
--go-grpc_out=. --go-grpc_opt=paths=source_relative \
helloworld.proto
主要オプション
--proto_path(-I)
.proto ファイルを検索するディレクトリを指定します。複数指定でき、import 解決にも使われます。区切りは Linux / macOS は :、Windows は ; です。
# 単一
protoc -I=./proto file.proto
# 複数(Linux / macOS)
protoc -I=./proto:./vendor file.proto
# 別ディレクトリの proto を import する場合に必須
protoc -I=./api -I=./third_party/googleapis api/service.proto
--xxx_out(言語ごとの出力)
protoc が標準で対応している言語の出力先を指定します。
| オプション | 対象言語 |
|---|---|
--cpp_out=DIR | C++ |
--java_out=DIR | Java |
--python_out=DIR | Python |
--csharp_out=DIR | C# |
--ruby_out=DIR | Ruby |
--php_out=DIR | PHP |
--objc_out=DIR | Objective-C |
--js_out=DIR | JavaScript |
--go_out / --go-grpc_out(プラグイン)
Go 向け生成は protoc 本体ではなくプラグインで提供されています。事前に Go ツールチェインで導入し、PATH を通す必要があります。
# Go 向けプラグインのインストール
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
# $GOPATH/bin にバイナリが入るので PATH を通す
export PATH="$PATH:$(go env GOPATH)/bin"
protoc はオプション名から protoc-gen-go のようなバイナリ名を逆算して呼び出すため、命名規則が固定です。
--descriptor_set_out
解析した結果をFileDescriptorSet(バイナリ形式の中間表現)として出力します。動的読み込みや gRPC サーバの reflection に使えます。
protoc \
--include_imports \
--descriptor_set_out=api.pb \
api/service.proto
パスの考え方
| オプション | 役割 |
|---|---|
-I / --proto_path | 入力 .proto を探す根 |
--xxx_out=DIR | 生成物の出力先 |
--xxx_opt=paths=source_relative | 生成パスを入力ファイル相対に保つ |
buf との関係
近年は buf(buf.build)という protoc のラッパが普及しており、依存解決・lint・breaking change 検出を YAML で管理できます。新規プロジェクトでは buf を推奨する声も多いですが、内部では protoc を呼んでいるためオプションの理解は依然として重要です。
よくあるエラーと対処
| エラー | 原因 / 対処 |
|---|---|
protoc-gen-go: program not found or is not executable | Go プラグイン未インストール / PATH 未設定。go install 後に $(go env GOPATH)/bin を PATH に追加 |
File not found. | -I で指定したパスが間違っている。proto ファイルのパスは -I からの相対で書く |
Import "xxx.proto" was not found | 依存 proto がある場合、その場所も -I で指定する必要がある |
Missing input file | 引数で .proto を渡し忘れ。シェルのワイルドカード(*.proto)が想定通り展開されているか確認 |
生成された Go コードに package が無い | .proto 側で option go_package = "..."; を指定 |
古い protoc でビルドが通らない | protobuf ランタイムと protoc のバージョンを揃える。brew upgrade protobuf 等で更新 |
関連
- コマンド・ディレクティブ一覧 — gRPC / Protocol Buffers の親カテゴリ
- Protocol Buffers — スキーマ言語の解説
- gRPC — protoc で生成したスタブを使う上位フレームワーク
- Go — protoc-gen-go の対象言語
子ページ
子ページはありません
同階層のページ
人気ページ
- 1 Eclipseで「サーバーに追加または除去できるリソースがありません。」の原因と対処法
- 2 tomcat の起動 / 停止ログと catalina.log・catalina.out の違い
- 3 JavaScript で base URL を取得する方法|window.location.origin
- 4 YouTube Data API v3 エラー一覧|403・400・404 の原因と対処
- 5 Laravel エラー一覧|500/Blade/DB 接続/ルーティングの代表エラー
- 6 3Dグラフィックスのソフト一覧|Blender・Metasequoiaと用途別の選び方
- 7 Spring Frameworkのアノテーション一覧
- 8 【Spring】@Valueアノテーションとは
- 9 CATALINA_HOME の確認方法 (Linux / Mac)
- 10 【Spring】@Autowiredアノテーションとは
最近更新/作成されたページ
- Visual Studio「デザイナーを表示できません」エラーの原因と対処 2026-10-28 12:06:00
- SSH 認証に失敗しました。再試行してください の対処 2026-10-28 12:06:00
- SSH2 秘密鍵の読み込みに失敗しました の原因と対処 2026-10-28 12:06:00
- TeraTerm のよくあるエラーと対処法完全ガイド — Connection refused / 2026-10-28 12:06:00
- Visual Studio エラー一覧|コンパイルエラー・警告の確認方法と対処 2026-10-28 11:39:57
- Whitelabel Error Page の原因と消し方|Spring Boot のエラーページ 2026-10-28 11:39:57
- Eclipseで「サーバーに追加または除去できるリソースがありません。」の原因と対処法 2026-10-28 11:39:57
- SQL WHERE 句完全ガイド 2026-10-28 11:39:57
- SQL JOIN 完全ガイド (INNER/LEFT/RIGHT/FULL OUTER) 2026-10-28 11:39:57
- tomcat の起動 / 停止ログと catalina.log・catalina.out の違い 2026-10-28 10:24:23
- Tomcat の起動確認方法 5 つ|localhost:8080・ポート・プロセス・ログ 2026-10-28 10:24:23
- Oracle 19c COMMITの使い方: 暗黙コミット・自動確定・応答不明時の確認 2026-10-28 09:59:09
- Oracle 19c DELETE文|削除対象の確認・COMMIT前の判断・ROLLBACKの条件 2026-10-28 09:59:09
- Oracle 19c INSERT文|INSERT ALL・SELECT・RETURNINGとMERGEの使い分け 2026-10-28 09:59:09
- Oracle 19cのトランザクション制御|COMMIT・ROLLBACK・分離レベルと接続設定 2026-10-28 09:59:09