API 文档 | PluginDependenciesSpec |
---|
用于在脚本中声明要使用的插件的 DSL。
在构建脚本中,plugins {}
脚本块的 API 即为此类型。也就是说,您可以在 plugins 脚本块的主体中使用此 API 来声明脚本要使用的插件。
The plugins {}
块的作用类似于 PluginAware.apply(java.util.Map)
方法,该方法可直接将插件应用于 Project
对象或类似对象。一个关键区别在于,通过 plugins {}
块应用的插件在概念上是应用于脚本,并由此扩展到脚本目标。目前,这两种方法在最终结果上没有可观察到的实际差异。
在构建脚本中使用时,plugins {}
块仅允许使用完整的构建脚本编程语言的严格子集。只能使用此类型的 API,且值必须是字面量(例如常量字符串,而非变量)。PluginDependencySpec.version(java.lang.String)
允许使用插值字符串,但替换值必须来源于 Gradle 属性。此外,plugins {}
块必须是构建脚本的第一段代码。有一个例外,即 buildscript {
} 块(用于声明脚本依赖)必须在其之前。
这意味着以下约束
- 只有
PluginDependenciesSpec.id(java.lang.String)
、PluginDependenciesSpec.alias(org.gradle.api.provider.Provider)
和PluginDependenciesSpec.alias(org.gradle.api.provider.ProviderConvertible)
方法调用可以是顶级语句 PluginDependenciesSpec.id(java.lang.String)
调用后只能跟着对返回对象调用PluginDependencySpec.version(java.lang.String)
方法和/或PluginDependencySpec.apply(boolean)
方法PluginDependenciesSpec.id(java.lang.String)
、PluginDependencySpec.version(java.lang.String)
和PluginDependencySpec.apply(boolean)
方法必须使用字面量参数调用(即非变量)plugins {}
脚本块必须在任何buildscript {}
脚本块之后,但在脚本中所有其他逻辑之前
可以使用 plugins {}
块应用核心 Gradle 插件。核心插件必须在不指定版本号的情况下使用,并且可以具有限定或非限定 ID。也就是说,java
插件可以通过以下方式使用
plugins {
id 'java'
}
或通过
plugins {
id 'org.gradle.java'
}
核心 Gradle 插件使用 org.gradle
命名空间。
有关特定 Gradle 版本可用的核心插件列表,请查阅用户手册。
非核心插件可从Gradle 插件门户获取。这些插件由 Gradle 用户贡献,用于扩展 Gradle 的功能。访问plugins.gradle.org 以浏览可用的插件和版本。
要使用社区插件,必须指定完整的 ID 以及版本。
在 settings 脚本中使用时,此 API 设置插件的默认版本,允许构建脚本引用插件 ID 时无需指定关联的版本。
在 settings 脚本中,上面概述的“严格语法”规则不适用。`plugins` 块可以包含任意代码,版本字符串可以包含属性替换。使用非 `false`(默认值)的值调用 `apply` 方法将导致错误。
方法 | 描述 |
id(id) | 添加对给定 ID 插件的依赖。 |
PluginDependencySpec
id
(String
id)
添加对给定 ID 插件的依赖。
plugins {
id "org.company.myplugin"
}
进一步的约束(例如版本号)可以通过返回对象的方法指定。
plugins { id "org.company.myplugin" version "1.3" }
插件默认会自动应用于当前脚本。可以使用 apply false
选项禁用此功能
plugins { id "org.company.myplugin" version "1.3" apply false }
这对于重用插件中的任务类或将其应用于当前脚本以外的其他目标非常有用。