Name: grpc-protobuf
Rating: 76
Author: DaichiHoshina

開発フロー

code

1. proto定義変更
   ↓
2. proto-sync実行（生成コード更新）
   ↓
3. バックエンド実装
   ↓
4. テスト作成・実行

Proto変更時のチェックリスト

1. Proto定義

• フィールド番号は既存と重複しない
• 必須/任意を正しく設定
• コメントで仕様を明記
• 命名規則（snake_case for fields）

protobuf

message ExampleRequest {
  string user_id = 1;     // 必須
  string email = 2;       // 任意
  int64 created_at = 3;   // Unix timestamp
}

2. 生成コード更新

bash

# proto-sync使用時
proto-sync sync

# 手動生成
protoc --go_out=. --go-grpc_out=. *.proto

3. バックエンド実装

// 生成されたインターフェースを実装
func (s *Server) ExampleMethod(ctx context.Context, req *pb.ExampleRequest) (*pb.ExampleResponse, error) {
    // 1. バリデーション
    if req.GetUserId() == "" {
        return nil, status.Error(codes.InvalidArgument, "user_id is required")
    }

    // 2. ビジネスロジック
    // ...

    // 3. レスポンス
    return &pb.ExampleResponse{}, nil
}

後方互換性

変更	互換性
フィールド追加	OK
フィールド削除	NG（reservedに）
型変更	NG
フィールド番号変更	NG

protobuf

// 削除したフィールドはreserved
message User {
  reserved 2;  // 削除されたemail
  string name = 1;
  string new_email = 3;
}