Go to file
Elliotte Rusty Harold 858a1f8fb9 Update to Guava 28.1
Remove serviceAccountWithScopeNotToJwt as test no longer makes sense
and it is hard to adapt to the new cred API.
2019-09-13 11:16:08 -07:00
.github github/lock.yml: Lock GitHub issues after 90 days 2018-09-28 09:48:13 -07:00
all Apply java plugin explicitly when needed 2019-09-13 09:42:17 -07:00
alts Apply animalsniffer plugin explicitly when needed 2019-09-13 09:42:17 -07:00
android all: Update to truth 1.0 2019-09-11 08:53:18 -07:00
android-interop-testing all: Update to truth 1.0 2019-09-11 08:53:18 -07:00
api Apply animalsniffer plugin explicitly when needed 2019-09-13 09:42:17 -07:00
auth Update to Guava 28.1 2019-09-13 11:16:08 -07:00
benchmarks Apply java plugin explicitly when needed 2019-09-13 09:42:17 -07:00
bom Apply maven-publish plugin explicitly when needed 2019-09-13 09:42:17 -07:00
buildscripts buildscripts: add config for building grpc-cronet artifact (#6134) 2019-09-09 16:14:56 -07:00
compiler Apply java plugin explicitly when needed 2019-09-13 09:42:17 -07:00
context Apply animalsniffer plugin explicitly when needed 2019-09-13 09:42:17 -07:00
core Apply animalsniffer plugin explicitly when needed 2019-09-13 09:42:17 -07:00
cronet Start 1.25.0 development cycle (#6141) 2019-09-10 17:41:37 -07:00
documentation Update README etc to reference 1.23.0 2019-08-13 17:46:50 -07:00
examples all: Update to truth 1.0 2019-09-11 08:53:18 -07:00
gae-interop-testing Swap to Gradle's Plugin DSL for much of build 2019-09-13 09:42:17 -07:00
gradle/wrapper Swap to Gradle's Plugin DSL for much of build 2019-09-13 09:42:17 -07:00
grpclb Apply java plugin explicitly when needed 2019-09-13 09:42:17 -07:00
interop-testing Apply java plugin explicitly when needed 2019-09-13 09:42:17 -07:00
netty Apply animalsniffer plugin explicitly when needed 2019-09-13 09:42:17 -07:00
okhttp Apply animalsniffer plugin explicitly when needed 2019-09-13 09:42:17 -07:00
protobuf Apply animalsniffer plugin explicitly when needed 2019-09-13 09:42:17 -07:00
protobuf-lite Apply animalsniffer plugin explicitly when needed 2019-09-13 09:42:17 -07:00
services Apply animalsniffer plugin explicitly when needed 2019-09-13 09:42:17 -07:00
stub Apply animalsniffer plugin explicitly when needed 2019-09-13 09:42:17 -07:00
testing Apply java plugin explicitly when needed 2019-09-13 09:42:17 -07:00
testing-proto Apply java plugin explicitly when needed 2019-09-13 09:42:17 -07:00
xds Apply animalsniffer plugin explicitly when needed 2019-09-13 09:42:17 -07:00
.bazelignore bazel: ignore examples/ from root WORKSPACE 2018-12-18 14:54:57 -07:00
.gitattributes Delete protobuf-nano 2019-05-22 08:49:07 -07:00
.gitignore Fix gitignore for Intellij filebased import 2019-07-08 17:11:26 -07:00
.travis.yml travis.yml: Choose dist trusty to fix Java 8 2019-05-01 16:22:36 -07:00
AUTHORS all: update to Apache 2 licence 2017-05-31 13:29:01 -07:00
BUILD.bazel core: Move io.grpc to grpc-api 2019-04-16 21:45:40 -07:00
COMPILING.md all: update to proto 3.9.0 2019-07-26 13:53:05 -07:00
CONTRIBUTING.md CONTRIBUTING.md: Fix google java style guide link (#5318) 2019-02-04 15:09:41 -08:00
LICENSE fix LICENSE file (#3107) 2017-06-20 08:52:39 +02:00
MAINTAINERS.md change from Inc. to LLC for Google and update the list (#6096) 2019-08-26 12:20:34 -07:00
NOTICE.txt xds: bump envoy to 6ff0bce8ff417a252cde4d04dfb9cba2bab463d8 2019-08-28 12:58:09 -07:00
README.md README.md: Swap to Gradle Plugins DSL 2019-08-30 11:39:16 -07:00
RELEASING.md doc: fix version bug in documentation/android-channel-builder.md 2019-07-30 15:36:33 -07:00
SECURITY.md docs, examples: Update the maven plugins version (#6065) 2019-08-20 14:35:03 -07:00
WORKSPACE all: update to proto 3.9.0 2019-07-26 13:53:05 -07:00
build.gradle Update to Guava 28.1 2019-09-13 11:16:08 -07:00
codecov.yml Disable codecov comment and changes status 2016-05-01 22:39:12 -07:00
gradlew all: update to gradle 4.0.1 2017-07-12 10:07:14 -07:00
gradlew.bat all: update to gradle 3.2 2016-11-23 14:43:18 -08:00
java_grpc_library.bzl bazel: Fix java path separator bug on Windows (#6054) 2019-08-14 14:28:31 -07:00
repositories.bzl Update to Guava 28.1 2019-09-13 11:16:08 -07:00
run-test-client.sh Avoid interop build instructions when already built 2018-10-11 17:17:13 -07:00
run-test-server.sh Avoid interop build instructions when already built 2018-10-11 17:17:13 -07:00
settings.gradle Swap to Gradle's Plugin DSL for much of build 2019-09-13 09:42:17 -07:00

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

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

implementation 'io.grpc:grpc-netty-shaded:1.23.0'
implementation 'io.grpc:grpc-protobuf:1.23.0'
implementation 'io.grpc:grpc-stub:1.23.0'

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

implementation 'io.grpc:grpc-okhttp:1.23.0'
implementation 'io.grpc:grpc-protobuf-lite:1.23.0'
implementation 'io.grpc:grpc-stub:1.23.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.6.2</version>
    </extension>
  </extensions>
  <plugins>
    <plugin>
      <groupId>org.xolstice.maven.plugins</groupId>
      <artifactId>protobuf-maven-plugin</artifactId>
      <version>0.6.1</version>
      <configuration>
        <protocArtifact>com.google.protobuf:protoc:3.9.0:exe:${os.detected.classifier}</protocArtifact>
        <pluginId>grpc-java</pluginId>
        <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.23.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:

plugins {
    id 'com.google.protobuf' version '0.8.8'
}

protobuf {
  protoc {
    artifact = "com.google.protobuf:protoc:3.9.0"
  }
  plugins {
    grpc {
      artifact = 'io.grpc:protoc-gen-grpc-java:1.23.0'
    }
  }
  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.