Go to file
abtom 537dbe826a
binder: Helper class to allow in process servers to use peer uids in test (#11014)
2024-03-22 15:57:29 -07:00
.github Fix tests and warnings on Java 17 2024-02-29 16:55:46 -08:00
all Use Javadoc's -linkoffline instead of -link 2024-02-23 17:22:48 -08:00
alts alts,census,gcp-observability: Explicitly set grpc-context as an implementation dependency (#10997) 2024-03-11 14:00:12 -07:00
android Change many api deps to implementation deps 2023-12-15 15:14:29 -08:00
android-interop-testing android-interop-testing: Improve errror logging (#10972) 2024-03-04 11:23:17 -08:00
api Allow configuration of the queued byte threshold at which a Stream is considered not ready (#10977) 2024-03-21 15:37:26 -07:00
auth alts,census,gcp-observability: Explicitly set grpc-context as an implementation dependency (#10997) 2024-03-11 14:00:12 -07:00
authz Remove unneeded dependency excludes 2023-06-23 11:18:10 -07:00
benchmarks Remove build usages of Jetty ALPN 2024-02-23 15:27:33 -08:00
binder binder: Helper class to allow in process servers to use peer uids in test (#11014) 2024-03-22 15:57:29 -07:00
bom Revert "bom: Remove protoc-gen-grpc-java" 2022-05-09 10:28:32 -07:00
buildSrc Make custom tasks compatible with configuration cache 2023-11-27 14:28:44 -08:00
buildscripts buildscripts: Remove unused Kokoro files for Bazel 2024-02-26 10:03:35 -08:00
census alts,census,gcp-observability: Explicitly set grpc-context as an implementation dependency (#10997) 2024-03-11 14:00:12 -07:00
compiler Start 1.64.0 development cycle (#11030) 2024-03-22 09:32:10 -07:00
context api, context: fix bazel build: export api from context and remove context dep from api (#10326) 2023-06-29 13:51:13 -07:00
core Fix retry race condition that can lead to double decrementing inFlightSubStreams and so miss calling closed (#11026) 2024-03-22 10:01:58 -07:00
cronet Allow configuration of the queued byte threshold at which a Stream is considered not ready (#10977) 2024-03-21 15:37:26 -07:00
documentation Avoid repeating grpc version in Android documentation 2023-04-14 15:06:53 -07:00
examples Start 1.64.0 development cycle (#11030) 2024-03-22 09:32:10 -07:00
gae-interop-testing Change GAE interop tests to use java11 runtime (#10933) 2024-02-20 10:52:22 -08:00
gcp-observability alts,census,gcp-observability: Explicitly set grpc-context as an implementation dependency (#10997) 2024-03-11 14:00:12 -07:00
googleapis Add check for empty addresses and if not there disable ipV6. (#10848) 2024-01-29 17:20:11 -08:00
gradle (minor) Add missing update notes for cronet to libs.versions.toml (#11007) 2024-03-14 10:40:00 -07:00
grpclb api: Remove test dependency on grpclb 2023-12-14 08:07:34 -08:00
inprocess Allow configuration of the queued byte threshold at which a Stream is considered not ready (#10977) 2024-03-21 15:37:26 -07:00
interop-testing core: Provide DEADLINE_EXCEEDED insights for context deadline 2024-03-21 17:02:06 -07:00
istio-interop-testing Remove build usages of Jetty ALPN 2024-02-23 15:27:33 -08:00
netty Allow configuration of the queued byte threshold at which a Stream is considered not ready (#10977) 2024-03-21 15:37:26 -07:00
okhttp Allow configuration of the queued byte threshold at which a Stream is considered not ready (#10977) 2024-03-21 15:37:26 -07:00
opentelemetry opentelemetry : Implement metrics (#10593) 2023-11-13 10:58:16 -08:00
protobuf Use Javadoc's -linkoffline instead of -link 2024-02-23 17:22:48 -08:00
protobuf-lite protobuf-lite: ProtoLiteUtils experimental comment (#10627) 2023-10-25 15:37:49 -07:00
rls Enable Happy Eyeballs by default (#11022) 2024-03-21 16:59:54 -07:00
services services: Remove deprecated `io.grpc.services.BinaryLogs` (#10832) 2024-01-18 11:29:19 -08:00
servlet servlet: Move deps to version catalog 2024-02-27 21:48:19 -08:00
stub Allow configuration of the queued byte threshold at which a Stream is considered not ready (#10977) 2024-03-21 15:37:26 -07:00
testing alts,census,gcp-observability: Explicitly set grpc-context as an implementation dependency (#10997) 2024-03-11 14:00:12 -07:00
testing-proto all: generate automatic module name in the manifest (#10413) 2023-07-25 09:00:11 -07:00
util util: Status desc for outlier detection ejection (#11036) 2024-03-22 14:40:06 -07:00
xds Enable Happy Eyeballs by default (#11022) 2024-03-21 16:59:54 -07:00
.bazelignore bazel: ignore examples/ from root WORKSPACE 2018-12-18 14:54:57 -07:00
.bazelrc Upgrade Protobuf Java to 3.22.3 (aka 22.3) 2023-04-17 13:16:20 -07:00
.gitattributes gitattributes: Show diffs for golden generated code 2021-07-02 22:11:40 -07:00
.gitignore Port from Travis-CI to GitHub Actions 2021-06-17 13:32:56 -07:00
AUTHORS
BUILD.bazel bazel: Include `@Generated` dep for autovalue 2022-12-19 19:51:29 -05:00
CODE-OF-CONDUCT.md Update governance, contributing, code of conduct docs (#6171) 2019-09-20 16:28:42 -07:00
COMPILING.md COMPILING.md: Fix small typo 2023-09-14 12:03:20 -07:00
CONTRIBUTING.md Remove build usages of Jetty ALPN 2024-02-23 15:27:33 -08:00
GOVERNANCE.md Update governance, contributing, code of conduct docs (#6171) 2019-09-20 16:28:42 -07:00
LICENSE
MAINTAINERS.md MAINTAINERS.md: Add Binder maintainers 2022-11-29 13:01:53 -08:00
NOTICE.txt xds: rollback PGV dependency from using maven artifact to importing proto source 2020-03-27 17:09:27 -07:00
README.md Update README to v1.62.2 (#10965) 2024-02-27 12:52:59 -08:00
RELEASING.md RELEASING.md: Include author email in shortlog (#10794) 2024-01-11 11:37:19 -08:00
SECURITY.md Bump Netty to 4.1.100.Final 2023-11-06 13:05:22 -08:00
WORKSPACE Bump rules_jvm_external to 5.3 2023-09-28 09:33:09 -07:00
build.gradle Start 1.64.0 development cycle (#11030) 2024-03-22 09:32:10 -07:00
codecov.yml
gradlew Bump gradle from 8.3 to 8.5 (#10791) 2024-01-12 16:01:48 -08:00
gradlew.bat Bump gradle from 8.3 to 8.5 (#10791) 2024-01-12 16:01:48 -08:00
java_grpc_library.bzl java_grpc_library.bzl: Support runfiles for protoc and the plugin 2024-01-19 17:02:55 -08:00
repositories.bzl Have EDS resource parse the additional addresses from envoy message (#11011) 2024-03-15 12:26:21 -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 Upgrade to Gradle 8.6 and upgrade plugins 2024-03-11 15:44:20 -07:00

README.md

gRPC-Java - An RPC library and framework

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

Join the chat at https://gitter.im/grpc/grpc GitHub Actions Linux Testing Line Coverage Status Branch-adjusted Line Coverage Status

Supported Platforms

gRPC-Java supports Java 8 and later. Android minSdkVersion 21 (Lollipop) and later are supported with Java 8 language desugaring.

TLS usage on Android typically requires Play Services Dynamic Security Provider. Please see the Security Readme.

Older Java versions are not directly supported, but a branch remains available for fixes and releases. See gRFC P5 JDK Version Support Policy.

Java version gRPC Branch
7 1.41.x

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.62.2</version>
  <scope>runtime</scope>
</dependency>
<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-protobuf</artifactId>
  <version>1.62.2</version>
</dependency>
<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-stub</artifactId>
  <version>1.62.2</version>
</dependency>
<dependency> <!-- necessary for Java 9+ -->
  <groupId>org.apache.tomcat</groupId>
  <artifactId>annotations-api</artifactId>
  <version>6.0.53</version>
  <scope>provided</scope>
</dependency>

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

runtimeOnly 'io.grpc:grpc-netty-shaded:1.62.2'
implementation 'io.grpc:grpc-protobuf:1.62.2'
implementation 'io.grpc:grpc-stub:1.62.2'
compileOnly 'org.apache.tomcat:annotations-api:6.0.53' // necessary for Java 9+

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.62.2'
implementation 'io.grpc:grpc-protobuf-lite:1.62.2'
implementation 'io.grpc:grpc-stub:1.62.2'
compileOnly 'org.apache.tomcat:annotations-api:6.0.53' // necessary for Java 9+

For Bazel, you can either use Maven (with the GAVs from above), or use @io_grpc_grpc_java//api et al (see below).

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.7.1</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.25.1:exe:${os.detected.classifier}</protocArtifact>
        <pluginId>grpc-java</pluginId>
        <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.62.2:exe:${os.detected.classifier}</pluginArtifact>
      </configuration>
      <executions>
        <execution>
          <goals>
            <goal>compile</goal>
            <goal>compile-custom</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

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

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

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

For Android protobuf-based codegen integrated with the Gradle build system, also use protobuf-gradle-plugin but specify the 'lite' options:

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

protobuf {
  protoc {
    artifact = "com.google.protobuf:protoc:3.25.1"
  }
  plugins {
    grpc {
      artifact = 'io.grpc:protoc-gen-grpc-java:1.62.2'
    }
  }
  generateProtoTasks {
    all().each { task ->
      task.builtins {
        java { option 'lite' }
      }
      task.plugins {
        grpc { option 'lite' }
      }
    }
  }
}

For Bazel, use the proto_library and the java_proto_library (no load() required) and load("@io_grpc_grpc_java//:java_grpc_library.bzl", "java_grpc_library") (from this project), as in this example BUILD.bazel.

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 multiple Transport implementations:

  1. The Netty-based HTTP/2 transport is the main transport implementation based on Netty. It is not officially supported on Android.
  2. The OkHttp-based HTTP/2 transport is a lightweight transport based on Okio and forked low-level parts of OkHttp. It is mainly for use on Android.
  3. The in-process transport is for when a server is in the same process as the client. It is used frequently for testing, while also being safe for production use.
  4. The Binder transport is for Android cross-process communication on a single device.