Gradle 任务

JProfiler 支持通过 Gradle 的特殊任务进行分析 (profiling)。此外，JProfiler 还提供了一些 用于处理快照 (snapshot) 的命令行可执行文件 (command line executables) ，这些可执行文件也有对应的 Gradle 任务。

使用 Gradle 任务

要在 Gradle 构建文件中使用 JProfiler 的 Gradle 任务，可以在 plugins 块中添加如下内容

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

如果你不想通过 Gradle 插件仓库获取插件，JProfiler 插件也包含在 bin/gradle.jar 文件中。

接下来，你需要告诉 JProfiler Gradle 插件 JProfiler 的安装路径。

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

通过 Gradle 进行分析 (Profiling)

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

如果不做额外配置，这两个任务都会启动一个交互式分析会话 (profiling session)，分析代理 (agent) 会在默认端口 8849 等待 JProfiler GUI 的连接。对于离线分析 (offline profiling)，你需要添加下表中展示的一些属性。

下面是一个分析包含 main 方法的 Java 类（由当前项目编译）的示例：

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 
    sessionId = 80 
    configFile = file('path/to/jprofiler_config.xml') 
} 

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

从快照导出数据

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

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

使用 export 任务的示例：

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 命令行工具 (command line tool) 类似， com.jprofiler.gradle.Compare 任务可用于比较两个或多个快照 (snapshot)。 其属性如下：

与 Export 任务中定义导出视图类似，Compare 任务有一个 comparisons 方法，可以通过嵌套调用 comparison(name, file[, options]) 来定义需要执行的比较。可用比较名称列表请参见 jpcompare 命令行可执行文件 (command line executable) 的帮助页面。

使用 compare 任务的示例：

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']) 
    } 
} 

分析堆快照 (heap snapshots)

gradle 任务 com.jprofiler.gradle.Analyze 具有与 bin/jpanalyze 命令行工具 (command line tool) 相同的功能。

该任务有一个 snapshotFiles 属性（与 Compare 任务一样）用于指定要处理的快照，以及 obfuscator 和 mappingfile 属性（与 Export 任务一样）用于反混淆。此外，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') 
}