grpc-java README

The project's README from github.com/grpc/grpc-java. As one markdown file: README.md.

gRPC-Java - An RPC library and framework

Homepage: grpc.io
Mailing List: [email protected]

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 24 (Nougat) 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.84.0</version>
  <scope>runtime</scope>
</dependency>
<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-protobuf</artifactId>
  <version>1.84.0</version>
</dependency>
<dependency>
  <groupId>io.grpc</groupId>
  <artifactId>grpc-stub</artifactId>
  <version>1.84.0</version>
</dependency>

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

runtimeOnly 'io.grpc:grpc-netty-shaded:1.84.0'
implementation 'io.grpc:grpc-protobuf:1.84.0'
implementation 'io.grpc:grpc-stub:1.84.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.84.0'
implementation 'io.grpc:grpc-protobuf-lite:1.84.0'
implementation 'io.grpc:grpc-stub:1.84.0'

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

grpc-java (grpc/grpc-java)

Searching Database…

12.1K ·GitHub
Grpc-java
Что это такое?gRPC-Java — официальная реализация gRPC на Java, RPC-фреймворка от Google, построенного поверх HTTP/2. Она позволяет клиентам и серверам на Java и Android вызывать методы друг друга через типизированные бинарные стабы сервисов вместо самописных REST/JSON API.
Это просто библиотека или она ещё и генерирует код?Это и то и другое: библиотека времени выполнения, разделённая на слои Стаб, Канал и Транспорт, плюс плагин для protoc (protoc-gen-grpc-java), который генерирует стабы сервисов на Java из ваших файлов .proto.
Как мне добавить это в проект?Добавьте зависимости grpc-netty-shaded, grpc-protobuf и grpc-stub через Maven или Gradle (или эквивалентные цели Bazel); для Android замените их на grpc-okhttp и grpc-protobuf-lite.
Нужна ли мне конкретная версия Java для работы?Библиотека рассчитана на Java 8 и новее; на Android нужен minSdkVersion 24 (Nougat) или выше с десугарингом языка Java 8. Более старые JDK (Java 7) получают исправления только в устаревшей ветке 1.41.x.
TLS на Android работает сам по себе, без дополнительных настроек?Нет, автоматически не работает: для TLS на Android обычно нужно отдельно настроить Play Services Dynamic Security Provider, а основной транспорт на базе Netty официально на Android не поддерживается (вместо него там используется grpc-okhttp).
gRPC-Java ведёт себя на Android так же, как на обычной серверной JVM?Не совсем: Android-приложения используют облегчённый транспорт на базе OkHttp и могут использовать транспорт Binder для вызовов между процессами на устройстве, тогда как серверы обычно опираются на транспорт на базе Netty, который Android официально не поддерживает.
Какие реализации транспорта входят в gRPC-Java?HTTP/2 на базе Netty (основной транспорт вне Android), HTTP/2 на базе OkHttp (в основном для Android), внутрипроцессный транспорт для тестов в одном процессе и транспорт Binder для вызовов между процессами на Android.
Могу ли я собирать сгенерированные стабы с Bazel вместо Maven или Gradle?Да, в проекте есть правила для Bazel: используйте proto_library и java_proto_library, а также макрос java_grpc_library, загружаемый из этого репозитория, как показано в примере файла BUILD.bazel.
Что означают аннотации @Internal и @ExperimentalApi?@Internal помечает API, предназначенные только для внутреннего использования самим gRPC, а @ExperimentalApi — API, которые могут измениться в будущих версиях; плагин Error Prone grpc-java-api-checker может указать на непреднамеренное использование любого из них в вашем коде.
Что на практике представляют собой Стаб, Канал и Транспорт?Стаб — типизированный сгенерированный API, которым пользуется большинство разработчиков; Канал — слой перехвата и обёртывания вызовов для задач вроде логирования и аутентификации; Транспорт — низкоуровневый слой, который непосредственно передаёт байты по сети.
What are similar projects?grpc-rust, grpc-go, brpc, grpc, dubbo, grpc-gateway, go-zero, flatbuffers
Which topics is it in?bazel, protocol-buffers, http2, rpc, android-library, grpc, tls, microservices, java, backend, desktop, networking
Creator
grpc
Size
127.4 MB
Stars
12.1K
Updated
CommitOct 16Releasev1.85.0Oct 14
Age
11y
Commits · 90 Days