Protocol Buffer の基本: Dart

Protocol Buffers を使用した基本的な Dart プログラマー向け入門

このチュートリアルでは、Protocol Buffers 言語の proto3 バージョンを使用して、Protocol Buffers を使用した基本的な Dart プログラマー向け入門を提供します。簡単なサンプルアプリケーションの作成を通して、以下の方法を説明します。

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

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

問題領域

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

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

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

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

サンプルコードの場所

この例は、protocol buffers を使用してエンコードされたアドレス帳データファイルを管理するためのコマンドラインアプリケーションのセットです。コマンド 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 buffers はそれを行いません。

Protocol Buffers のコンパイル

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

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

  2. その README に記載されているように、Dart Protocol Buffer プラグインをインストールします。実行可能ファイル bin/protoc-gen-dart は、protocol buffer protoc がそれを見つけることができるように、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 をファイルに書き戻すプログラムです。プロトコルコンパイラによって生成されたコードを直接呼び出すか参照する部分は強調表示されています。

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 です。数値型の場合、デフォルト値はゼロです。