Java基準(zhǔn)性能測試--JMH使用介紹

JMH是什么

JMH是Java Microbenchmark Harness的簡稱，一個(gè)針對(duì)Java做基準(zhǔn)測試的工具，是由開發(fā)JVM的那群人開發(fā)的。想準(zhǔn)確的對(duì)一段代碼做基準(zhǔn)性能測試并不容易，因?yàn)镴VM層面在編譯期、運(yùn)行時(shí)對(duì)代碼做很多優(yōu)化，但是當(dāng)代碼塊處于整個(gè)系統(tǒng)中運(yùn)行時(shí)這些優(yōu)化并不一定會(huì)生效，從而產(chǎn)生錯(cuò)誤的基準(zhǔn)測試結(jié)果，而這個(gè)問題就是JMH要解決的。

JMH vs JMeter

JMeter可能是最常用的性能測試工具。它既支持圖形界面，也支持命令行，屬于黑盒測試的范疇，對(duì)非開發(fā)人員比較友好，上手也非常容易。圖形界面一般用于編寫、調(diào)試測試用例，而實(shí)際的性能測試建議還是在命令行下運(yùn)行。

很多場景下JMeter和JMH都可以做性能測試，但是對(duì)于嚴(yán)格意義上的基準(zhǔn)測試來說，只有JMH才適合。JMeter的測試結(jié)果精度相對(duì)JVM較低、所以JMeter不適合于類級(jí)別的基準(zhǔn)測試，更適合于對(duì)精度要求不高、耗時(shí)相對(duì)較長的操作。

  • JMeter測試精度差： JMeter自身框架比較重，舉個(gè)例子：使用JMH測試一個(gè)方法，平均耗時(shí)0.01ms，而使用JMeter測試的結(jié)果平均耗時(shí)20ms，相差200倍。
  • JMeter內(nèi)置很多采樣器：JMeter內(nèi)置了支持多種網(wǎng)絡(luò)協(xié)議的采樣器，可以在不寫Java代碼的情況下實(shí)現(xiàn)很多復(fù)雜的測試。JMeter支持集群的方式運(yùn)行，方便模擬多用戶、高并發(fā)壓力測試。

總結(jié)： JMeter適合一些相對(duì)耗時(shí)的集成功能測試，如API接口的測試。JMH適合于類或者方法的單元測試。

JMH基本用法

創(chuàng)建JMH項(xiàng)目

官方推薦為JMH基準(zhǔn)測試創(chuàng)建單獨(dú)的項(xiàng)目，最簡單的創(chuàng)建JMH項(xiàng)目的方法就是基于maven項(xiàng)目原型的方式創(chuàng)建（如果是在windows環(huán)境下，需要對(duì)org.open.jdk.jmh這樣帶.的用雙引號(hào)包裹。）。

 mvn archetype:generate
          -DinteractiveMode=false
          -DarchetypeGroupId=org.openjdk.jmh
          -DarchetypeArtifactId=jmh-java-benchmark-archetype
          -DarchetypeVersion=1.21
          -DgroupId=com.jenkov
          -DartifactId=first-benchmark
          -Dversion=1.0

可以看到生成的項(xiàng)目pom文件中主要是添加了兩個(gè)jmh
的依賴和設(shè)置了maven-shade-plugin的編譯方式（負(fù)責(zé)把項(xiàng)目的所有依賴jar包打入到目標(biāo)jar包中，與springboot的實(shí)現(xiàn)方式類似）。

...
<dependencies>
        <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>
            <scope>provided</scope>
        </dependency>
    </dependencies>
...
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-shade-plugin</artifactId>
    <version>2.2</version>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>shade</goal>
            </goals>
            <configuration>
                <finalName>${uberjar.name}</finalName>
                <transformers>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                        <mainClass>org.openjdk.jmh.Main</mainClass>
                    </transformer>
                </transformers>
                <filters>
                    <filter>
                        <!--
                            Shading signed JARs will fail without this.
                            http://stackoverflow.com/questions/999489/invalid-signature-file-when-attempting-to-run-a-jar
                        -->
                        <artifact>*:*</artifact>
                        <excludes>
                            <exclude>META-INF/*.SF</exclude>
                            <exclude>META-INF/*.DSA</exclude>
                            <exclude>META-INF/*.RSA</exclude>
                        </excludes>
                    </filter>
                </filters>
            </configuration>
        </execution>
    </executions>
</plugin>
...

生成的項(xiàng)目中已經(jīng)包含了一個(gè)class文件MyBenchmark.java，如下：

package org.sample;

import org.openjdk.jmh.annotations.Benchmark;

public class MyBenchmark {

    @Benchmark
    public void testMethod() {
        // This is a demo/sample template for building your JMH benchmarks. Edit as needed.
        // Put your benchmark code here.
    }

}

編寫基準(zhǔn)測試代碼

在上面生成的MyBenchmark類的testMethod中就可以添加基準(zhǔn)測試的java代碼，舉例如下：測試AtomicInteger的incrementAndGet的基準(zhǔn)性能。

package org.sample;

import org.openjdk.jmh.annotations.Benchmark;

import java.util.concurrent.atomic.AtomicInteger;

public class MyBenchmark {
    static AtomicInteger integer = new AtomicInteger();

    @Benchmark
    public void testMethod() {
        // This is a demo/sample template for building your JMH benchmarks. Edit as needed.
        // Put your benchmark code here.
        integer.incrementAndGet();
    }
}

JMH打包、運(yùn)行

項(xiàng)目打包

mvn clean install

運(yùn)行生成的目標(biāo)jar包benchmark.jar：

java -jar benchmark.jar

# JMH version: 1.21
# VM version: JDK 1.8.0_181, Java HotSpot(TM) 64-Bit Server VM, 25.181-b13
# VM invoker: C:\Java\jdk1.8.0_181\jre\bin\java.exe
# VM options: <none>
# Warmup: 5 iterations, 10 s each
# Measurement: 5 iterations, 10 s each
# Timeout: 10 min per iteration
# Threads: 1 thread, will synchronize iterations
# Benchmark mode: Throughput, ops/time
# Benchmark: org.sample.MyBenchmark.testMethod

# Run progress: 0.00% complete, ETA 00:01:40
# Fork: 1 of 1
# Warmup Iteration   1: 81052462.185 ops/s
# Warmup Iteration   2: 80152956.333 ops/s
# Warmup Iteration   3: 81305026.522 ops/s
# Warmup Iteration   4: 81740215.227 ops/s
# Warmup Iteration   5: 82398485.097 ops/s
Iteration   1: 82176523.804 ops/s
Iteration   2: 81818881.730 ops/s
Iteration   3: 82812749.807 ops/s
Iteration   4: 82406672.531 ops/s
Iteration   5: 74270344.512 ops/s


Result "org.sample.MyBenchmark.testMethod":
  80697034.477 ±(99.9%) 13903555.960 ops/s [Average]
  (min, avg, max) = (74270344.512, 80697034.477, 82812749.807), stdev = 3610709.330
  CI (99.9%): [66793478.517, 94600590.437] (assumes normal distribution)


# Run complete. Total time: 00:01:41

REMEMBER: The numbers below are just data. To gain reusable insights, you need to follow up on
why the numbers are the way they are. Use profilers (see -prof, -lprof), design factorial
experiments, perform baseline and negative tests that provide experimental control, make sure
the benchmarking environment is safe on JVM/OS/HW level, ask for reviews from the domain experts.
Do not assume the numbers tell you what you want them to tell.

Benchmark                Mode  Cnt         Score          Error  Units
MyBenchmark.testMethod  thrpt    5  80697034.477 ± 13903555.960  ops/s

從上面的日志我們大致可以了解到 JMH的基準(zhǔn)測試主要經(jīng)歷了下面幾個(gè)過程：

  1. 打印本次測試的配置，warmup：5輪；measurement：5輪；每輪：10s；啟動(dòng)1個(gè)線程做測試；基準(zhǔn)測試指標(biāo)：吞吐量（throughput，單位是s）；測試方法MyBenchmark.testMethod
  2. 啟動(dòng)一個(gè)JVM進(jìn)程做基準(zhǔn)測試（也可以設(shè)置啟動(dòng)多個(gè)進(jìn)程，減少隨機(jī)因素的誤差影響）
  3. 在JVM進(jìn)程中先執(zhí)行了5輪的預(yù)熱（warmup），每輪10s，總共50s的預(yù)熱時(shí)間。預(yù)熱的數(shù)據(jù)不作為基準(zhǔn)測試的參考。
  4. 測試了5輪，每輪10s，總共50s的測試時(shí)間
  5. 匯總測試數(shù)據(jù)、生成結(jié)果報(bào)表。最終結(jié)論是吞吐量（80697034.477 ±13903555.960 ops/s）,其中80697034.477 是結(jié)果，13903555.960是誤差范圍。

JMH與Springboot

在對(duì)Springboot項(xiàng)目做JMH基準(zhǔn)測試時(shí)可能會(huì)因?yàn)閙aven-shade-plugin插件的問題打包報(bào)錯(cuò)，需要在JMH的maven-shade-plugin的插件配置中添加id即可。項(xiàng)目的pom可能如下：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.7.RELEASE</version>
        <relativePath/>
    </parent>
...
<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-shade-plugin</artifactId>
    <version>2.2</version>
    <executions>
        <execution>
            <!-- 需要在此處添加一個(gè)id標(biāo)簽，否則mvn package時(shí)會(huì)報(bào)錯(cuò) -->
            <id>shade-all-dependency-jar</id>
            <phase>package</phase>
            <goals>
                <goal>shade</goal>
            </goals>
            <configuration>
                ...
            </configuration>
        </execution>
    </executions>
</plugin>
...
</project>

在測試代碼中正?；赟pringBootApplication構(gòu)建ConfigurableApplicationContext從而獲取bean的方式獲取對(duì)象測試即可。

public class StringRedisTemplateBenchmark  {
    StringRedisTemplate redisTemplate;
            
    @Setup(Level.Trial)
    public void setUp() {
        redisTemplate = SpringApplication.run(SpringBootApplicationClass.class).getBean(StringRedisTemplate.class);
    }
    
    @Benchmark
    public void testGet() {
        redisTemplate.opsForValue().get("testkey");
    }
}

@SpringBootApplication
public class SpringBootApplicationClass {

}

resources/application.properties

lettuce.pool.maxTotal=50
lettuce.pool.maxIdle=10
lettuce.pool.minIdle=0

lettuce.sentinel.master=mymaster
lettuce.sentinel.nodes=10.xx.xx.xx:26379,10.xx.xx.xx:26379
lettuce.password=xxxxxx

JMH注解

JMH測試的相關(guān)配置大多是通過注解的方式體現(xiàn)的。具體每個(gè)注解的使用實(shí)例也可以參考官網(wǎng)http://hg.openjdk.java.net/code-tools/jmh/file/tip/jmh-samples/src/main/java/org/openjdk/jmh/samples/

JMH Benchmark Modes

JMH benchmark支持如下幾種測試模式：

  • Throughput： 吞吐量，測試每秒可以執(zhí)行操作的次數(shù)
  • Average Time： 平均耗時(shí)，測試單次操作的平均耗時(shí)
  • Sample Time：采樣耗時(shí)，測試單次操作的耗時(shí)，包括最大、最小耗時(shí)，已經(jīng)百分位耗時(shí)等
  • Single Shot Time： 只計(jì)算一次的耗時(shí)，一般用來測試?yán)鋯?dòng)的性能（不設(shè)置JVM預(yù)熱）
  • All： 測試上面的所有指標(biāo)

默認(rèn)的benchmark mode是Throughput，可以通過注解的方式設(shè)置BenchmarkMode，注解支持放在類或方法上。如下所示設(shè)置了Throughput和SampleTime兩個(gè)Benchmark mode。

@BenchmarkMode({Mode.Throughput, Mode.SampleTime})
public class MyBenchmark {
    static AtomicInteger integer = new AtomicInteger();

    @Benchmark
    public void testMethod() {
        // This is a demo/sample template for building your JMH benchmarks. Edit as needed.
        // Put your benchmark code here.
        integer.incrementAndGet();
    }
}

Benchmark Time Units

JMH支持設(shè)置打印基準(zhǔn)測試結(jié)果的時(shí)間單位，通過@OutputTimeUnit注解的方式設(shè)置。

@OutputTimeUnit(TimeUnit.SECONDS)
public class MyBenchmark {
    static AtomicInteger integer = new AtomicInteger();

    @Benchmark
    public void testMethod() {
        integer.incrementAndGet();
    }

}

Benchmark State

有時(shí)候我們?cè)谧龌鶞?zhǔn)測試的時(shí)候會(huì)需要使用一些變量、字段，@State注解是用來配置這些變量的生命周期，@State注解可以放在類上，然后在基準(zhǔn)測試方法中可以通過參數(shù)的方式把該類對(duì)象作為參數(shù)使用。@State支持的生命周期類型：

  • Benchmark： 整個(gè)基準(zhǔn)測試的生命周期，多個(gè)線程共用同一份實(shí)例對(duì)象。該類內(nèi)部的@Setup @TearDown注解的方法可能會(huì)被任一個(gè)線程執(zhí)行，但是只會(huì)執(zhí)行一次。
  • Group： 每一個(gè)Group內(nèi)部共享同一個(gè)實(shí)例，需要配合@Group @GroupThread使用。該類內(nèi)部的@Setup @TearDown注解的方法可能會(huì)該Group內(nèi)的任一個(gè)線程執(zhí)行，但是只會(huì)執(zhí)行一次。
  • Thread：每個(gè)線程的實(shí)例都是不同的、唯一的。該類內(nèi)部的@Setup @TearDown注解的方法只會(huì)被當(dāng)前線程執(zhí)行，而且只會(huì)執(zhí)行一次。

被@State標(biāo)示的類必須滿足如下兩個(gè)要求：

  • 類必須是public的
  • 必須有無參構(gòu)造函數(shù)

State Object @Setup @TearDown

在@Scope注解標(biāo)示的類的方法上可以添加@Setup和@TearDwon注解。@Setup：用來標(biāo)示在Benchmark方法使用State對(duì)象之前需要執(zhí)行的操作。@TearDown：用來標(biāo)示在Benchmark方法之后需要對(duì)State對(duì)象執(zhí)行的操作。
如下示例：

@OutputTimeUnit(TimeUnit.SECONDS)
public class MyBenchmark {
    
    @Benchmark
    public void testMethod(TestAddAndGetState state) {
        state.getInteger().incrementAndGet();
    }

    @State(Scope.Benchmark)
    public static class TestAddAndGetState {
        private AtomicInteger integer;

        @Setup(Level.Iteration)
        public void setup() {
            integer = new AtomicInteger();
        }

        public AtomicInteger getInteger() {
            return integer;
        }
    }
}

@Setup、@TearDown支持設(shè)置Level級(jí)別，Level有三個(gè)值：

  • Trial： 每次benchmark前/后執(zhí)行一次，每次benchmark會(huì)包含多輪（Iteration）
  • Iteration： 每輪執(zhí)行前/后執(zhí)行一次
  • Invocation： 每次調(diào)用測試的方法前/后都執(zhí)行一次，這個(gè)執(zhí)行頻率會(huì)很高，一般用不上。

Fork

@Fork注解用來設(shè)置啟動(dòng)的JVM進(jìn)程數(shù)量，多個(gè)進(jìn)程是串行的方式啟動(dòng)的，多個(gè)進(jìn)程可以減少偶發(fā)因素對(duì)測試結(jié)果的影響。

Thread

@Thread用來配置執(zhí)行測試啟動(dòng)的線程數(shù)量

Warmup

@Warmup 用來配置預(yù)熱的時(shí)間，如下所示配置預(yù)熱五輪，每輪1second，也就是說總共會(huì)預(yù)熱5s左右，在這5s內(nèi)會(huì)不停的循環(huán)調(diào)用測試方法，但是預(yù)熱時(shí)的數(shù)據(jù)不作為測試結(jié)果參考。

@Warmup(iterations = 5, time = 1)

Measurement

@Measurement用來配置基準(zhǔn)測試的時(shí)間，如下所示配置預(yù)熱10輪，每輪1second，也就是說總共會(huì)測試10s左右，在這10s內(nèi)會(huì)不停的循環(huán)調(diào)用測試方法，同事測試數(shù)據(jù)會(huì)被基準(zhǔn)測試結(jié)果參考。

@Measurement(iterations = 5, time = 1)

輸出測試結(jié)果

jmh支持多種格式的結(jié)果輸出text, csv, scsv, json, latex
如下打印出json格式的：

java -jar benchmark.jar -rf json

JMH Visual

jmh可以基于jmh生成的json格式測試結(jié)果展示出圖形化的界面，參考網(wǎng)站：https://jmh.morethan.io/#details

image.png

參考

http://tutorials.jenkov.com/java-performance/jmh.html
http://openjdk.java.net/projects/code-tools/jmh/
https://yangbingdong.com/2018/spring-boot-learning-testing/

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容