The Java gRPC implementation. HTTP/2 based RPC
Java Protocol Buffer C++ Other
Permalink
Failed to load latest commit information.
.github github: add an issue template Nov 2, 2016
all core: split Context into a separate grpc-context artifact. Sep 2, 2016
android-interop-testing android: Fix ProGuard rules in Android apps Jan 23, 2017
auth core: change method descriptor to be builder based Jan 23, 2017
benchmarks core: change method descriptor to be builder based Jan 23, 2017
buildscripts Bump protobuf to 3.1.0 Nov 1, 2016
compiler compile: add std:: to all stl types Jan 17, 2017
context docs: clarify requirements of detach(). (#2630) Jan 20, 2017
core core: change method descriptor to be builder based Jan 23, 2017
examples android: Fix ProGuard rules in Android apps Jan 23, 2017
gradle/wrapper all: update to gradle 3.2 Nov 23, 2016
grpclb core: change method descriptor to be builder based Jan 23, 2017
interop-testing core: make StatsContextFactory setters protected (#2634) Jan 21, 2017
netty core: change method descriptor to be builder based Jan 23, 2017
okhttp core: change method descriptor to be builder based Jan 23, 2017
protobuf-lite all: Bump protobuf to 3.0.2, to fix protoc in CI Sep 29, 2016
protobuf-nano Speed up NanoUtilsTest by 10s Mar 14, 2016
protobuf proto: remove deprecated methods Jan 11, 2017
services core,services: separately index mutable and immutable services Jan 14, 2017
stub core: change method descriptor to be builder based Jan 23, 2017
testing-proto compiler: reduce synchronzed invocation (#2539) Dec 29, 2016
testing core: change method descriptor to be builder based Jan 23, 2017
thrift Mark Thrift experimental Sep 12, 2016
.gitattributes Add native support for Protobuf Lite Mar 22, 2016
.gitignore examples: Provide Maven and Gradle build files Jul 11, 2016
.travis.yml travis: Remove old comment for broken OS X caching Nov 24, 2016
CHANGES.md Add a Changes document to keep track of release notes Sep 16, 2015
COMPILING.md Bump protobuf to 3.1.0 Nov 1, 2016
CONTRIBUTING.md all: update styleguide XML to canonical one on github Jan 9, 2017
LICENSE Initial commit Jan 8, 2015
NOTICE.txt Reduce OkHttp dependency, copy all the needed files into our repository. Oct 15, 2015
PATENTS Create PATENTS Feb 26, 2015
README.md docs: add links to examples and tutorials. (#2614) Jan 18, 2017
RELEASING.md releasing: Document bumping version on grpc.io Jan 5, 2017
SECURITY.md all: bump to netty 4.1.7 Jan 19, 2017
build.gradle all: bump to netty 4.1.7 Jan 19, 2017
checkstyle.license Enable license header checking in checkstyle Sep 10, 2015
checkstyle.xml Update checkstyle version and sync style updates Apr 18, 2016
codecov.yml Disable codecov comment and changes status May 2, 2016
gradlew all: update to gradle 3.2 Nov 23, 2016
gradlew.bat all: update to gradle 3.2 Nov 23, 2016
run-test-client.sh interop-testing: -PskipCodegen requires =true Nov 1, 2016
run-test-server.sh interop-testing: -PskipCodegen requires =true Nov 1, 2016
settings.gradle testing: added junit rule for in-process servers Dec 6, 2016

README.md

gRPC-Java - An RPC library and framework

gRPC-Java works with JDK 6. TLS usage typically requires using Java 8, or Play Services Dynamic Security Provider on Android. Please see the Security Readme.

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

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

Download

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

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

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

compile 'io.grpc:grpc-netty:1.0.3'
compile 'io.grpc:grpc-protobuf:1.0.3'
compile 'io.grpc:grpc-stub:1.0.3'

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

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

Development snapshots are available in Sonatypes's snapshot repository.

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.4.1.Final</version>
    </extension>
  </extensions>
  <plugins>
    <plugin>
      <groupId>org.xolstice.maven.plugins</groupId>
      <artifactId>protobuf-maven-plugin</artifactId>
      <version>0.5.0</version>
      <configuration>
        <protocArtifact>com.google.protobuf:protoc:3.0.2:exe:${os.detected.classifier}</protocArtifact>
        <pluginId>grpc-java</pluginId>
        <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.0.3: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: 'java'
apply plugin: 'com.google.protobuf'

buildscript {
  repositories {
    mavenCentral()
  }
  dependencies {
    // ASSUMES GRADLE 2.12 OR HIGHER. Use plugin version 0.7.5 with earlier
    // gradle versions
    classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.0'
  }
}

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

How to Build

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

Navigating Around the Source

Here's a quick readers' guide to the code to help folks get started. At a high level there are three distinct layers to the library: Stub, Channel & 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 should be trivial to add and are welcome.

Key Interfaces

Stream Observer

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. Flow-control is also exposed at this layer to allow more sophisticated applications to interact with it directly.

Common

Client

Server

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. Transports are modeled as Stream factories. The variation in interface between a server Stream and a client Stream exists to codify their differing semantics for cancellation and error reporting.

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 inProcess transport is for when a server is in the same process as the client. It is useful for testing.

Common

Client

Server

Examples

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