プロトコルバッファーの基本: Kotlin

Kotlin プログラマーがプロトコルバッファーを扱うための基本的な入門書です。

このチュートリアルでは、proto3 バージョンのプロトコルバッファー言語を使用して、Kotlin プログラマーがプロトコルバッファーを扱うための基本的な入門書を提供します。簡単なサンプルアプリケーションの作成を通して、以下の方法を説明します。

.proto ファイルでメッセージ形式を定義する。
プロトコルバッファーコンパイラーを使用する。
Kotlin プロトコルバッファー API を使用してメッセージを書き込み、読み取る。

これは Kotlin でのプロトコルバッファーの使用に関する包括的なガイドではありません。詳細なリファレンス情報については、Protocol Buffer Language Guide、Kotlin API Reference、Kotlin Generated Code Guide、および Encoding Reference を参照してください。

問題領域

ここで使用する例は、人々の連絡先の詳細をファイルとの間で読み書きできる、非常にシンプルな「アドレス帳」アプリケーションです。アドレス帳の各個人は、名前、ID、メールアドレス、および連絡先の電話番号を持っています。

このような構造化データをシリアライズおよび取得するにはどうすればよいでしょうか？この問題を解決する方法はいくつかあります。

kotlinx.serialization を使用する。C++ または Python で記述されたアプリケーションとデータを共有する必要がある場合、これはあまりうまく機能しません。kotlinx.serialization には protobuf モードがありますが、これはプロトコルバッファーのすべての機能を提供するわけではありません。
データ項目を単一の文字列にエンコードするアドホックな方法を考案できます。たとえば、4 つの整数を「12:3:-23:67」としてエンコードするなどです。これはシンプルで柔軟なアプローチですが、一回限りのエンコードおよび解析コードの記述が必要であり、解析にはわずかなランタイムコストがかかります。これは非常に単純なデータをエンコードするのに最適です。
データを XML にシリアライズする。XML は（ある意味で）人間が読めるものであり、多くの言語用のバインディングライブラリがあるため、このアプローチは非常に魅力的です。他のアプリケーション/プロジェクトとデータを共有したい場合は、これが良い選択肢となる可能性があります。ただし、XML は非常にスペース集約型であり、エンコード/デコードにはアプリケーションに大きなパフォーマンスペナルティを課す可能性があります。また、XML DOM ツリーをナビゲートすることは、通常クラス内の単純なフィールドをナビゲートするよりもかなり複雑です。

プロトコルバッファーは、まさにこの問題を解決するための、柔軟で効率的で自動化されたソリューションです。プロトコルバッファーを使用すると、保存したいデータ構造の .proto 記述を記述します。それから、プロトコルバッファーコンパイラーは、効率的なバイナリ形式でプロトコルバッファーデータの自動エンコードと解析を実装するクラスを作成します。生成されたクラスは、プロトコルバッファーを構成するフィールドのゲッターとセッターを提供し、プロトコルバッファーをユニットとして読み書きする詳細を処理します。重要なことは、プロトコルバッファー形式は、コードが古い形式でエンコードされたデータを引き続き読み取ることができるように、形式を時間の経過とともに拡張するというアイデアをサポートしていることです。

サンプルコードの場所

私たちの例は、プロトコルバッファーを使用してエンコードされたアドレス帳データファイルを管理するためのコマンドラインアプリケーションのセットです。コマンド add_person_kotlin は、データファイルに新しいエントリを追加します。コマンド list_people_kotlin は、データファイルを解析し、データをコンソールに出力します。

完全な例は、GitHub リポジトリの examples ディレクトリにあります。

プロトコル形式の定義

アドレス帳アプリケーションを作成するには、.proto ファイルから始める必要があります。.proto ファイルの定義はシンプルです。シリアライズしたいデータ構造ごとに message を追加し、メッセージ内の各フィールドの名前と型を指定します。私たちの例では、メッセージを定義する .proto ファイルは addressbook.proto です。

.proto ファイルは、パッケージ宣言から始まります。これは、異なるプロジェクト間の名前の衝突を防ぐのに役立ちます。

syntax = "proto3";
package tutorial;

import "google/protobuf/timestamp.proto";

次に、メッセージ定義があります。メッセージは、型付きフィールドのセットを含む集約にすぎません。bool、int32、float、double、string など、多くの標準的な単純データ型がフィールド型として利用可能です。また、他のメッセージ型をフィールド型として使用して、メッセージにさらに構造を追加することもできます。

message Person {
  string name = 1;
  int32 id = 2;  // Unique ID number for this person.
  string email = 3;

  enum PhoneType {
    PHONE_TYPE_UNSPECIFIED = 0;
    PHONE_TYPE_MOBILE = 1;
    PHONE_TYPE_HOME = 2;
    PHONE_TYPE_WORK = 3;
  }

  message PhoneNumber {
    string number = 1;
    PhoneType type = 2;
  }

  repeated PhoneNumber phones = 4;

  google.protobuf.Timestamp last_updated = 5;
}

// Our address book file is just one of these.
message AddressBook {
  repeated Person people = 1;
}

上記の例では、Person メッセージは PhoneNumber メッセージを含み、AddressBook メッセージは Person メッセージを含んでいます。他のメッセージ内にネストされたメッセージ型を定義することもできます。ご覧のとおり、PhoneNumber 型は Person 内で定義されています。また、フィールドの 1 つに事前定義された値のリストの 1 つを持たせたい場合は、enum 型を定義することもできます。ここでは、電話番号が PHONE_TYPE_MOBILE、PHONE_TYPE_HOME、または PHONE_TYPE_WORK のいずれかであることを指定したいと考えています。

各要素の " = 1"、" = 2" マーカーは、フィールドがバイナリエンコーディングで使用する一意の「タグ」を識別します。タグ番号 1〜15 は、より高い番号よりもエンコードに必要なバイト数が 1 バイト少ないため、最適化として、これらのタグを一般的に使用される要素または繰り返し要素に使用し、タグ 16 以上をあまり使用されないオプション要素に残すことができます。繰り返しフィールドの各要素はタグ番号の再エンコードが必要なため、繰り返しフィールドはこの最適化の特に良い候補です。

フィールド値が設定されていない場合、デフォルト値が使用されます。数値型の場合はゼロ、文字列の場合は空文字列、ブール値の場合は false です。埋め込みメッセージの場合、デフォルト値は常にメッセージの「デフォルトインスタンス」または「プロトタイプ」であり、そのフィールドは設定されていません。明示的に設定されていないフィールドの値を取得するためにアクセサーを呼び出すと、常にそのフィールドのデフォルト値が返されます。

フィールドが repeated の場合、フィールドは任意の回数（ゼロ回を含む）繰り返すことができます。繰り返し値の順序は、プロトコルバッファーで保持されます。繰り返しフィールドを動的にサイズ変更される配列と考えてください。

.proto ファイルの記述に関する完全なガイド（可能なすべてのフィールド型を含む）は、Protocol Buffer Language Guide にあります。ただし、クラスの継承に似た機能を探さないでください。プロトコルバッファーはそれを行いません。

Protocol Buffers のコンパイル

.proto ができたので、次に必要なのは、AddressBook（および Person と PhoneNumber）メッセージを読み書きするために必要なクラスを生成することです。これを行うには、プロトコルバッファーコンパイラー protoc を .proto で実行する必要があります。

コンパイラーをインストールしていない場合は、パッケージをダウンロードして、README の指示に従ってください。
次に、コンパイラーを実行し、ソースディレクトリ（アプリケーションのソースコードが存在する場所。値を指定しない場合は現在のディレクトリが使用されます）、出力先ディレクトリ（生成されたコードの出力先。多くの場合 $SRC_DIR と同じ）、および .proto へのパスを指定します。この場合、次のように呼び出します。
```
protoc -I=$SRC_DIR --java_out=$DST_DIR --kotlin_out=$DST_DIR $SRC_DIR/addressbook.proto
```
Kotlin コードが必要なため、--kotlin_out オプションを使用します。同様のオプションは、他のサポートされている言語にも用意されています。

Kotlin コードを生成する場合は、--java_out と --kotlin_out の両方を使用する必要があることに注意してください。これにより、指定された Java 出力先ディレクトリに com/example/tutorial/protos/ サブディレクトリが生成され、いくつかの生成された .java ファイルが含まれ、指定された Kotlin 出力先ディレクトリに com/example/tutorial/protos/ サブディレクトリが生成され、いくつかの生成された .kt ファイルが含まれます。

Protocol Buffer API

Kotlin 用のプロトコルバッファーコンパイラーは、Java 用のプロトコルバッファー用に生成された既存の API に追加する Kotlin API を生成します。これにより、Java と Kotlin の混合で記述されたコードベースが、特別な処理や変換なしに同じプロトコルバッファーメッセージオブジェクトと対話できるようになります。

JavaScript や native など、他の Kotlin コンパイルターゲット用のプロトコルバッファーは、現在サポートされていません。

addressbook.proto をコンパイルすると、Java で次の API が得られます。

AddressBook クラス
- Kotlin からは、peopleList : List<Person> プロパティを持ちます
Person クラス
- Kotlin からは、name、id、email、および phonesList プロパティを持ちます
- number および type プロパティを持つ Person.PhoneNumber ネストされたクラス
- Person.PhoneType ネストされた enum

ただし、次の Kotlin API も生成します。

addressBook { ... } および person { ... } ファクトリメソッド
phoneNumber { ... } ファクトリメソッドを持つ PersonKt オブジェクト

生成される内容の正確な詳細については、Kotlin Generated Code ガイドを参照してください。

メッセージの書き込み

それでは、プロトコルバッファークラスを使用してみましょう。アドレス帳アプリケーションで最初にできるようにしたいことは、個人情報をアドレス帳ファイルに書き込むことです。これを行うには、プロトコルバッファークラスのインスタンスを作成して入力し、それらを出力ストリームに書き込む必要があります。

これは、ファイルから AddressBook を読み取り、ユーザー入力に基づいて新しい Person を追加し、新しい AddressBook をファイルに書き戻すプログラムです。プロトコルコンパイラーによって生成されたコードを直接呼び出すか参照する部分は強調表示されています。

import com.example.tutorial.Person
import com.example.tutorial.AddressBook
import com.example.tutorial.person
import com.example.tutorial.addressBook
import com.example.tutorial.PersonKt.phoneNumber
import java.util.Scanner

// This function fills in a Person message based on user input.
fun promptPerson(): Person = person {
  print("Enter person ID: ")
  id = readLine().toInt()

  print("Enter name: ")
  name = readLine()

  print("Enter email address (blank for none): ")
  val email = readLine()
  if (email.isNotEmpty()) {
    this.email = email
  }

  while (true) {
    print("Enter a phone number (or leave blank to finish): ")
    val number = readLine()
    if (number.isEmpty()) break

    print("Is this a mobile, home, or work phone? ")
    val type = when (readLine()) {
      "mobile" -> Person.PhoneType.PHONE_TYPE_MOBILE
      "home" -> Person.PhoneType.PHONE_TYPE_HOME
      "work" -> Person.PhoneType.PHONE_TYPE_WORK
      else -> {
        println("Unknown phone type.  Using home.")
        Person.PhoneType.PHONE_TYPE_HOME
      }
    }
    phones += phoneNumber {
      this.number = number
      this.type = type
    }
  }
}

// Reads the entire address book from a file, adds one person based
// on user input, then writes it back out to the same file.
fun main(args: List) {
  if (arguments.size != 1) {
    println("Usage: add_person ADDRESS_BOOK_FILE")
    exitProcess(-1)
  }
  val path = Path(arguments.single())
  val initialAddressBook = if (!path.exists()) {
    println("File not found. Creating new file.")
    addressBook {}
  } else {
    path.inputStream().use {
      AddressBook.newBuilder().mergeFrom(it).build()
    }
  }
  path.outputStream().use {
    initialAddressBook.copy { peopleList += promptPerson() }.writeTo(it)
  }
}

メッセージの読み取り

もちろん、アドレス帳から情報を取得できなければ、あまり役に立ちません。この例では、上記の例で作成されたファイルを読み取り、その中のすべての情報を出力します。

import com.example.tutorial.Person
import com.example.tutorial.AddressBook

// Iterates though all people in the AddressBook and prints info about them.
fun print(addressBook: AddressBook) {
  for (person in addressBook.peopleList) {
    println("Person ID: ${person.id}")
    println("  Name: ${person.name}")
    if (person.hasEmail()) {
      println("  Email address: ${person.email}")
    }
    for (phoneNumber in person.phonesList) {
      val modifier = when (phoneNumber.type) {
        Person.PhoneType.PHONE_TYPE_MOBILE -> "Mobile"
        Person.PhoneType.PHONE_TYPE_HOME -> "Home"
        Person.PhoneType.PHONE_TYPE_WORK -> "Work"
        else -> "Unknown"
      }
      println("  $modifier phone #: ${phoneNumber.number}")
    }
  }
}

fun main(args: List) {
  if (arguments.size != 1) {
    println("Usage: list_person ADDRESS_BOOK_FILE")
    exitProcess(-1)
  }
  Path(arguments.single()).inputStream().use {
    print(AddressBook.newBuilder().mergeFrom(it).build())
  }
}

Protocol Buffer の拡張

プロトコルバッファーを使用するコードをリリースした後、遅かれ早かれ、プロトコルバッファーの定義を「改善」したいと思うでしょう。新しいバッファーに後方互換性を持たせ、古いバッファーに前方互換性を持たせたい場合（そして、ほぼ確実にそうしたいはずです）、従う必要のあるルールがいくつかあります。プロトコルバッファーの新しいバージョンでは、

既存のフィールドのタグ番号を変更してはなりません。
フィールドを削除できます。
新しいフィールドを追加できますが、新しいタグ番号（つまり、このプロトコルバッファーで一度も使用されたことのないタグ番号。削除されたフィールドでもない）を使用する必要があります。

（これらのルールにはいくつかの例外がありますが、めったに使用されません。）

これらのルールに従うと、古いコードは新しいメッセージを問題なく読み取り、新しいフィールドを単に無視します。古いコードにとって、削除された単数フィールドは単にデフォルト値を持ち、削除された繰り返しフィールドは空になります。新しいコードも古いメッセージを透過的に読み取ります。

ただし、新しいフィールドは古いメッセージには存在しないことに注意してください。そのため、デフォルト値に対して適切な処理を行う必要があります。型固有のデフォルト値が使用されます。文字列の場合、デフォルト値は空文字列です。ブール値の場合、デフォルト値は false です。数値型の場合、デフォルト値はゼロです。

プロトコル バッファーの基本: Kotlin