Java大师成长计划之第14天：使用JMH进行Java代码性能基准测试-CSDN博客

本文链接：https://blog.csdn.net/weixin_42132035/article/details/147460312

📢 友情提示：

本文由银河易创AI（https://ai.eaigx.com）平台gpt-4o-mini模型辅助创作完成，旨在提供灵感参考与技术分享，文中关键数据、代码与结论建议通过官方渠道验证。

在软件开发过程中，性能优化是一个不可忽视的重要环节。无论是处理大量数据的后台服务，还是高频率的请求响应，代码的执行效率直接影响到系统的整体性能。为了有效地测试和优化代码性能，使用基准测试（Benchmarking）工具来获取性能数据是必不可少的。而在 Java 生态中，Java Microbenchmark Harness（JMH）是专门为此目的而设计的工具。本文将深入介绍 JMH 的基本概念、使用方法以及如何进行性能基准测试。

一、什么是 JMH

Java Microbenchmark Harness（JMH）是由 Oracle 提供的一款用于在 Java 环境中进行微基准测试的框架。它专门设计用于帮助开发者准确测量 Java 代码片段的性能，特别是那些小型、短暂且可能受到即时编译器（Just-In-Time Compiler, JIT）优化影响的代码。JMH 旨在解决传统基准测试所面临的一些问题，如不一致的测量结果和难以控制的测试环境。

JMH 的设计充分考虑了 JVM 的特性，例如异常处理、内存管理以及编译优化等。使用 JMH，开发者既可以执行简单的性能测试，也可以应对复杂的场景，包括多线程和并发执行。JMH 把基准测试的过程进行了封装，从而使得开发者可以关注性能测试本身，而不必担心底层实现的细节。

1.1 JMH 的核心概念

JMH 的核心构建模块包括：

Benchmark：标记需要执行基准测试的方法。基准测试方法的实现将被执行多次，以获得精确的性能数据。
State：定义测试状态的类，可以设置测试的上下文。例如，可以在 @State 注解中定义 Scope（例如线程、类或方法）来共享数据。
Setup 和 TearDown：在基准测试之前和之后执行的初始化和清理操作，使用 @Setup 和 @TearDown 注解进行标识，确保测试数据的准备和资源的释放。
Options：配置基准测试的参数，例如测试的迭代次数、时间单位、并发级别等。

总之，JMH 提供了一个易用的 API 和丰富的配置选项，使得开发人员能够高效地进行 Java 代码性能基准测试。

二、为什么使用 JMH

在软件开发中，进行准确的性能基准测试是至关重要的。选择 JMH 进行基准测试的原因主要有以下几点：

2.1 准确性

JMH 通过多次迭代和多种策略确保基准测试结果的准确性：

JIT 编译优化：JMH 充分运行代码，使得 JVM 热点代码能够得到 JIT 编译，从而间接排除了初始编译对性能的影响。
多轮测试：JMH 会在测试周期中进行多次测量，保证结果的可靠性和一致性。

2.2 处理复杂性

在 Java 环境中，基准测试的复杂性来源于多种因素，比如多线程以及 JVM 本身的优化能力等。JMH 通过内置的机制处理了这些复杂性：

线程安全：可以通过 @Fork 注解和 @State 标记来设置多个线程并行执行基准测试，精确地量化在并发环境下的处理性能。
热启动与冷启动：JMH 整合了热启动和冷启动的处理机制，使得开发者不必手动管理，在正式测试之前会自动进行了必要的预热。

2.3 丰富的报告功能

JMH 提供了详细的测试报告，包含了性能指标如吞吐量、响应时间、误差范围等各种数据。这些数据能够帮助开发人员更清晰地掌握代码的性能瓶颈，并制定相应的优化策略。

2.4 简单易用

JMH 的 API 设计简洁明了，开发者可以快速上手。只需要添加一些注解，就能够轻松地定义基准测试类和方法，极大降低了基准测试的学习曲线。

2.5 社区支持

JMH 拥有活跃的社区和广泛的应用，官方文档和社区资料非常丰富，这为开发者的学习和应用提供了良好的保障。无论是新手还是资深开发者，都能从中找到相关的解决方案和最佳实践。

2.6 适用于微服务架构

在微服务架构日益普及的情况下，性能保障越来越成为开发者关注的重点。JMH 能够帮助开发者分析小功能模块的性能，从而确保在分布式系统中各个服务都能高效、稳定地运行。

综上所述，使用 JMH 进行 Java 代码性能基准测试不仅可以确保测量的准确性，还能简化测试流程、提高开发效率。JMH 已经成为 Java 开发者在性能优化过程中的必须工具，为代码的高效执行打下了坚实的基础。

三、JMH的基本使用

Java Microbenchmark Harness (JMH) 提供了一个简单而强大的框架，使开发者能够快速创建和运行微基准测试。以下内容将详细介绍如何使用 JMH 进行性能基准测试，包括依赖管理、编写基准测试类、运行基准测试和分析结果。

3.1 引入 JMH 依赖

在开始之前，需要在项目中引入 JMH 的依赖。如果你的项目使用 Maven，在 pom.xml 文件中添加以下依赖：

<dependency>
    <groupId>org.openjdk.jmh</groupId>
    <artifactId>jmh-core</artifactId>
    <version>1.34</version>
</dependency>
<dependency>
    <groupId>org.openjdk.jmh</groupId>
    <artifactId>jmh-generator-annprocess</artifactId>
    <version>1.34</version>
</dependency>

对于使用 Gradle 的项目，在 build.gradle 文件中添加如下依赖：

dependencies {
    implementation 'org.openjdk.jmh:jmh-core:1.34'
    annotationProcessor 'org.openjdk.jmh:jmh-generator-annprocess:1.34'
}

添加完依赖后，确保你更新了项目，以下载 JMH 所需的库。

3.2 编写基准测试类

在 JMH 中，基准测试类的构建主要依赖注解来处理测试的各种方面。我们将逐步创建一个简单的基准测试类。

3.2.1 创建基准测试类

首先，创建一个新的 Java 类，在类中定义要基准测试的方法，并使用 @Benchmark 注解标记它。以下是一个示例代码，基准测试一个简单的求和方法：

import org.openjdk.jmh.annotations.*;

import java.util.concurrent.TimeUnit;

@State(Scope.Thread)  // 定义测试状态，将其范围设置为线程
public class MyBenchmark {

    @Param({"100", "1000", "10000"})  // 使用不同参数进行测试
    private int size;

    private int[] array;

    @Setup(Level.Trial)  // 在每次试验开始时进行初始化
    public void setUp() {
        array = new int[size];  // 根据参数大小初始化数组
        for (int i = 0; i < size; i++) {
            array[i] = i;  // 填充数组
        }
    }

    @Benchmark  // 标记为基准测试方法
    @OutputTimeUnit(TimeUnit.MILLISECONDS)  // 输出时间单位
    public long sum() {
        long sum = 0;
        for (int i : array) {
            sum += i;  // 求和操作
        }
        return sum;
    }
}

3.2.2 代码详解

@State(Scope.Thread)：用于定义基准测试的状态，表示这个类的实例是在每个线程中共享的。适当的使用作用域可以减少开销，并优化性能。
@Param：允许我们用不同的参数值进行基准测试，支持多种配置场景。每次测试时，JMH 会自动为 size 字段分配不同的值。
@Setup(Level.Trial)：在每次试验开始之前，对资源进行初始化。在这里，对于每个试验，我们初始化一个数组。
@Benchmark：标记该方法为基准测试方法。JMH 将会多次调用这个方法以测量其性能。
@OutputTimeUnit(TimeUnit.MILLISECONDS)：配置输出结果中使用的时间单位。

3.3 运行基准测试

编写完基准测试类后，接下来需要创建一个主类来运行测试。通过主类中的 Options 配置进行控制和执行。

3.3.1 创建主类

创建一个名为 BenchmarkRunner 的类来运行你的基准测试：

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;

public class BenchmarkRunner {
    public static void main(String[] args) throws RunnerException {
        // 构建基准测试的选项
        Options options = new OptionsBuilder()
                .include(MyBenchmark.class.getSimpleName())  // 包括需要测试的基准类
                .forks(1)  // 试验过程中创建一个新的 JVM 实例
                .warmupIterations(2)  // 预热迭代次数
                .measurementIterations(5)  // 测量迭代次数
                .build();

        // 运行基准测试
        new Runner(options).run();
    }
}

3.3.2 代码详解

OptionsBuilder：使用 OptionsBuilder 来配置基准测试的参数。可以设置需要测试的类、预热和测量的迭代次数、是否需进行 Fork 等。
Forks：这参数指定了在基准测试执行期间实例化新 JVM 的数量。Forking 允许各自的基准测试环境独立运行，避免 JVM 的影响。
WarmupIterations：预热迭代允许 JVM 在正式测试之前预热代码，使其状态更稳定。
MeasurementIterations：正式测量迭代的数量，以获取更准确的性能数据。

3.4 基准测试报告

一旦运行了基准测试，JMH 会输出详细的测试结果，包括执行时间、吞吐量等。以下是一个典型的输出结果示例：

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

Benchmark                   Mode  Cnt    Score    Error  Units
MyBenchmark.sum            thrpt   10  2048.000 ± 10.000  ops/ms

3.4.1 结果解析

Benchmark：显示基准测试的名称。
Mode：表示测试模式，thrpt 代表吞吐量（即每秒处理的操作数）。
Cnt：表示测试执行的次数。
Score：表示测试结果的实际值，例如吞吐量（ops/ms）。
Error：表示在测量结果中产生的误差范围。
Units：表示结果的单位，例如操作每秒、毫秒等。

3.5 其他常用选项

3.5.1 测试模式

JMH 提供多种模式供选择，最常用的包括：

Throughput：每秒完成的操作数量。
AverageTime：每次操作的平均时间。
SampleTime：操作的样本时间。
SingleShotTime：单次操作的执行时间。

可以通过 mode 方法设置：

.options(mode(Mode.Throughput))

3.5.2 其他配置参数

时间单位：使用 @OutputTimeUnit(TimeUnit.SECONDS) 指定输出的时间单位。
参数化测试：使用 @Param 进行参数化测试，可以通过指定参数数组实现不同配置场景的性能测试。
条件测试：通过 @Setup 和 @TearDown 可以在测试前后做一些条件判断和资源清理。

使用 JMH 进行性能基准测试的过程是灵活且强大的。通过简单的注解，我们可以定义基准测试类，设置参数，通过主类运行并生成准确的测试报告。JMH 的准确性和易用性使其成为现代 Java 开发中的不可或缺的工具。掌握 JMH 的用法对于性能优化有很大的帮助，能够让开发者在不断变化的需求和高并发的环境中，始终保持代码的优良性能。继续学习 JMH 的其他高级特性，提升自己的性能调优技能，是每个 Java 大师成长道路上的重要一步。

四、基准测试的注意事项

在使用 JMH 进行性能基准测试时，有一些重要的注意事项需要牢记，以确保测试结果的准确性与可靠性。这些潜在的问题若未被妥善处理，可能会导致误导性的结果，从而在优化过程中做出不当的决策。以下是一些关键的注意事项：

4.1 预热和迭代

4.1.1 冷启动与热启动

在 Java 的运行机制中，JIT（即时编译）的优化有可能会在代码的首个执行中产生较大的开销。因此，使用 JMH 时，通常会在正式测试前进行预热，以便让 JVM 有机会对代码进行编译和优化。测试的预热阶段通常设置为几次迭代，这样可以帮助消除测试结果中因初始启动引起的不稳定性。

最好进行至少 2到 5 次的热启动迭代来确保基准测试的有效性。

4.1.2 迭代次数的配置

在设置测量迭代次数时，建议在有效的范围内进行设置，通常可设置为 5 至 10 次。过少的测量次数可能导致统计数据不稳定，而过多则会导致测试时间显著增加。

4.2 测试环境的一致性

4.2.1 运行环境

基准测试应该在尽可能一致的隔离环境中执行，以避免外部因素（如 CPU 和内存压力、其他进程的干扰）对测试结果的影响。最佳实践是在干净的机器上或虚拟环境中执行基准测试，不要与其他服务或大型应用程序共享运行环境。

4.2.2 资源占用

确保系统中没有高负载的后台进程在运行，因为它们可能会占用 CPU 和内存资源，从而影响结果。

4.3 外部依赖

4.3.1 数据库与网络

如果基准测试涉及到数据库操作或网络请求，应考虑这些外部依赖所带来的延迟与不稳定性。为了确保结果的准确性，可以考虑使用 Mock 对象或在本地数据库中预先填充数据，以排除外部因素的干扰。

4.3.2 配置参数

实验前应确保所有的测试参数都经过仔细配置，包括 JVM 参数的调整，确保在一个稳定的环境下运行。

4.4 结果解读

4.4.1 确认测量结果合理性

分析基准测试结果时，应评估是否符合预期。对结果的偏差与性能峰值进行理解，寻找可能的瓶颈，而不仅仅是追求更高的吞吐率。

4.4.2 多维度分析

有时单一的性能指标可能会造成片面性，因此建议结合多种性能度量，例如吞吐量、平均时间和错误率，全方位分析代码性能。

4.5 记录测试过程

记录下测试的所有配置、结果以及相应的上下文信息（如环境、数据集等），以便将来进行复现和对比。这不仅有助于跟踪性能变化，也能为后续分析提供参考。

小结

遵循上述注意事项有助于在JMH基准测试中获得更准确、可靠的结果，使得数据能够对代码的性能优化提供有效指导。

五、总结

在现代软件开发中，性能优化是一个不可或缺的重要环节。Java Microbenchmark Harness（JMH）为开发者提供了一个强大、易用的框架，用于精确测量 Java 代码的性能。本文详细介绍了 JMH 的基本概念、使用方法以及基准测试的注意事项。通过这些知识，开发者可以有效地进行性能分析与优化。