Gradle 任务

JProfiler 支持通过专用的任务在 Gradle 中进行 profiling。此外，JProfiler 还提供了许多 用于处理快照的命令行可执行文件，它们都有对应的 Gradle 任务。

使用 Gradle 任务

要在 Gradle 构建文件中使用 JProfiler Gradle 任务，可以使用 plugins 块

plugins {
    id 'com.jprofiler' version 'X.Y.Z'
}

如果您不想为此使用 Gradle 插件仓库，Gradle 插件也可在文件 bin/gradle.jar 中找到。

默认情况下，该插件会自动预配与插件版本相同的 JProfiler 发行版，并将其保存在 <Gradle user home>/jprofiler/dist 下。要覆盖缓存目录，请在 jprofiler 块中设置 autoProvisioningCacheDir 属性。

如果您想改用本地 JProfiler 安装，请告知 JProfiler Gradle 插件 JProfiler 的安装位置。在 macOS 上，安装目录为应用程序包的路径，例如 /Applications/JProfiler.app。

jprofiler {
    installDir = file('/path/to/jprofiler/home')
}

从 Gradle 进行 Profiling

通过类型为 com.jprofiler.gradle.JavaProfile 的任务，您可以 profile 任何 Java 进程。该类继承自 Gradle 内置的 JavaExec，因此您可以使用相同的参数来配置进程。要对测试进行 profiling，请使用继承自 Gradle Test 任务的 com.jprofiler.gradle.TestProfile 类型的任务。

在没有任何进一步配置的情况下，这两个任务都会启动一个交互式 profiling 会话 (session)，其中 profiling agent 会在默认端口 8849 上等待来自 JProfiler GUI 的连接。对于离线 profiling，您可以引用导出的配置文件，也可以直接使用下表中所示的属性来配置通用会话设置 (session settings) 和自动记录。

下面给出了一个用于 profile 由所在项目编译且带有 main 方法的 Java 类的示例：

task run(type: com.jprofiler.gradle.JavaProfile) {
    mainClass = 'com.mycorp.MyMainClass'
    classpath sourceSets.main.runtimeClasspath
    offline = true
    callTreeMode = 'sampling'
    profile = ['com.mycorp.', 'org.example.']
    snapshotFile = file('build/snapshots/run.jps')
    recording = ['cpu', 'allocation', 'jdbc']
    duration = '10m'
}

对于无配置属性未涵盖的高级设置，请导出配置文件并使用 configFile 和 sessionId 进行引用。

task run(type: com.jprofiler.gradle.JavaProfile) {
    mainClass = 'com.mycorp.MyMainClass'
    classpath sourceSets.main.runtimeClasspath
    offline = true
    sessionId = 80
    configFile = file('path/to/jprofiler_config.xml')
}

您可以在 api/samples/offline 示例项目中查看此任务的可运行示例。与标准的 JavaExec 任务不同，JavaProfile 任务还可以通过在其上调用 createProcess() 在后台启动。有关此功能的演示，请参见 api/samples/mbean 示例项目。

如果您需要 profiling 所需的 VM 参数，com.jprofiler.gradle.SetAgentpathProperty 任务会将其分配给通过 propertyName 属性配置名称的属性。应用 JProfiler 插件会自动向您的项目添加一个名为 setAgentPathProperty 的此类任务。要获取前一个示例中使用的 VM 参数，您只需添加

setAgentPathProperty {
    propertyName = 'profilingVmParameter'
    offline = true
    callTreeMode = 'sampling'
    profile = ['com.mycorp.', 'org.example.']
}

到您的项目中，并为其他任务添加对 setAgentPathProperty 的依赖。然后，您可以在该任务的执行阶段使用项目属性 profilingVmParameter。将该属性赋值给其他任务属性时，请将其使用包裹在 doFirst {...} 代码块中，以确保您处于 Gradle 执行阶段而不是配置阶段。

从快照导出数据

com.jprofiler.gradle.Export 任务可用于从已保存的快照中导出视图 (view)，并复刻了 bin/jpexport 命令行工具 的参数。它支持以下属性：

在导出任务中，调用 views 方法并向其传递一个闭包，在闭包中可以一次或多次调用 view(name, file[, options])。每次调用 view 都会生成一个输出文件。name 参数为视图 (view) 名称。有关可用视图 (view) 名称的列表，请参见 jpexport 命令行可执行文件 的帮助页面。参数 file 为输出文件，可以是绝对路径文件，也可以是相对于项目的相对路径文件。最后，可选的 options 参数是一个包含所选视图 (view) 导出选项的 Map。

使用导出任务的示例如下：

task export(type: com.jprofiler.gradle.Export) {
    snapshotFile = file('snapshot.jps')
    views {
        view('CallTree', 'callTree.html')
        view('HotSpots', 'hotSpots.html',
            [threadStatus: 'all', expandBacktraces: 'true'])
    }
}

比较快照

与 bin/jpcompare 命令行工具 一样，com.jprofiler.gradle.Compare 任务可以比较两个或多个快照。其属性如下：

正如为 Export 任务定义导出的视图 (view) 一样，Compare 任务有一个 comparisons 方法，其中对 comparison(name, file[, options]) 的嵌套调用定义了应执行的比较。可用比较名称的列表可在 jpcompare 命令行可执行文件 的帮助页面中找到。

使用比较任务的示例如下：

task compare(type: com.jprofiler.gradle.Compare) {
    snapshotFiles = files('snapshot1.jps', 'snapshot2.jps')
    comparisons {
        comparison('CallTree', 'callTree.html')
        comparison('HotSpots', 'hotSpots.csv',
            [valueSummation: 'total', format: 'csv'])
    }
}

或者，如果您想要为多个快照创建遥测 (telemetry) 比较：

task compare(type: com.jprofiler.gradle.Compare) {
    snapshotFiles = fileTree(dir: 'snapshots', include: '*.jps')
    sortByTime = true
    comparisons {
        comparison('TelemetryHeap', 'heap.html', [valueType: 'maximum'])
        comparison('ProbeTelemetry', 'jdbc.html', [probeId: 'JdbcProbe'])
    }
}

分析堆快照

Gradle 任务 com.jprofiler.gradle.Analyze 具有与 bin/jpanalyze 命令行工具 相同的功能。

该任务具有类似于 Compare 任务的 snapshotFiles 属性以指定要处理的快照，以及类似于 Export 任务的 obfuscator 和 mappingFile 属性用于反混淆。属性 removeUnreferenced、retainSoft、retainWeak、retainPhantom、retainFinalizer 和 retained 对应于该命令行工具的参数。

下面给出了使用 Analyze 任务的示例：

task analyze(type: com.jprofiler.gradle.Analyze) {
    snapshotFiles = fileTree(dir: 'snapshots', include: '*.jps')
    retainWeak = true
    obfuscator = 'proguard'
    mappingFile = file('obfuscation.txt')
}