使用 CLI 配置 IRX 檔案產生

• 配置檔用法
• 配置檔範本及設定
• 目標包括及排除行為
• 配置檔範例

配置檔用法

只要發出 appscan prepare (Windows™) 或 appscan.sh prepare （Linux™ 及 macOS） 指令以產生 IRX 檔案，Static Analyzer 指令行公用程式 就會自動檢查現行目錄中是否有 appscan-config.xml 檔。如果找到該檔案便會自動使用。

如果您的配置檔是在不同的目錄，或者檔案名稱不同，則可以在發出 appscan prepare 或 appscan.sh prepare 指令時包括 -c 選項，藉此使用該檔案。在此情況下，請在 (Windows™) 上發出 appscan prepare -c <configuration_file> 或在 （Linux™ 及 macOS） 上發出 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) 屬性及子元素的用法如下所示：

• 只有在您想要掃描目錄並強制 指令行公用程式 僅尋找建置輸出檔（例如 .jar、.war 及 .class 檔案）時，才使用 Target 元素 outputs-only 屬性。此屬性預設是設定為 false。這表示 指令行公用程式 會搜尋該目錄，以判定它是否為目標（例如應用程式伺服器或 Eclipse 工作區）- 或者該目錄是否包含建置 Script、Maven .pom 檔及 make 檔之類的項目。如果您希望將掃描目標當成簡單目錄，並且只尋找輸出檔，請在 Target 元素中指定 outputs-only="true"。

  例如，如果您指定 <Target outputs-only="false" path="C:\Tomcat">，則 指令行公用程式 會假設目標是 Tomcat 應用程式伺服器，並搜尋其已部署的 .war 檔案。不過，如果您指定 <Target outputs-only="true" path="C:\Tomcat">，則 指令行公用程式 會將該位置視為目錄，並找出其中所有的建置輸出檔。

• 使用 Target 元素 path 屬性以指定掃描目標的路徑或掃描目標的目錄 (<scan_target_path>)。當指定目錄時，在掃描期間會包含其所有子目錄。

  例如，如果您指定 <Target outputs-only="false" path="C:\WebSphere\AppServer85\profiles\AppSrv01">，則 指令行公用程式 會尋找 AppSrv01 設定檔中所有已部署的 .ear 檔案。如果您指定 <Target outputs-only="false" path="C:\WebSphere\AppServer85">，則 指令行公用程式 會尋找所有設定檔中所有已部署 .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>