Apache Tomcat迁移工具技术文档

Apache Tomcat迁移工具技术文档

tomcat-jakartaee-migration Apache Tomcat migration tool for Jakarta EE 项目地址: https://gitcode.com/gh_mirrors/to/tomcat-jakartaee-migration

概述

Apache Tomcat迁移工具旨在将基于Java EE 8编写的Web应用程序自动转换为可以在实现Jakarta EE 9的Apache Tomcat 10上运行的应用程序。该工具可以通过命令行或作为Ant任务使用。

安装指南

下载

从以下地址下载源码或二进制分发包：

https://tomcat.apache.org/download-migration.cgi

构建

通过以下命令从源码构建迁移工具：

./mvnw verify

构建完成后，您将获得一个可执行的JAR文件，通常位于target/jakartaee-migration-*-shaded.jar。

项目安装方式

命令行使用

通过以下命令运行迁移工具：

java -jar jakartaee-migration-*-shaded.jar <source> <destination>

其中，<source>是源文件或目录的路径，<destination>是目标文件或目录的路径。源可以是压缩包、文件夹或单个文件，目标将根据源的类型创建。

Ant任务使用

迁移工具也可以作为Ant任务使用。以下是一个示例：

<taskdef name="javax2jakarta" classname="org.apache.tomcat.jakartaee.MigrationTask" classpath="jakartaee-migration-*-shaded.jar"/>

<javax2jakarta src="webapp.war" dest="webapp.migrated.war" profile="tomcat"/>

项目的使用说明

迁移过程

迁移工具将自动将Java EE 8的javax.*命名空间中的包重命名为Jakarta EE 9的jakarta.*命名空间。这包括类中的包引用、字符串常量、配置文件、JSP、TLD等。

注意事项

• 该工具会移除JAR文件中的加密签名，因为更改后的资源将不再匹配这些签名。
• 对于每个被移除签名的JAR文件，工具将记录一条警告。

项目API使用文档

主要API

• org.apache.tomcat.jakartaee.MigrationTask: 用于在Ant中定义迁移任务的类。
• org.apache.tomcat.jakartaee.Migration: 核心迁移类，负责执行实际的迁移操作。

使用示例

在Ant构建文件中定义迁移任务：

<taskdef name="javax2jakarta" classname="org.apache.tomcat.jakartaee.MigrationTask" classpath="jakartaee-migration-*-shaded.jar"/>

<javax2jakarta src="webapp.war" dest="webapp.migrated.war" profile="tomcat"/>

参数说明

• src: 源文件或目录的路径。
• dest: 目标文件或目录的路径。
• profile: 迁移配置文件，通常为tomcat。

法律声明

该工具会修改Web应用程序的内容，包括第三方提供的内容。强烈建议您确认与任何第三方内容相关的许可证是否允许此类修改，尤其是在您打算分发结果的情况下。

tomcat-jakartaee-migration Apache Tomcat migration tool for Jakarta EE 项目地址: https://gitcode.com/gh_mirrors/to/tomcat-jakartaee-migration