快捷導(dǎo)航

Java gRPC攔截器簡單實現(xiàn)分布式日志鏈路追蹤器過程詳解

更新時間：2023年03月01日 10:32:33 作者：Redick01

有請求的發(fā)送、處理，當然就會有攔截器的需求，例如在服務(wù)端通過攔截器統(tǒng)一進行請求認證等操作，這些就需要攔截器來完成，今天松哥先和小伙伴們來聊一聊gRPC中攔截器的基本用法，后面我再整一篇文章和小伙伴們做一個基于攔截器實現(xiàn)的JWT認證的gRPC

之前開源過一個分布式日志鏈路追蹤的工具，其作用是規(guī)范日志格式，實現(xiàn)分布式日志層面的鏈路追蹤，并且工具支持SpringMVC，Dubbo，OpenFeign，HttpClient，OkHttp等網(wǎng)絡(luò)工具或RPC框架，基于此，為了擴展日志鏈路追蹤使用場景，同時最近又在學(xué)習JAVA+gRPC，所以將該日志工具的鏈路追蹤能力擴展了到gRPC場景。

跨進程鏈路追蹤原理

想要實現(xiàn)跨進程間的分布式鏈路追蹤，就要在發(fā)起遠程調(diào)用的時候通過請求頭或者公共的自定義域?qū)㈡溌穮?shù)放進去，然后服務(wù)端收到請求后將鏈路參數(shù)從請求頭或者自定義域中或取出來，就這樣一層一層的將鏈路參數(shù)傳遞下去直至調(diào)用結(jié)束。

JAVA的gRPC庫io.grpc提供了在RPC調(diào)用中客戶端和服務(wù)端的攔截器（Interceptor），通過客戶端攔截器我們可以將鏈路追蹤的參數(shù)放到gRPC調(diào)用的Metadata中，通過服務(wù)端攔截器能夠從Metadata中獲取到鏈路追蹤所傳遞的參數(shù)；io.grpc提供的客戶端攔截器和服務(wù)端攔截器分別是io.grpc.ClientInterceptor和io.grpc.ServerInterceptor。

代碼實現(xiàn)

maven依賴

    <dependencies>
        <dependency>
            <groupId>io.grpc</groupId>
            <artifactId>grpc-all</artifactId>
            <version>${grpc.version}</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>net.devh</groupId>
            <artifactId>grpc-server-spring-boot-starter</artifactId>
            <version>${grpc.starter.version}</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>net.devh</groupId>
            <artifactId>grpc-client-spring-boot-starter</artifactId>
            <version>${grpc.starter.version}</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>io.github.redick01</groupId>
            <artifactId>log-helper-spring-boot-starter-common</artifactId>
            <version>1.0.3-RELEASE</version>
        </dependency>
    </dependencies>

攔截器實現(xiàn)

@Slf4j
@GrpcGlobalClientInterceptor
@GrpcGlobalServerInterceptor
public class GrpcInterceptor extends AbstractInterceptor implements ServerInterceptor, ClientInterceptor {
    // 鏈路追蹤參數(shù)traceId
    private static final Metadata.Key<String> TRACE = Metadata.Key.of("traceId", Metadata.ASCII_STRING_MARSHALLER)
    // 鏈路追蹤參數(shù)spanId
    private static final Metadata.Key<String> SPAN = Metadata.Key.of("spanId", Metadata.ASCII_STRING_MARSHALLER);
    // 鏈路追蹤參數(shù)parentId
    private static final Metadata.Key<String> PARENT = Metadata.Key.of("parentId", Metadata.ASCII_STRING_MARSHALLER);
    @Override
    public <ReqT, RespT> ClientCall<ReqT, RespT> interceptCall(
            MethodDescriptor<ReqT, RespT> methodDescriptor, CallOptions callOptions,
            Channel channel) {
        StopWatch stopWatch = new StopWatch();
        stopWatch.start();
        try {
            return new ForwardingClientCall.SimpleForwardingClientCall<ReqT, RespT>(channel.newCall(methodDescriptor, callOptions)) {
                @Override
                public void start(Listener<RespT> responseListener, Metadata headers) {
                    // 客戶端傳遞鏈路追中數(shù)據(jù)，將數(shù)據(jù)放到headers中
                    String traceId = traceId();
                    if (StringUtils.isNotBlank(traceId)) {
                        headers.put(TRACE, traceId);
                        headers.put(SPAN, spanId());
                        headers.put(PARENT, parentId());
                    }
                    // 繼續(xù)下一步
                    super.start(new ForwardingClientCallListener.SimpleForwardingClientCallListener<RespT>(responseListener) {
                        @Override
                        public void onHeaders(Metadata headers) {
                            // 服務(wù)端傳遞回來的header
                            super.onHeaders(headers);
                        }
                    }, headers);
                }
            };
        } finally {
            stopWatch.stop();
            log.info(LogUtil.marker(stopWatch.getTime()), "GRPC調(diào)用耗時");
        }
    }
    @Override
    public <ReqT, RespT> Listener<ReqT> interceptCall(ServerCall<ReqT, RespT> serverCall,
            Metadata headers, ServerCallHandler<ReqT, RespT> serverCallHandler) {
        // 服務(wù)端從headers中獲取到鏈路追蹤參數(shù)
        String traceId = headers.get(TRACE);
        String spanId = headers.get(SPAN);
        String parentId = headers.get(PARENT);
        // 構(gòu)建當前進程的鏈路追蹤數(shù)據(jù)并體現(xiàn)在日志中
        Tracer.trace(traceId, spanId, parentId);
        log.info(LogUtil.marker(), "開始處理");
        return serverCallHandler.startCall(new ForwardingServerCall.SimpleForwardingServerCall<ReqT, RespT>(serverCall) {
            @Override
            public void sendHeaders(Metadata responseHeaders) {
                super.sendHeaders(responseHeaders);
            }
            @Override
            public void close(Status status, Metadata trailers) {
                super.close(status, trailers);
            }
        }, headers);
    }
}

客戶端使用

客戶端使用代碼如下，該使用示例是在我開源的日志工具中的例子，我這里通過springboot自動裝配將GrpcInterceptor交由spring容器管理。所以可以直接通過自動注入的方式使用。

@RestController
public class TestController {
    @GrpcClient("userClient")
    private UserServiceGrpc.UserServiceBlockingStub userService;
    @Autowired
    private GrpcInterceptor grpcInterceptor;
    //@LogMarker(businessDescription = "獲取用戶名")
    @GetMapping("/getUser")
    public String getUser()     {
        User user = User.newBuilder()
                .setUserId(100)
                .putHobbys("pingpong", "play pingpong")
                .setCode(200)
                .build();
        Channel channel = ClientInterceptors.intercept(userService.getChannel(), grpcInterceptor);
        userService = UserServiceGrpc.newBlockingStub(channel);
        User u = userService.getUser(user);
        return u.getName();
    }
}