.Net Core中使用ref和Span提升程序性能

1、前言

其實說到ref，不少同窗對它已經有所瞭解，ref是C# 7.0的一個語言特性，它爲開發人員提供了返回本地變量引用和值引用的機制。
Span 也是創建在ref語法基礎上的一個複雜的數據類型，在文章的後半部分，我會有一個例子說明如何使用它。

2、ref關鍵字

不管是ref仍是out關鍵，都是一種比較難以理解和操做的語言特性，如C語言中操做指針同樣，這樣的高級語法老是什麼帶來一些反作用，可是我不認爲這有什麼，並且不是每個C#開發者都要對這些內部運行的機制有着深入的理解，我以爲不論什麼複雜的東西只是爲人們提供了一個自由的選擇，風險和靈活性永遠是不能兼容的。

來看幾個例子來講明引用與指針的相同性，固然下面的使用方式早在C# 7.0以前就可使用了：

public static void IncrementByRef(ref int x)
{
    x++;
}

public unsafe static void IncrementByPointer(int* x)
{
   (*x)++;
}

上面兩個函數分別是使用ref和非安全指針來完成參數+1。

int i = 30;
IncrementByRef(ref i);
// i = 31
unsafe{
   IncrementByPointer(&i);
}
// i = 32

下面是C# 7.0提供的特性：

1.ref locals (引用本地變量)

int i = 42;
ref var x = ref i;
x = x + 1;
// i = 43

這個例子中爲本地 i 變量的引用 x, 當改變x的值時i變量的值也改變了。

2.ref returns (返回值引用)

ref returns是C# 7中一個強大的特性，下面代碼是最能體現其特性的，該函數提供了，返回int數組中某一項的引用：

public static ref int GetArrayRef(int[] items, int index) => ref items[index];

經過下標取得數組中的項目的引用，改變引用值時，數組也會隨之改變。

3、Span

System.Span 是.Net Core核心的一部分，在 System.Memory.dll 程序集下。目前該特性是獨立的，未來可能會集成到CoreFx中；

如何使用呢？在.Net Core 2.0 SDK建立的項目下引用以下NuGet包：

<ItemGroup>
    <PackageReference Include="System.Memory" Version="4.4.0-preview1-25305-02" />
    <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="4.4.0-preview1-25305-02" />
  </ItemGroup>

在上面咱們看到了使用ref關鍵字能夠提供的相似指針(T*)的操做單一值對象方式。基本上在.NET體系下操做指針都不認爲是一件好的事件，固然.NET爲咱們提供了安全操做單值引用的ref。可是單值只是用戶使用「指針」的一小部分需求；對於指針來講，更常見的狀況是操做一系列連續的內存空間中的「元素」時。

Span 表示爲一個已知長度和類型的連續內存塊。許多方面講它很是相似T[]或ArraySegment ，它提供安全的訪問內存區域指針的能力。其實我理解它更將是.NET中操做(void*)指針的抽象,熟悉C/C++開發者應該更明白這意味着什麼。

Span 的特色以下：

• 抽象了全部連續內存空間的類型系統，包括：數組、非託管指針、堆棧指針、fixed或pinned過的託管數據，以及值內部區域的引用
• 支持CLR標準對象類型和值類型
• 支持泛型
• 支持GC,而不像指針須要本身來管理釋放

下面來看下Span 的定義，它與ref有着語法和語義上的聯繫：

public struct Span<T> {
    ref T _reference;
    int _length;
    public ref T this[int index] { get {...} }
    ...
}

public struct ReadOnlySpan<T> {
    ref T _reference;
    int _length;
    public T this[int index] { get {...} }
    ...
}

接下來我會用一個直觀的例子來講明Span 的使用場景；咱們以字符截取和字符轉換（轉換爲整型）爲例：

若有一個字符串string content = "content-length:123",要轉換將123轉換爲整型，一般的作法是先Substring將與數字字符無關的字符串進行截斷，轉換代碼以下：

string content = "content-length:123";
Stopwatch watch1 = new Stopwatch();
watch1.Start();
for (int j = 0; j < 100000; j++)
{
    int.Parse(content.Substring(15));
}
watch1.Stop();
Console.WriteLine("\tTime Elapsed:\t" + watch1.ElapsedMilliseconds.ToString("N0") + "ms");

爲何使用這個例子呢，這是一個典型的substring的使用場景，每次操做string都會生成新的string對象,固然不光是Substring,在進行int.Parse時重複操做string對象，若是大量操做就會給GC形成壓力。

使用Span實現這個算法：

string content = "content-length:123";
ReadOnlySpan<char> span = content.ToCharArray();    
span.Slice(15).ParseToInt();
watch.Start();
for (int j = 0; j < 100000; j++)
{
    int icb = span.Slice(15).ParseToInt();
}
watch.Stop();
Console.WriteLine("\tTime Elapsed:\t" + watch.ElapsedMilliseconds.ToString("N0") + "ms");

這裏將string轉換爲int的算法利用ReadonlySpan實現，這也是Span 的典型使用場景，官方給的場景也是如些，Span 適用於屢次複用操做連續內存的場景。

轉換代碼以下：

public static class ReadonlySpanxtension
{
    public static int ParseToInt(this ReadOnlySpan<char> rspan)
    {
        Int16 sign = 1;
        int num = 0;
        UInt16 index = 0;
        if (rspan[0].Equals('-')){
            sign = -1; index = 1;
        }
        for (int idx = index; idx < rspan.Length; idx++){
            char c = rspan[idx];
            num = (c - '0') + num * 10;
        }
        return num * sign;
    }

}

4、最後

上述兩段代碼100000次調用的時間以下：

String Substring Convert:
        Time Elapsed:   18ms
ReadOnlySpan Convert:
        Time Elapsed:   4ms

目前Span 的相關支持還夠，它只是最基礎架構，以後CoreFx會對不少API使用Span 進行重構和實現。可見.Net Core的性能往後會愈來愈強大。

相關Demo會上傳到QQ羣中。

　　GitHub：https://github.com/maxzhang1985/YOYOFx 若是覺還能夠請Star下， 歡迎一塊兒交流。

　　.NET Core 開源學習羣：214741894