属性

描述

在项目中设置一个属性（通过名称和值），或一组属性（来自文件或资源）。属性区分大小写。

属性是不可变的：第一个设置属性的人会将其冻结以供构建的其余部分使用；它们绝对不是变量。

有七种方法可以设置属性

• 通过同时提供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 问题 49366。特别是

• 在 Windows 上，Ant 现在将返回额外的“环境变量”，这些变量对应于从命令行运行 Ant 时特定于驱动器的当前工作目录。这些变量的键以等号开头。
• 一些用户报告说，一些特定于 Cygwin 的变量（特别是PROMPT）不再存在。
• 在 OS/2 上，Ant 不再返回BEGINLIBPATH变量。

作为嵌套元素指定的参数

classpath

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"/>

因为user.home属性由 JVM 定义为您的主目录。user.home属性在文件系统中解析的位置取决于操作系统版本和 JVM 实现。在基于 Unix 的系统上，这将映射到用户的 home 目录。在现代 Windows 变体上，这很可能解析到用户在Documents and Settings或Users文件夹中的目录。较旧的 Windows 变体（如 Windows 98/ME）不太可预测，其他操作系统/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()）中实现了以下操作系统的命令