This generates the Java interfaces out of the service definition from a
.proto
file. It works with the Protobuf Compiler (protoc
).
Normally you don't need to compile the codegen by yourself, since pre-compiled binaries for common platforms are available on Maven Central:
- Navigate to https://mvnrepository.com/artifact/io.grpc/protoc-gen-grpc-java
- Click into a version
- Click "Files"
However, if the pre-compiled binaries are not compatible with your system, you may want to build your own codegen.
Set up your system as described in COMPILING.md.
Then change to the compiler
directory:
$ cd $GRPC_JAVA_ROOT/compiler
To compile the plugin:
$ ../gradlew java_pluginExecutable
To test the plugin with the compiler:
$ ../gradlew test
You will see a PASS
if the test succeeds.
To compile a proto file and generate Java interfaces out of the service definitions:
$ protoc --plugin=protoc-gen-grpc-java=build/exe/java_plugin/protoc-gen-grpc-java \
--grpc-java_out="$OUTPUT_FILE" --proto_path="$DIR_OF_PROTO_FILE" "$PROTO_FILE"
To generate Java interfaces with protobuf lite:
$ protoc --plugin=protoc-gen-grpc-java=build/exe/java_plugin/protoc-gen-grpc-java \
--grpc-java_out=lite:"$OUTPUT_FILE" --proto_path="$DIR_OF_PROTO_FILE" "$PROTO_FILE"
This will compile a codegen and put it under your ~/.m2/repository
. This
will make it available to any build tool that pulls codegens from Maven
repositories.
$ ../gradlew publishToMavenLocal
Please follow the instructions in RELEASING.md
under the root directory for
details on how to create a new release.