The Java gRPC implementation. HTTP/2 based RPC
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github github/lock.yml: Lock GitHub issues after 90 days Sep 28, 2018
all all: exclude internal/testing package from jacoco coverage report Nov 21, 2018
alts Update net.ltgt.errorprone to 0.6 and enable Error Prone on JDK 10+ Dec 13, 2018
android-interop-testing Start 1.18.0 development cycle Nov 19, 2018
android Update net.ltgt.errorprone to 0.6 and enable Error Prone on JDK 10+ Dec 13, 2018
auth Fix buildifier warnings (#5058) Nov 14, 2018
benchmarks Update net.ltgt.errorprone to 0.6 and enable Error Prone on JDK 10+ Dec 13, 2018
buildscripts all: remove copies of gradle wrapper Dec 12, 2018
compiler Update net.ltgt.errorprone to 0.6 and enable Error Prone on JDK 10+ Dec 13, 2018
context context: make Deadline toString() more readable Dec 6, 2018
core core: hide RetriableStream type from ClientTransportProvider Dec 12, 2018
cronet Start 1.18.0 development cycle Nov 19, 2018
documentation Start 1.18.0 development cycle Nov 19, 2018
examples Examples: Add a JWT authentication example (#5154) Dec 13, 2018
gae-interop-testing interop-testing: update test proto to match grpc-proto. (#5003) Oct 30, 2018
gradle/wrapper Upgrade Gradle to 4.9 Jul 26, 2018
grpclb grpclb: refresh name resolution when balancer stream closed. (#5127) Dec 6, 2018
interop-testing Update net.ltgt.errorprone to 0.6 and enable Error Prone on JDK 10+ Dec 13, 2018
netty Update net.ltgt.errorprone to 0.6 and enable Error Prone on JDK 10+ Dec 13, 2018
okhttp Add missing j2objc dependency to Bazel build Nov 13, 2018
protobuf-lite Update net.ltgt.errorprone to 0.6 and enable Error Prone on JDK 10+ Dec 13, 2018
protobuf-nano Add missing j2objc dependency to Bazel build Nov 13, 2018
protobuf Add missing j2objc dependency to Bazel build Nov 13, 2018
services services: add method to make health checker permanently go unhealthy Dec 7, 2018
stub doc: fix a javadoc warning (#5136) Dec 7, 2018
testing-proto testing-proto: add test for @RpcMethod Aug 3, 2018
testing core: allow ClientStreamTracer to intercept trailers. (#5088) Nov 27, 2018
.gitattributes Include Java's @deprecated annotation on RPC services or methods with… Aug 15, 2018
.gitignore Partial fix for fresh Intellij import Dec 15, 2017
.travis.yml Update net.ltgt.errorprone to 0.6 and enable Error Prone on JDK 10+ Dec 13, 2018
AUTHORS all: update to Apache 2 licence May 31, 2017
BUILD.bazel all: normalize copyright header May 3, 2018
COMPILING.md doc: emphasize building examples on master branch should follow COMPI… Dec 6, 2018
CONTRIBUTING.md CONTRIBUTING.md: Add reference to COMPILING.md Jul 31, 2018
LICENSE fix LICENSE file (#3107) Jun 20, 2017
NOTICE.txt all: normalize copyright header May 3, 2018
README.md Update README to reference 1.17.1 Dec 10, 2018
RELEASING.md doc: emphasize building examples on master branch should follow COMPI… Dec 6, 2018
SECURITY.md netty: bump to 4.1.32 and tcnative 2.0.20 Dec 5, 2018
WORKSPACE all: rename Bazel workspace to io_grpc_grpc_java Feb 22, 2018
build.gradle Update net.ltgt.errorprone to 0.6 and enable Error Prone on JDK 10+ Dec 13, 2018
codecov.yml Disable codecov comment and changes status May 2, 2016
gradlew all: update to gradle 4.0.1 Jul 12, 2017
gradlew.bat all: update to gradle 3.2 Nov 23, 2016
java_grpc_library.bzl Bazel: Fix compilation in Java 9 Apr 26, 2018
repositories.bzl all: update proto-google-common-proto to 1.12.0 Dec 10, 2018
run-test-client.sh Avoid interop build instructions when already built Oct 12, 2018
run-test-server.sh Avoid interop build instructions when already built Oct 12, 2018
settings.gradle all: add gradle format checker Jun 12, 2018

README.md

gRPC-Java - An RPC library and framework

gRPC-Java works with JDK 7. gRPC-Java clients are supported on Android API levels 14 and up (Ice Cream Sandwich and later). Deploying gRPC servers on an Android device is not supported.

TLS usage typically requires using Java 8, or Play Services Dynamic Security Provider on Android. Please see the Security Readme.

Homepage: grpc.io
Mailing List: grpc-io@googlegroups.com

Join the chat at https://gitter.im/grpc/grpc Build Status Coverage Status

Getting Started

For a guided tour, take a look at the quick start guide or the more explanatory gRPC basics.

The examples and the Android example are standalone projects that showcase the usage of gRPC.

Download

Download the JARs. Or for Maven with non-Android, add to your pom.xml:

<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-netty-shaded</artifactId>
  <version>1.17.1</version>
</dependency>
<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-protobuf</artifactId>
  <version>1.17.1</version>
</dependency>
<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-stub</artifactId>
  <version>1.17.1</version>
</dependency>

Or for Gradle with non-Android, add to your dependencies:

compile 'io.grpc:grpc-netty-shaded:1.17.1'
compile 'io.grpc:grpc-protobuf:1.17.1'
compile 'io.grpc:grpc-stub:1.17.1'

For Android client, use grpc-okhttp instead of grpc-netty-shaded and grpc-protobuf-lite instead of grpc-protobuf:

compile 'io.grpc:grpc-okhttp:1.17.1'
compile 'io.grpc:grpc-protobuf-lite:1.17.1'
compile 'io.grpc:grpc-stub:1.17.1'

Development snapshots are available in Sonatypes's snapshot repository.

Generated Code

For protobuf-based codegen, you can put your proto files in the src/main/proto and src/test/proto directories along with an appropriate plugin.

For protobuf-based codegen integrated with the Maven build system, you can use protobuf-maven-plugin (Eclipse and NetBeans users should also look at os-maven-plugin's IDE documentation):

<build>
  <extensions>
    <extension>
      <groupId>kr.motd.maven</groupId>
      <artifactId>os-maven-plugin</artifactId>
      <version>1.5.0.Final</version>
    </extension>
  </extensions>
  <plugins>
    <plugin>
      <groupId>org.xolstice.maven.plugins</groupId>
      <artifactId>protobuf-maven-plugin</artifactId>
      <version>0.5.1</version>
      <configuration>
        <protocArtifact>com.google.protobuf:protoc:3.5.1-1:exe:${os.detected.classifier}</protocArtifact>
        <pluginId>grpc-java</pluginId>
        <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.17.1:exe:${os.detected.classifier}</pluginArtifact>
      </configuration>
      <executions>
        <execution>
          <goals>
            <goal>compile</goal>
            <goal>compile-custom</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

For protobuf-based codegen integrated with the Gradle build system, you can use protobuf-gradle-plugin:

apply plugin: 'com.google.protobuf'

buildscript {
  repositories {
    mavenCentral()
  }
  dependencies {
    classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.5'
  }
}

protobuf {
  protoc {
    artifact = "com.google.protobuf:protoc:3.5.1-1"
  }
  plugins {
    grpc {
      artifact = 'io.grpc:protoc-gen-grpc-java:1.17.1'
    }
  }
  generateProtoTasks {
    all()*.plugins {
      grpc {}
    }
  }
}

The prebuilt protoc-gen-grpc-java binary uses glibc on Linux. If you are compiling on Alpine Linux, you may want to use the Alpine grpc-java package which uses musl instead.

API Stability

APIs annotated with @Internal are for internal use by the gRPC library and should not be used by gRPC users. APIs annotated with @ExperimentalApi are subject to change in future releases, and library code that other projects may depend on should not use these APIs.

We recommend using the grpc-java-api-checker (an Error Prone plugin) to check for usages of @ExperimentalApi and @Internal in any library code that depends on gRPC. It may also be used to check for @Internal usage or unintended @ExperimentalApi consumption in non-library code.

How to Build

If you are making changes to gRPC-Java, see the compiling instructions.

High-level Components

At a high level there are three distinct layers to the library: Stub, Channel, and Transport.

Stub

The Stub layer is what is exposed to most developers and provides type-safe bindings to whatever datamodel/IDL/interface you are adapting. gRPC comes with a plugin to the protocol-buffers compiler that generates Stub interfaces out of .proto files, but bindings to other datamodel/IDL are easy and encouraged.

Channel

The Channel layer is an abstraction over Transport handling that is suitable for interception/decoration and exposes more behavior to the application than the Stub layer. It is intended to be easy for application frameworks to use this layer to address cross-cutting concerns such as logging, monitoring, auth, etc.

Transport

The Transport layer does the heavy lifting of putting and taking bytes off the wire. The interfaces to it are abstract just enough to allow plugging in of different implementations. Note the transport layer API is considered internal to gRPC and has weaker API guarantees than the core API under package io.grpc.

gRPC comes with three Transport implementations:

  1. The Netty-based transport is the main transport implementation based on Netty. It is for both the client and the server.
  2. The OkHttp-based transport is a lightweight transport based on OkHttp. It is mainly for use on Android and is for client only.
  3. The in-process transport is for when a server is in the same process as the client. It is useful for testing, while also being safe for production use.