[譯]C# 7系列，Part 7: ref Returns ref返回結(jié)果

精品唯居 2020-04-29

展開全文

原文：https://blogs.msdn.microsoft.com/mazhou/2017/12/12/c-7-series-part-7-ref-returns/

背景

有兩種方法可以將一個值傳遞給一個方法：

按值傳遞。當(dāng)一個參數(shù)被傳遞給一個方法時，一個參數(shù)的副本(如果它是一個值類型)或一個"參數(shù)引用"的副本(如果它是一個引用類型)被傳遞。當(dāng)您更改方法中的參數(shù)時，更改(單個賦值或復(fù)合賦值)會反映到參數(shù)/"參數(shù)引用"的副本，而不會反映到參數(shù)或“參數(shù)引用”本身。這是.NET語言中的默認(rèn)方式(Visual Basic中的ByVal)。（譯注："參數(shù)引用"其實是個指針，指向另外一個它實際代表的對象，這里指的是修改這個指針本身。）
以引用的方式傳遞。當(dāng)一個參數(shù)被傳遞給一個方法時，要么參數(shù)本身(如果它是一個值類型)要么“參數(shù)引用”(如果它是一個引用類型)被直接傳遞。沒有生成其他副本。當(dāng)您更改方法中的參數(shù)時，更改(單個賦值或復(fù)合賦值)將反映到參數(shù)或“參數(shù)引用”本身。這可以通過在C#中使用ref關(guān)鍵字或者在Visual Basic中使用ByRef關(guān)鍵字來表明。

例如，F(xiàn)CL(.NET Framework Class Library)中的Array. resize()方法接受類型為Array的ref參數(shù)，該ref值在方法實現(xiàn)中進(jìn)行了修改，以指向調(diào)整大小后的數(shù)組新空間。你可以繼續(xù)使用該數(shù)組變量，并訪問新的內(nèi)存空間：

byte[] data = new byte[10];
Array.Resize(ref data, 20); //譯注：上一行data指向的內(nèi)存空間和這里data指向的內(nèi)存空間可能變更了。
Console.WriteLine($"New array size is: {data.Length}");

ref返回結(jié)果

ref返回結(jié)果是方法的引用返回值。與作為方法參數(shù)傳遞的ref值類似，調(diào)用者可以修改ref返回值，對該返回值的任何更改(賦值)都將反映到從方法中返回的原始值。

在C#中，你可以使用return ref關(guān)鍵字創(chuàng)建一個ref返回結(jié)果。

請看下面的示例：

private static ref T ElementAt<T>(ref T[] array, int position)
{
     if (array == null)
     {
         throw new ArgumentNullException(nameof(array));
     }

     if (position < 0 || position >= array.Length)
     {
         throw new ArgumentOutOfRangeException(nameof(position));
     }

     return ref array[position];
}

上述方法的目的是在數(shù)組的特定位置獲取對元素的引用。稍后你可以使用這個引用來更改該元素的值；因為它是一個ref值，所以更改將應(yīng)用于數(shù)組中的原始值。（譯注：就是數(shù)組中的原始值會被改變）

要使用這個方法，需要使用ref局部變量：

private static void Main(string[] args)
{
    int[] data = new int[10];
    Console.WriteLine($"Before change, element at 2 is: {data[2]}");
    ref int value = ref ElementAt(ref data, 2);
    // Change the ref value.
    value = 5;
    Console.WriteLine($"After change, element at 2 is: {data[2]}");
}

Visual Studio智能感知表面調(diào)用的方法是一個ref返回結(jié)果方法。

上面代碼的運行輸出結(jié)果如下：

調(diào)用帶有ref返回結(jié)果的方法

與前面的示例一樣，要獲得ref返回值的引用，你需要使用ref局部變量，并將ref關(guān)鍵字放在調(diào)用方法前面(ref在等式左右兩邊都有)。

ref int value = ref ElementAt(ref data, 2);

你還可以在不使用ref關(guān)鍵字的情況下調(diào)用此方法，這時候返回的是值。（譯注：不是引用）

int value = ElementAt(ref data, 2);

在這種情況下，程序輸出如下：

但是，你需要在兩邊都指定ref，或者兩邊都沒有ref；你不能在一邊指定ref而在另一邊不指定ref。

此外，以下代碼也可以運行：

ElementAt(ref data, 2) = 5;

你將獲得與第一個示例相同的輸出。位置2的元素從0(默認(rèn)值)更改為5。這是因為ref返回可以作為一個LValue出現(xiàn)。（譯注：LValue被稱為左值，簡單地說就是出現(xiàn)在等號左邊的值，詳見"左值和右值表達(dá)式"）

解決重載

因為返回類型不是認(rèn)定一個重載的方法簽名的一部分，所以下面的方法定義可能不起作用。（譯注：不能同時出現(xiàn)在一個類中，他們被視為同樣的簽名，同樣簽名的方法在一個類中只能出現(xiàn)一次）

public int M(int[] value);
public ref int M(int[] value);

但是下面的定義將會起作用，因為參數(shù)在第一個方法中有ref，在第二個方法中沒有ref，是傳值。（譯注：參數(shù)是方法簽名的一部分）

public ref int M(ref int[] value);
public ref int M(int[] value);

因此，為了重載一個ref返回結(jié)果方法，你需要滿足如下參數(shù)規(guī)則：

使用不同數(shù)量的參數(shù)，或者
使用不同類型的參數(shù)，或者
使用不同的傳值方式的參數(shù)（值或者引用）。

限制

ref return有一些限制：

一個方法ref返回的值必須是一個ref local（譯注：ref局部變量）；這個ref局部變量的來源可以是這個方法的一個實際的ref/out參數(shù)，或者是聲明方法所在類型中的一個字段。
不能引用返回空類型。
不能直接引用返回null。但是你可以返回一個ref局部變量，它的值是null。
不能從異步方法ref返回，因為在異步方法返回時，返回值可能是不確定的。
不允許ref返回常量和枚舉。

結(jié)論

ref返回結(jié)果是C#語言的擴(kuò)展，它可以通過減少從方法返回中復(fù)制值的可能性來提高代碼的性能。這對于那些低級別的編程組件很有用，比如互操作性、跨平臺或資源受限的場景(移動、物聯(lián)網(wǎng)等)。要使用這個特性，你需要使用C# language 7.0，升級你的Visual Studio版本到2017年或更高版本。

系列文章：