C# 中居然也有切片語法糖，太厲害了
阿新 • • 發佈：2020-09-23
## 一：背景
### 1. 講故事
昨天在 github 上準備找找 C# 9 又有哪些新語法糖可以試用，不覺在一個文件上看到一個很奇怪的寫法: `foreach (var item in myArray[0..5])` 哈哈，熟悉又陌生，玩過python的朋友對這個 `[0..5]` 太熟悉不過了，居然在 C# 中也遇到了，開心哈，看了下是 C# 8 的新語法，諷刺諷刺，8 都沒玩熟就搞 9 了，我的探索欲比較強，總想看看這玩意底層是由什麼支撐的。
## 二：.. 語法糖的用法
從前面介紹的 `myArray[0..5]` 語義上也能看出，這是一個切分array的操作，那到底有幾種切分方式呢？ 下面一個一個來介紹，為了方便演示，我先定義一個數組，程式碼如下：
``` C#
var myarr = new string[] { "10", "20", "30", "40", "50", "60", "70", "80", "90", "100" };
```
### 1. 提取 arr 前3個元素
如果用 linq 的話，可以用 Take(3)，用切片操作的話就是 [0..3]， 程式碼如下：
``` C#
static void Main(string[] args)
{
var myarr = new string[] { "10", "20", "30", "40", "50", "60", "70", "80", "90", "100" };
//1. 獲取陣列 前3個元素
var query1 = myarr[0..3];
var query2 = myarr.Take(3).ToList();
Console.WriteLine($"query1={string.Join(",", query1)}");
Console.WriteLine($"query2={string.Join(",", query2)}");
}
```
### 2. 提取 arr 最後三個元素
這個怎麼提取呢？在 python 中直接用 -3 表示就可以了，在C# 中需要用 ^ 來表示從末尾開始，程式碼如下：
``` C#
static void Main(string[] args)
{
var myarr = new string[] { "10", "20", "30", "40", "50", "60", "70", "80", "90", "100" };
//1. 獲取陣列 最後3個元素
var query1 = myarr[^3..];
var query2 = myarr.Skip(myarr.Length - 3).ToList();
Console.WriteLine($"query1={string.Join(",", query1)}");
Console.WriteLine($"query2={string.Join(",", query2)}");
}
```
### 3. 提取 array 中index = 4，5，6 的三個位置元素
用 linq 的話，就需要使用 `Skip + Take` 雙組合，如果用切片操作的話就太簡單了。。。
``` C#
static void Main(string[] args)
{
var myarr = new string[] { "10", "20", "30", "40", "50", "60", "70", "80", "90", "100" };
//1. 獲取陣列 中 index=4,5,6 三個位置的元素
var query1 = myarr[4..7];
var query2 = myarr.Skip(4).Take(3).ToList();
Console.WriteLine($"query1={string.Join(",", query1)}");
Console.WriteLine($"query2={string.Join(",", query2)}");
}
```
從上面的切割區間 `[4..7]` 的輸出結果來看，這是一個 `左閉右開` 的區間，所以要特別注意一下。
### 4. 獲取 array 中倒數第三和第二個元素
從要求上來看就是獲取元素 80 和 90，如果你理解了前面的兩個用法，我相信這個你會很快的寫出來，程式碼如下：
``` C#
static void Main(string[] args)
{
var myarr = new string[] { "10", "20", "30", "40", "50", "60", "70", "80", "90", "100" };
//1. 獲取 array 中倒數第三和第二個元素
var query1 = myarr[^3..^1];
var query2 = myarr.Skip(myarr.Length - 3).Take(2).ToList();
Console.WriteLine($"query1={string.Join(",", query1)}");
Console.WriteLine($"query2={string.Join(",", query2)}");
}
```
## 三. 探究原理
通過前面 4 個例子，我想大家都知道怎麼玩了，接下來就是看看到底內部是用什麼做支撐的，這裡使用 DnSpy 去挖挖看。
### 1. 從 myarr[0..3] 看起
用 dnspy 反編譯程式碼如下：
``` C#
//編譯前
var query1 = myarr[0..3];
//編譯後：
string[] query = RuntimeHelpers.GetSubArray(myarr, new Range(0, 3));
```
從編譯後的程式碼可以看出，原來獲取切片的 array 是呼叫 `RuntimeHelpers.GetSubArray` 得到了，然後我簡化一下這個方法，程式碼如下：
``` C#
public static T[] GetSubArray<[Nullable(2)] T>(T[] array, Range range)
{
ValueTuple offsetAndLength = range.GetOffsetAndLength(array.Length);
int item = offsetAndLength.Item1;
int item2 = offsetAndLength.Item2;
T[] array3 = new T[item2];
Buffer.Memmove(Unsafe.As(array3.GetRawSzArrayData()), Unsafe.Add(Unsafe.As(array.GetRawSzArrayData()), item), (ulong)item2);
return array3;
}
```
從上面程式碼可以看到，最後的 子array 是由 `Buffer.Memmove` 完成的，但是給 子array 的切割位置是由 `GetOffsetAndLength` 方法實現，繼續追一下程式碼：
``` C#
public readonly struct Range : IEquatable
{
public Index Start { get; }
public Index End { get; }
public Range(Index start, Index end)
{
this.Start = start;
this.End = end;
}
public ValueTuple GetOffsetAndLength(int length)
{
Index start = this.Start;
int num;
if (start.IsFromEnd)
{
num = length - start.Value;
}
else
{
num = start.Value;
}
Index end = this.End;
int num2;
if (end.IsFromEnd)
{
num2 = length - end.Value;
}
else
{
num2 = end.Value;
}
return new ValueTuple(num, num2 - num);
}
}
```
看完上面的程式碼，你可能有兩點疑惑：
#### 1) start.IsFromEnd 和 end.IsFromEnd 是什麼意思。
其實看完上面程式碼邏輯，你就明白了，IsFromEnd 表示起始點是從左開始還是從右邊開始，就這麼簡單。
#### 2) 我並沒有看到 start.IsFromEnd 和 end.IsFromEnd 是怎麼賦上值的。
在 Index 類的建構函式中，取決於上一層怎麼去 new Index 的時候塞入的 true 或者 false，如下程式碼：
這個例子的流程大概是： `new Range(1,3) -> operator Index(int value) -> FromStart(value) -> new Index(value)` ，可以看到最後在 new 的時候並沒有對可選引數賦值。
### 2. 探究 myarr[^3..]
剛才的例子是沒有對可選引數賦值，那看看本例是不是 new Index 的時候賦值了?
``` C#
//編譯前：
var query1 = myarr[^3..];
//編譯後：
string[] query = RuntimeHelpers.GetSubArray(myarr, Range.StartAt(new Index(3, true)));
```
看到沒有，這一次 new Index 的時候，給了 IsFromEnd = true , 表示從末尾開始計算，大家再結合剛才的 GetOffsetAndLength 方法，我想這邏輯你應該理順了吧。
## 四：總結
總的來說這個切片操作太實用了，作用於 arr 可以大幅度減少對 skip & take 的使用，作用於 string 也可以大幅減少 SubString 的使用，如：`"12345"[1..3]` -> `"12345".Substring(1, 2)`，嘿嘿，厲害了吧！ 還是C# 大法