警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期

目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章簡介動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。本文使用的爬取步驟如下：使用 Selenium 獲取渲染後的 HTML 文檔使用 HtmlAgility ...

本文將舉一個例子，給出屬性求值副作用導致邏輯不符合預期的簡單復現步驟，用此例子告訴大家在 Visual Studio 裡面進入斷點和不進入斷點導致的邏輯行為差異

預設啟用屬性求值或其他隱式函數調用選項在 VisualStudio 的選項->調試裡面，如下圖所示

如以下代碼，在一個名為 F1 類型裡面有一個 F2 屬性。這個屬性採用非常常見的延遲創建方法，核心代碼如下

class F1
{
    public F2 F2
    {
        get
        {
            if (_f2 is null)
            {
                var f2 = new F2(this);
                _f2 = f2;
            }

            return _f2;
        }
    }

    private F2? _f2;
}

class F2
{
    ...
}

以上代碼看起來也是非常正常。接著再給 F1 添加一個事件，這個事件讓 F2 構造函數監聽，其更改之後的代碼如下

class F1
{
    public event EventHandler? FxxEvent;

    public void RaiseFxxEvent()
    {
        FxxEvent?.Invoke(this, EventArgs.Empty);
    }
}

class F2
{
    public F2(F1 f1)
    {
        f1.FxxEvent += F1_FxxEvent;
    }

    private void F1_FxxEvent(object? sender, EventArgs e)
    {
        ...
    }
}

此時的邏輯還看不出來問題，再添加一些核心關鍵點。在 F2 裡面添加一個 F3 屬性，這個 F3 屬性是在外面進行賦值的，且業務邏輯完全能夠確保被賦值，代碼如下

class F2
{
    public F3 F3 { get; set; } = null!;
}

class F3
{
    public void Foo()
    {
    }
}

讓 F2 的 F3 屬性被 F1 的 FxxEvent 事件觸發時使用，代碼如下

class F2
{
    public F3 F3 { get; set; } = null!;

    private void F1_FxxEvent(object? sender, EventArgs e)
    {
        F3.Foo();
    }
}

現在的類型定義和實現邏輯搭建就完成了，代碼如下

class F1
{
    public F2 F2
    {
        get
        {
            if (_f2 is null)
            {
                var f2 = new F2(this);
                _f2 = f2;
            }

            return _f2;
        }
    }

    private F2? _f2;

    public event EventHandler? FxxEvent;

    public void RaiseFxxEvent()
    {
        FxxEvent?.Invoke(this, EventArgs.Empty);
    }
}

class F2
{
    public F2(F1 f1)
    {
        f1.FxxEvent += F1_FxxEvent;
    }

    public F3 F3 { get; set; } = null!;

    private void F1_FxxEvent(object? sender, EventArgs e)
    {
        F3.Foo();
    }
}

class F3
{
    public void Foo()
    {
    }
}

完成搭建類型之後，編寫以下代碼進行調用

var f1 = new F1();
var f2 = f1.F2;
f2.F3 = new F3();
f1.RaiseFxxEvent();

上述代碼在不進入斷點時，預期和實際都能很好工作。原因是 F2 屬性能夠必然返回一個 F2 類型的對象，且立刻調用 f2.F3 = new F3(); 賦值。接著再觸發 F1 的 FxxEvent 事件。在 FxxEvent 事件裡面，由 F2 調用 F3 的 Foo 方法，邏輯非常簡單

然而大家試試在 F2 構造函數裡面打上斷點，然後查看傳入的 F1 參數的屬性，將會發現接下來會拋出空異常

class F2
{
    public F2(F1 f1)
    {
        // 在這裡下斷點，然後查看 f1 的屬性
        f1.FxxEvent += F1_FxxEvent;
    }
    ...
}

有趣的是現在的 f1 裡面的 F2 屬性已經有值了，但是別忘了，下斷點的 F2 構造函數正是 F1 的屬性調用進來的，調用堆棧如下

>	F2.F2(F1 f1)
 	F1.F2.get()

也如下圖所示，當前是在 F1 裡面的 F2 的 get 方法裡面嘗試創建 F2 對象的，進入構造函數的斷點

繼續按下 F5 向下跑，將會發現在 F1_FxxEvent 方法裡面拋出異常，因為 F2 的 F3 屬性為空

是不是感覺很奇怪，明明從靜態代碼邏輯裡面分析，完全不可能存在 F2 的 F3 屬性為空的情況，因為事件的觸發是在對 F3 屬性賦值之後，如下麵代碼所示

var f1 = new F1();
var f2 = f1.F2;
f2.F3 = new F3();
f1.RaiseFxxEvent();

其實核心的原因在上文已經有給大家提示了，在進入 F2 構造函數時，已經可以在局部變數視窗裡面看到 F1 參數的 F2 屬性有值了

這就意味著 F2 屬性已經被 get 過一次了，被求值了

為了更好的說明問題，這次咱先在 F2 屬性的 get 方法下斷點，重啟進程調試，如下圖所示

可見此時 _f2 欄位還是 null 值，非常符合預期

繼續進入 F2 構造函數，展開局部變數，嘗試去看一下 f1 參數此時的 F2 屬性，可以看到此時的屬性已經有值了，且 _f2 欄位也有值了

但是回到代碼裡面，邏輯上應該是當前的 _f2 欄位是沒有值的，因為現在正在 F2 的構造函數里，只有 F2 構造函數執行結束之後，才會給 _f2 欄位賦值

如下圖，嘗試在 F2 構造函數完成之後出來的地方，即將給 _f2 欄位賦值處，進入斷點。此時可見已經有值的 _f2 欄位將被 f2 局部變數賦值。此時給 _f2 欄位和 f2 局部變數添加對象 Id 號，可以看到這兩個對象的 Id 號是不相同的。在 Visual Studio 裡面，對象 Id 號不相同，意味著這是兩個完全不同的對象

於是當前的 _f2 欄位的 F2 對象，將會被 f2 局部變數的 F2 對象覆蓋

接著原本 f2 局部變數的 F2 對象的 F3 屬性將被賦值，然後 F1 的 FxxEvent 事件將觸發。但是原本的被覆蓋的 _f2 欄位的 F2 對象的 F3 屬性卻沒有地方賦值，但這個被覆蓋的 F2 對象卻添加了事件監聽，在事件處理函數裡面訪問了沒有賦值的 F3 屬性，最終導致空異常

為什麼會出現給 _f2 欄位賦值之前，就存在 _f2 欄位的值？這是由於 Visual Studio 在調試的時候嘗試進行了屬性求值。在本例子裡面的 F2 屬性的 get 方法是有副作用的，其作用就是創建了一個 F2 對象且給 _f2 欄位賦值。這個過程導致了代碼執行邏輯的變更，執行代碼邏輯的變更導致了進入了不符合預期的分支，即創建出來的 F2 對象的 F3 屬性沒有被賦值，因為調試過程中屬性求值創建的 F2 對象很快就被正常代碼邏輯的 F2 對象所覆蓋，最終導致了空異常

這就是值得大家警惕的進入斷點時的屬性求值導致的副作用

如果一個屬性的 get 方法是會變更代碼執行邏輯，那進入斷點時的屬性求值，將會影響邏輯行為。從而導致下斷點和不下斷點有所差異

其解決方法有兩個，第一個方法就是邏輯上保證能夠接受此差異度，如本文例子裡面加上判空和加上註釋說明調試器可能進入此異常分支。第二個方法就是關閉 Visual Studio 的啟用屬性求值或其他隱式函數調用功能，雖然關閉之後會影響部分調試效率，但是在某些邏輯上只好如此

本文使用調試代碼如下，為了方便大家使用，我還給 F2 添加了 Id 屬性，通過 Id 屬性可以判斷對象是否相等，就不需要在 Visual Studio 裡面創建對象 Id 了

var f1 = new F1();
var f2 = f1.F2;
f2.F3 = new F3();
f1.RaiseFxxEvent();

Console.WriteLine("Hello, World!");

class F1
{
    public F2 F2
    {
        get
        {
            if (_f2 is null)
            {
                var f2 = new F2(this);
                _f2 = f2;
            }

            return _f2;
        }
    }

    private F2? _f2;

    public event EventHandler? FxxEvent;

    public void RaiseFxxEvent()
    {
        FxxEvent?.Invoke(this, EventArgs.Empty);
    }
}

class F2
{
    public F2(F1 f1)
    {
        Id = Interlocked.Increment(ref _count);
        f1.FxxEvent += F1_FxxEvent;
    }

    public int Id { get; }

    public F3 F3 { get; set; } = null!;

    private void F1_FxxEvent(object? sender, EventArgs e)
    {
        F3.Foo();
    }

    private static int _count;
}

class F3
{
    public void Foo()
    {
    }
}

本文代碼放在 github 和 gitee 上，可以使用如下命令行拉取代碼。我整個代碼倉庫比較龐大，使用以下命令行可以進行部分拉取，拉取速度比較快

先創建一個空文件夾，接著使用命令行 cd 命令進入此空文件夾，在命令行裡面輸入以下代碼，即可獲取到本文的代碼

git init
git remote add origin https://gitee.com/lindexi/lindexi_gd.git
git pull origin 0a4c3b24161a79e0acbf99cf591bc29eb858d36a

以上使用的是國內的 gitee 的源，如果 gitee 不能訪問，請替換為 github 的源。請在命令行繼續輸入以下代碼，將 gitee 源換成 github 源進行拉取代碼。如果依然拉取不到代碼，可以發郵件向我要代碼

git remote remove origin
git remote add origin https://github.com/lindexi/lindexi_gd.git
git pull origin 0a4c3b24161a79e0acbf99cf591bc29eb858d36a

獲取代碼之後，進入 Workbench/NawlawdairfeJineardemyunal 文件夾，即可獲取到源代碼

更多關於 VisualStudio 進入斷點和不進入斷點的差異，請參閱 VisualStudio 打斷點調試和不打斷點調試有什麼區別

此問題除了直接斷點之外，還可能受到 DebuggerDisplay 影響，詳細請參閱 VisualStudio 在 DebuggerDisplay 的屬性更改業務邏輯將會讓調試和非調試下邏輯不同

更多技術博客，請參閱博客導航

博客園博客只做備份，博客發佈就不再更新，如果想看最新博客，請訪問 https://blog.lindexi.com/

如圖片看不見，請在瀏覽器開啟不安全http內容相容

本作品採用知識共用署名-非商業性使用-相同方式共用 4.0 國際許可協議進行許可。歡迎轉載、使用、重新發佈，但務必保留文章署名[林德熙](https://www.cnblogs.com/lindexi)(包含鏈接:https://www.cnblogs.com/lindexi )，不得用於商業目的，基於本文修改後的作品務必以相同的許可發佈。如有任何疑問，請與我[聯繫](mailto:[email protected])。