Gradle 任务

JProfiler 支持通过 Gradle 使用特殊任务进行分析。此外，JProfiler 还提供了许多 用于处理快照的命令行可执行文件， 这些文件都有对应的 Gradle 任务。

使用 Gradle 任务

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

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

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

接下来，需要告知 JProfiler Gradle 插件 JProfiler 的安装位置。

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

从 Gradle 进行分析

使用类型为 com.jprofiler.gradle.JavaProfile 的任务，可以分析任何 Java 进程。 该类继承自 Gradle 内置的 JavaExec，因此可以使用相同的参数来配置进程。 对于测试分析，请使用类型为 com.jprofiler.gradle.TestProfile 的任务， 它继承自 Gradle 的 Test 任务。

在没有任何额外配置的情况下，两个任务都会启动一个交互式分析会话（session）， 分析代理（agent）在默认端口 8849 上等待来自 JProfiler GUI 的连接。 对于离线分析，可以引用导出的配置文件，或者直接使用下表中所示的属性配置常用 session 设置和自动化记录。

以下是一个分析包含 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 示例项目以了解此功能的演示。

如果需要分析所需的 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')
}