本指南适用于希望使用 Migration Toolkit for Runtimes (MTR) 迁移 Java 应用程序或其他组件的工程师、顾问和其他组件。它介绍了如何安装和运行 CLI，查看生成的报告，并利用附加功能。

什么是 Migration Toolkit for Runtimes?

Migration Toolkit for Runtimes (MTR) 是一个可扩展、可自定义的基于规则的工具，简化了 Java 应用程序的迁移和现代化。

MTR 检查应用程序工件，包括项目源目录和应用程序存档，然后生成 HTML 报告突出显示需要更改的区域。MTR 支持许多迁移路径，包括以下示例：

有关用例和迁移路径的更多信息，请参阅开发人员网页的 MTR。

Migration Toolkit for Runtimes 如何简化迁移？

Migration Toolkit for Runtimes 会查找常见资源和在迁移应用程序时的已知问题。它为应用程序使用的技术提供了高级视图。

MTR 生成详细的报告，评估迁移或现代化路径。此报告可帮助您估算大型项目所需的工作量，并减少涉及的工作。

如何了解更多信息？

请参阅 Migration Toolkit for Runtimes 简介，了解有关 Migration Toolkit for Runtimes 中的功能、支持的配置、系统要求以及可用工具的更多信息。

CLI 是 Migration Toolkit for Runtimes 的 Migration Toolkit for Applications 中的命令行工具，允许用户对应用程序的迁移和现代化工作进行评估和优先级。它提供了大量报告，突出显示分析而不用其他工具的开销。CLI 包括广泛的自定义选项，允许您微调 MTR 分析选项或与外部自动化工具集成。

您可以在 Linux、Windows 或 macOS 操作系统上安装 CLI。

您可以针对您的应用程序运行 MTR。

$ <MTR_HOME>/bin/windup-cli \
    --input /path/to/jee-example-app-1.0.0.ear \
    --output /path/to/report-output/ --source eap:5 --target eap:7 \
    --packages com.acme org.apache

$ <MTR_HOME>/bin/windup-cli --sourceMode --input /path/to/seam-booking-5.2/ \
    --output /path/to/report-output/ --target eap:6 --packages org.jboss.seam

$ <MTR_HOME>/bin/windup-cli --input /path/to/jee-example-app-1.0.0.ear \
    --output /path/to/report-output/ \
    --target eap:7 --target cloud-readiness --packages com.acme org.apache

$ <MTR_HOME>/bin/windup-cli -Dwindup.decompiler=procyon \
    --input <INPUT_ARCHIVE_OR_DIRECTORY> --output <OUTPUT_REPORT_DIRECTORY> \
    --target <TARGET_TECHNOLOGY> --packages <PACKAGE_1> <PACKAGE_2>

$ <MTR_HOME>/bin/windup-cli [TAB]

$ source <MTR_HOME>/bash-completion/windup-cli

$ <MTR_HOME>/bin/windup-cli --help

当您运行 Migration Toolkit for Runtimes 时，会在您在命令行中使用 --output 参数指定的 <OUTPUT_REPORT_DIRECTORY> 中生成报告。

输出目录包含以下文件和子目录：

<OUTPUT_REPORT_DIRECTORY>/
├── index.html          // Landing page for the report
├── <EXPORT_FILE>.csv   // Optional export of data in CSV format
├── archives/           // Archives extracted from the application
├── mavenized/          // Optional Maven project structure
├── reports/            // Generated HTML reports
├── stats/              // Performance statistics

单击 Technologies 链接，从报告登录页面访问此报告。

此报告提供了分析的应用程序所使用的技术的聚合列表，按功能分组。它展示了技术分布方式，通常在分析大量应用程序以对应用程序进行分组并确定模式后，通常会审查技术。它还显示每个应用程序的大小、库数和故事点数。

点击任意标头（如 Markup ）以降序排列结果。再次选择同一标头将按顺序选择结果。当前选定的标头以粗体显示，方向箭头旁边表示排序的方向。

图 3.12. 跨多个应用程序使用的技术

点 Dependencies Graph 链接从报告登录页面访问此报告。

它包含所有 WAR 和 JAR 的列表，以及在每个所含文件之间建立关系。图中的每个圆圈代表应用程序中定义的唯一依赖项。如果某个文件作为依赖项包含在多个应用程序中，它们会在图表中链接。

在以下镜像中，我们可以看到两个不同的组。在左侧的一半中，我们看到一个 WAR，它定义了多个 JAR 作为依赖项。右半我们看到多个 WAR 使用的相同依赖关系，其中一个是选定的 overlord-commons-auth-2.0.11.Final.jar 之一。

图 3.13. 跨多个应用程序的依赖关系图

可使用以下任一方式调整依赖项图。

点击 由多个应用程序链接共享的 归档，从报告登录页面访问这些报告。请注意，只有在有适用的共享存档时，此链接才可用。

图 3.14. 多个应用程序共享的存档

这可让您查看在多个应用程序间共享的所有存档的详细报告。

点 规则提供程序执行概述 链接，从报告登录页面访问此报告。

该报告提供了针对应用程序运行 MTR 迁移命令时运行的规则列表。

图 3.15. 规则提供程序执行概述

点 FreeMarker 方法 链接，从报告登录页面访问此报告。

此报告列出了用于构建报告的所有注册函数和指令。它可用于调试目的，或者计划构建自己的自定义报告。

图 3.16. 使用的 FreeMarker 功能和指令

点 Send feedback 链接，从报告登录页面访问此反馈表单。

通过此表单，您可以对产品进行评级，讨论您需要的内容，并提出改进建议。

图 3.17. 发送反馈表

要将报告导出为 CSV 文件，请使用 --exportCSV 参数运行 MTR。在由分析的每个应用程序的 --output 参数指定的目录中创建一个 CSV 文件。

所有发现的问题（跨越所有分析的应用程序）都包含在导出至报告根目录下的 AllIssues.csv 文件中。

从应用程序报告访问报告

如果您导出了 CSV 报告，您可以在问题报告中下载所有 CSV 问题。要下载这些问题，请点问题报告中的 Download All issues CSV。

图 4.1. CSV 下载的问题报告

CSV 格式化输出文件包含以下数据字段：

您可以通过在执行 MTR 时传递 --mavenize 标志来为所提供的应用程序生成 Maven 项目结构。

以下示例使用 jee-example-app-1.0.0.ear 测试应用程序运行 MTR：

$ <MTR_HOME>/bin/windup-cli --input /path/to/jee-example-app-1.0.0.ear --output /path/to/output --target eap:6 --packages com.acme org.apache --mavenize

这会在 /path/to/output/mavenized 目录中生成 Maven 项目结构。

您还可以使用 --mavenizeGroupId 选项指定用于 POM 文件的 <groupId>。如果未指定，则 MTR 将尝试识别适合应用程序的 <groupId>，或者将默认设置为 com.mycompany.mavenized。

The /path/to/output/mavenized/<APPLICATION_NAME>/ 目录包括以下内容：

示例 jee-example-app-1.0.0.ear 应用是包含 WAR 和多个 JAR 的 EAR 存档。每个工件都创建一个单独的目录。以下是为此应用程序创建的 Maven 项目结构。

/path/to/output/mavenized/jee-example-app/
    jee-example-app-bom/pom.xml
    jee-example-app-ear/pom.xml
    jee-example-services2-jar/pom.xml
    jee-example-services-jar/pom.xml
    jee-example-web-war/pom.xml
    pom.xml

检查每个生成的文件，并根据您的项目自定义。要了解更多有关 Maven POM 文件的信息，请参阅 Apache Maven 文档中的 POM 部分介绍。

root POM 文件

jee-example-app-1.0.0.ear 应用程序的 root POM 文件可在 /path/to/output/mavenized/jee-example-app/pom.xml 中找到。此文件标识了所有项目模块的目录。

以下模块列在示例 jee-example-app-1.0.0.ear 应用程序的 root POM 中。

<modules>
  <module>jee-example-app-bom</module>
  <module>jee-example-services2-jar</module>
  <module>jee-example-services-jar</module>
  <module>jee-example-web-war</module>
  <module>jee-example-app-ear</module>
</modules>

root POM 也被配置为使用 Red Hat JBoss Enterprise Application Platform Maven 存储库下载项目依赖项。

BOM 文件

在目录中生成的 Bill of Materials (BOM) 文件以 -bom 结尾。对于示例应用程序 jee-example-app-1.0.0.ear，可在 /path/to/output/mavenized/jee-example-app/jee-example-app/jee-example-app-bom/pom/pom.xml 中找到 BOM 文件。此 BOM 的目的是，项目使用的第三方依赖项的版本可以在一个位置定义。有关使用 BOM 的更多信息，请参阅 Apache Maven 文档中的 依赖关系机制简介 部分。

以下依赖项列在 jee-example-app-1.0.0.ear 应用程序的 BOM 中

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>log4j</groupId>
      <artifactId>log4j</artifactId>
      <version>1.2.6</version>
    </dependency>
    <dependency>
      <groupId>commons-lang</groupId>
      <artifactId>commons-lang</artifactId>
      <version>2.5</version>
    </dependency>
  </dependencies>
</dependencyManagement>

应用程序 POM 文件

每个可以 mavenized 的应用程序模块都有一个单独的目录，其中包含其 POM 文件。目录名称包含存档的名称，以 -jar、-war 或 -ear 后缀（根据归档类型）结束。

每个应用程序 POM 文件都会列出该模块的依赖项，包括：

例如，jee-example-app-1.0.0.ear EAR、/path/to/output/mavenized/jee-example-app/jee-example-app-ear/pom.xml 的 POM 文件，列出下列依赖项。

<dependencies>
  <dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.6</version>
  </dependency>
  <dependency>
    <groupId>org.jboss.seam</groupId>
    <artifactId>jee-example-web-war</artifactId>
    <version>1.0</version>
    <type>war</type>
  </dependency>
  <dependency>
    <groupId>org.jboss.seam</groupId>
    <artifactId>jee-example-services-jar</artifactId>
    <version>1.0</version>
  </dependency>
  <dependency>
    <groupId>org.jboss.seam</groupId>
    <artifactId>jee-example-services2-jar</artifactId>
    <version>1.0</version>
  </dependency>
</dependencies>

在升级硬件前首先尝试这些建议。

如果上述应用程序和命令行建议无法提高性能，您可能需要升级硬件。