第 2 章 使用规则入门

1. 在 /home/<USER_NAME>/migration-rules/data/ 子目录中创建一个 jbossweb.xml 文件。

2. 复制以下内容。

   <!DOCTYPE jboss-web PUBLIC "-//JBoss//DTD Web Application 4.2//EN" "http://www.jboss.org/j2ee/dtd/jboss-web_4_2.dtd">
   <jboss-web>
       <class-loading java2ClassLoadingCompliance="false">
           <loader-repository>
               seam.jboss.org:loader=@projectName@
               <loader-repository-config>java2ParentDelegation=false</loader-repository-config>
           </loader-repository>
       </class-loading>
   </jboss-web>

   创建规则

流程

1. 在 /home/<USER_NAME>/migration-rules/rules/ 目录中，创建一个名为 JBoss5-web-class-loading.windup.xml 的文件，其中包含以下内容：

   <?xml version="1.0"?>
   <ruleset id="<UNIQUE_RULESET_ID>"
     xmlns="http://windup.jboss.org/schema/jboss-ruleset"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://windup.jboss.org/schema/jboss-ruleset http://windup.jboss.org/schema/jboss-ruleset/windup-jboss-ruleset.xsd">
     <metadata>
         <description>
             <!-- Ruleset Description -->
         </description>
         <dependencies>
             <!-- Ruleset Dependencies -->
         </dependencies>
         <sourceTechnology id="<SOURCE_ID>" versionRange="<SOURCE_VERSION_RANGE>"/>
         <targetTechnology id="<TARGET_ID>" versionRange="<TARGET_VERSION_RANGE>"/>
         <tag>Reviewed-2015-05-01</tag>
     </metadata>
     <rules>
         <rule id="<UNIQUE_RULE_ID>">
           <when>
               <!-- Test for a condition here -->
           </when>
           <perform>
               <!-- Perform an action -->
           </perform>
         </rule>
      </rules>
   </ruleset>

   注意

   XML 文件名必须包含 .windup.xml 扩展。否则，MTR 不会评估新规则。

2. 为 ruleset 和 rule 添加唯一标识符：

   • 将 <UNIQUE_RULESET_ID> 替换为适当的规则集 ID，如 JBoss5-web-class-loading。
   • 将 <UNIQUE_RULE_ID> 替换为适当的规则 ID，例如 JBoss5-web-class-loading_001。

3. 添加以下 ruleset 附加组件依赖项：

   <dependencies>
     <addon id="org.jboss.windup.rules,windup-rules-javaee,3.0.0.Final"/>
     <addon id="org.jboss.windup.rules,windup-rules-java,3.0.0.Final"/>
   </dependencies>

4. 添加源和目标技术：

   • 将 <SOURCE_ID> 替换为 eap。
   • 将 <TARGET_ID> 替换为 eap。

5. 设置源和目标技术版本。

   • 将 <SOURCE_VERSION_RANGE> 替换为 (4,5)。
   • 将 <TARGET_VERSION_RANGE> 替换为 (6,)。

   如需更多信息，请参阅 Apache Maven 版本范围规格。

6. 完成 when 条件。由于此规则测试在 XML 文件中的一个匹配项，因此 xmlfile 被用于评估文件。

   要在作为 jboss-web 的子 class-loading 项上匹配，请使用 xpath 表达式 jboss-web/class-loading。

   <when>
       <xmlfile matches="jboss-web/class-loading" />
   </when>

7. 为这个规则完成 perform 操作。

   • 添加带有描述性标题的分类，以及 1 的工作量级别。

   • 提供提示以及描述迁移详情的文档的链接。

     <perform>
         <iteration>
             <classification title="JBoss Web Application Descriptor" effort="1"/>
             <hint title="JBoss Web XML class-loading element is no longer valid">
               <message>
                 The class-loading element is no longer valid in the jboss-web.xml file.
               </message>
               <link href="https://access.redhat.com/documentation/zh-CN/JBoss_Enterprise_Application_Platform/6.4/html-single/Migration_Guide/index.html#Create_or_Modify_Files_That_Control_Class_Loading_in_JBoss_Enterprise_Application_Platform_6" title="Create or Modify Files That Control Class Loading in JBoss EAP 6"/>
             </hint>
         </iteration>
     </perform>

1. 在一个 web 浏览器打开 /home/<USER_NAME>/migration-rules/reports/index.html。

2. 验证规则是否已成功运行。

   1. 在主登录页面中，点 Rule providers execution overview 链接，以打开 Rule Providers Execution Overview。

   2. 找到 JBoss5-web-class-loading_001 规则，验证它的 Status? 是 Condition met，它的 Result? 是 success。

      图 2.1. 测试规则执行

      

3. 验证规则是否与测试数据匹配：

   1. 在主登录页面中，点应用程序或输入文件夹的名称，本例中为 data。
   2. 点 Application Details 报告链接。

   3. 点 jboss-web.xml 链接，以查看 Source 报告。

      您可以看到 <class-loading> 行已被突出显示，自定义规则中的 hint 会显示内联。

      图 2.2. 规则匹配

      

      文件顶部列出了匹配规则的分类。您可以使用链接图标查看该规则的详情。请注意在本示例中，jboss-web.xml 文件匹配另外一个规则 (JBoss web application descriptor (jboss-web.xml)) ，它生成的故事点为 1。此故事点和来自自定义规则的 1 个故事点将此文件的总故事点设置为 2。