JMH使用說明
概述
JMH,即Java Microbenchmark Harness,是專門用于代碼微基準(zhǔn)測試的工具套件霎挟。
maven依賴
<!-- JMH -->
<dependency>
<groupId>org.openjdk.jmh</groupId>
<artifactId>jmh-core</artifactId>
<version>${jmh.version}</version>
</dependency>
<dependency>
<groupId>org.openjdk.jmh</groupId>
<artifactId>jmh-generator-annprocess</artifactId>
<version>${jmh.version}</version>
</dependency>
基本參數(shù)概念
Mode
Mode 表示 JMH 進(jìn)行 Benchmark 時所使用的模式夷陋。通常是測量的維度不同,或是測量的方式不同先紫。目前 JMH 共有四種模式:
Throughput: 吞吐量,一段時間內(nèi)可執(zhí)行的次數(shù),每秒可執(zhí)行次數(shù)
AverageTime: 每次調(diào)用的平均耗時時間筹煮。
SampleTime: 隨機(jī)進(jìn)行采樣執(zhí)行的時間遮精,最后輸出取樣結(jié)果的分布
SingleShotTime: 在每次執(zhí)行中計算耗時,以上模式都是默認(rèn)一次 iteration 是 1s,只有 SingleShotTime 是只運(yùn)行一次败潦。
Iteration
Iteration 是 JMH 進(jìn)行測試的最小單位本冲。在大部分模式下,一次 iteration 代表的是一秒劫扒,JMH 會在這一秒內(nèi)不斷調(diào)用需要 benchmark 的方法檬洞,然后根據(jù)模式對其采樣,計算吞吐量沟饥,計算平均執(zhí)行時間等添怔。
Warmup
Warmup 是指在實(shí)際進(jìn)行 benchmark 前先進(jìn)行預(yù)熱的行為。為什么需要預(yù)熱贤旷?因為 JVM 的 JIT 機(jī)制的存在广料,如果某個函數(shù)被調(diào)用多次之后,JVM 會嘗試將其編譯成為機(jī)器碼從而提高執(zhí)行速度幼驶。為了讓 benchmark 的結(jié)果更加接近真實(shí)情況就需要進(jìn)行預(yù)熱
@BenchmarkMode({Mode.Throughput, Mode.AverageTime}) // 測試方法平均執(zhí)行時間
@OutputTimeUnit(TimeUnit.SECONDS) // 輸出結(jié)果的時間粒度為微秒
@State(Scope.Thread) // 每個測試線程一個實(shí)例
public class SimpleBenchmark {
@Benchmark
public void bench() {
add(1, 1);
}
private static int add(int a, int b) {
return a + b;
}
@Benchmark
public String stringConcat() {
String a = "a";
String b = "b";
String c = "c";
return a + b + c;
}
public static void main(String[] args) throws RunnerException {
Options options = new OptionsBuilder()
.include(SimpleBenchmark.class.getSimpleName())
.exclude("stringConcat")
.forks(2)
.warmupIterations(5)
.measurementIterations(5)
.build();
new Runner(options).run();
}
}
include(SimpleBenchmark.class.getSimpleName())
代表我要測試的是哪個類的方法
exclude("stringConcat")
代表測試的時候需要排除stringConcat方法
forks(2)
指的是做2輪測試艾杏,在一輪測試無法得出最滿意的結(jié)果時,可以多測幾輪以便得出更全面的測試結(jié)果,而每一輪都是先預(yù)熱盅藻,再正式計量购桑。
warmupIterations(5)
代表先預(yù)熱5次
measurementIterations(5)
正式運(yùn)行測試5次
注解
@BenchmarkMode
對應(yīng)Mode選項畅铭,可用于類或者方法上, 需要注意的是勃蜘,這個注解的value是一個數(shù)組硕噩,可以把幾種Mode集合在一起執(zhí)行,還可以設(shè)置為Mode.All元旬,即全部執(zhí)行一遍榴徐。
@State
類注解,JMH測試類必須使用@State注解匀归,State定義了一個類實(shí)例的生命周期坑资,可以類比Spring Bean的Scope。由于JMH允許多線程同時執(zhí)行測試穆端,不同的選項含義如下:
Scope.Thread:默認(rèn)的State袱贮,每個測試線程分配一個實(shí)例;
Scope.Benchmark:所有測試線程共享一個實(shí)例体啰,用于測試有狀態(tài)實(shí)例在多線程共享下的性能攒巍;
Scope.Group:每個線程組共享一個實(shí)例;
@OutputTimeUnit
benchmark 結(jié)果所使用的時間單位荒勇,可用于類或者方法注解柒莉,使用java.util.concurrent.TimeUnit中的標(biāo)準(zhǔn)時間單位。
@Benchmark
方法注解沽翔,表示該方法是需要進(jìn)行 benchmark 的對象兢孝。
@Setup
方法注解,會在執(zhí)行 benchmark 之前被執(zhí)行仅偎,正如其名跨蟹,主要用于初始化。
@TearDown
方法注解橘沥,與@Setup 相對的窗轩,會在所有 benchmark 執(zhí)行結(jié)束以后執(zhí)行,主要用于資源的回收等座咆。
@Param
成員注解痢艺,可以用來指定某項參數(shù)的多種情況。特別適合用來測試一個函數(shù)在不同的參數(shù)輸入的情況下的性能介陶。@Param注解接收一個String數(shù)組腹备,在@setup方法執(zhí)行前轉(zhuǎn)化為為對應(yīng)的數(shù)據(jù)類型。多個@Param注解的成員之間是乘積關(guān)系斤蔓,譬如有兩個用@Param注解的字段,第一個有5個值镀岛,第二個字段有2個值弦牡,那么每個測試方法會跑5*2=10次友驮。