ScalaPBと関連ライブラリやツール

ScalaPB自体の説明に入るまえに、関連する依存ライブラリやプロジェクトについて説明します。 できれば読んでおいたほうがいいですが、とにかくすぐ使いたい人は、このページをとばして次のセットアップのページに進んでください。

• ScalaPB
  • ScalaPB本体のリポジトリ
  • protocol buffersの公式のparserからASTを受け取って、Scalaコードを生成する本体
• sbt-scalapb
  • ScalaPBをsbtから使うためのpluginだが、非推奨になって、 https://github.com/scalapb/protoc-bridge, https://github.com/thesamet/sbt-protoc に置き換わった
• Lenses
  • ScalaPBが自動で生成するcase classがデフォルトで強制的に依存するライブラリ
  • Lensというのは、Haskell界隈などを中心に使われる関数型のテクニック
  • ネストしたcase classの一部を更新する場合などに便利
  • 実装は1ファイルだけで、百数十行程度でかなり少ない
  • 自動でLens関連のメソッドが追加されるが、Lensを理解しないとScalaPBが使えないというわけではないので、あまり怖がる必要はない^lens
  • 2018年5月頃に、ScalaPB本体のリポジトリに統合された https://github.com/scalapb/ScalaPB/commit/d3623520d4c
• sbt-protobuf
  • sbt-scalapbが依存しているが、sbt-scalapb自体が非推奨になったため、関係なくなった
• protoc-jar
  • 環境ごとのprotocのバイナリを1つのjarにまとめたもの
  • sbt-protocがデフォルトでこれに依存している
• protobuf-scala-runtime
  • scala-jsやscala-native対応のために、一部の公式のprotobuf-java^{protobuf-java}のclassをScalaで再実装したもの
  • scala-jsやscala-nativeでない場合は、公式のprotobufを使わずにこちらを使うメリットは特にないと思われるので、JVMのみでScalaPBを使う場合は通常必要ない
• fastparse
  • version0.5.19以降実行時に依存
  • protobufには、text formatと呼ばれるデータの表現の形式があり、そのフォーマットをparseするためのもの
  • text formatを使用しない場合は関係ないので気にしなくてよい
  • ちなみにversion0.5.18以前では、一旦Javaのクラスのインスタンスを生成してScalaのクラスのインスタンスに変換していた。^{java-text-format-1 java-text-format-2}
• protoc-bridge
  • version0.5.19くらいまではScalaPBの本体リポジトリの中にあった部分
  • 多少汎用化されて別リポジトリになった
  • 直接使うことはあまりないので、普通のユーザーは気にしなくてよい
• sbt-protoc
  • ScalaPBを使用する際に使うsbt plugin
  • 作成者はScalaPB作者と同じ
  • ScalaPB以外でも使用可能なように、汎用的に作られている

^{scalapb-and-plugin}. 単にクロスビルドやScalaのversionの都合上、リポジトリが分かれていたほうがいい、という判断だと思われる ↩

^lens. つまり、使う必要がなければLensは使わなくてよいです ↩

^{protobuf-java}. これのこと https://repo1.maven.org/maven2/com/google/protobuf/protobuf-java/ https://github.com/google/protobuf/tree/v3.5.1/java ↩

^{java-text-format-1}. https://github.com/google/protobuf/blob/v3.5.1/java/core/src/main/java/com/google/protobuf/TextFormat.java ↩

^{java-text-format-2}. https://github.com/scalapb/ScalaPB/commit/44af26eae9 ↩