jmh学习笔记-自定义项目引入jmh

系列文章目录

jmh学习笔记-源代码编译与bench mode
jmh学习笔记-State共享对象
jmh学习笔记-State共享对象前后置方法
jmh学习笔记-代码清除
jmh学习笔记-常量折叠
jmh学习笔记-Forking分叉
jmh学习笔记-环境配置
jmh学习笔记-缓存行的处理方式
jmh学习笔记-自定义项目引入jmh

---

---

前言

在前面的章节当中我们介绍了jmh项目的部分知识，实际使用jmh时，我们并不需要自己去编译源代码（对于学习jmh很有用）。直接通过maven引入依赖即可。

引入依赖

需要引入jmh依赖和插件依赖

    <properties>
        <java.version>1.8</java.version>
        <uberjar.name>benchmarks</uberjar.name>
    </properties>
    
   <dependencies>
	   <dependency>
	       <groupId>org.openjdk.jmh</groupId>
	       <artifactId>jmh-core</artifactId>
	       <version>1.26</version>
	   </dependency>
	   <dependency>
	       <groupId>org.openjdk.jmh</groupId>
	       <artifactId>jmh-generator-annprocess</artifactId>
	       <version>1.26</version>
	   </dependency>
   </dependencies>

	<build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>2.5.1</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>


            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <version>2.16</version>
                <configuration>
                    <forkMode>always</forkMode>
                    <redirectTestOutputToFile>true</redirectTestOutputToFile>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>3.2.1</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>
                                <transformer
                                        implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
                            </transformers>
                        </configuration>
                    </execution>
                </executions>
            </plugin>

        </plugins>
    </build>
 

编写jmh基准测试

package com.example.jmh.samples;

import org.openjdk.jmh.annotations.*;
import org.openjdk.jmh.runner.Runner;
import org.openjdk.jmh.runner.RunnerException;
import org.openjdk.jmh.runner.options.Options;
import org.openjdk.jmh.runner.options.OptionsBuilder;

import java.util.concurrent.TimeUnit;

@State(Scope.Thread)
@OutputTimeUnit(TimeUnit.MICROSECONDS)
@Fork(1)
public class JMHSample_20_Annotations {

    double x1 = Math.PI;

    /**
     * Note JMH honors the default annotation settings. You can always override
     * the defaults via the command line or API.
     */
    public static void main(String[] args) throws RunnerException {
        Options opt = new OptionsBuilder()
                .include(JMHSample_20_Annotations.class.getSimpleName())
                .build();

        new Runner(opt).run();
    }

    @Benchmark
    @Warmup(iterations = 5, time = 100, timeUnit = TimeUnit.MILLISECONDS)
    @Measurement(iterations = 5, time = 100, timeUnit = TimeUnit.MILLISECONDS)
    public double measure() {
        return Math.log(x1);
    }
}

执行结果如下

# JMH version: 1.26
# VM version: JDK 1.8.0_121, Java HotSpot(TM) 64-Bit Server VM, 25.121-b13
# VM invoker: C:\Program Files\Java\jdk1.8.0_121\jre\bin\java.exe
# VM options: -javaagent:D:\Program Files\JetBrains\IntelliJ IDEA 2019.3.1\lib\idea_rt.jar=54465:D:\Program Files\JetBrains\IntelliJ IDEA 2019.3.1\bin -Dfile.encoding=UTF-8
# Warmup: 5 iterations, 100 ms each
# Measurement: 5 iterations, 100 ms each
# Timeout: 10 min per iteration
# Threads: 1 thread, will synchronize iterations
# Benchmark mode: Throughput, ops/time
# Benchmark: com.example.jmh.samples.JMHSample_20_Annotations.measure

# Run progress: 0.00% complete, ETA 00:00:01
# Fork: 1 of 1
# Warmup Iteration   1: 8.599 ops/us
# Warmup Iteration   2: 19.260 ops/us
# Warmup Iteration   3: 20.847 ops/us
# Warmup Iteration   4: 12.648 ops/us
# Warmup Iteration   5: 16.049 ops/us
Iteration   1: 7.854 ops/us
Iteration   2: 12.976 ops/us
Iteration   3: 21.232 ops/us
Iteration   4: 21.293 ops/us
Iteration   5: 21.414 ops/us


Result "com.example.jmh.samples.JMHSample_20_Annotations.measure":
  16.954 ±(99.9%) 24.021 ops/us [Average]
  (min, avg, max) = (7.854, 16.954, 21.414), stdev = 6.238
  CI (99.9%): [≈ 0, 40.975] (assumes normal distribution)


# Run complete. Total time: 00:00:03

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
JMHSample_20_Annotations.measure  thrpt    5  16.954 ± 24.021  ops/us

---

总结

通过jmh基准测试可以避免预热、编译、系统优化造成的测试不精确问题。