JMH的DEMO演示和常用的注解參數
前言
"If you cannot measure it, you cannot improve it".
在日常開發中，我們對一些代碼的調用或者工具的使用會存在多種選擇方式，在不確定他們性能的時候，我們首先想要做的就是去測量它。大多數時候，我們會簡單的采用多次計數的方式來測量，來看這個方法的總耗時。
但是，如果熟悉JVM類加載機制的話，應該知道JVM默認的執行模式是JIT編譯與解釋混合執行。JVM通過熱點代碼統計分析，識別高頻方法的調用、循環體、公共模塊等，基于JIT動態編譯技術，會將熱點代碼轉換成機器碼，直接交給CPU執行。
也就是說，JVM會不斷的進行編譯優化，這就使得很難確定重復多少次才能得到一個穩定的測試結果？所以，很多有經驗的同學會在測試代碼前寫一段預熱的邏輯。
JMH，全稱 Java Microbenchmark Harness (微基準測試框架），是專門用于Java代碼微基準測試的一套測試工具API，是由 OpenJDK/Oracle 官方發布的工具。何謂 Micro Benchmark 呢？簡單地說就是在 method 層面上的 benchmark，精度可以精確到微秒級。
Java的基準測試需要注意的幾個點：
- 測試前需要預熱。
- 防止無用代碼進入測試方法中。
- 并發測試。
- 測試結果呈現。
JMH的使用場景：
- 定量分析某個熱點函數的優化效果
- 想定量地知道某個函數需要執行多長時間，以及執行時間和輸入變量的相關性
- 對比一個函數的多種實現方式
本篇主要是介紹JMH的DEMO演示，和常用的注解參數。希望能對你起到幫助。
基于 Spring Boot + MyBatis Plus + Vue & Element 實現的后臺管理系統 + 用戶小程序，支持 RBAC 動態權限、多租戶、數據權限、工作流、三方登錄、支付、短信、商城等功能
DEMO 演示
這里先演示一個DEMO，讓不了解JMH的同學能夠快速掌握這個工具的大概用法。
1. 測試項目構建
JMH是內置Java9及之后的版本。這里是以Java8進行說明。
為了方便，這里直接介紹使用maven構建JMH測試項目的方式。
第一種是使用命令行構建，在指定目錄下執行以下命令：
$mvnarchetype:generate
-DinteractiveMode=false
-DarchetypeGroupId=org.openjdk.jmh
-DarchetypeArtifactId=jmh-java-benchmark-archetype
-DgroupId=org.sample
-DartifactId=test
-Dversion=1.0
對應目錄下會出現一個test項目，打開項目后我們會看到這樣的項目結構。
第二種方式就是直接在現有的maven項目中添加jmh-core和jmh-generator-annprocess的依賴來集成JMH。
<dependency>
<groupId>org.openjdk.jmhgroupId>
<artifactId>jmh-coreartifactId>
<version>${jmh.version}version>
dependency>
<dependency>
<groupId>org.openjdk.jmhgroupId>
<artifactId>jmh-generator-annprocessartifactId>
<version>${jmh.version}version>
<scope>providedscope>
dependency>
2. 編寫性能測試
這里我以測試LinkedList 通過index 方式迭代和foreach 方式迭代的性能差距為例子，編寫測試類，涉及到的注解在之后會講解。
/**
*@authorRichard_yyf
*@version1.02019/8/27
*/
@State(Scope.Benchmark)
@OutputTimeUnit(TimeUnit.SECONDS)
@Threads(Threads.MAX)
publicclassLinkedListIterationBenchMark{
privatestaticfinalintSIZE=10000;
privateListlist=newLinkedList<>();
@Setup
publicvoidsetUp(){
for(inti=0;i@Benchmark
@BenchmarkMode(Mode.Throughput)
publicvoidforIndexIterate(){
for(inti=0;i"");
}
}
@Benchmark
@BenchmarkMode(Mode.Throughput)
publicvoidforEachIterate(){
for(Strings:list){
System.out.print("");
}
}
}
3. 執行測試
運行 JMH 基準測試有兩種方式，一個是生產jar文件運行，另一個是直接寫main函數或者放在單元測試中執行。
生成jar文件的形式主要是針對一些比較大的測試，可能對機器性能或者真實環境模擬有一些需求，需要將測試方法寫好了放在linux環境執行。
具體命令如下
$mvncleaninstall
$java-jartarget/benchmarks.jar
我們日常中遇到的一般是一些小測試，比如我上面寫的例子，直接在IDE中跑就好了。
啟動方式如下：
publicstaticvoidmain(String[]args)throwsRunnerException{
Optionsopt=newOptionsBuilder()
.include(LinkedListIterationBenchMark.class.getSimpleName())
.forks(1)
.warmupIterations(2)
.measurementIterations(2)
.output("E:/Benchmark.log")
.build();
newRunner(opt).run();
}
4. 報告結果
輸出結果如下，
最后的結果：
BenchmarkModeCntScoreErrorUnits
LinkedListIterationBenchMark.forEachIteratethrpt21192.380ops/s
LinkedListIterationBenchMark.forIndexIteratethrpt2206.866ops/s
整個過程：
>基于SpringCloudAlibaba+Gateway+Nacos+RocketMQ+Vue&Element實現的后臺管理系統+用戶小程序，支持RBAC動態權限、多租戶、數據權限、工作流、三方登錄、支付、短信、商城等功能
>
>*項目地址：
>*視頻教程：
注解介紹
下面我們來詳細介紹一下相關的注解。
@BenchmarkMode
微基準測試類型。JMH 提供了以下幾種類型進行支持：
| 類型 | 描述 |
|---|---|
| Throughput | 每段時間執行的次數，一般是秒 |
| AverageTime | 平均時間，每次操作的平均耗時 |
| SampleTime | 在測試中，隨機進行采樣執行的時間 |
| SingleShotTime | 在每次執行中計算耗時 |
| All | 所有模式 |
可以注釋在方法級別，也可以注釋在類級別。
@BenchmarkMode(Mode.All)
publicclassLinkedListIterationBenchMark{
...
}
@Benchmark
@BenchmarkMode({Mode.Throughput,Mode.SingleShotTime})
publicvoidm(){
...
}
@Warmup
這個單詞的意思就是預熱，iterations = 3就是指預熱輪數。
@Benchmark
@BenchmarkMode({Mode.Throughput,Mode.SingleShotTime})
@Warmup(iterations=3)
publicvoidm(){
...
}
@Measurement
正式度量計算的輪數。
-
iterations進行測試的輪次 -
time每輪進行的時長 -
timeUnit時長單位
@Benchmark
@BenchmarkMode({Mode.Throughput,Mode.SingleShotTime})
@Measurement(iterations=3)
publicvoidm(){
...
}
@Threads
每個進程中的測試線程。
@Threads(Threads.MAX)
publicclassLinkedListIterationBenchMark{
...
}
@Fork
進行 fork 的次數。如果 fork 數是3的話，則 JMH 會 fork 出3個進程來進行測試。
@Benchmark
@BenchmarkMode({Mode.Throughput,Mode.SingleShotTime})
@Fork(value=3)
publicvoidm(){
...
}
@OutputTimeUnit
基準測試結果的時間類型。一般選擇秒、毫秒、微秒。
@OutputTimeUnit(TimeUnit.SECONDS)
publicclassLinkedListIterationBenchMark{
...
}
@Benchmark
方法級注解，表示該方法是需要進行 benchmark 的對象，用法和 JUnit 的 @Test 類似。
@Param
屬性級注解，@Param 可以用來指定某項參數的多種情況。特別適合用來測試一個函數在不同的參數輸入的情況下的性能。
@Setup
方法級注解，這個注解的作用就是我們需要在測試之前進行一些準備工作 ，比如對一些數據的初始化之類的。
@TearDown
方法級注解，這個注解的作用就是我們需要在測試之后進行一些結束工作 ，比如關閉線程池，數據庫連接等的，主要用于資源的回收等。
@State
當使用@Setup參數的時候，必須在類上加這個參數，不然會提示無法運行。
就比如我上面的例子中，就必須設置state。
State 用于聲明某個類是一個“狀態”，然后接受一個 Scope 參數用來表示該狀態的共享范圍。因為很多 benchmark 會需要一些表示狀態的類，JMH 允許你把這些類以依賴注入的方式注入到 benchmark 函數里。Scope 主要分為三種。
- Thread: 該狀態為每個線程獨享。
- Group: 該狀態為同一個組里面所有線程共享。
- Benchmark: 該狀態在所有線程間共享。
啟動方法
在啟動方法中，可以直接指定上述說到的一些參數，并且能將測試結果輸出到指定文件中，
/**
*僅限于IDE中運行
*命令行模式則是build然后java-jar啟動
*
*1.這是benchmark啟動的入口
*2.這里同時還完成了JMH測試的一些配置工作
*3.默認場景下，JMH會去找尋標注了@Benchmark的方法，可以通過include和exclude兩個方法來完成包含以及排除的語義
*/
publicstaticvoidmain(String[]args)throwsRunnerException{
Optionsopt=newOptionsBuilder()
//包含語義
//可以用方法名，也可以用XXX.class.getSimpleName()
.include("Helloworld")
//排除語義
.exclude("Pref")
//預熱10輪
.warmupIterations(10)
//代表正式計量測試做10輪，
//而每次都是先執行完預熱再執行正式計量，
//內容都是調用標注了@Benchmark的代碼。
.measurementIterations(10)
//forks(3)指的是做3輪測試，
//因為一次測試無法有效的代表結果，
//所以通過3輪測試較為全面的測試，
//而每一輪都是先預熱，再正式計量。
.forks(3)
.output("E:/Benchmark.log")
.build();
newRunner(opt).run();
}
結語
基于JMH可以對很多工具和框架進行測試，比如日志框架性能對比、BeanCopy性能對比 等，更多的example可以參考官方給出的JMH samples(https://hg.openjdk.java.net/code-tools/jmh/file/tip/jmh-samples/src/main/java/org/openjdk/jmh/samples/)
審核編輯：湯梓紅
-
JAVA
+關注
關注
20文章
3001瀏覽量
116434 -
JVM
+關注
關注
0文章
161瀏覽量
13037
原文標題：別再寫 main 方法測試了，太 Low！這才是專業 Java 測試方法！
文章出處：【微信號：芋道源碼，微信公眾號：芋道源碼】歡迎添加關注！文章轉載請注明出處。
發布評論請先 登錄
如何通過注解來優化我們的Java代碼
【HarmonyOS IPC 試用連載 】開箱+DEMO演示
HarmonyOS注解的使用方法分享
基于TX4101制作的DEMO演示板
基于TX4205制作的DEMO演示板
基于TX6410制作的DEMO演示板
Spring Boot常用注解與使用方式
SpringBoot常用注解及使用方法1
SpringBoot常用注解及使用方法2
Springboot常用注解合集
SpringBoot常用注解及原理
JAVA中注解是怎么做到的（上）
JAVA中注解是怎么做到的（下）
工商網監
評論