Azure Functions输出绑定out参数使用场景及相关用法疑问
Azure Functions 输出绑定常见问题解答
输出绑定的常见定义方式
Azure Functions 中实现输出绑定常用三种定义方式:
- Blob存储:无需额外语法,直接声明可写类型的绑定参数即可
- CosmosDB:可将绑定对应参数指定为
out参数实现输出 - 队列:可通过方法返回值加
return:特性标记定义绑定
示例代码如下:
public static class myblobtestfunc { [FunctionName("myblobtestfunc")] [return: Queue("samplequeue", Connection = "storageconnection")] public static string Run([BlobTrigger("functiontestblob/{name}.txt", Connection = "storageconnection")]Stream myBlob, [Blob("copyblob/{name}", FileAccess.Write)]Stream copyBlob, [CosmosDB(databaseName: "testfiledb", collectionName: "testfilecoll", ConnectionStringSetting = "cosmosdbconnectionstring")]out dynamic document, string name, ILogger log ) { log.LogInformation($"C# Blob trigger function Processed blob\n Name:{name} \n Size: {myBlob.Length} Bytes"); myBlob.CopyTo(copyBlob); document = new { Description = name, id = Guid.NewGuid() }; return name; } }
问题1:输出绑定是否支持三种定义方式任意选用?
不支持任意混用,不同定义方式有对应的适用边界,你提到的CosmosDB是支持return方式定义的:
- 直接声明可写参数的方式:仅适用于支持流式写入的绑定类型,比如Blob存储,适配大文件写入场景,不需要将全量内容加载到内存
out参数方式:支持除了流式绑定外的绝大多数输出绑定,适合多输出的场景,比如示例中同时需要输出到Blob、CosmosDB、队列三个目标,就可以用多个out参数或者混合流式参数实现- return标记方式:几乎所有非流式输出绑定都支持,包括CosmosDB,但是仅适用于单输出的场景,因为方法只能有一个返回值。如果要给CosmosDB用return方式,只需把
[return: CosmosDB(...)]特性标记到方法上,返回值对应要写入的文档对象即可
问题2:为什么要提供多种不同的输出绑定定义风格?
核心是为了兼顾不同开发场景的需求,平衡代码简洁性和灵活性:
- 单输出场景下用return方式代码最简洁,无冗余参数,可读性高
- 多输出场景下用
out参数可以满足多目标输出的需求 - 流式写入场景下的直接参数声明符合常规文件写入的开发习惯,性能更优,避免大文件内存占用过高的问题
内容的提问来源于stack exchange,提问作者Pradeepl
相关产品推荐
相关产品推荐

