Skip to content

ceragon/GradleGeneratorPlugin

Repository files navigation

GradleGeneratorPlugin

gradle generator plugin 是一个使用java语言编写的gradle插件。 你可以用它完成protobuf的代码生成,相较于protobuf官方的protoc工具,具有跨平台运行、额外代码生成等特性。

功能

  1. 通过定义的proto文件,生成不同语言的protobuf官方代码
  2. 通过编写模板文件,实现生成proto的衍生代码,例如某个消息的处理类

快速上手

用于生成官方的 protobuf 代码

  1. 点击下载基础文件目录 proto-simple.zip
  2. 解压到某个目录
  3. 在目录的 protofiles 目录中添加自定义的 proto 文件
  4. 执行 proto-build.bat 或者 proto-build.sh
  5. 最后在build 目录的 generated-sources 目录中可以看到生成的 protobuf 的 java 文件

使用方法

工具提供两种使用方式,一种是独立方式,另外一种是作为gradle工程的插件使用方式

独立方式

  1. 下载基础文件目录 proto-full.zip
  2. 解压到某个目录
  3. 在目录的 protofiles 目录中添加自定义的 proto 文件
  4. 执行 proto-build.bat 或者 proto-build.sh
  5. 最后在build 目录的 generated-sources 目录中可以看到生成的 protobuf 的 java 文件

作为 gradle 工程的插件

  1. 在build.gradle 中添加插件配置

更多配置方式可查看此工程的 gradle官方插件仓库

plugins {
    id "io.github.ceragon.proto" version "1.3"
}

About

作为gradle插件,提供protobuf生成及衍生功能

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages