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,在數據庫里面查看數據:
肯定是有數據了,具體就不細看了。
就講到這,謝謝大家。