sbt-protobuf 使用与技术文档

安装指南

在您的项目中，首先需要添加对 sbt-protobuf 插件的依赖。在项目目录下创建一个名为 project/plugins.sbt 的文件，并添加以下内容：

addSbtPlugin("com.github.sbt" % "sbt-protobuf" % "0.8.1")

此操作会自动将 "com.google.protobuf" % "protobuf-java" 添加到 Compile 依赖范围内，其默认版本为 3.9.0，可以通过设置 ProtobufConfig / version 来调整版本。

使用说明

要激活 sbt-protobuf 插件，需要在 build.sbt 文件中包含以下设置：

enablePlugins(ProtobufPlugin)

声明依赖

如果您的项目依赖中包含了 .proto 文件和 Java 字节码文件，可以通过以下方式声明：

libraryDependencies += "some.groupID" % "some.artifactID" % "1.0" % ProtobufConfig.name // #1
libraryDependencies += "some.groupID" % "some.artifactID" % "1.0" // #2

其中，#1 行指示 sbt-protobuf 该依赖包含了 .proto 文件，需提取并添加到 protoc 的 --proto_path 参数中；#2 行则是将该依赖添加到常规编译类路径中。

编译外部 proto 文件

如果需要编译外部的 proto 文件（例如，因为库是用较旧的 protoc 版本编译的），可以添加以下设置：

ProtobufConfig / sourceDirectories += (ProtobufConfig / protobufExternalIncludePath).value

编译 gRPC proto 文件

要启用 gRPC 支持，请设置：

ProtobufConfig / protobufGrpcEnabled := true

打包 proto 文件

要将 .proto 文件包含在 JAR 文件中，可以在构建定义中添加以下设置：

Compile / unmanagedResourceDirectories += (ProtobufConfig / sourceDirectory).value

或者，可以将 .proto 文件打包到一个单独的 JAR 文件中，使用 proto 分类器：

addArtifact(ProtobufConfig / protobufPackage / artifact, ProtobufConfig / protobufPackage)

项目API使用文档

关于 sbt-protobuf 的详细配置和 API 使用，请参考项目在 GitHub 上的官方文档和 Wiki 页面。

项目安装方式

sbt-protobuf 插件通过 sbt 的插件管理进行安装，通常不需要额外的安装步骤。只需按照安装指南在 project/plugins.sbt 文件中添加依赖即可。

以上内容提供了 sbt-protobuf 插件的基本安装和使用说明，更多高级配置和用法，请查阅官方文档。