由于异步方法的特殊性,.NET 不允许异步方法带有 out 或 ref 参数。事实上这个设计是合理的,因为异步方法几乎都是立即返回,而此时传入方法内的 out
/ref
参数可能还没有被赋值。那么,如果确实需要在异步方法内用到类似于 out
/ref
的按引用传参的机制怎么办呢?
为什么需要 out
/ref
?
简言之,为了让调用方法能够返回多个值。很常见的情况是,除了一般的返回值,我们还需要知道其他结果。例如,bool int.TryParse(String,out int)
这个方法用来将字符串转换为对于的 32 位整数,除了返回 true
/false
表示转换是否成功之外,我们还需要知道转换后的值,于是就加了个 out
参数来存储这个值。(题外话:这应该算是.NET 的历史遗留问题,如果可空值类型一早就出现在 .NET 里,可能这个方法就不会这样难看了,签名完全可以变成更简洁的形式:int? int.TryParse(String)
。)
示例
假设一个接口 IFileSystemProvider
提供了异步方法 ReadAsync
。这个接口方法抽象了对文件系统的读取操作。调用时,需要提供一个标识文件资源的字符串。方法完成后,从这个方法中获得该文件的流、文件名和一些元数据(MD5 哈希值、原始文件名、创建时间等)。元数据用一张字典存储。这样,从一个方法中,我们需要给出一个输入,并获得三个输出。
如果这个方法是同步的,那么我们可以不假思索地这么写下签名:
Stream Read(string resource, out string originalFileName, out IDictionary<