额外属性扩展

目录

特性
方法
脚本块
物业详情
方法详情
API文档：ExtraPropertiesExtension

Gradle 域对象的附加、临时属性。

额外的属性扩展允许将新属性添加到现有的域对象中。它们就像映射一样，允许存储任意键/值对。所有ExtensionAwareGradle 域对象本质上都有一个名为“ ext”的这种类型的扩展。

ExtensionAware 额外属性扩展的一个重要特征是，它的所有属性都可以通过拥有该扩展的对象 进行读写。

project.ext.set("myProp", "myValue")
assert project.myProp == "myValue"

project.myProp = "anotherValue"
assert project.myProp == "anotherValue"
assert project.ext.get("myProp") == "anotherValue"

额外的属性扩展对象支持 Groovy 属性语法。也就是说，属性可以通过 读取extension.«name»和设置 extension.«name» = "value"。只要有可能，Groovy 属性语法应优先于 ExtraPropertiesExtension.get(java.lang.String)和ExtraPropertiesExtension.set(java.lang.String, java.lang.Object)方法。 

project.ext {
  myprop = "a"
}
assert project.myprop == "a"
assert project.ext.myprop == "a"

project.myprop = "b"
assert project.myprop == "b"
assert project.ext.myprop == "b"

您还可以使用 Groovy 访问器语法来获取和设置额外属性扩展上的属性。 

project.ext["otherProp"] = "a"
assert project.otherProp == "a"
assert project.ext["otherProp"] == "a"

尝试获取不存在的属性的值时引发的异常根据是否使用 Groovy 语法而有所不同。如果使用 Groovy 属性语法，GroovyMissingPropertyException将被抛出。当ExtraPropertiesExtension.get(java.lang.String)使用该方法时，UnknownPropertyException将抛出一个异常。

特性

财产描述
properties

以映射形式返回所有已注册的属性及其当前值。返回的地图与扩展分离。也就是说，对地图所做的任何更改都不会更改其来源的扩展名。

方法

方法描述
get(name)

返回具有给定名称的已注册属性的值。当使用 Groovy 的额外属性扩展时，您还可以通过 Groovy 的属性语法获取属性。以下所有代码行都是等效的。

has(name)

返回扩展是否具有通过给定名称注册的属性。

set(name, value)

将具有给定名称的已注册属性的值更新为给定值，或者将其创建为给定值。当使用 Groovy 的额外属性扩展时，您还可以通过 Groovy 的属性语法设置属性。以下所有代码行都是等效的。

脚本块

无脚本块

物业详情

Map<String, Object> properties（只读）

以映射形式返回所有已注册的属性及其当前值。返回的地图与扩展分离。也就是说，对地图所做的任何更改都不会更改其来源的扩展名。 

project.version = "1.0"

assert project.hasProperty("version")
assert project.ext.properties.containsKey("version") == false

project.ext.foo = "bar"

assert project.ext.properties.containsKey("foo")
assert project.ext.properties.foo == project.ext.foo

assert project.ext.properties.every { key, value -> project.properties[key] == value }

方法详情

Object get（String姓名）

返回具有给定名称的已注册属性的值。当使用 Groovy 的额外属性扩展时，您还可以通过 Groovy 的属性语法获取属性。以下所有代码行都是等效的。 

project.ext { foo = "bar" }

assert project.ext.get("foo") == "bar"
assert project.ext.foo == "bar"
assert project.ext["foo"] == "bar"

assert project.foo == "bar"
assert project["foo"] == "bar"

使用第一种形式时，UnknownPropertyException如果扩展没有名为“ foo”的属性，则会抛出异常。当使用第二种形式（即 Groovy 表示法）时，Groovy 的表示MissingPropertyException法将被抛出。

boolean has（String姓名）

返回扩展是否具有通过给定名称注册的属性。 

assert project.ext.has("foo") == false
assert project.hasProperty("foo") == false

project.ext.foo = "bar"

assert project.ext.has("foo")
assert project.hasProperty("foo")

void set（String名称，Object值）

将具有给定名称的已注册属性的值更新为给定值，或者将其创建为给定值。当使用 Groovy 的额外属性扩展时，您还可以通过 Groovy 的属性语法设置属性。以下所有代码行都是等效的。 

project.ext.set("foo", "bar")
project.ext.foo = "bar"
project.ext["foo"] = "bar"

// Once the property has been created via the extension, it can be changed by the owner.
project.foo = "bar"
project["foo"] = "bar"