JMH Gradle 插件使用教程

1. 项目的目录结构及介绍

JMH Gradle 插件的目录结构如下：

jmh-gradle-plugin/
├── src/
│   ├── main/
│   │   ├── groovy/
│   │   ├── java/
│   │   ├── resources/
│   ├── test/
│   │   ├── groovy/
│   │   ├── java/
│   │   ├── resources/
├── build.gradle
├── settings.gradle

目录结构介绍

• src/main/groovy/ 和 src/main/java/：包含插件的主要代码。
• src/main/resources/：包含插件的资源文件。
• src/test/groovy/ 和 src/test/java/：包含插件的测试代码。
• src/test/resources/：包含插件的测试资源文件。
• build.gradle：Gradle 构建脚本，包含插件的依赖和任务配置。
• settings.gradle：Gradle 项目设置文件，包含项目名称和子项目配置。

2. 项目的启动文件介绍

JMH Gradle 插件的启动文件主要是 build.gradle 文件。以下是一个示例配置：

plugins {
    id 'me.champeau.jmh' version '0.6.5'
}

repositories {
    mavenCentral()
}

dependencies {
    jmh 'org.openjdk.jmh:jmh-core:1.33'
    jmh 'org.openjdk.jmh:jmh-generator-annprocess:1.33'
}

jmh {
    fork = 1
    iterations = 5
    warmupIterations = 5
}

启动文件介绍

• plugins 块：应用 JMH Gradle 插件。
• repositories 块：配置 Maven 中央仓库。
• dependencies 块：添加 JMH 核心库和注解处理器依赖。
• jmh 块：配置 JMH 运行参数，如 fork 次数、迭代次数和预热迭代次数。

3. 项目的配置文件介绍

JMH Gradle 插件的配置文件主要是 build.gradle 文件中的 jmh 块。以下是一个详细的配置示例：

jmh {
    includes = ['com.example.Benchmark.*']
    excludes = ['com.example.ExcludeBenchmark.*']
    benchmarkMode = ['Throughput', 'AverageTime']
    timeUnit = 'ms'
    fork = 2
    iterations = 10
    warmupIterations = 5
    warmup = '1s'
    timeOnIteration = '1s'
    resultFormat = 'CSV'
    profilers = ['gc']
    jvmArgs = ['-Xms2g', '-Xmx2g']
    humanOutputFile = project.file("${project.buildDir}/reports/jmh/human.txt")
    resultsFile = project.file("${project.buildDir}/reports/jmh/results.csv")
}

配置文件介绍

• includes 和 excludes：指定包含和排除的基准测试类。
• benchmarkMode：指定基准测试模式，如吞吐量和平均时间。
• timeUnit：指定时间单位。
• fork：指定 fork 次数。
• iterations 和 warmupIterations：指定迭代次数和预热迭代次数。
• warmup 和 timeOnIteration：指定预热时间和每次迭代时间。
• resultFormat：指定结果格式，如 CSV。
• profilers：指定使用的分析器，如 GC。
• jvmArgs：指定 JVM 参数。
• humanOutputFile 和 resultsFile：指定人类可读和结果文件的输出路径。

以上是 JMH Gradle 插件的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助。