The Java gRPC implementation. HTTP/2 based RPC
Java Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github all: update github issue template Nov 17, 2017
all all: add gradle format checker Jun 12, 2018
alts alts: add call credential security level attribute (#4657) Jul 19, 2018
android-interop-testing gradle: Use config_loc in checkstyle Jul 30, 2018
android android: fix raw type lint Aug 9, 2018
auth all: update animalsniffer to Java 7 and add Android 14 (#4727) Aug 9, 2018
benchmarks compiler,stub: update RpcMethod docs and usage Jul 13, 2018
buildscripts gradle: Use config_loc in checkstyle Jul 30, 2018
compiler Include Java's @deprecated annotation on RPC services or methods with… Aug 15, 2018
context all: update animalsniffer to Java 7 and add Android 14 (#4727) Aug 9, 2018
core Fix errror message when DNS name is invalid. (#4751) Aug 13, 2018
cronet cronet: cleanup remaining usages of deprecated CallOptions#of(). (#4720) Aug 1, 2018
documentation Encourage using grpc-netty-shaded instead of grpc-netty Aug 2, 2018
examples Bump protobuf-gradle-plugin to 0.8.5 Aug 3, 2018
gae-interop-testing gae-interop-testing: Disable special_status_message Jul 30, 2018
gradle/wrapper Upgrade Gradle to 4.9 Jul 26, 2018
grpclb grpclb: fix unused variable lint Aug 9, 2018
interop-testing Correctly determine --use_alts default (#4538) Aug 14, 2018
netty netty/internal: add InternalNettyChannelBuilder.buildTransportFactory… Aug 14, 2018
okhttp all: update animalsniffer to Java 7 and add Android 14 (#4727) Aug 9, 2018
protobuf-lite all: update animalsniffer to Java 7 and add Android 14 (#4727) Aug 9, 2018
protobuf-nano all: update animalsniffer to Java 7 and add Android 14 (#4727) Aug 9, 2018
protobuf all: update animalsniffer to Java 7 and add Android 14 (#4727) Aug 9, 2018
services all: update animalsniffer to Java 7 and add Android 14 (#4727) Aug 9, 2018
stub stub: update docs about Call lifetime + minor cleanups Aug 13, 2018
testing-proto testing-proto: add test for @RpcMethod Aug 3, 2018
testing Propagate EquivalentAddressGroup attributes to transports Jul 9, 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 travis.yml: Actually trigger coveralls Jul 30, 2018
AUTHORS all: update to Apache 2 licence May 31, 2017
BUILD.bazel all: normalize copyright header May 3, 2018
COMPILING.md COMPILING.md: Added note for IntelliJ building (#3958) Jan 11, 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 all: point readme to new jar URL Aug 14, 2018
RELEASING.md RELEASING.md: Remove manual artifact documentation Jul 12, 2018
SECURITY.md all: update to netty 4.1.27 and tcnative 2.0.12 Jul 20, 2018
WORKSPACE all: rename Bazel workspace to io_grpc_grpc_java Feb 22, 2018
build.gradle all: update animalsniffer to Java 7 and add Android 14 (#4727) Aug 9, 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 animalsniffer to Java 7 and add Android 14 (#4727) Aug 9, 2018
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 all: add gradle format checker Jun 12, 2018

README.md

gRPC-Java - An RPC library and framework

gRPC-Java works with JDK 6. 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.14.0</version>
</dependency>
<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-protobuf</artifactId>
  <version>1.14.0</version>
</dependency>
<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-stub</artifactId>
  <version>1.14.0</version>
</dependency>

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

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

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.14.0'
compile 'io.grpc:grpc-protobuf-lite:1.14.0'
compile 'io.grpc:grpc-stub:1.14.0'

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.14.0: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.14.0'
    }
  }
  generateProtoTasks {
    all()*.plugins {
      grpc {}
    }
  }
}

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.