Go to file
Eric Anderson c436561fc5 all: Use fixed version number for java 6/7 signatures
This is important for stable builds, as if the signature changes the old source
may no longer validate.
2017-06-30 15:25:34 -07:00
.github github: add an issue template 2016-11-02 15:28:47 -07:00
all all: Don't depend directly on grpc-protobuf-lite 2017-06-29 10:29:11 -07:00
android-interop-testing android-interop-testing: instrumented interop tests 2017-06-12 12:10:41 -07:00
auth all: Use fixed version number for java 6/7 signatures 2017-06-30 15:25:34 -07:00
benchmarks benchmarks: add missing ReportQpsScenarioServiceGrpc 2017-06-19 21:00:26 -07:00
buildscripts Make Kokoro logs less noisy (#3110) 2017-06-30 13:53:52 -07:00
compiler build: Add Bazel java_grpc_library rule 2017-06-22 13:06:49 -07:00
context all: Use fixed version number for java 6/7 signatures 2017-06-30 15:25:34 -07:00
core all: Use fixed version number for java 6/7 signatures 2017-06-30 15:25:34 -07:00
documentation documentation: update path/method for reflection 2017-03-20 12:41:33 -07:00
examples examples: use the official error_details.proto 2017-06-29 16:05:33 -07:00
gradle/wrapper all: update to gradle 3.5 2017-06-07 17:18:44 -07:00
grpclb all: fix licence whitespace 2017-06-01 14:28:37 -07:00
interop-testing testing: move NoopClientCall & NoopServerCall to internal 2017-06-22 15:10:58 -07:00
netty all: Use fixed version number for java 6/7 signatures 2017-06-30 15:25:34 -07:00
okhttp all: Use fixed version number for java 6/7 signatures 2017-06-30 15:25:34 -07:00
protobuf all: Use fixed version number for java 6/7 signatures 2017-06-30 15:25:34 -07:00
protobuf-lite all: Use fixed version number for java 6/7 signatures 2017-06-30 15:25:34 -07:00
protobuf-nano all: Use fixed version number for java 6/7 signatures 2017-06-30 15:25:34 -07:00
services all: Use fixed version number for java 6/7 signatures 2017-06-30 15:25:34 -07:00
stub all: Use fixed version number for java 6/7 signatures 2017-06-30 15:25:34 -07:00
testing testing: move NoopClientCall & NoopServerCall to internal 2017-06-22 15:10:58 -07:00
testing-proto all: update to Apache 2 licence 2017-05-31 13:29:01 -07:00
thrift all: fix licence whitespace 2017-06-01 14:28:37 -07:00
.gitattributes Add native support for Protobuf Lite 2016-03-22 15:40:51 -07:00
.gitignore examples: add bazel build example 2017-06-29 12:25:54 -07:00
.travis.yml all: bump to proto 3.3.1 2017-05-23 17:04:51 -07:00
AUTHORS all: update to Apache 2 licence 2017-05-31 13:29:01 -07:00
BUILD.bazel build: Add Bazel java_grpc_library rule 2017-06-22 13:06:49 -07:00
CHANGES.md Add a Changes document to keep track of release notes 2015-09-16 15:02:38 -07:00
COMPILING.md all: bump to proto 3.3.1 2017-05-23 17:04:51 -07:00
CONTRIBUTING.md all: improve contributing.md guidelines. 2017-06-01 11:14:44 -07:00
LICENSE fix LICENSE file (#3107) 2017-06-20 08:52:39 +02:00
NOTICE.txt all: update to Apache 2 licence 2017-05-31 13:29:01 -07:00
README.md all: update readme to point to 1.4.0 2017-06-16 15:03:14 -07:00
RELEASING.md all: include analytics in releasing notes 2017-03-20 09:53:55 -07:00
SECURITY.md update netty-tcnative version in SECURITY.md 2017-06-12 09:41:03 -07:00
WORKSPACE build: Add Bazel java_grpc_library rule 2017-06-22 13:06:49 -07:00
build.gradle netty: upgrade to netty tcnative 2.0.5 2017-06-26 18:29:14 -07:00
checkstyle.license all: fix licence whitespace 2017-06-01 14:28:37 -07:00
checkstyle.xml all: update to latest import ordering 2017-01-26 13:43:06 -08:00
codecov.yml Disable codecov comment and changes status 2016-05-01 22:39:12 -07:00
gradlew all: Update to gradle 3.4.1 2017-04-06 15:36:47 -07:00
gradlew.bat all: update to gradle 3.2 2016-11-23 14:43:18 -08:00
java_grpc_library.bzl build: Add Bazel java_grpc_library rule 2017-06-22 13:06:49 -07:00
repositories.bzl bazel: update netty tcnative to 2.0.5 2017-06-29 13:35:46 -07:00
run-test-client.sh interop-testing: -PskipCodegen requires =true 2016-11-01 14:45:40 -07:00
run-test-server.sh interop-testing: -PskipCodegen requires =true 2016-11-01 14:45:40 -07:00
settings.gradle testing: added junit rule for in-process servers 2016-12-06 09:32:04 -08:00

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.4.0</version>
</dependency>
<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-protobuf</artifactId>
  <version>1.4.0</version>
</dependency>
<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-stub</artifactId>
  <version>1.4.0</version>
</dependency>

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

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

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

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.3.0:exe:${os.detected.classifier}</protocArtifact>
        <pluginId>grpc-java</pluginId>
        <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.4.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: '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.2.0"
  }
  plugins {
    grpc {
      artifact = 'io.grpc:protoc-gen-grpc-java:1.4.0'
    }
  }
  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.