使用 CLI 配置 IRX 文件生成

• 配置文件用法
• 配置文件模板和设置
• 目标包含和排除行为
• 配置文件示例

配置文件用法

无论何时发出 appscan prepare (Windows™) 或 appscan.sh prepare （Linux™ 和 macOS） 命令来生成 IRX 文件，Static Analyzer Command Line Utility 都将自动检查当前目录中是否存在 appscan-config.xml 文件。如果找到该文件，则将自动使用该文件。

如果您在其他目录中有配置文件，或配置文件具有不同的文件名，则可通过在发出 appscan prepare 或 appscan.sh prepare 命令时包含 -c 选项来使用该文件。在这种情况下，在 appscan 上发出 appscan prepare -c <configuration_file>，或在 (Windows™) 上发出 appscan.sh prepare -c <configuration_file>，其中 <configuration_file> 是配置文件的完整路径和文件名。

配置文件模板和设置

准备配置文件时，请使用以下模板：

<Configuration attributes="true/false">
  <Targets>
    <Target outputs-only="true/false" path="scan_target_path">
      <CustomBuildInfo build_info="info"/>
      <Include>string_pattern</Include>
      <Exclude>string_pattern</Exclude>
    </Target>
  </Targets>
</Configuration>

使用 Targets 元素指示在生成 IRX 文件时要扫描的目标。目标 (Target) 属性及子元素的用法如下：

• 仅当您要扫描目录并强制 Command Line Utility 仅查找构建输出文件（例如，.jar、.war 和 .class 文件）时使用 Target 元素 outputs-only 属性。缺省情况下，将此属性设置为 false。这意味着 Command Line Utility 将搜索目录以确定该目录是否为目标（例如，应用程序服务器），或者该目录是否包含构建脚本、Maven .pom 文件和 make 文件等项。如果要将扫描目标视为简单目录，并且只查找输出文件，请在 Target 元素中指定 outputs-only="true"。

  例如，如果指定 <Target outputs-only="false" path="C:\Tomcat">，则 Command Line Utility 假定目标是 Tomcat 应用程序服务器，并搜索其部署的 .war 文件。但是，如果指定 <Target outputs-only="true" path="C:\Tomcat">，则 Command Line Utility 会将该位置视为目录，并在其中查找所有构建输出文件。

• 使用 Target 元素 path 属性指定扫描目标或扫描目标目录的路径 (<scan_target_path>)。指定目录时，在扫描期间将包含其所有子目录。

  例如，如果指定 <Target outputs-only="false" path="C:\WebSphere\AppServer85\profiles\AppSrv01">，则 Command Line Utility 会在 AppSrv01 配置文件中查找所有已部署的 .ear 文件。如果指定 <Target outputs-only="false" path="C:\WebSphere\AppServer85">，Command Line Utility 会在所有配置文件中查找所有已部署的 .ear 文件。

• 还可以指定这些可选的 Target 子元素：
  • 可以使用 CustomBuildInfo 元素来设置属性。通过使用这部分模板，

    
    <CustomBuildInfo build_info="info"/>

    可根据目标语言来指定构建信息。对于某些语言，可设置多个属性，例如可根据目标语言设置 <CustomBuildInfo build_info_1="info_1" build_info_2="info_2" build_info_3="info_3"/>。
    • 对于 Java，可设置以下属性：

      <CustomBuildInfo additional_classpath="dependency_path"
        jdk_path="JDK_path" jsp_compiler="JSP_compiler_path" package_includes="namespaces" package_excludes="namespaces"/>

      • 使用 additional_classpath 属性指定更多类路径。在 Windows™ 上，使用分号分隔多个类路径。在 Linux™ 和 macOS 上，使用冒号分隔多个类路径。
      • 使用 jdk_path 属性指定 JDK 安装的路径。
      • 使用 jsp_compiler 属性指定 JSP 编译器的路径，例如：

        jsp_compiler="C:\Tomcat"

        jsp_compiler="C:\Program Files (x86)\IBM\WebSphere\AppServer"

        jsp_compiler="C:\Oracle"

      • 使用 package_includes 属性覆盖现有的第三方排除项，并仅扫描来自给定名称空间的那些类。使用分号分隔名称空间列表。例如：

        package_includes="com.hcl.example;com.hcl.sample"

      • 使用 package_excludes 属性将指定的名称空间追加到现有第三方排除项列表。使用分号分隔名称空间列表。
      • 使用 <CustomBuildInfo> 标记中的 irx_minor_cache_home 属性来设置 Java 并行处理高速缓存位置。该值应该指向用于高速缓存的位置。例如：

        <CustomBuildInfo irx_minor_cache_home="X:/mycache"/>

    • 对于提供的 Tomcat 下的 JSP，可以设置以下属性：

      <CustomBuildInfo jsp_compiler_args="-ARGUMENTS"/>

      • 使用 jsp_compiler_args 属性指定 JSP 编译器命令行参数以设置或覆盖 JSP 编译器。
    • 对于 .NET（仅 Windows），可设置以下属性：

      <CustomBuildInfo references="assembly_references"
        configuration="build_configuration"/>

      • 使用 references 属性添加组合件引用。用分号分隔多个引用。
      • 使用 configuration 属性可包含 Visual Studio 解决方案发现的构建配置。
      • 使用 package_includes 属性覆盖现有的第三方排除项，并仅扫描来自给定名称空间的那些类。使用分号分隔名称空间列表。例如：

        package_includes="com.hcl.example;com.hcl.sample"

      • 使用 package_excludes 属性将指定的名称空间追加到现有第三方排除项列表。使用分号分隔名称空间列表。
    • 对于 C/C++（仅 Windows），可设置以下属性：

      <CustomBuildInfo configuration="build_configuration"
        include_paths="include_directories" macros="macros" compiler_opts=/>

      • 使用 configuration 属性可包含构建配置。
      • 使用 include_paths 属性指定包含路径。用分号分隔多个包含路径。
      • 使用 macros 属性包含宏。用分号分隔多个宏。
      • 使用 compiler_opts 属性指定编译器选项。用分号分隔多个选项。
  注： 通过这些属性设置的值将由子目标继承。例如，如果目标是 EAR 文件，其中包含 WAR 和 JAR 子目标，则会假定 WAR 和 JAR 具有为使用这些属性的 EAR 文件设置的相同值。
• 使用 Include 子元素可指定在生成 IRX 文件时要包含的文件模式 (<string_pattern>)。Include 行为取决于目标类型，如目标包含和排除行为部分中所概述。要指定多个 include 模式，请在其自己的 <Include></Include> 标记中添加每个模式。例如，

  <Include>string_pattern_1</Include>
  <Include>string_pattern_2</Include>

  注： 如果指定了冲突的 include 和 exclude 模式，则 exclude 模式优先。
• 使用 Exclude 子元素可指定生成 IRX 文件时要排除的文件模式。Exclude 行为取决于目标类型，如目标包含和排除行为部分中所概述。要指定多个 exclude 模式，请在其自己的 <Exclude></Exclude> 标记中添加每个模式。
  注： 如果指定了冲突的 include 和 exclude 模式，则 exclude 模式优先。

目标包含和排除行为

配置文件示例

<Configuration>
  <Targets>
    <Target path="C:\test\MyApplication.ear">
      <CustomBuildInfo additional_classpath="C:\java\lib;C:\java2\lib"
        jdk_path="C:\Program Files\Java\jdk1.7" jsp_compiler="C:\Tomcat"/>
      <Include>ShoppingCart.war</Include>
      <Include>*Account.jar</Include>
      <Exclude>thirdPartyJars/</Exclude>
      <Exclude>*test*</Exclude>
    </Target>
  </Targets>
</Configuration>