.NET 7中为WCF请求添加APIKey请求头，当前实现是否正确？

1. 当前实现方式的正确性 #

你当前基于OperationContextScope的实现是完全正确且有效的，在.NET 7中依然可以正常工作。.NET Core/.NET 5+对WCF客户端的OperationContext相关API做了兼容保留，只要你的代码能成功调用API并返回正确结果，就说明这种方式没问题。

注意代码里的一个小笔误：

var requestProp = new HttpRequestMessageProperty { Headers = { [config.ApiHeader] = config.ApiHeader } };

这里应该是把API密钥值赋值给请求头，而不是用头名称给自己赋值，修正后更合理：

var requestProp = new HttpRequestMessageProperty { Headers = { [config.ApiHeaderName] = config.ApiKeyValue } };

2. 关于“Interceptor”类的说明 #

.NET 7中并没有内置名为Interceptor的WCF扩展类，你看到的示例里的Interceptor是自定义的Endpoint Behavior，需要自己实现。这种方式的优势是一次性配置后，所有通过该客户端发起的请求都会自动带上API密钥头，不用每次调用都重复写OperationContextScope的代码。

自定义Endpoint Behavior实现示例 #

你可以编写一个实现IClientMessageInspector的类来拦截请求并添加头，再配套一个IEndpointBehavior类将其绑定到客户端：

public class ApiKeyMessageInspector : IClientMessageInspector
{
    private readonly string _apiHeaderName;
    private readonly string _apiKeyValue;

    public ApiKeyMessageInspector(string apiHeaderName, string apiKeyValue)
    {
        _apiHeaderName = apiHeaderName;
        _apiKeyValue = apiKeyValue;
    }

    public object BeforeSendRequest(ref Message request, IClientChannel channel)
    {
        // 获取或创建HTTP请求属性
        if (OperationContext.Current.OutgoingMessageProperties.TryGetValue(HttpRequestMessageProperty.Name, out var propObj) &&
            propObj is HttpRequestMessageProperty requestProp)
        {
            requestProp.Headers.Add(_apiHeaderName, _apiKeyValue);
        }
        else
        {
            requestProp = new HttpRequestMessageProperty();
            requestProp.Headers.Add(_apiHeaderName, _apiKeyValue);
            OperationContext.Current.OutgoingMessageProperties[HttpRequestMessageProperty.Name] = requestProp;
        }
        return null;
    }

    public void AfterReceiveReply(ref Message reply, object correlationState)
    {
        // 无需处理响应，留空即可
    }
}

public class ApiKeyEndpointBehavior : IEndpointBehavior
{
    private readonly ApiKeyMessageInspector _inspector;

    public ApiKeyEndpointBehavior(string apiHeaderName, string apiKeyValue)
    {
        _inspector = new ApiKeyMessageInspector(apiHeaderName, apiKeyValue);
    }

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

    // 其他接口方法无需实现，留空即可
    public void AddBindingParameters(ServiceEndpoint endpoint, BindingParameterCollection bindingParameters) { }
    public void ApplyDispatchBehavior(ServiceEndpoint endpoint, EndpointDispatcher endpointDispatcher) { }
    public void Validate(ServiceEndpoint endpoint) { }
}

使用自定义Behavior的方式 #

初始化客户端时添加这个Behavior，后续所有请求都会自动带上API密钥头：

grpClient = new CustomerDataService.CustomerDataPortTypeClient(GetBinding(), GetEndpointAddress(config.ServiceUri));
grpClient.Endpoint.Behaviors.Add(new ApiKeyEndpointBehavior(config.ApiHeaderName, config.ApiKeyValue));

// 后续调用无需再写OperationContextScope的代码
var fetchedData = await grpClient.getBrandDetailsAsync();

3. 两种方式的选择 #

• 如果只是单次或少数几次调用API，用你当前的OperationContextScope方式足够简单直接。
• 如果需要多次调用该客户端的不同方法，自定义Endpoint Behavior的方式更简洁，避免重复代码。

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