Go to file
Eric Anderson 1fc4ab0bb2 LBs should avoid calling LBs after lb.shutdown()
LoadBalancers shouldn't be called after shutdown(), but RingHashLb could
have enqueued work to the SynchronizationContext that executed after
shutdown(). This commit fixes problems discovered when auditing all LBs
usage of the syncContext for that type of problem.

Similarly, PickFirstLb could have requested a new connection after
shutdown(). We want to avoid that sort of thing too.

RingHashLb's test changed from CONNECTING to TRANSIENT_FAILURE to get
the latest picker. Because two subchannels have failed it will be in
TRANSIENT_FAILURE. Previously the test was using an older picker with
out-of-date subchannelView, and the verifyConnection() was too imprecise
to notice it was creating the wrong subchannel.

As discovered in b/430347751, where ClusterImplLb was seeing a new
subchannel being called after the child LB was shutdown (the shutdown
itself had been caused by RingHashConfig not implementing equals() and
was fixed by a8de9f07ab, which caused ClusterResolverLb to replace its
state):

```
java.lang.NullPointerException
	at io.grpc.xds.ClusterImplLoadBalancer$ClusterImplLbHelper.createClusterLocalityFromAttributes(ClusterImplLoadBalancer.java:322)
	at io.grpc.xds.ClusterImplLoadBalancer$ClusterImplLbHelper.createSubchannel(ClusterImplLoadBalancer.java:236)
	at io.grpc.util.ForwardingLoadBalancerHelper.createSubchannel(ForwardingLoadBalancerHelper.java:47)
	at io.grpc.util.ForwardingLoadBalancerHelper.createSubchannel(ForwardingLoadBalancerHelper.java:47)
	at io.grpc.internal.PickFirstLeafLoadBalancer.createNewSubchannel(PickFirstLeafLoadBalancer.java:527)
	at io.grpc.internal.PickFirstLeafLoadBalancer.requestConnection(PickFirstLeafLoadBalancer.java:459)
	at io.grpc.internal.PickFirstLeafLoadBalancer.acceptResolvedAddresses(PickFirstLeafLoadBalancer.java:174)
	at io.grpc.xds.LazyLoadBalancer$LazyDelegate.activate(LazyLoadBalancer.java:64)
	at io.grpc.xds.LazyLoadBalancer$LazyDelegate.requestConnection(LazyLoadBalancer.java:97)
	at io.grpc.util.ForwardingLoadBalancer.requestConnection(ForwardingLoadBalancer.java:61)
	at io.grpc.xds.RingHashLoadBalancer$RingHashPicker.lambda$pickSubchannel$0(RingHashLoadBalancer.java:440)
	at io.grpc.SynchronizationContext.drain(SynchronizationContext.java:96)
	at io.grpc.SynchronizationContext.execute(SynchronizationContext.java:128)
	at io.grpc.xds.client.XdsClientImpl$ResourceSubscriber.onData(XdsClientImpl.java:817)
```
2025-07-17 12:56:33 +00:00
.github Replace Kokoro ARM build with GitHub Actions 2025-02-04 10:51:13 -08:00
all all:Add GCP CSM Observability (#11305) 2024-06-21 14:35:39 -07:00
alts compiler: Default to @generated=omit (#12080) 2025-05-21 22:49:30 +05:30
android Replace jsr305's GuardedBy with Error Prone's 2025-01-10 08:16:48 -08:00
android-interop-testing compiler: generate blocking v2 unary calls that throw StatusException (#12126) 2025-06-10 10:31:03 +05:30
api LBs should avoid calling LBs after lb.shutdown() 2025-07-17 12:56:33 +00:00
auth auth: Use pre-existing private key in test 2025-04-08 11:03:45 -07:00
authz Re-enable animalsniffer, fixing violations 2024-12-19 07:54:54 -08:00
benchmarks compiler: generate blocking v2 unary calls that throw StatusException (#12126) 2025-06-10 10:31:03 +05:30
binder binder: Introduce server pre-authorization (#12127) 2025-07-10 14:14:36 -07:00
bom use gradle java-platform in grpc-bom; Fixes #5530 (#11875) 2025-02-05 11:10:39 -08:00
buildSrc Upgrade dependencies 2024-07-11 15:09:00 -07:00
buildscripts release: Migrate artifacts publishing from legacy OSSRH to Central Portal (#12156) 2025-06-24 10:12:35 +05:30
census census: APIs for stats and tracing (#12050) 2025-07-01 20:44:28 +05:30
compiler Start 1.75.0 development cycle 2025-06-25 04:52:17 +00: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
contextstorage Re-enable animalsniffer, fixing violations 2024-12-19 07:54:54 -08:00
core LBs should avoid calling LBs after lb.shutdown() 2025-07-17 12:56:33 +00:00
cronet cronet: Delete TODO for User-Agent on CronetEngine 2025-05-27 10:52:47 -07:00
documentation documentation: upgrade to junit 4.13.2 (#11967) 2025-03-18 18:43:03 +05:30
examples LBs should avoid calling LBs after lb.shutdown() 2025-07-17 12:56:33 +00:00
gae-interop-testing gae-interop-testing: Remove duplicate repositories 2025-01-03 09:29:08 -08:00
gcp-csm-observability Re-enable animalsniffer, fixing violations 2024-12-19 07:54:54 -08:00
gcp-observability gcp-observability: Optimize GcpObservabilityTest.enableObservability execution time (#11783) 2025-01-24 16:50:41 +05:30
googleapis Re-enable animalsniffer, fixing violations 2024-12-19 07:54:54 -08:00
gradle s2a: Use protos published under com.google.s2a.proto.v2. (#11908) 2025-02-19 16:59:50 -08:00
grpclb compiler: Default to @generated=omit (#12080) 2025-05-21 22:49:30 +05:30
inprocess core: grpc-timeout should always be positive (#12201) 2025-07-03 11:44:04 +05:30
interop-testing compiler: generate blocking v2 unary calls that throw StatusException (#12126) 2025-06-10 10:31:03 +05:30
istio-interop-testing compiler: generate blocking v2 unary calls that throw StatusException (#12126) 2025-06-10 10:31:03 +05:30
netty tests: Replace usages of deprecated junit ExpectedException with assertThrows (#12103) 2025-05-30 10:55:37 +05:30
okhttp tests: Replace usages of deprecated junit ExpectedException with assertThrows (#12103) 2025-05-30 10:55:37 +05:30
opentelemetry Implement grpc.lb.backend_service optional label 2025-04-21 06:17:43 -07:00
protobuf protobuf: Stabilize marshallerWithRecursionLimit (#11884) 2025-02-07 14:16:13 +05:30
protobuf-lite tests: Replace usages of deprecated junit ExpectedException with assertThrows (#12103) 2025-05-30 10:55:37 +05:30
rls Fix RLS regressions from XdsDepMan conversion 2025-06-30 14:23:32 +00:00
s2a s2a: Use protos published under com.google.s2a.proto.v2. (#11908) 2025-02-19 16:59:50 -08:00
services compiler: generate blocking v2 unary calls that throw StatusException (#12126) 2025-06-10 10:31:03 +05:30
servlet servlet: set description for CANCELLED status (#11927) 2025-03-12 14:09:49 +05:30
stub compiler: generate blocking v2 unary calls that throw StatusException (#12126) 2025-06-10 10:31:03 +05:30
testing tests: Replace usages of deprecated junit ExpectedException with assertThrows (#12103) 2025-05-30 10:55:37 +05:30
testing-proto compiler: generate blocking v2 unary calls that throw StatusException (#12126) 2025-06-10 10:31:03 +05:30
util util: Deliver addresses in a random order in MultiChildLb 2025-06-17 07:14:32 -07:00
xds LBs should avoid calling LBs after lb.shutdown() 2025-07-17 12:56:33 +00: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 bazel: Add support for bzlmod (#11046) 2024-04-04 08:36:55 -07:00
AUTHORS all: update to Apache 2 licence 2017-05-31 13:29:01 -07:00
BUILD.bazel compiler: Default to @generated=omit (#12080) 2025-05-21 22:49:30 +05:30
CODE-OF-CONDUCT.md Update governance, contributing, code of conduct docs (#6171) 2019-09-20 16:28:42 -07:00
COMPILING.md Upgrade Protobuf C++ to 22.5 (#11961) 2025-05-23 12:24:14 +05:30
CONTRIBUTING.md CONTRIBUTING.md: Update commit guidelines 2024-08-07 16:34:11 -07:00
GOVERNANCE.md Update governance, contributing, code of conduct docs (#6171) 2019-09-20 16:28:42 -07:00
LICENSE fix LICENSE file (#3107) 2017-06-20 08:52:39 +02:00
MAINTAINERS.md Remove inactive maintainers (#12187) 2025-07-11 15:07:00 -07:00
MODULE.bazel Start 1.75.0 development cycle 2025-06-25 04:52:17 +00: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 release: Migrate artifacts publishing from legacy OSSRH to Central Portal (#12156) 2025-06-24 10:12:35 +05:30
RELEASING.md release: Migrate artifacts publishing from legacy OSSRH to Central Portal (#12156) 2025-06-24 10:12:35 +05:30
SECURITY.md Upgrade netty-tcnative to 2.0.70 2025-02-13 12:41:56 -08:00
WORKSPACE Add `load()` statements for the Bazel builtin top-level java symbols (#11105) 2024-04-17 16:43:21 -07:00
WORKSPACE.bzlmod bazel: Add support for bzlmod (#11046) 2024-04-04 08:36:55 -07:00
build.gradle Start 1.75.0 development cycle 2025-06-25 04:52:17 +00:00
codecov.yml Disable codecov comment and changes status 2016-05-01 22:39:12 -07:00
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 bazel: Migrate java_grpc_library to use DefaultInfo (#12148) 2025-06-12 08:43:23 -07:00
repositories.bzl xds: cncf/xds proto sync to 2025-05-02 (#12225) 2025-07-17 10:26:12 +05:30
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 Bump com.google.protobuf gradle plugin to 0.9.5 2025-05-06 06:20:33 -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.73.0</version>
  <scope>runtime</scope>
</dependency>
<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-protobuf</artifactId>
  <version>1.73.0</version>
</dependency>
<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-stub</artifactId>
  <version>1.73.0</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.73.0'
implementation 'io.grpc:grpc-protobuf:1.73.0'
implementation 'io.grpc:grpc-stub:1.73.0'
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.73.0'
implementation 'io.grpc:grpc-protobuf-lite:1.73.0'
implementation 'io.grpc:grpc-stub:1.73.0'
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.5:exe:${os.detected.classifier}</protocArtifact>
        <pluginId>grpc-java</pluginId>
        <pluginArtifact>io.grpc:protoc-gen-grpc-java:1.73.0: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.5'
}

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

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.5'
}

protobuf {
  protoc {
    artifact = "com.google.protobuf:protoc:3.25.5"
  }
  plugins {
    grpc {
      artifact = 'io.grpc:protoc-gen-grpc-java:1.73.0'
    }
  }
  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. There is a "grpc-netty-shaded" version of this transport. It is generally preferred over using the Netty-based transport directly as it requires less dependency management and is easier to upgrade within many applications.
  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.