.NET Core下User Agent头格式错误及WCF自定义头偶发异常问题

我碰到过不少类似的兼容性问题，本质就是**.NET Framework与.NET Core的WCF客户端实现差异**在搞鬼——你参考的那个老方法是针对.NET Framework的WCF设计的，而.NET Core的WCF客户端（基于System.ServiceModel.Http）底层用的是HttpClient栈，在HTTP头处理、线程安全、格式验证上都有不同的行为，这就解释了为什么在.NET Framework里正常，到.NET Core就出现非必现异常，还伴随User Agent格式错误。

问题根源拆解 #

• 自定义头实现的兼容性问题：老方法可能依赖于.NET Framework特有的HttpRequestMessageProperty或HttpWebRequest内部逻辑，.NET Core的WCF客户端对这些属性的处理时机和方式不同，尤其是并发场景下，容易出现头被覆盖或未正确注入的情况，导致非必现异常。
• User Agent格式验证更严格：.NET Core的WCF客户端对User Agent的格式有更严格的校验，老方法可能无意中修改了User Agent的格式（比如添加了非法字符），或者.NET Framework自动生成的User Agent在.NET Core里不符合规范，触发格式错误。

针对性解决方案 #

1. 替换自定义HTTP头的实现方式（适配.NET Core）

放弃老的全局注入方式，改用**.NET Core WCF原生支持的IClientMessageInspector**来实现每个请求的自定义头注入，确保线程安全和正确的处理时机：

public class CustomHeaderInspector : IClientMessageInspector
{
    private readonly Dictionary<string, string> _customHeaders;

    public CustomHeaderInspector(Dictionary<string, string> customHeaders)
    {
        _customHeaders = customHeaders;
    }

    public object BeforeSendRequest(ref Message request, IClientChannel channel)
    {
        var httpRequestMessage = request.Properties["httpRequest"] as HttpRequestMessage;
        if (httpRequestMessage != null)
        {
            foreach (var header in _customHeaders)
            {
                // 避免重复添加头，先检查再注入
                if (!httpRequestMessage.Headers.Contains(header.Key))
                {
                    httpRequestMessage.Headers.Add(header.Key, header.Value);
                }
            }
        }
        return null;
    }

    public void AfterReceiveReply(ref Message reply, object correlationState)
    {
        // 不需要处理回复的话留空即可
    }
}

// 封装客户端创建逻辑，自动添加自定义头行为
public static T CreateWcfClientWithCustomHeaders<T>(Dictionary<string, string> headers) where T : class
{
    var factory = new ChannelFactory<T>();
    factory.Endpoint.Behaviors.Add(new CustomHeaderBehavior(headers));
    return factory.CreateChannel();
}

public class CustomHeaderBehavior : IEndpointBehavior
{
    private readonly Dictionary<string, string> _headers;

    public CustomHeaderBehavior(Dictionary<string, string> headers)
    {
        _headers = headers;
    }

    public void AddBindingParameters(ServiceEndpoint endpoint, BindingParameterCollection bindingParameters) { }
    public void ApplyDispatchBehavior(ServiceEndpoint endpoint, EndpointDispatcher endpointDispatcher) { }
    public void Validate(ServiceEndpoint endpoint) { }

    public void ApplyClientBehavior(ServiceEndpoint endpoint, ClientRuntime clientRuntime)
    {
        clientRuntime.ClientMessageInspectors.Add(new CustomHeaderInspector(_headers));
    }
}

2. 修复User Agent格式问题

如果是User Agent格式错误触发的异常，你可以手动设置符合规范的User Agent，或者禁用WCF自动生成的User Agent：

// 在CustomHeaderInspector的BeforeSendRequest方法中添加：
if (httpRequestMessage != null)
{
    // 替换成符合HTTP规范的User Agent，比如：
    httpRequestMessage.Headers.UserAgent.ParseAdd("MyWcfClient/1.0 (.NET Core)");
    // 或者先清除自动生成的User Agent再添加自定义的：
    // httpRequestMessage.Headers.UserAgent.Clear();
    // httpRequestMessage.Headers.UserAgent.Add(new ProductInfoHeaderValue("MyWcfClient", "1.0"));
}

3. 确保客户端实例的线程安全

非必现异常很多时候和并发调用同一个WCF客户端实例有关——.NET Core的WCF客户端实例不是线程安全的，所以要确保每个请求使用独立的客户端实例，或者用池化方式管理客户端生命周期。

额外排查技巧 #

可以开启WCF的详细日志，捕获更精准的异常细节：

// 在appsettings.json中添加配置
{
  "Logging": {
    "LogLevel": {
      "System.ServiceModel": "Debug",
      "System.ServiceModel.MessageLogging": "Debug"
    }
  },
  "System.ServiceModel.MessageLogging": {
    "LogEntireMessage": true,
    "LogMessagesAtServiceLevel": true,
    "LogMessagesAtTransportLevel": true
  }
}

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