Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/grpc-ecosystem/grpc-spring

Spring Boot starter module for gRPC framework.
https://github.com/grpc-ecosystem/grpc-spring

grpc grpc-framework grpc-java java spring spring-boot spring-boot-grpc spring-boot-starter spring-cloud

Last synced: about 3 hours ago
JSON representation

Spring Boot starter module for gRPC framework.

Host: GitHub
URL: https://github.com/grpc-ecosystem/grpc-spring
Owner: grpc-ecosystem
License: apache-2.0
Created: 2016-12-30T09:06:15.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2024-04-30T11:58:19.000Z (5 months ago)
Last Synced: 2024-05-01T20:26:25.779Z (5 months ago)
Topics: grpc, grpc-framework, grpc-java, java, spring, spring-boot, spring-boot-grpc, spring-boot-starter, spring-cloud
Language: Java
Homepage: https://grpc-ecosystem.github.io/grpc-spring/
Size: 3.62 MB
Stars: 3,339
Watchers: 119
Forks: 792
Open Issues: 121
Metadata Files:
- Readme: README-zh-CN.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        # gRPC Spring Boot Starter

[![Build master branch](https://github.com/grpc-ecosystem/grpc-spring/workflows/Build%20master%20branch/badge.svg)](https://github.com/grpc-ecosystem/grpc-spring/actions) [![Maven Central with version prefix filter](https://img.shields.io/maven-central/v/net.devh/grpc-spring-boot-starter.svg)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22net.devh%22%20grpc) [![License](https://img.shields.io/github/license/mashape/apistatus.svg)](LICENSE) [![Crowdin](https://badges.crowdin.net/grpc-spring-boot-starter/localized.svg)](https://crowdin.com/project/grpc-spring-boot-starter)

[![Client-Javadoc](https://www.javadoc.io/badge/net.devh/grpc-client-spring-boot-starter.svg?label=Client-Javadoc)](https://www.javadoc.io/doc/net.devh/grpc-client-spring-boot-starter) [![Server-Javadoc](https://www.javadoc.io/badge/net.devh/grpc-server-spring-boot-starter.svg?label=Server-Javadoc)](https://www.javadoc.io/doc/net.devh/grpc-server-spring-boot-starter) [![Common-Javadoc](https://www.javadoc.io/badge/net.devh/grpc-common-spring-boot.svg?label=Common-Javadoc)](https://www.javadoc.io/doc/net.devh/grpc-common-spring-boot)

README: [English](README.md) | [中文](README-zh-CN.md)

**文档：** [English](https://yidongnan.github.io/grpc-spring-boot-starter/en/) | [中文](https://yidongnan.github.io/grpc-spring-boot-starter/zh-CN/)

## 特性

* 使用 `@GrpcService` 注解可以实现自动配置和运行 gRPC Server 端

* 使用 `@GrpcClient` 注解可以实现自动创建和管理您的 gRPC Channels 和 stubs

* 支持其他 grpc-java 的变种 (例如： [Reactive gRPC (RxJava)](https://github.com/salesforce/reactive-grpc/tree/master/rx-java), [grpc-kotlin](https://github.com/grpc/grpc-kotlin), ...)

  * Server 端：适用于所有 grpc-java 的变种 ( 基于 `io.grpc.BindableService`)

  * Client 端：需要自定义 `StubFactory` 当前内置支持：

    * grpc-java

    * (请告知我们不支持的组件，我们可以添加对它们的支持)

* 支持 [Spring-Security](https://github.com/spring-projects/spring-security)

* 支持 [Spring Cloud](https://spring.io/projects/spring-cloud)

  * 服务端：向服务注册详情中添加 gRPC 端口信息。 目前原生支持：

    * [Consul](https://github.com/spring-cloud/spring-cloud-consul)

    * [Eureka](https://github.com/spring-cloud/spring-cloud-netflix)

    * [Nacos](https://github.com/spring-cloud-incubator/spring-cloud-alibaba)

    * (请告诉我们不支持的组件，我们可以添加对它们的支持)

  * 客户端：从 Spring 的 `DiscoveryClient` (所有变种) 读取服务的目标地址

* 支持[Spring Sleuth](https://github.com/spring-cloud/spring-cloud-sleuth)作为分布式链路跟踪解决方案(如果[brave-instrument-grpc](https://mvnrepository.com/artifact/io.zipkin.brave/brave-instrumentation-grpc)存在)

* 支持全局和自定义的 gRPC 服务端/客户端拦截器

* 支持metric (基于[micrometer](https://micrometer.io/)/[actuator](https://github.com/spring-projects/spring-boot/tree/master/spring-boot-project/spring-boot-actuator) )

* 也适用于 (non-shaded) grpc-netty

## 版本

最新版本是 `3.1.0.RELEASE` 它能跟 Spring-Boot `3.2.4` 和 Spring-Cloud `2023.0.0` 搭配使用。 但它也与各种其他版本兼容。 我们的 [文档](https://yidongnan.github.io/grpc-spring-boot-starter/en/versions.html) 中可以找到所有版本及其相应的库版本的概览。

**注意:** 该项目也可以在没有 Spring-Boot 的情况下使用，但是您需要手动配置一些 bean。

## 用法

### gRPC 服务端 + 客户端

使用以下命令添加 Maven 依赖项：

````xml

  net.devh

  grpc-spring-boot-starter

  3.1.0.RELEASE

````

使用 Gradle 添加依赖：

````gradle

dependencies {

  implementation 'net.devh:grpc-spring-boot-starter:3.1.0.RELEASE'

}

````

### gRPC 服务端

使用以下命令添加 Maven 依赖项：

````xml

  net.devh

  grpc-server-spring-boot-starter

  3.1.0.RELEASE

````

使用 Gradle 添加依赖项：

````gradle

dependencies {

  implementation 'net.devh:grpc-server-spring-boot-starter:3.1.0.RELEASE'

}

````

在服务端接口实现类上添加 `@GrpcService` 注解。

````java

@GrpcService

public class GrpcServerService extends GreeterGrpc.GreeterImplBase {

    @Override

    public void sayHello(HelloRequest req, StreamObserver responseObserver) {

        HelloReply reply = HelloReply.newBuilder().setMessage("Hello ==> " + req.getName()).build();

        responseObserver.onNext(reply);

        responseObserver.onCompleted();

    }

}

````

默认情况下，gRPC 服务器将监听端口 `9090`。 端口的配置和其他的 [设置](grpc-server-spring-boot-starter/src/main/java/net/devh/boot/grpc/server/config/GrpcServerProperties.java) 可以通过 Spring 的属性机制进行更改。 服务端的配置使用 `grpc.server.` 前缀。

详情请参阅我们的[文档](https://yidongnan.github.io/grpc-spring-boot-starter/)。

### gRPC 客户端

使用一下命令添加 Maven 依赖项：

````xml

  net.devh

  grpc-client-spring-boot-starter

  3.1.0.RELEASE

````

使用 Gradle 添加依赖项：

````gradle

dependencies {

  compile 'net.devh:grpc-client-spring-boot-starter:3.1.0.RELEASE'

}

````

在 grpc 客户端的的 stub 字段上添加 `@GrpcClient(serverName)` 注解。

* 请不要将 @GrpcClient 与 `@Autowireed` 或 `@Inject` 一起使用。

  ````java

  @GrpcClient("gRPC server name")

  private GreeterGrpc.GreeterBlockingStub greeterStub;

  ````

**注意:** 你可以将相同的 grpc 服务端名称用于多个 channel， 也可以使用不同的 stub （甚至使用不同的 stub 拦截器）

然后您可以向您的服务器发送查询，就像这样：

````java

HelloReply response = stub.sayHello(HelloRequest.newBuilder().setName(name).build());

````

可以单独配置每个客户端的目标地址。 但在某些情况下，您可以仅依靠默认配置。 您可以通过 `NameResolver.Factory` Bean 类自定义默认的 url 映射。 如果您没有配置那个Bean，那么默认的 uri 将使用默认方案和名称(如：`dns:`)：

这些配置和其他的 [设置](grpc-client-spring-boot-starter/src/main/java/net/devh/boot/grpc/client/config/GrpcChannelProperties.java) 可以通过 Spring 的属性机制进行更改。 客户端使用`grpc.client.(serverName)。` 前缀。

详情请参阅我们的[文档](https://yidongnan.github.io/grpc-spring-boot-starter/)。

## 使用 (non-shaded) grpc-netty 运行

这个库支持`grpc-netty`和`grpc-nety-shaded`。 后一种可能会防止与不兼容的 gRPC 版本冲突或不同 netty 版本之间的冲突。

**注意:** 如果在classpath 中存在 shaded netty， 则 shaded netty 将使用有线与 non-shaded grpc-netty。

您可以在 Maven 中这样使用。

````xml

    io.grpc

    grpc-netty

    ${grpcVersion}

    net.devh

    grpc-spring-boot-starter

    ...

    

        

            io.grpc

            grpc-netty-shaded

        

    

    net.devh

    grpc-server-spring-boot-starter

    ...

    

        

            io.grpc

            grpc-netty-shaded

        

    

    net.devh

    grpc-client-spring-boot-starter

    ...

    

        

            io.grpc

            grpc-netty-shaded

        

    

````

类似，使用 Gradle 的如下

````groovy

implementation "io.grpc:grpc-netty:${grpcVersion}"

implementation 'net.devh:grpc-spring-boot-starter:...' exclude group: 'io.grpc', module: 'grpc-netty-shaded' // For both

implementation 'net.devh:grpc-client-spring-boot-starter:...' exclude group: 'io.grpc', module: 'grpc-netty-shaded' // For the client (only)

implementation 'net.devh:grpc-server-spring-boot-starter:...' exclude group: 'io.grpc', module: 'grpc-netty-shaded' // For the server (only)

````

## 示例项目

在 [这里](examples)可以查看更多关于该项目的示例。

## 排除故障

请参阅我们的[文档](https://yidongnan.github.io/grpc-spring-boot-starter/en/trouble-shooting)寻求帮助。

## 参与贡献

欢迎您对项目作出任何贡献。 详见[CONTRIBUTING.md](CONTRIBUTING.md)。