如何在Azure Function中间件中为EventHubOutput设置关联ID？

问题分析 #

你遇到的核心问题有两个：

1. 当函数返回字符串时，中间件仅能获取到返回的消息体，无法访问Event Hub事件的元数据（如Properties）
2. 直接返回EventData对象时，EventHubOutput绑定会错误地将其序列化为Azure.Messaging.EventHubs.EventData字符串，而非正确发送事件内容和属性

解决方案 #

1. 修正EventHubOutput的使用方式（解决序列化错误） #

在孤立模型中，不要通过返回值返回EventData，而是使用**参数注入IAsyncCollector<EventData>**的方式发送事件，这样绑定会直接处理EventData实例，避免序列化错误。

函数代码示例：

[Function("MyFunction")]
public async Task Run(
    [HttpTrigger(AuthorizationLevel.Anonymous, "post")] HttpRequest req,
    [EventHubOutput("output", Connection = "output-connection")] IAsyncCollector<EventData> outputEvents)
{
    var payload = await new StreamReader(req.Body).ReadToEndAsync();
    var eventData = new EventData(Encoding.UTF8.GetBytes(payload));
    await outputEvents.AddAsync(eventData);
}

2. 在中间件中获取输出事件并设置关联ID #

通过FunctionContext的GetOutputBindings<T>()方法，可以获取到所有待发送的EventData实例，遍历添加关联ID属性即可。

中间件代码示例：

public class CorrelationMiddleware : IFunctionsWorkerMiddleware
{
    public async Task Invoke(FunctionContext context, FunctionExecutionDelegate next)
    {
        await next(context);
        SetOutputCorrelation(context);
    }

    private void SetOutputCorrelation(FunctionContext context)
    {
        var correlationId = Guid.NewGuid().ToString();
        // 获取指定绑定名称的输出事件（"output"对应EventHubOutput的名称）
        var outputEvents = context.GetOutputBindings<EventData>("output");
        
        foreach (var eventData in outputEvents)
        {
            eventData.Properties["correlation-id"] = correlationId;
        }
    }
}

3. 确保依赖包版本正确 #

确认你的项目引用了最新版本的Microsoft.Azure.Functions.Worker.Extensions.EventHubs包（建议版本5.0及以上），该版本对孤立模型的EventData绑定提供了完整支持。

关键说明 #

• 孤立模型中，函数返回值默认会经过JSON序列化处理，直接返回EventData会触发默认序列化逻辑，导致错误的字符串输出
• 使用IAsyncCollector<EventData>参数时，EventHub绑定会跳过JSON序列化，直接将EventData实例发送到Event Hub，保留消息体和属性的完整性
• GetOutputBindings<T>()方法可以精准获取指定类型或指定名称的输出绑定数据，适合在中间件中统一处理元数据

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