[VisualStudio] ASP.NET Core 非同步代碼分析工具 - Threading.Analyzers ~ m@rcus 學習筆記

前言
在上一篇介紹了 ASP.NET Core Task block 檢測器 - Ben.BlockingDetector ，可以在 ASP.NET Runtime 時偵測 task block 的情境並透過 log 輸出，但預防的工作總是希望越早進行越好，越快發現就更早的預防不好的寫法及早修改，本篇要介紹的是非同步代碼分析套件，可以分析靜態代碼中可能用法"不正確"的代碼，可以若有問題或是錯誤的地方歡迎高手大大給予指導或討論。

安裝
開啟 Visual Studio 的 Nuget 搜尋 Microsoft.VisualStudio.Threading.Analyzers 找到後下載

或是可以透過 Nuget Package Console 輸入下列指令

Install-Package Microsoft.VisualStudio.Threading.Analyzers -Version 16.3.52

安裝完畢之後到專案檔底下確認是否有安裝成功

<ItemGroup>
  <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" Version="16.3.52" />
</ItemGroup>

分析指南
在安裝完後會針對目前專案靜態代碼進行分析，主要目的是透過此套件來檢查有關 Threads 和非同步的常見錯誤或是潛在問題，從官方 Github 說明頁面可以得知分析項目有包含以下內容

並且在規則中有分嚴重程度，且根據分析工具抓到靜態代碼的內容來給於提示與建議，嚴重性分為三類

Critical : Code issues that often result in deadlocks

Advisory : Code that may perform differently than intended or lead to occasional deadlocks

Guideline : Code that deviates from best practices and may limit the benefits of other analyzers

加入範例代碼

透過上述了解了規則之後，接下來我們加入 Thread blocking 的代碼來簡單示範分析結果，在新增的專案 controller 類別加入常見的 Task.Result 與 Task.Wait 阻塞方法

public class ValuesController : ControllerBase
{
    // GET api/values
    [HttpGet]
    public async void Get()
    {
        var result = await Task.Run(() => BlockingTask());
    }
    private static int BlockingTask()
    {
        // Detected blocking
        return MethodAsync().Result;
    }
 
    private static async Task<int> MethodAsync()
    {
        await Task.Delay(1000);
        return 5;
    }
 
    //private static object _lock;
 
    [HttpGet("/")]
    public Task Slower()
    {
        // Detected blocking in called method
        return DoSomethingAsync();
    }
 
    private async Task DoSomethingAsync()
    {
        await Task.Delay(1000);
 
        // Detected blocking
        Task.Run(() => { Thread.Sleep(1000); }).Wait();
    }
 
    [HttpGet("/hello")]
    public string Hello()
    {
        // Not detected: Thread.Sleep happens at OS level
        Thread.Sleep(2000);
 
        return "Hello World";
    }
 
    [HttpGet("/hello-sync-over-async")]
    public string HelloSyncOverAsync()
    {
        // Detected blocking
        Task.Delay(2000).Wait();
 
        return "Hello World";
    }
 
    [HttpGet("/hello-async-over-sync")]
    public async Task<string> HelloAsyncOverSync()
    {
        // Detected blocking in called method
        var result = await Task.Run(() => BlockingTask());
 
        return $"Hello World {result}";
    }
        
    [HttpGet("/hello-async")]
    public async Task<string> HelloAsync()
    {
        // No blocking :)
        await Task.Delay(2000);
 
        return "Hello World";
    }
 
    [HttpGet("/hello-async-precompleted")]
    public async Task<string> HelloAsyncPrecompleted()
    {
        Task<int> task = MethodAsync();
 
        if (!task.IsCompletedSuccessfully)
        {
            // Await completes the Task without blocking
            await task;
        }
 
        // The task is completed at this point so .Result doesn't trigger blocking
        var result = task.Result;
 
        return $"Hello World {result}";
    }
}

分析建議

在安裝完套件之後，可以看到原本看似 peace 的靜態代碼在分析之後有潛在的風險，舉例來說用到 Task.Result ，就會說明目前寫法可能會造成 deadlock，建議改用 await 方式避免

或是使用 Task.Wait

或是方法也會有相關建議

透過此套件可以提早發現代碼中可能造成的問題，避免上線後才發現影響到用戶，在 Github 網頁有更詳細的介紹與說明，若有興趣了解細節運作可以查看其 Github source code : 傳送門，希望這篇文章有幫助到大家&喜歡 :)

參考
vs-threading

[Benchmark] String 比較字串效能分析前言在 .NET 開發時很常會用到字串的比對，C# 中提供多種字串比對的方式，這篇文章就列出在 C# 提供的字串比方法，針對這幾種常用的方法使用 BenchmarkDotNet 做效能的測試及比對，並會在 .NET Framework 與 .NET Core 分別測試結果，若有問題或是錯誤的地方歡迎各位給予指導及討論。測試代碼測試使用 BenchmarkDotNe… Read More
[NET] Task.Run 與 Task.Factory.StartNew前言從 .NET 4.0 版本新增 TPL (Task Parallel Library) 函式庫，常在公司專案 Code 中可以看到 Task.Run 與 Task.Factory.StartNew 兩種建立任務的方式，某次同事也有提問對兩者的差異性不太明白，因此這篇文章整理自己對於兩者的相關資訊與用法，希望有不清楚或是自己研究錯誤的地方歡迎提出討論探索問題 Task.Run 與 Task.Factory.StartN… Read More
[NETCore] 如何設定 ASP.NET Core 健康檢查（Health Check）功能前言過去當應用程式開發完成之後，另外一項重要的事情就是建立上線後的監控機制，尤其是重要性高的服務更是不可或缺的事情，有遇過公司是在站台底下放置一個檔案內容文字是OK，在透過工具固定時間去確認網站底下這檔案是否有正常回傳，就可代表網站是否存活者，各種不同的實作方式都可以達到此目的；在 ASP.NET Core 2.2 開始提供 Health Check 中介層 (Middleware)，透過 HTTP 方式可以即時取得應用程式的健康狀況… Read More
[NETCore] 如何設定 ASP.NET Core 健康檢查（Health Check）功能 - Health Check UI前言在前一篇針對 ASP.NET Core 2.2 新特性 Health Check功能做基本的介紹，接著要分享的是在 BeatPulse 中實用的功能 Health Check UI，提供 UI 介面顯示及儲存 Health Check 檢查的結果內容，如果有多台時也可以在設定檔加上指定 URL 達到同時監控多台的效果，此篇就針對 Health Check UI 做介紹，若有問題或是錯誤的地方歡迎網路的高手大大給予指導。 Health… Read More
[NETCore] 動態 String 字串相加效能比較前言在前一篇 [.NETCore] String 字串相加效能比較對於 C# string 的應用做了一些測試，得到在使用固定字串相加時使用 string 效能反而比 stringBuilder 來的好，在 string 有多種應用情境因此這篇就在針對另一種使用情境針對 string 動態文字相加做比較若有問題或是錯誤的地方歡迎各位給予指導及討論。測試代碼測試方式同樣以 B… Read More

m@rcus 學習筆記

只有累積，沒有奇蹟

2019年9月13日星期五