配置

<- 返回索引

本节描述您如何配置您的 grpc-spring-boot-starter 客户端。

目录

附加主题

通过属性配置

grpc-spring-boot-starter 可以通过 Spring 的 @ConfigurationProperties 机制来进行 配置。

您可以在这里找到所有内置配置属性：

如果你希望阅读源代码，你可以查阅 这里。

Channels 的属性都是以 grpc.client.__name__. 或 grpc.client.__name__.security. 为前缀。 Channel 的名称从 @GrpcClient("__name__") 注解中获取。 如果您想要配置一些其他的选项，如为所有服务端设置可信证书，并可以使用 GLOBAL 作为名称。 指定 Channel 的配置项优先于 GLOBAL 的配置项

选择目标

您可以使用以下属性指定目标服务器：

grpc.client.__name__.address=static://localhost:9090

目标服务器支持多种 schemes，您可以使用它们来指定目标服务器（优先级0（低） - 10（高））：

如果您没有定义地址，它将按照如下方式被猜测：

注意: 斜杠的数量很重要！ 还要确保不要连接到普通的 web / REST / 非 grpc 服务器（端口）。

客户端安全性 页面上解释了 SSL / TLS 和其他与安全相关的配置。

通过Beans 配置

虽然这个项目提供大多数功能作为配置选项，但有时会因为添加它的开销太高了，我们会选择没有添加它。 如果您觉得这是一项重要功能，请随意打开一项功能性 Pull Request。

如果您要更改应用程序，而不是通过属性进行更改，则可以使用该项目中现有存在的扩展点。

首先，大多数 bean 可以被自定义 bean 替换，您可以按照您想要的任何方式进行配置。 如果您不希望这么麻烦，可以使用 GrpcChannelConfigurer 和 StubTransformer 等类来配置 channels，stubs 和其他组件，它不会丢失这个项目所提供的任何功能。

GrpcClientBean

在您不可以通过 @GrpcClient 注入实例时，使用此注解可以注入bean。 这个注解可以重复添加到您的 @Configuration 类中。

注意：我们建议在整个应用程序中使用@GrpcClientBean或用@GrpcClient注释的字段，因为这两者的混合使用可能会给未来的开发者带来混乱。

@Configuration
@GrpcClientBean(
    clazz = TestServiceBlockingStub.class,
    beanName = "blockingStub",
    client = @GrpcClient("test")
)
@GrpcClientBean(
    clazz = FactoryMethodAccessibleStub.class,
    beanName = "accessibleStub",
    client = @GrpcClient("test"))
public class YourCustomConfiguration {

    @Bean
    FooService fooServiceBean(@Autowired TestServiceGrpc.TestServiceBlockingStub blockingStub) {
        return new FooService(blockingStub);
    }

}

@Service
@AllArgsConsturtor
public class BarService {

    private FactoryMethodAccessibleStub accessibleStub;

    public String receiveGreeting(String name) {
        HelloRequest request = HelloRequest.newBuilder()
                .setName(name)
                .build();
        return accessibleStub.sayHello(request).getMessage();
    }

}

GrpcChannelConfigurer

Grpc 客户端配置器允许您将自定义配置添加到 gRPC 的 ManagedChannelBuilder 中 。

@Bean
public GrpcChannelConfigurer keepAliveClientConfigurer() {
    return (channelBuilder, name) -> {
        if (channelBuilder instanceof NettyChannelBuilder) {
            ((NettyChannelBuilder) channelBuilder)
                    .keepAliveTime(30, TimeUnit.SECONDS)
                    .keepAliveTimeout(5, TimeUnit.SECONDS);
        }
    };
}

注意，根据您的配置，在应用上下文中可能有不同类型的 ManagedChannelBuilder (例如InProcessChannelFactory)。

ClientInterceptor

ClientInterceptor 可以用于各种任务，包括：

向您的 Channel 添加 ClientInterceptor 的三种方式。

以下示例演示如何使用注解创建全局客户拦截器：

@Configuration
public class GlobalInterceptorConfiguration {

    @GrpcGlobalClientInterceptor
    LogGrpcInterceptor logClientInterceptor() {
        return new LogGrpcInterceptor();
    }

}

下面的示例通过 GlobalClientInterestorConfigurer 演示创建全局拦截器

@Configuration
public class GlobalInterceptorConfiguration {

    @Bean
    GlobalClientInterceptorConfigurer globalClientInterceptorConfigurer() {
        interceptors -> interceptors.add(new LogGrpcInterceptor());
    }

}

如果您想要将第三方拦截器添加到全局拦截器，上述这些变种会非常简单。

对于您自己的拦截器实现功能，您可以通过添加注解到类本身来实现相同的结果：

@GrpcGlobalClientInterceptor
public class LogGrpcInterceptor implements ClientInterceptor {

    private static final Logger log = LoggerFactory.getLogger(LogGrpcInterceptor.class);

    @Override
    public <ReqT, RespT> ClientCall<ReqT, RespT> interceptCall(
            final MethodDescriptor<ReqT, RespT> method,
            final CallOptions callOptions,
            final Channel next) {

        log.info(method.getFullMethodName());
        return next.newCall(method, callOptions);
    }

}

StubFactory

StubFactory 用于创建一个特定类型的 Stub 。 注册的 stub 工厂将按顺序检查是否适用，第一个适用的工厂将被用来创建 stub。

该库内置了对 grpc-java 中定义的 Stub 类型的支持：

但是您也可以通过向应用程序上下文添加自定义 StubFactory 轻松添加对其他 Stub 类型的支持。

@Component
public class MyCustomStubFactory implements StubFactory {

    @Override
    public MyCustomStub<?> createStub(Class<? extends AbstractStub<?>> stubType, Channel channel) {
        try {
            Class<?> enclosingClass = stubType.getEnclosingClass();
            Method factoryMethod = enclosingClass.getMethod("newMyBetterFutureStub", Channel.class);
            return stubType.cast(factoryMethod.invoke(null, channel));
        } catch (Exception e) {
            throw new BeanInstantiationException(stubType, "Failed to create gRPC stub", e);
        }
    }

    @Override
    public boolean isApplicable(Class<? extends AbstractStub<?>> stubType) {
        return AbstractMyCustomStub.class.isAssignableFrom(stubType);
    }

}

注意： 请在我们的 issue 中报告缺少支持的 stub 类型(和相应的库)，以便我们添加对它的支持。

StubTransformer

StubTransformer 允许您在注入您的 Bean 之前修改Stub。 如果要往 stub 中添加 CallCredentials ，我们会推荐你用这种方式。

@Bean
public StubTransformer call() {
    return (name, stub) -> {
        if ("serviceA".equals(name)) {
            return stub.withWaitForReady();
        } else {
            return stub;
        }
    };
}

您也可以使用 StubTransformer来添加自定义 ClientInterceptor 到你的 stub 中。

注意: StubTransformer 是在 @GrpcClient#interceptors(Names) 添加后应用的。

自定义 NameResolverProvider

有时，你可能想根据一些自定义的逻辑来决定连接到哪个服务器：这时你可以使用自定义 NameResolverProvider 来实现。

注意： 这只能用于在应用程序级别上，而不是应用在每个请求级别上。

这个库内置提供了一些 NameResolverProvider，因此你可以直接使用 它们。

你也利用 Java 的 ServiceLoader ，在 META-INF/services/io.grpc.NameResolverProvider 文件中添加，或者通过在 spring context 中添加，以此注册自定义的 NameResolverProvider。 如果你想在你的 NameResolver 中使用一些 spring 的 bean， 那么你必须通过 spring 的 context 来定义它 (否则会使用使用 static)。

注意： NameResolverProvider 注册是全局的： 如果你在同一JVM中注册了两个或多个，那可能会遇到问题（例如测试期间）。

HealthIndicator

这个库会自动为所有 grpcChannel 客户端提供 HealthIndicator (actuator/health)。 如果客户端有 TRANSIENT_FAILURE 状态，那服务为上报 OUT_OF_SERVICE。 如果您想要去掉它并提供更具体的 HealthIndicator， 您可以通过 exclude GrpcClientHealthAutoConfiguration 来禁用它。

附加主题

<- 返回索引