Protocol Buffer の基礎: Dart

Dart プログラマーが protocol buffer を扱うための基本的な入門です。

このチュートリアルは、Dart プログラマー向けに、protocol buffer 言語の proto3 バージョンを使用した protocol buffer の基本的な使い方を紹介します。簡単なサンプルアプリケーションの作成を通して、以下の方法を学びます。

  • .proto ファイルでメッセージ形式を定義する。
  • protocol buffer コンパイラを使用する。
  • Dart protocol buffer API を使用してメッセージを書き込み、読み込む。

これは、Dart で protocol buffer を使用するための包括的なガイドではありません。より詳細なリファレンス情報については、Protocol Buffer 言語ガイド、Dart 言語ツアー、Dart API リファレンス、Dart 生成コードガイド、およびエンコーディングリファレンスを参照してください。

問題領域

ここで使用する例は、人々の連絡先の詳細をファイルに読み書きできる、非常にシンプルな「アドレス帳」アプリケーションです。アドレス帳の各人物には、名前、ID、メールアドレス、連絡先の電話番号があります。

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

  • データ項目を単一の文字列にエンコードする独自の方法を考案することもできます。例えば、4つの整数を「12:3:-23:67」のようにエンコードするなどです。これはシンプルで柔軟なアプローチですが、独自のエンコードと解析のコードを書く必要があり、解析にはわずかな実行時コストがかかります。これは、非常に単純なデータをエンコードするのに最適です。
  • データを XML にシリアライズする。このアプローチは、XML が（ある程度）人間が読める形式であり、多くの言語でバインディングライブラリが存在するため、非常に魅力的に見えることがあります。他のアプリケーションやプロジェクトとデータを共有したい場合には良い選択肢です。しかし、XML は領域を大量に消費することで知られており、そのエンコード/デコードはアプリケーションに大きなパフォーマンス上のペナルティを課す可能性があります。また、XML DOM ツリーをナビゲートすることは、クラスの単純なフィールドをナビゲートするよりもはるかに複雑です。

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

サンプルコードの場所

私たちの例は、protocol buffer を使用してエンコードされたアドレス帳データファイルを管理するための一連のコマンドラインアプリケーションです。コマンド dart add_person.dart はデータファイルに新しいエントリを追加します。コマンド dart list_people.dart はデータファイルを解析し、そのデータをコンソールに出力します。

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

プロトコルフォーマットの定義

アドレス帳アプリケーションを作成するには、まず .proto ファイルから始める必要があります。.proto ファイルの定義はシンプルです。シリアライズしたい各データ構造に対してメッセージを追加し、次にメッセージ内の各フィールドの名前と型を指定します。この例では、メッセージを定義する .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つを持つようにしたい場合は、enum 型を定義することもできます – ここでは、電話番号が PHONE_TYPE_MOBILE、PHONE_TYPE_HOME、または PHONE_TYPE_WORK のいずれかであることを指定したいと考えています。

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

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

フィールドが repeated の場合、そのフィールドは任意の回数（ゼロ回を含む）繰り返すことができます。繰り返される値の順序は protocol buffer 内で保持されます。繰り返しフィールドは動的サイズの配列と考えることができます。

.proto ファイルの書き方に関する完全なガイド（すべての可能なフィールド型を含む）は、Protocol Buffer 言語ガイドにあります。ただし、クラスの継承に似た機能を探しても見つかりません。protocol buffer はそれをサポートしていません。

Protocol Buffer のコンパイル

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

  1. コンパイラをインストールしていない場合は、パッケージをダウンロードし、README の指示に従ってください。

  2. README の説明に従って、Dart Protocol Buffer プラグインをインストールします。protocol buffer の protoc が見つけられるように、実行可能ファイル bin/protoc-gen-dart が PATH に含まれている必要があります。

  3. 次に、ソースディレクトリ（アプリケーションのソースコードがある場所 – 値を指定しない場合はカレントディレクトリが使用されます）、デスティネーションディレクトリ（生成されたコードを配置したい場所。多くの場合 $SRC_DIR と同じです）、および .proto ファイルへのパスを指定して、コンパイラを実行します。この場合、次のように呼び出します。

    protoc -I=$SRC_DIR --dart_out=$DST_DIR $SRC_DIR/addressbook.proto

    Dart コードが必要なため、--dart_out オプションを使用します。他のサポートされている言語にも同様のオプションが提供されています。

これにより、指定したデスティネーションディレクトリに addressbook.pb.dart が生成されます。

Protocol Buffer API

addressbook.pb.dart を生成すると、以下の便利な型が得られます。

  • List<Person> get people ゲッターを持つ AddressBook クラス。
  • name、id、email、phones のアクセサメソッドを持つ Person クラス。
  • number と type のアクセサメソッドを持つ Person_PhoneNumber クラス。
  • Person.PhoneType enum の各値に対応する静的フィールドを持つ Person_PhoneType クラス。

生成されるものの詳細については、Dart 生成コードガイドで詳しく読むことができます。

メッセージの書き込み

それでは、protocol buffer クラスを使ってみましょう。アドレス帳アプリケーションが最初にできるようにしたいことは、個人の詳細をアドレス帳ファイルに書き込むことです。これを行うには、protocol buffer クラスのインスタンスを作成してデータを設定し、それを出力ストリームに書き込む必要があります。

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

import 'dart:io';

import 'dart_tutorial/addressbook.pb.dart';

// This function fills in a Person message based on user input.
Person promptForAddress() {
  Person person = Person();

  print('Enter person ID: ');
  String input = stdin.readLineSync();
  person.id = int.parse(input);

  print('Enter name');
  person.name = stdin.readLineSync();

  print('Enter email address (blank for none) : ');
  String email = stdin.readLineSync();
  if (email.isNotEmpty) {
    person.email = email;
  }

  while (true) {
    print('Enter a phone number (or leave blank to finish): ');
    String number = stdin.readLineSync();
    if (number.isEmpty) break;

    Person_PhoneNumber phoneNumber = Person_PhoneNumber();

    phoneNumber.number = number;
    print('Is this a mobile, home, or work phone? ');

    String type = stdin.readLineSync();
    switch (type) {
      case 'mobile':
        phoneNumber.type = Person_PhoneType.PHONE_TYPE_MOBILE;
        break;
      case 'home':
        phoneNumber.type = Person_PhoneType.PHONE_TYPE_HOME;
        break;
      case 'work':
        phoneNumber.type = Person_PhoneType.PHONE_TYPE_WORK;
        break;
      default:
        print('Unknown phone type.  Using default.');
    }
    person.phones.add(phoneNumber);
  }

  return person;
}

// Reads the entire address book from a file, adds one person based
// on user input, then writes it back out to the same file.
main(List arguments) {
  if (arguments.length != 1) {
    print('Usage: add_person ADDRESS_BOOK_FILE');
    exit(-1);
  }

  File file = File(arguments.first);
  AddressBook addressBook;
  if (!file.existsSync()) {
    print('File not found. Creating new file.');
    addressBook = AddressBook();
  } else {
    addressBook = AddressBook.fromBuffer(file.readAsBytesSync());
  }
  addressBook.people.add(promptForAddress());
  file.writeAsBytes(addressBook.writeToBuffer());
}

メッセージの読み取り

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

import 'dart:io';

import 'dart_tutorial/addressbook.pb.dart';
import 'dart_tutorial/addressbook.pbenum.dart';

// Iterates though all people in the AddressBook and prints info about them.
void printAddressBook(AddressBook addressBook) {
  for (Person person in addressBook.people) {
    print('Person ID: ${ person.id}');
    print('  Name: ${ person.name}');
    if (person.hasEmail()) {
      print('  E-mail address:${ person.email}');
    }

    for (Person_PhoneNumber phoneNumber in person.phones) {
      switch (phoneNumber.type) {
        case Person_PhoneType.PHONE_TYPE_MOBILE:
          print('   Mobile phone #: ');
          break;
        case Person_PhoneType.PHONE_TYPE_HOME:
          print('   Home phone #: ');
          break;
        case Person_PhoneType.PHONE_TYPE_WORK:
          print('   Work phone #: ');
          break;
        default:
          print('   Unknown phone #: ');
          break;
      }
      print(phoneNumber.number);
    }
  }
}

// Reads the entire address book from a file and prints all
// the information inside.
main(List arguments) {
  if (arguments.length != 1) {
    print('Usage: list_person ADDRESS_BOOK_FILE');
    exit(-1);
  }

  // Read the existing address book.
  File file = new File(arguments.first);
 AddressBook addressBook = new AddressBook.fromBuffer(file.readAsBytesSync());
  printAddressBook(addressBook);
}

Protocol Buffer の拡張

protocol buffer を使用するコードをリリースした後、遅かれ早かれ、protocol buffer の定義を「改善」したくなることは間違いありません。新しいバッファが後方互換性を持ち、古いバッファが前方互換性を持つようにしたい場合（そして、ほとんどの場合そうしたいはずです）、従うべきいくつかのルールがあります。protocol buffer の新しいバージョンでは

  • 既存のフィールドのタグ番号を変更してはいけません。
  • フィールドを削除してもかまいません。
  • 新しいフィールドを追加してもかまいませんが、新しいタグ番号（つまり、この protocol buffer で一度も使用されていないタグ番号。削除されたフィールドが使用していたものも含む）を使用しなければなりません。

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

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

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