寫了多年代碼，你會 StackOverflow 嗎

Intro

準備寫一個傻逼代碼的系列文章，怎么寫 StackOverflow 的代碼，怎么寫死鎖代碼，怎么寫一個把 CPU 跑滿，怎么寫一個 OutOfMemory 的代碼，

今天主要來看 StackOverflow，StackOverlow 是一個著名的問答社區，做開發相關的應該都會知道這個網站，很多你遇到的問題都可以在這個網站上找到答案，

但這不是我的主題，今天的主題是如何寫一段代碼導致 StackOverflow

如何讓你的代碼發生 StackOverflow

在 C# 中有一個 StackOverflowException 的例外，發生 StackOverlow 也就是觸發 StackOverlowException，關于 StackOverflowException 的介紹可以參考微軟檔案

StackOverflowException is thrown for execution stack overflow errors, typically in case of a very deep or unbounded recursion.

這里節選了一小段話， 在執行堆疊發生溢位錯誤的時候會拋出 StackOverflowException ，典型的案例就是一個特別深的或者沒有邊界的遞回，

這里說明了一種典型的會發生 StackOverflowException 的示例就是遞回，這種方式可能大家都知道了，

除此之外還有一種情況也會引發 StackOverflowException ，微軟的檔案上沒有明確說明，我們知道，在 C# 中，值型別的記憶體分配一般是在堆疊上的，這個堆疊也就是執行緒堆疊，一個執行緒的堆疊是有限制的，這里可以出一個面試題，執行緒堆疊有多大

執行緒堆疊默認 1M，也是最大值，最大也是 1M（下次面試的時候可別不知道了哈）

詳細介紹可以看檔案 https://docs.microsoft.com/en-us/dotnet/api/system.threading.thread.-ctor?view=netcore-3.1

在執行緒堆疊上分配記憶體不夠的時候同樣也會引發 StackOverflowException

所以寫出 StackOverflow 代碼的兩種方式就有了

• 死遞回（沒有邊界，一直在回圈呼叫自己）
• 執行緒堆疊記憶體分配

死遞回

死遞回這種方式最簡單了，寫一個方法呼叫自己即可，來看一個示例：

public static void Test1()
{
    Test1();
}

通常這樣的代碼，大家一眼就能看出來，一般也不會寫這樣的代碼，通常寫出 StackOverflow 的代碼都是有引數的，引數傳遞有問題所以導致的 StackOverflow，比如下面這樣的一個示例：

// StackOverflow
public static void Test2(int num)
{
    if(num > 0)
    {
        Test2(num);
    }
}
// work
public static void Test3(int num)
{
    if(num > 0)
    {
        Test3(--num);
    }
}

下面的代碼是正常代碼，上面的代碼會 StackOverlow ，只是因為一行代碼的失誤導致的問題，這種情況更為常見一些

我之前也寫過一個 StackOverflow 的代碼，之前的代碼也是帶引數的遞回，遞回的引數是一個列舉，方法體里有多個列舉引數，結果在方法體遞回的時候傳錯了引數，導致了一個死遞回

執行緒堆疊記憶體分配

通常值型別的分配是在執行緒堆疊上的，但是我們也不會在一個執行緒上分配很多的值型別物件，所以通常也不會因為值型別的記憶體分配而導致 StackOverflowException

在 C# 7.2 之后引入了 Span （.net core 2.1 之后默認包含了 Span，.netstandard2.1也包含了 Span，如果是低版本或者 .net framework 需要額外參考一個包來支持 Span），我們可以在安全代碼中使用 stackalloc 來實作在執行緒堆疊上分配記憶體，我們要使用這個來做測驗，來看下面的測驗代碼：

public static void Test()
{
    ReadOnlySpan<byte> bytes = stackalloc byte[1024 * 1024];
    Console.WriteLine($"{bytes.Length} passed");

    bytes = stackalloc byte[1024 * 1024 + 1];
    Console.WriteLine($"{bytes.Length} passed");
}

可以看到在超過 1M 的時候就會發生 StackOverflow

Thread MaxStackSize

如果你比較細心，使用 Thread 比較多的話，你會發現 Thread 在實體化的時候，可以在構造方法里指定一個引數來指定執行緒的最大堆疊，參考檔案：https://docs.microsoft.com/en-us/dotnet/api/system.threading.thread.-ctor?view=netcore-3.1

public Thread (System.Threading.ThreadStart start, int maxStackSize)

所以我們也可以指定一個比較小的 maxStackSize 來更容易測驗出來 StackOverflow

來看一個示例：

public static void Test2()
{
    var thread = new Thread(() =>
    {
        ReadOnlySpan<byte> bytes = stackalloc byte[16*1024+1];
        Console.WriteLine($"{bytes.Length} passed");

        bytes = stackalloc byte[32*1024+1];
        Console.WriteLine($"{bytes.Length} passed");

        bytes = stackalloc byte[256*1024+1];
        Console.WriteLine($"{bytes.Length} passed");
    }, 1);
    thread.IsBackground = true;
    thread.Start();
}

這里可以看到，我直接指定了 maxStackSize 為 1，但是實際測驗下來并不是1，按微軟的檔案上所說，最小值是 256kb（如果我沒理解錯的話），但是實際測驗下來并不是，沒有到 256kb 就發生了 StackOverflow（有大神看到還望指導一下），上面的測驗輸出結果

再來看一個遞回的示例：

public static void Test3()
{
    var thread = new Thread(() =>
    {
        TestMethod(1024);
    }, 1);
    thread.IsBackground = true;
    thread.Start();
}

private static void TestMethod(int num)
{
    if(num > 0)
    {
        num--;
        TestMethod(num);
    }
}

輸出結果如下：

上面使用的數字也許不會在你的電腦上發生例外，你可以嘗試自己除錯一個臨界值，或者直接設定一個比較大的值

More

StackOverflowException 不能通過 try...catch 來捕捉，當發生 StackOverflowException 時應用程式就會直接退出，通常執行緒堆疊上分配記憶體不夠的情況基本上是不會發生的，所以對于怎么避免 StackOverflowException 我們只需要在寫遞回代碼的時候小心一些，不要寫成死回圈遞回就可以了，

對于在執行緒堆疊上分配記憶體，也可以通過寫非安全代碼來實作，有興趣的童鞋可以自己研究一下?，?

Reference

• https://docs.microsoft.com/en-us/dotnet/api/system.stackoverflowexception?view=netcore-3.1
• https://docs.microsoft.com/en-us/dotnet/api/system.threading.thread.-ctor?view=netcore-3.1
• https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/operators/stackalloc
• https://github.com/WeihanLi/SamplesInPractice/blob/master/StupidSamples/StackOverflowSample.cs

標籤：.NET Core

上一篇：IdentityServer4系列 | 常見術語說明

下一篇：C#實體(經典):四路光電開關&激光雷達資料采集和波形圖繪制