原文:https://blogs.msdn.microsoft.com/mazhou/2017/12/12/c-7-series-part-7-ref-returns/ 背景 有兩種方法可以將一個值傳遞給一個方法: 例如,FCL(.NET Framework Class Library)中的Arra ...
原文:https://blogs.msdn.microsoft.com/mazhou/2017/12/12/c-7-series-part-7-ref-returns/
背景
有兩種方法可以將一個值傳遞給一個方法:
- 按值傳遞。當一個參數被傳遞給一個方法時,一個參數的副本(如果它是一個值類型)或一個"參數引用"的副本(如果它是一個引用類型)被傳遞。當您更改方法中的參數時,更改(單個賦值或複合賦值)會反映到參數/"參數引用"的副本,而不會反映到參數或“參數引用”本身。這是.NET語言中的預設方式(Visual Basic中的ByVal)。(譯註:"參數引用"其實是個指針,指向另外一個它實際代表的對象,這裡指的是修改這個指針本身。)
- 以引用的方式傳遞。當一個參數被傳遞給一個方法時,要麼參數本身(如果它是一個值類型)要麼“參數引用”(如果它是一個引用類型)被直接傳遞。沒有生成其他副本。當您更改方法中的參數時,更改(單個賦值或複合賦值)將反映到參數或“參數引用”本身。這可以通過在C#中使用ref關鍵字或者在Visual Basic中使用ByRef關鍵字來表明。
例如,FCL(.NET Framework Class Library)中的Array. resize()方法接受類型為Array的ref參數,該ref值在方法實現中進行了修改,以指向調整大小後的數組新空間。你可以繼續使用該數組變數,並訪問新的記憶體空間:
byte[] data = new byte[10]; Array.Resize(ref data, 20); //譯註:上一行data指向的記憶體空間和這裡data指向的記憶體空間可能變更了。 Console.WriteLine($"New array size is: {data.Length}");
ref返回結果
ref返回結果是方法的引用返回值。與作為方法參數傳遞的ref值類似,調用者可以修改ref返回值,對該返回值的任何更改(賦值)都將反映到從方法中返回的原始值。
在C#中,你可以使用return ref關鍵字創建一個ref返回結果。
請看下麵的示例:
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]; }
上述方法的目的是在數組的特定位置獲取對元素的引用。稍後你可以使用這個引用來更改該元素的值;因為它是一個ref值,所以更改將應用於數組中的原始值。(譯註:就是數組中的原始值會被改變)
要使用這個方法,需要使用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智能感知錶面調用的方法是一個ref返回結果方法。
上面代碼的運行輸出結果如下:
調用帶有ref返回結果的方法
與前面的示例一樣,要獲得ref返回值的引用,你需要使用ref局部變數,並將ref關鍵字放在調用方法前面(ref在等式左右兩邊都有)。
ref int value = ref ElementAt(ref data, 2);
你還可以在不使用ref關鍵字的情況下調用此方法,這時候返回的是值。(譯註:不是引用)
int value = ElementAt(ref data, 2);
在這種情況下,程式輸出如下:
但是,你需要在兩邊都指定ref,或者兩邊都沒有ref;你不能在一邊指定ref而在另一邊不指定ref。
此外,以下代碼也可以運行:
ElementAt(ref data, 2) = 5;
你將獲得與第一個示例相同的輸出。位置2的元素從0(預設值)更改為5。這是因為ref返回可以作為一個LValue出現。(譯註:LValue被稱為左值,簡單地說就是出現在等號左邊的值,詳見"左值和右值表達式")
解決重載
因為返回類型不是認定一個重載的方法簽名的一部分,所以下麵的方法定義可能不起作用。(譯註:不能同時出現在一個類中,他們被視為同樣的簽名,同樣簽名的方法在一個類中只能出現一次)
public int M(int[] value); public ref int M(int[] value);
但是下麵的定義將會起作用,因為參數在第一個方法中有ref,在第二個方法中沒有ref,是傳值。(譯註:參數是方法簽名的一部分)
public ref int M(ref int[] value); public ref int M(int[] value);
因此,為了重載一個ref返回結果方法,你需要滿足如下參數規則:
- 使用不同數量的參數,或者
- 使用不同類型的參數,或者
- 使用不同的傳值方式的參數(值或者引用)。
限制
ref return有一些限制:
- 一個方法ref返回的值必須是一個ref local(譯註:ref局部變數);這個ref局部變數的來源可以是這個方法的一個實際的ref/out參數,或者是聲明方法所在類型中的一個欄位。
- 不能引用返回空類型。
- 不能直接引用返回null。但是你可以返回一個ref局部變數,它的值是null。
- 不能從非同步方法ref返回,因為在非同步方法返回時,返回值可能是不確定的。
- 不允許ref返回常量和枚舉。
結論
ref返回結果是C#語言的擴展,它可以通過減少從方法返回中複製值的可能性來提高代碼的性能。這對於那些低級別的編程組件很有用,比如互操作性、跨平臺或資源受限的場景(移動、物聯網等)。要使用這個特性,你需要使用C# language 7.0,升級你的Visual Studio版本到2017年或更高版本。
系列文章: