.NET Core 性能分析: xUnit.Performance 简介
?xunit-performance 是xUnit的一個(gè)擴(kuò)展, 使用它可以對(duì).NET Core項(xiàng)目進(jìn)行性能測(cè)試。
官網(wǎng):https://github.com/Microsoft/xunit-performance
?
xUnit大家可能都用過,它是用來做單元測(cè)試的,它可以很快給開發(fā)人員功能是否OK的反饋。
和xUnit一樣,xUnit-Performance可以很快給出性能上的反饋。
?
準(zhǔn)備和安裝xUnit-Performance
為了講解,我們需要準(zhǔn)備一個(gè)需要被測(cè)試的項(xiàng)目和一個(gè)測(cè)試項(xiàng)目。
我使用Visual Studio 2017建立項(xiàng)目之后總有一些問題,不過后來我是用dotnet cli和VSCode就沒有什么問題了。
?
建立項(xiàng)目的順序如下:
1. 首先使用dotnet cli建立一個(gè)classlib類型的被測(cè)試項(xiàng)目,它的目標(biāo)框架是.NET Standard 2.0:
?
這個(gè)項(xiàng)目里只有一個(gè)類,也就是要被測(cè)試的類:
這個(gè)類有三個(gè)方法,分別是使用foreach,for和Linq擴(kuò)展方法的Sum對(duì)集合循環(huán)并求和。
?
2. 使用dotnet cli建立一個(gè)console項(xiàng)目(如果使用VS2017的話直接建類庫就可以,因?yàn)閂S2017內(nèi)置Test Runner),這個(gè)是測(cè)試項(xiàng)目,它的版本只能是2.0(可能是因?yàn)槲译娔Xsdk的版本較老):
另外還需要引用被測(cè)試項(xiàng)目。
?
3.然后,按照官方文檔安裝兩個(gè)庫。?
xUnit-Performance目前還處于Beta階段,這兩個(gè)庫需要按照官網(wǎng)的指示進(jìn)行安裝:
最新版的xunit.performance.api.dll, 這里用到的是MyGet:??https://dotnet.myget.org/feed/dotnet-core/package/nuget/xunit.performance.api#.
?
然后是最新版的?Microsoft.Diagnostics.Tracing.TraceEvent, 這個(gè)使用Nuge:?https://www.nuget.org/packages/Microsoft.Diagnostics.Tracing.TraceEvent
?
OK,現(xiàn)在依賴庫都裝好了。
?
編寫性能測(cè)試
性能測(cè)試和單元測(cè)試略有不同, 性能測(cè)試是跑很多次, 然后取平均值. 同時(shí)也要考慮到內(nèi)存等其它因素的影響.
在性能測(cè)試?yán)锞筒恍枰獪y(cè)試功能的正確性了, 但是程序在壓力下可能會(huì)產(chǎn)生不同的結(jié)果, 尤其是多線程的情況. 這時(shí)你就需要寫壓力測(cè)試了.
而對(duì)于性能測(cè)試, 我們只考慮速度.
?
由于我是用的是dotnet cli和VSCode,所以測(cè)試項(xiàng)目我選用的是控制臺(tái)項(xiàng)目,它的Main方法需要這樣寫:
如果您能成功的使用VS2017建立測(cè)試項(xiàng)目,那么就不需要Main方法了,建立一個(gè)類庫項(xiàng)目即可,直接使用VS2017的Test Runner即可。
?
性能測(cè)試代碼
下面我們編寫性能測(cè)試方法。
首先在測(cè)試項(xiàng)目建立一個(gè)類,然后做一些準(zhǔn)備工作:
這里我準(zhǔn)備了一個(gè)List<KeyValuePair<int, double>>,它有100000條數(shù)據(jù),是隨機(jī)生成的。
?
然后是測(cè)試方法,在這里我們使用[Benchmark]替代了xUnit單元測(cè)試中的[Fact]:
xUnit.Performance的測(cè)試會(huì)跑很多次,結(jié)果是取平均值的。
這里我們循環(huán)遍歷Benchmark.Iterations,它有一個(gè)默認(rèn)值,我這里默認(rèn)是跑了1000次循環(huán)。
再循環(huán)里,首先您可以做一些準(zhǔn)備工作。然后使用iteration.StartMeasurement()來開始進(jìn)行測(cè)量。
只有iteration.StartMeasurement()后邊的部分才會(huì)被測(cè)量,在大括號(hào)里面寫被測(cè)試相關(guān)的代碼就可以了。
?
然后在命令行輸入運(yùn)行測(cè)試:
dotnet run --perf:collect stopwatch
?
測(cè)試結(jié)果如下:
提供了控制臺(tái)輸出,xml,csv,md輸出(在項(xiàng)目文件夾里)。
從控制臺(tái)可以看到該測(cè)試的循環(huán)跑了1000次,平均結(jié)果是0.963毫秒。
?
下面是csv結(jié)果的截圖:
?
下面是md結(jié)果文件的截圖:
?
下面是xml結(jié)果文件的截圖,它里面有詳細(xì)數(shù)據(jù):
?
內(nèi)部循環(huán)
xUnit.Performance還可以添加一個(gè)內(nèi)部循環(huán)屬性?InnerIterationCount。先看代碼,添加以下方法:
[Benchmark(InnerIterationCount = 10_000)],這里的InnerIterationCount是內(nèi)部循環(huán)遍歷的次數(shù)。
在StartMeasurement()之后,進(jìn)行內(nèi)部循環(huán)。
這樣的話,外層循環(huán)的次數(shù)可能會(huì)很少,而且第一次外層循環(huán)是熱身,不包括在測(cè)試結(jié)果中。
而內(nèi)部循環(huán)適合于運(yùn)行比較快速的代碼(微秒級(jí))。
?
有時(shí)確實(shí)需要這樣兩層循環(huán),做一些熱身工作或者需要完成不同級(jí)別的準(zhǔn)備工作。
?
然后我們來跑測(cè)試
在結(jié)果里看到外層循環(huán)有2次的記錄,但是它實(shí)際跑了3次,第一次算作熱身,不做統(tǒng)計(jì)。
它的時(shí)間是內(nèi)層循環(huán)的總和,除以10000之后,和第一個(gè)方法的結(jié)果差不太多。
?
我可以在方法中打印輸出循環(huán)次數(shù):
其結(jié)果如下:
可以看到確實(shí)是跑了3次,但統(tǒng)計(jì)了2次。
?
然后我再添加另外兩個(gè)測(cè)試方法,分別測(cè)試另外兩個(gè)方法:
?
運(yùn)行測(cè)試:
可以看到現(xiàn)在這4個(gè)測(cè)試方法的結(jié)果。
看來針對(duì)List來說foreach要比linq和for循環(huán)快。
注意foreach測(cè)試的外層循環(huán)跑了2次,而for和linq的測(cè)試循環(huán)只跑了1次,可能是因?yàn)榛ㄙM(fèi)時(shí)間太久了吧?這個(gè)我不太確定。
?
StopWatch
可以看到測(cè)試命令的參數(shù) stopwatch,它應(yīng)該是來自System.Diagnostics命名空間下的StopWatch類。
它有Start()和Stop()方法和一些其它屬性用來統(tǒng)計(jì)逝去的時(shí)間。
StopWatch類是跨平臺(tái)的,但是在其它系統(tǒng)上,它只能統(tǒng)計(jì)時(shí)間;而在Windows上,它還可以使用內(nèi)核ETW events和CPU性能計(jì)數(shù)來給您更多的數(shù)據(jù),具體請(qǐng)查閱相關(guān)資料。
?
結(jié)語
該庫還有很多功能和命令的參數(shù),具體請(qǐng)參考文檔:https://github.com/Microsoft/xunit-performance
但是要注意,它仍然是beta狀態(tài),只能在MyGet而不是Nuget獲取。
博客文章可以隨便轉(zhuǎn)載和抓取.?
總結(jié)
以上是生活随笔為你收集整理的.NET Core 性能分析: xUnit.Performance 简介的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: Insider Dev Tour 201
- 下一篇: TeamCity+Rancher+Doc