屬性

說明

設定專案中的屬性（依據名稱和值），或設定屬性組（從檔案或資源）。屬性區分大小寫。

屬性不可變：誰先設定屬性，就凍結該屬性，在建置的其餘時間都無法變更；屬性絕對不是變數。

有七種方式可以設定屬性

• 提供name和value或location屬性。
• 提供name和巢狀文字。
• 提供name和refid屬性。
• 設定file屬性，並提供要載入的屬性檔檔名。此屬性檔的格式與java.util.Properties類別中使用的檔案格式相同，關於如何跳脫非 ISO-8859-1 字元的規則也相同。
• 設定url屬性，並提供要從中載入屬性的 URL。此 URL 必須導向一個檔案，其格式與java.util.Properties類別中使用的檔案格式相同。
• 設定resource屬性，並提供要載入的屬性檔資源名稱。資源是目前類別路徑或指定類別路徑上的屬性檔。
• 設定environment屬性，並提供要使用的字首。屬性會針對每個環境變數定義，方法是將提供的名稱和句點加到變數名稱前面。
• 設定runtime屬性，並提供要使用的字首。屬性prefix.availableProcessors、prefix.freeMemory、prefix.totalMemory和prefix.maxMemory會定義為Runtime類別的對應方法傳回的值。

雖然可以結合這些方式，但一次只能使用一種方式。例如，屬性設定的順序可能會發生問題。

要設定的屬性值部分可能包含對其他屬性的參照。這些參照會在設定這些屬性時解析。這也適用於從屬性檔載入的屬性。

可以在這裡找到預先定義的屬性清單。

自 Apache Ant 1.8.0 起，在 Java 5+ 上執行時，可以載入根據Sun DTD定義的 XML 中的屬性。為此，檔案、資源或 url 的名稱必須以.xml結尾。

參數

OpenVMS 使用者

使用 environment 屬性，此工作會載入 OpenVMS 系統上定義的所有邏輯。具有多個等效名稱的邏輯會對應到一個屬性，其值是所有等效名稱的逗號分隔清單。如果邏輯在多個表格中定義，只會提供最本地的定義（表格優先順序為 PROCESS、JOB、GROUP、SYSTEM）。

OpenVMS 以外的所有作業系統

自 Ant 1.8.2 起，如果 Ant 偵測到它在 Java 5 或更新版本上執行，Ant 會使用 System.getenv()，而不是它自己的作業系統依賴原生實作。對於某些作業系統，與舊版 Ant 相比，這會造成一些微小的差異。如需完整清單，請參閱 Bugzilla Issue 49366。特別是

• 在 Windows 上，當 Ant 從命令列執行時，Ant 現在會傳回其他「環境變數」，這些變數對應到磁碟機特定的目前工作目錄。這些變數的鍵以等號開頭。
• 一些使用者回報說，某些 Cygwin 特定變數（特別是 PROMPT）已不存在。
• 在 OS/2 上，Ant 不再傳回 BEGINLIBPATH 變數。

指定為巢狀元素的參數

類別路徑

Property 的 classpath 屬性為 路徑結構，也可以透過巢狀 classpath 元素設定。

範例

將屬性 foo.dist 設定為值 dist。

<property name="foo.dist" value="dist"/>

將屬性 foo.dist 設定為值 dist。

<property name="foo.dist">dist</property>

從名為 foo.properties 的檔案讀取一組屬性。

<property file="foo.properties"/>

從網址 https://www.mysite.com/bla/props/foo.properties 讀取一組屬性。

<property url="https://www.mysite.com/bla/props/foo.properties"/>

從名為 foo.properties 的資源讀取一組屬性。

<property resource="foo.properties"/>

請注意，您可以使用下列方式為所有 Ant 建置參照一個全域屬性檔案

<property file="${user.home}/.ant-global.properties"/>

因為 JVM 將 user.home 屬性定義為您的家目錄。user.home 屬性在檔案系統中解析到的位置取決於作業系統版本和 JVM 實作。在基於 Unix 的系統上，這會對應到使用者的家目錄。在現代 Windows 變體上，這很可能會解析到 Documents and Settings 或 Users 資料夾中的使用者目錄。Windows 98/ME 等較舊的 Windows 變體較難預測，其他作業系統/JVM 組合也是如此。

讀取系統環境變數並將它們儲存在屬性中，字首為 env。請注意，這只會在選定的作業系統上運作。會顯示兩個值的迴音。

<property environment="env"/>
<echo message="Number of Processors = ${env.NUMBER_OF_PROCESSORS}"/>
<echo message="ANT_HOME is set to = ${env.ANT_HOME}"/>

此建置檔使用 build.properties 中定義的屬性。關於環境變數 STAGE，某些或所有值可能會被覆寫，例如有 STAGE=test 和 test.properties，您有特殊值（例如測試伺服器的另一個名稱）。最後，所有這些值都可以透過每個使用者的檔案以個人設定覆寫。

<property environment="env"/>
<property file="${user.name}.properties"/>
<property file="${env.STAGE}.properties"/>
<property file="build.properties"/>

將相對路徑儲存在 foo：../my/file.txt

<property name="foo" location="my/file.txt" relative="true" basedir=".."/>

將相對路徑儲存在 foo：cvs/my/file.txt

<property name="foo" location="my/file.txt" relative="true" basedir="cvs"/>

屬性檔

如所述，此任務將載入儲存在檔案系統或作為類別路徑資源的屬性檔。以下是關於此功能的一些有趣事實

1. 如果檔案不存在，除了 -verbose 記錄層級之外，不會印出任何內容。這讓您為每個專案提供選用的組態檔，團隊成員可以自訂。
2. 此格式的規則符合 java.util.Properties。
3. 尾隨空白不會被移除。這可能是您想要的。
4. 想要不尋常的字元？用 \u0456 或 \" 樣式跳脫。
5. Ant 屬性會在檔案中擴充
6. 如果您想擴充在同一個檔案中定義的屬性，並且您使用任務的 prefix 屬性，您必須在擴充屬性時使用相同的字首，或將 prefixValues 設為 true。

檔案內屬性擴充非常棒。學習使用它。

範例

build.compiler=jikes
deploy.server=lucky
deploy.port=8443
deploy.url=https://${deploy.server}:${deploy.port}/

關於環境變數的注意事項

當 Ant 開始支援從環境變數設定屬性時，它在 Java 1.2 上執行，其中 System.getEnv 無法使用。因此，我們決定在新的程序中啟動一個指令，它會印出環境變數、分析輸出並建立屬性。在 Ant 1.9.0 中，當我們開始需要 Java 5 時，我們改回 System.getEnv，即使它在某些平台上傳回不同的結果。以下說明的指令仍用於 OpenVMS 或如果 System.getEnv 引發例外狀況。

以下作業系統的指令已在 Execute.java（方法 getProcEnvCommand()）中實作