如何在.NET Grpc.Net.*包的基础gRPC实现中替换默认User-Agent

默认情况下，Grpc.Net客户端会自动生成并附加包含版本信息的User-Agent请求头。当手动添加自定义User-Agent时，客户端会将自动生成的值与自定义值拼接在一起，而非直接替换。要实现完全替换需求，有两种可行方案：

方案一：通过GrpcChannelOptions全局设置 #

在创建gRPC通道时，直接配置GrpcChannelOptions.UserAgent属性，这会完全覆盖客户端自动生成的User-Agent值，所有通过该通道发送的请求都会使用指定的自定义值。

示例代码：

// 创建通道时指定自定义User-Agent
var channel = GrpcChannel.ForAddress("https://your-service-endpoint", new GrpcChannelOptions
{
    UserAgent = "foo"
});

// 基于该通道创建客户端
var ordersClient = new OrderingService.OrdersClient(channel);

依赖注入场景下的配置方式：

services.AddGrpcClient<OrderingService.OrdersClient>(options =>
{
    options.Address = new Uri("https://your-service-endpoint");
    options.UserAgent = "foo"; // 全局替换所有请求的User-Agent
});

方案二：使用拦截器灵活控制 #

如果需要针对不同请求设置不同的User-Agent，或者无法直接修改通道配置，可以通过自定义拦截器在请求发送前修改元数据，移除自动生成的User-Agent并添加自定义值。

步骤1：定义拦截器 #

public class CustomUserAgentInterceptor : Interceptor
{
    private readonly string _targetUserAgent;

    public CustomUserAgentInterceptor(string targetUserAgent)
    {
        _targetUserAgent = targetUserAgent;
    }

    // 针对一元请求重写方法，如需支持流式请求，需重写对应方法（如AsyncServerStreamingCall等）
    public override AsyncUnaryCall<TResponse> AsyncUnaryCall<TRequest, TResponse>(
        TRequest request,
        ClientInterceptorContext<TRequest, TResponse> context,
        AsyncUnaryCallContinuation<TRequest, TResponse> continuation)
    {
        // 移除已存在的User-Agent元数据
        var existingUserAgent = context.Metadata.FirstOrDefault(m => 
            m.Key.Equals("user-agent", StringComparison.OrdinalIgnoreCase));
        if (existingUserAgent != null)
        {
            context.Metadata.Remove(existingUserAgent);
        }

        // 添加自定义User-Agent
        context.Metadata.Add("user-agent", _targetUserAgent);

        return continuation(request, context);
    }
}

步骤2：为客户端添加拦截器 #

var channel = GrpcChannel.ForAddress("https://your-service-endpoint");
// 为通道添加拦截器
var interceptedInvoker = channel.Intercept(new CustomUserAgentInterceptor("foo"));
// 使用拦截后的调用器创建客户端
var ordersClient = new OrderingService.OrdersClient(interceptedInvoker);

依赖注入场景下注册拦截器：

services.AddGrpcClient<OrderingService.OrdersClient>(options =>
{
    options.Address = new Uri("https://your-service-endpoint");
})
.AddInterceptor<CustomUserAgentInterceptor>();

// 注册拦截器实例
services.AddSingleton(new CustomUserAgentInterceptor("foo"));

原理说明 #

Grpc.Net客户端的默认逻辑是：如果未通过GrpcChannelOptions设置User-Agent，则自动生成；如果手动在请求元数据中添加User-Agent，则将其与自动生成的值拼接。通过GrpcChannelOptions设置会直接覆盖自动生成逻辑，而拦截器则是在请求发送前主动移除原有头，确保自定义值成为唯一的User-Agent。

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