ASP.NET CORE MVC用時分析工具MiniProfiler
MiniProfiler(https://miniprofiler.com/)是一個輕量級且簡單易用的分析工具庫,它可以用來分析ASP.NET Core應用。
優點
針對ASP.NET Core MVC應用,使用MiniProfiler的優點是:它會把結果直接放在頁面的左下角,隨時可以點選檢視;這樣的話就可以感知出你的程式執行的怎麼樣;同時這也意味著,在你開發新功能的同時,可以很快速的得到反饋。
安裝配置MiniProfiler
在現有的ASP.NET Core MVC專案裡,透過Nuget安裝:
接下來,想把MiniProfiler配置好,總共分三步😂:
第一步,來到StartUp.cs的ConfigureServices方法裡,新增 services.AddMiniProfiler():
當然這個方法還可以新增一個lambda表示式作為引數,從而做一些自定義的配置:
可以看到可用的配置選項還是很多,具體還需要看官方文件。
在這個例子裡,我就只使用兩個選項吧:
第一行是設定彈出視窗的位置是左下角;第二行是在彈出的明細視窗裡會顯式Time With Children這列。
第二步,來到Startup的Configure方法裡,新增app.UseMiniProfiler():
最重要的一點是,一定要把它放在UseMvc()方法之前。
這裡就是配置中介軟體在管道中的位置,想必大家都瞭解。
第三步,就是把MiniProfiler的Tag helper放到頁面上:
這裡還分兩步:
1. 在_ViewImports裡面把它的Tag Helper全引入進來:
一共又有兩行程式碼:
@using StackExchange.Profiling
@addTagHelper *, MiniProfiler.AspNetCore.Mvc
2.最後,需要把MiniProfiler的Tag Helper放在_Layout.cshtml裡:
放在這裡的話,每個頁面就都能看到它了。
其實放在這個頁面的什麼地方都應該可以,但是由於它會載入一些指令碼檔案,所以我放在footer下面:
執行應用,可以看到左下角就是MiniProfiler:
點選它之後會彈出視窗:
這裡面有每個步驟具體的耗用時間。
分析區域性程式碼
前面的例子裡,我們使用MiniProfiler分析了頁面整個流程的時間。而MiniProfiler也可以用來分析一段程式碼所耗用的時間。看例子:
(注意,如果這段程式碼不在主Web專案裡,你需要在那段程式碼所在的專案新增MiniProfiler.AspNetCore這個庫)
然後這樣用就可以了:
這裡我們使用了using語句,裡面使用了MiniProfiler類的Current屬性,在該屬性上面有一個Step()方法,它可以用來分析using語句裡面的程式碼,在Step方法裡,要提供一個具有描述性的名稱來表示該段程式碼做的是什麼動作,這個名稱會顯示在結果裡。
通常,我會巢狀著使用:
如果你只想分析一句話,那麼使用using語句就顯得太麻煩了,這種情況下可以使用Inline()方法:
該方法可以保證得到的結果是相同型別的。
執行程式,點選左下角的按鈕:
可以看到剛才那幾塊程式碼的分析結果按照其巢狀解構展示出來了。
自定義分析 CustomTiming
有時候,分析一些例如請求外部動作的時候,上面講的做法可能不太靈光,這裡我們就可以使用CustomTiming()方法。
直接看例子:
這個例子裡,我們使用了MiniProfiler.Current.CustomTiming()方法。方法第一個引數是一個用於分類的字串,由於我這個例子是http請求,所以第一個引數我寫的是http;第二個引數是命令字串,暫時留空,第三個引數是執行型別,這裡我是用的是HTTPGet,所以就寫了GET。
然後在response返回之後,我再把命令字串給補上。這裡就需要引用一下CustomTiming()方法返回的物件,所以在using語句裡我新增了一個變數timing。在response返回後,我設定了timing變數的命令字串為URL和返回的狀態碼,因為我感覺這樣寫才可以更準確的表明這次動作。而狀態碼只有response返回之後才有,所以在using語句裡呼叫CustomTiming()方法時,我暫時把第二個命令設定為空字串。
執行程式,可以看到彈出視窗的右側出現了http這一列:
點選這個1437.7(1),會再彈出一個視窗:
可以看到這就是我們使用CustomTiming分析的那段程式碼,URL和返回碼都顯示了出來。
如果需要分析所有的HttpClient的請求,那麼你可以在Http管道里放一個DelegatingHandler,具體說就是建立一個類,繼承於DelegatingHandler,只需要重寫一個叫做SendAsync的方法,把分析的程式碼寫在這個方法裡即可,最後需要在HttpClientFactory裡面進行配置。這部分程式碼我先不寫,以後再說。
而如果不是HttpClient的請求,那麼你可以自己寫一個Wrapper或透過裝飾者設計模式來實現。。。
在WebApi專案裡使用MiniProfiler並且分析 Entity Framework Core
我換了一個ASP.NET Core Web API的解決方案,它用到了Entity Framework Core。
基本配置和上面是一樣的,只不過不需要使用TagHelper了。
需要安裝MiniProfiler.EntityFrameworkCore,注意不管使用EFCore的專案在哪,你還是需要把這個庫安裝在主Web專案裡:
首先新增一個配置選項,用於訪問分析結果;然後在之前的配置後邊加上AddEntityFramework()即可:
執行程式,這時一共有三個檢視分析結果相關的URL地址:
- /profiler/results-index
- /profiler/results
- /profiler/results-list
先看results-index:
什麼也沒有,這時因為我還沒有呼叫任何API,接下來就呼叫一個API,然後再檢視該頁面:
這個頁面自動重新整理了,出現了剛才呼叫API的結果。可以看到總時間為3066毫秒。
再看result-list頁面:
其實就是分析結果的json資料。
最後從result-index頁面點選連結進入這次API呼叫的詳細結果頁面,也就是result頁面:
最上面列表的最後一列括號外的資料是執行SQL語句的總耗時,而括號裡面是指一共執行了4個語句。
下面那一大片就是整個過程中每步的分析結果明細,這裡包含了四個SQL語句,但是截圖不全。
對分析結果進行訪問控制
你肯定不想讓任何人都看到MiniProfiler的分析結果,這就需要你對其進行訪問許可權控制。
在Startup.cs的ConfigureServices方法裡,再新增兩個配置:
ResultsAuthorize的引數是一個Func,引數是HttpRequest,返回型別為bool,在這裡你就可以寫一個函式來判斷使用者的身份。返回true就代表使用者有許可權。
UserIdProvider,它的引數也是一個Func,用來為當前請求的使用者返回他的ID或使用者名稱(唯一的)。這個專案裡我可以使用User.Identity.Name。
當使用者沒登入的時候:
左下角不顯示分析結果按鈕了。
登入一個admin角色的使用者以後:
左下角出現了結果,並且只是當前使用者操作的分析結果。
把分析結果存到資料庫
你可能需要把分析結果持久話,例如存到資料庫裡。
這時你需要安裝一個MiniProfiler的儲存提供商:
我這裡使用的是SqlServer,所以安裝SqlServer那個:
通常這種資料是放在一個單獨的資料庫裡,所以新增一個資料庫連線字串:
再來到Startup的ConfigureServices裡,獲取ConnectionString,然後設定Storage選項即可:
最後,還需要建立MiniProfiler所使用的資料庫表,這些建立表的SQL語句存在於SqlServerStorage物件的TableCreationScripts裡,你可以在程式的某個地方貼上如下程式碼:
然後把SQL語句複製下來並執行,從而生成表😂:
執行完以後,表如下:
執行程式,呼叫API,在資料庫裡面檢視資料:
肯定是有資料了,具體就不細看了。
就講到這,謝謝大家。