这是本节的多页打印视图。 点击此处打印.

返回本页常规视图.

使用 gRPC-Java

1 - 服务注册

引入依赖

<dependency>
    <groupId>com.tencent.polaris</groupId>
    <artifactId>grpc-java-polaris</artifactId>
    <version>${grpc-java-polaris.version}</version>
</dependency>

初始化 polaris.yaml

你需要在项目的根路径下创建一个 polaris.yaml 文件用于 grpc-java-polaris 初始化 polaris sdk。polaris.yaml配置详细

如何使用

将原本的 ServerBuilder 替换为 PolarisGrpcServerBuilder 即可实现将 gRPC-java 服务注册到北极星中

原本 gRPC-java 的创建方式

server = ServerBuilder.forPort(port).addService(new GreeterImpl()).build().start();

使用 gRPC-java-polaris 的创建方式

Server server = PolarisGrpcServerBuilder.forPort(port).addService(new GreeterImpl()).build().start();

注册信息控制

命名空间

默认情况下，gRPC-java 注册到北极星的 default 命名空间中，如果希望注册到别的命名空间，可通过设置namespace的方式

public class GrpcServerDemo {

    public static void main(String[] args) {
        Server server = PolarisGrpcServerBuilder
                .forPort(0)
                .namespace("grpc-java-demo")
                .addService(new HelloProvider(metadata))
                .addService(new HiProvider())
                .build();

        Server server = server.start();
        JvmHookHelper.addShutdownHook(() -> {
            server.shutdown();
        });
    }
}

注册粒度

默认情况下，gRPC-java的注册粒度是按照 ServerServiceDefinition 来进行注册的，如果希望将整个 gRPC-java 进程作为一个服务进行注册的话，可通过设置 applicationName 的方式

public class GrpcServerDemo {

    public static void main(String[] args) {
        Server server = PolarisGrpcServerBuilder
                .forPort(0)
                .applicationName("grpc-java-demo")
                .addService(new HelloProvider(metadata))
                .addService(new HiProvider())
                .build();

        Server server = server.start();
        JvmHookHelper.addShutdownHook(() -> {
            server.shutdown();
        });
    }
}

实例属性设置

public class GrpcServerDemo {

    public static void main(String[] args) {
        Server server = PolarisGrpcServerBuilder
                .forPort(0)
                // 设置实例的权重信息
                .weight(int)
                // 设置实例的元数据信息
                .metadata(Map<String, String>)
                // 设置实例的版本信息
                .version(String)
                .addService(new HelloProvider(metadata))
                .addService(new HiProvider())
                .build();

        Server server = server.start();
        JvmHookHelper.addShutdownHook(() -> {
            server.shutdown();
        });
    }
}

如何基于 grpc-java-polaris 完成一个服务注册的程序

2 - 服务发现

引入依赖

<dependency>
    <groupId>com.tencent.polaris</groupId>
    <artifactId>grpc-java-polaris</artifactId>
    <version>${grpc-java-polaris.version}</version>
</dependency>

初始化 polaris.yaml

你需要在项目的根路径下创建一个 polaris.yaml 文件用于 grpc-java-polaris 初始化 polaris sdk。polaris.yaml配置详细

如何使用

方式一

SDKContext context = SDKContext.initContext();
ManagedChannel channel = ManagedChannelBuilder.forTarget(target)
          			.nameResolverFactory(new PolarisNameResolverProvider(context))
          			.usePlaintext()
          			.build();

方式二

ManagedChannel channel = PolarisManagedChannelBuilder.forTarget(target).usePlaintext().build();

额外参数设置

命名空间设置

默认情况下，gRPC-java只发现北极星default命名空间中的服务，如果希望发现别的命名空间下的服务，可通过设置url参数的方式

public class GrpcClientDemo {

    public static void main(String[] args) {
        ManagedChannel channel = PolarisManagedChannelBuilder.forTarget("polaris://grpc-java-demo?namespace=demo")
                                .usePlaintext()
                                .build();
    }
}

如何基于 grpc-java-polaris 完成一个服务发现的程序

3 - 动态路由

当前支持针对 gRPC 消息的以下内容进行动态路由：

消息类型 gRPC 消息内容 路由规则请求类型
消息头 metadata 请求头(HEADER)
gRPC方法 method 路径(PATH)

引入依赖

<dependency>
    <groupId>com.tencent.polaris</groupId>
    <artifactId>grpc-java-polaris</artifactId>
    <version>${grpc-java-polaris.version}</version>
</dependency>

初始化 polaris.yaml

你需要在项目的根路径下创建一个 polaris.yaml 文件用于 grpc-java-polaris 初始化 polaris sdk。polaris.yaml配置详细

gRPC Client 构建

// 使用 grpc-java-polaris 提供的 PolarisManagedChannelBuilder 即可
ManagedChannel channel = PolarisManagedChannelBuilder.forTarget(target).usePlaintext().build();

如何配置动态路由参数

gRPC-Java 中的 PolarisMesh Balancer 扩展点实现，能够根据用户配置的服务路由规则，自动的从当前 RPC 调用上下文以及请求信息中识别出需要参与服务路由的请求标签信息。

假定一个场景：

  • 希望 uid 为 user-1 的请求，路由到 env 标签为 dev 的实例上
  • 希望 uid 为 user-2 的请求，路由到 env 标签为 pre 的实例上
  • 其他则路由到 env 标签为 prod 的实例上，那可以为 gRPC-Java 服务设置三条路由规则。

  • 请求匹配规则为 请求头(HEADER):
    • 标签来源: RPC 调用的额外标签信息，即 PickSubchannelArgs.getHeaders()

示例代码（gRPC-Java原生使用方式）

Metadata metadata = new Metadata();
headers.forEach((s, val) -> {
    if (StringUtils.equals("uid", s.toLowerCase())) {
        metadata.put(Key.of(s.toLowerCase(), Metadata.ASCII_STRING_MARSHALLER), val.get(0));
    }
})

HelloGrpc.HelloBlockingStub helloBlockingStub = HelloGrpc.newBlockingStub(channel);
helloBlockingStub = helloBlockingStub.withInterceptors(MetadataUtils.newAttachHeadersInterceptor(metadata));
HelloPolaris.request request = HelloPolaris.request.newBuilder().setMsg(value).build();
HelloPolaris.response response = helloBlockingStub.sayHello(request);

验证

可根据 grpc-java-polaris example 开展

4 - 访问限流

当前支持针对 gRPC 消息的以下内容进行访问限流：

消息类型 gRPC 消息内容 路由规则请求类型
消息头 metadata 请求头(HEADER)
gRPC方法 method 路径(PATH)

引入依赖

<dependency>
    <groupId>com.tencent.polaris</groupId>
    <artifactId>grpc-java-polaris</artifactId>
    <version>${grpc-java-polaris.version}</version>
</dependency>

初始化 polaris.yaml

你需要在项目的根路径下创建一个 polaris.yaml 文件用于 grpc-java-polaris 初始化 polaris sdk。polaris.yaml配置详细

gRPC Server 构建

Server polarisGrpcServer = PolarisGrpcServerBuilder
        .forPort(0)
        .namespace("default")
        .applicationName("RateLimitServerGRPCJava")
        // 注入限流的 server 拦截器
        .intercept(PolarisHelper.buildRateLimitInterceptor()
                .build())
        .heartbeatInterval(5)
        .addService(new HelloProvider())
        .addService(new HiProvider())
        .build();

如何配置访问限流参数

gRPC-Java 中的 PolarisMesh RateLimiter 扩展点实现，能够根据用户配置的限流规则，自动的从当前 RPC 调用上下文以及请求信息中识别出需要参与限流的请求标签信息。

比如对 gRPC-Java 中的 sayHello 方法，对 Metadata 中 uid 为 user-1 的进行限流，速率为10/s。

  • 请求匹配规则为 请求头(HEADER):
    • 标签来源: RPC 调用的额外标签信息，即 interceptCall(ServerCall<ReqT, RespT> call, Metadata headers, ServerCallHandler<ReqT, RespT> next)

验证

可根据 grpc-java-polaris example 开展