Spring Boot中gRPC自定义拦截器YAML注册失效问题排查

常见注册缺失点分析 #

在Spring Boot集成gRPC的场景中，CachingInterceptor未被触发，通常是因为拦截器没有被正确注册到gRPC服务的拦截器链中，常见缺失项包括以下几种：

1. 未将拦截器标记为Spring管理Bean #

如果CachingInterceptor没有通过@Component或@Service等注解声明为Spring Bean，gRPC框架无法自动发现并加载它。

• 解决：在CachingInterceptor类上添加@Component注解，确保Spring能扫描到该类并完成实例化。

2. 未在gRPC服务类上指定拦截器 #

若使用net.devh:grpc-spring-boot-starter这类集成包，需要在gRPC服务实现类（如BanksDataGrpcServiceImpl）的@GrpcService注解中显式指定拦截器。

• 正确写法示例：

@GrpcService(interceptors = CachingInterceptor.class)
public class BanksDataGrpcServiceImpl extends BanksDataGrpc.BanksDataImplBase {
    // 服务实现逻辑
}

3. 全局拦截器未配置（针对全局生效场景） #

如果希望拦截器作用于所有gRPC服务，需要通过配置类实现GlobalServerInterceptorConfigurer接口来注册全局拦截器：

@Configuration
public class GrpcInterceptorConfig implements GlobalServerInterceptorConfigurer {
    @Override
    public void configureServerInterceptors(ServerInterceptorRegistry registry) {
        registry.addServerInterceptor(new CachingInterceptor());
        // 或注入Spring管理的Bean实例
        // registry.addServerInterceptor(cachingInterceptor);
    }
}

缺少该配置类时，全局拦截器不会被加入到服务端拦截器链中。

4. 拦截器接口实现错误 #

需确保CachingInterceptor实现的是服务端拦截器接口io.grpc.ServerInterceptor，而非客户端拦截器ClientInterceptor。接口类型不匹配会导致服务端无法加载该拦截器。

• 正确类定义示例：

@Component
public class CachingInterceptor implements ServerInterceptor {
    @Override
    public <ReqT, RespT> ServerCall.Listener<ReqT> interceptCall(
            ServerCall<ReqT, RespT> call,
            Metadata headers,
            ServerCallHandler<ReqT, RespT> next) {
        // 自定义拦截逻辑
        return next.startCall(call, headers);
    }
}

5. 配置文件未声明拦截器（部分集成场景） #

检查application.yaml中是否存在禁用拦截器的配置，或是否需要显式指定拦截器Bean名称：

grpc:
  server:
    interceptors:
      - cachingInterceptor # 对应Spring Bean的名称

总结 #

最常见的缺失是未在@GrpcService注解中指定拦截器，或未将拦截器注册为Spring Bean并加入全局拦截器链，可按照上述步骤逐一排查验证。

内容的提问来源于stack exchange，提问作者Sanjay Naik