[譯]C# 7系列，Part 1: Value Tuples 值元組

Mark Zhou寫了很不錯的一系列介紹C# 7的文章，雖然是2年多年前發佈的，不過對於不熟悉C# 7特性的同學來說，仍然有很高的閱讀價值。

原文：https://blogs.msdn.microsoft.com/mazhou/2017/05/26/c-7-series-part-1-value-tuples/

 

譯文：

從今天開始，我將開始一個新的C# 7系列文章，介紹C# 7+的新語言特性。請注意，我說的不是C# 7.0，我說的是C# 7+，因爲將會有一些小的版本(比如7.1、7.2)逐步引入新的特性(感謝Roslyn!)，比如async Main和default literals。

Tuples

類System.Tuple提供了一種類型來表示類似屬性包的鍵值對。當你想用一種數據結構來保存一個帶有屬性(元素)的對象，但又不想創建一個單獨的類型的時候，你可以使用它。下面的代碼展示瞭如何用它作爲一個方法的返回值，這個返回值包含了學生姓名和年齡。

public Tuple<string, int> GetStudentInfo(string id)
{     
    // Search by ID and find the student.
    return new Tuple<string, int>("Annie", 25);
}

可以看到，我返回了一個Tuple<string,int>的實例對象，它的第一個參數是name，第二個參數是age。之後，我們在代碼中調用這個方法，像這樣:

public void Test()
{     
    Tuple<string, int> info = GetStudentInfo("100-000-1000");
    Console.WriteLine($"Name: {info.Item1}, Age: {info.Item2}");
}

你可以通過引用Item1和Item2來訪問name和age。

Tuple類有一些明顯的問題:

• 您需要使用ItemX這樣的形式來訪問屬性，這樣的屬性名可能對調用者來說沒有什麼含義，如果我們可以使用類似info.Name和info.Age這樣的形式來訪問會比info.Item1和info.Item2更好。
• 最多隻能有8個屬性。如果需要更多，最後一個類型參數必須是另一個元組。這使得語法非常難以理解。
• Tuple是一種引用類型，不像其他基本類型(它們是大多數值類型)，它分配在堆上，對於CPU密集型操作來說，它可能需要太多的對象創建/分配。

Value Tuples

C# 7.0引入了ValueTuple結構，它是Tuple對象的值類型表示。C#語言團隊爲這個值元組類型做了很多不錯的事情，包括新的語法和許多特性(比如解構)。

下面是使用Value Tuples的重寫版本，請注意，如果在你的項目中不能用ValueTuple類型，那你必須通過NuGet下載System.ValueTuple 4.3.0 NuGet包到你的項目。如果您使用的是.Net Framework 4.7或更高版本，或者.Net Standard Library 2.0或更高版本，你什麼也不用做，ValueTuple已經包含在內了。

public (string, int) GetStudentInfo(string id)
{
    // Search by ID and find the student. 
    return ("Annie", 25);
}
 
public void Test()
{ 
    (string, int) info = GetStudentInfo("100-000-1000"); 
    Console.WriteLine($"Name: {info.Item1}, Age: {info.Item2}");
}

通過使用語法()，上面的代碼得到了極大的簡化。 
您甚至可以爲ValueTuple中的每個元素指定一個名稱，如下所示:

public (string name, int age) GetStudentInfo(string id)
{
    // Search by ID and find the student.
    return (name: "Annie", age: 25);
}
 
public void Test()
{
    (string name, int age) info = GetStudentInfo("100-000-1000"); 
    Console.WriteLine($"Name: {info.name}, Age: {info.age}");
}

帥！現在你的元組對象中的元素有了好的元數據，那麼你就不需要來回檢查確認返回/訪問元素的順序是正確的了。

當您使用值元組時，Visual Studio IDE會給您提示。

Value Tuple 解構

你可以從值元組對象中解構元素，並訪問局部變量。

// 解構使用 var (x, y) 語法，
// 或者 (var x, var y) 語法。
var (name, age) = GetStudentInfo("100-000-1000");
// 現在你有兩個局部變量：name and age.
Console.WriteLine($"Name: {name}, Age: {age}");

如果只關心某些元素而不是所有元素，可以使用_關鍵字忽略局部變量。

var (name, _) = GetStudentInfo("100-000-1000");
// 現在你只有一個局部變量：name，值age被忽略了。
Console.WriteLine($"Name: {name}");

從Value Tuples到Tuples

類型System.Tuple和System.ValueTuple提供了一些擴展方法來幫助它們之間相互轉換。

var valueTuple = (id: 1, name: "Annie", age: 25, dob: DateTime.Parse("1/1/1993"));
var tuple = valueTuple.ToTuple();

 

結論

ValueTuple使C#語言更現代，更易於使用簡化的語法。它解決了許多Tuple的問題：

• 值元組對象具有第一類語法支持，它簡化了使用元組元素的代碼。
• 您可以用一個名稱與值元組的元素相關聯，從而獲得一定程度的設計階段和編譯器階段的代碼驗證。
  請注意，與元組元素相關聯的名字不是一個運行時的元數據，即在運行時的實例值元組中不存在這樣一個名稱的屬性/字段，屬性的名稱仍Item1、Item2等等，所有的元素名稱僅存在設計和編譯階段。
• 你現在可以通過使用解構和_關鍵字靈活地訪問所有元組元素，或者其中的一部分。
• 值元組類型是值類型，沒有繼承或其他特性，這意味着值元組具有更好的性能。

由於值元組元素的名稱不是運行時的，所以在使用一些類庫(如Newtonsoft)進行序列化時，必須小心使用元組類型。除非你更新過支持新元數據(TupleElementNameAttribute等)的類庫，否則你會遇到bug。

 

系列文章：

• [譯]C# 7系列，Part 1: Value Tuples 值元組 （本文）
• [譯]C# 7系列，Part 2: Async Main 異步Main方法
• [譯]C# 7系列，Part 3: Default Literals 默認文本表達式
• [譯]C# 7系列，Part 4: Discards 棄元
• [譯]C# 7系列，Part 5: private protected 訪問修飾符
• [譯]C# 7系列,  Part 6: Read-only structs 只讀結構
• [譯]C# 7系列，Part 7: ref Returns ref返回結果
• [譯]C# 7系列，Part 8: in Parameters in參數
• [譯]C# 7系列，Part 9: ref structs ref結構
• [譯]C# 7系列，Part 10: Span<T> and universal memory management Span<T>和統一內存管理 （本文）