另一种选择是编写一个简单的Gradle插件,以配置项目以满足您的需求。通过编写自己的插件,您可以配置所需的所有内容,例如添加注释处理器的依赖项,然后修改javaCompile任务以将生成的依赖项移动到所需的文件夹中。
现在我意识到这可能看起来有些过度,但Gradle插件非常强大且相当易于制作。如果您能克服编写Groovy代码的初始学习曲线(我假设除了在build.gradle文件中外,您没有使用Groovy),那么它可以是实现您想要的功能的一种非常快速和简单的选项。
在我开始解释如何将Gradle插件与您的库结合使用之前,让我先解释一下我所做的事情:
我曾经编写过一个名为
ProguardAnnotations的库,需要做的事情超出了注释处理器的范围。在我的情况下,我需要配置项目的proguard设置,以使用由我的注释处理器生成的proguard规则文件。实现插件并进行配置不费吹灰之力,除了配置proguard设置外,我还可以使用它来向项目添加注释处理器的依赖项。然后,我将该插件发布到Gradle插件存储库中,因此,要使用我的插件,只需在其build.gradle文件的顶部执行以下操作即可添加所有必需的依赖项并适当地配置项目:
plugins {
id "com.github.wrdlbrnft.proguard-annotations" version "0.2.0.51"
}
你可以看到这样做可以使使用库变得非常简单。只需添加这个Gradle,它就会发挥其魔力,处理所有插件配置。
现在让我们来看一下插件本身。参考
this link,可以查看我为我的库编写的Gradle插件。最终,您的插件应该看起来非常相似。
首先让我们看一下项目结构,为了简单起见,我将向您展示我为我的库编写的Gradle插件的屏幕截图。这应该是编写Gradle插件所需的最简单设置。
[![Gradle Plugin Project Setup][1]](https://istack.dev59.com/WveF1.webp)
这里有三个重要的部分。Gradle选择使用Groovy作为脚本语言。所以你需要做的第一件事是在这里获取Groovy SDK:
http://groovy-lang.org/download.html
我建议你使用IntelliJ来编写Gradle插件,但理论上Android Studio通过一些额外的配置也应该能够正常工作。
由于我们正在编写Groovy代码,您需要将代码放置在
src/main/groovy
文件夹中,而不是
src/main/java
。 您的源文件本身需要具有
.groovy
扩展名,而不是
.java
。 这里IntellIj相当棘手,即使您在
src/main/groovy
文件夹中工作,它仍然会首先提示您创建Java文件,只需注意文件名旁边图标的形状即可。 如果它是方形而不是圆形,则您正在处理Groovy文件。 除了编写Groovy代码之外,一切都很简单-每个有效的Java代码在Groovy中也是有效的-因此,您可以像在Java中一样开始编写代码,然后进行编译。 对于初学者,我不建议使用所有其他Groovy功能,因为可能会非常令人困惑。
另一个非常重要的部分是资源文件夹。在截图中,您可以看到文件夹
src/main/resources/META-INF/gradle-plugins
中的属性文件。这个属性文件确定了您的Gradle插件的id - 实际上是名称。它实际上非常简单:属性文件的名称就是您的Gradle插件的名称!截图中的属性文件名为
com.github.wrdlbrnft.proguard-annotations.properties
,因此我的Gradle插件名称为
com.github.wrdlbrnft.proguard-annotations
。如果您想在build.gradle文件中应用它,则可以在apply语句中使用该名称:
apply project: 'com.github.wrdlbrnft.proguard-annotations'
或如上面更进一步地在
plugins
部分中使用
id
!
最后一部分是build.gradle本身。您需要配置它以能够编译groovy代码,并且需要所有Gradle插件所需的依赖项。幸运的是,您只需要五行代码:
apply plugin: 'groovy'
dependencies {
compile gradleApi()
compile localGroovy()
}
有了这个基本的build.gradle设置,也许需要稍微调整一下IDE设置,你就可以准备编写自己的Gradle插件了。
现在让我们创建插件类本身。选择一个像Java中的包名并创建一个适当的Groovy文件,例如YourLibraryPlugin.groovy。Gradle插件的基本样板看起来像这样:
package com.github.example.yourlibrary
import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.ProjectConfigurationException
class YourLibraryPlugin implements Plugin<Project> {
@Override
void apply(Project project) {
}
}
现在,与Java相比,您的Groovy代码有两个不同之处:
- 您不需要指定类的可见性。通常最好不要在代码中指定Java中的包本地可见性。但是,如果您希望,可以指定公共可见性,没有任何变化。
- 如果您查看导入内容,可以看到每行末尾没有分号。在Groovy中,分号完全是可选的。您不需要它们。但是也可以使用它们,它们只是不必要的。
类本身是您的主要插件类。这是您的插件开始发挥作用的地方。一旦将插件应用于项目,就会调用apply(Project)
方法。如果您曾经想详细了解build.gradle文件中的apply plugin: 'com.android.application'
语句的作用-现在您已经有了答案。它们创建插件类的实例,并使用Gradle项目作为参数调用应用程序方法。
通常,在应用方法中,您想要做的第一件事是:
@Override
void apply(Project project) {
project.afterEvaluate {
}
}
现在,
project.afterEvaluate
的意思是,在
afterEvaluate
后面的括号内的代码将在整个build.gradle被评估之后调用。这是一个好方法,因为你的插件可能依赖于应用于项目的其他插件,但开发人员可能已经将
apply project: ...
语句放在引用您的插件的语句
apply project: ...
之后。因此,通过调用
afterEvaluate
,您确保在执行任何操作之前至少进行了基本的项目配置,这可以避免错误并减少使用您的插件的开发人员的摩擦。但是不应该过度使用。您可以立即配置有关项目的所有内容。但是,在您的情况下,现在没有什么可做的,所以我们继续在
afterEvaluate
语句中。
现在你可以做的第一件事是为你的注释处理器添加依赖项。这意味着你的用户只需要应用插件,而不必担心添加任何依赖项。
@Override
void apply(Project project) {
project.afterEvaluate {
project.afterEvaluate {
project.dependencies {
compile 'com.github.wrdlbrnft:proguard-annotations-api:0.2.0.44'
apt 'com.github.wrdlbrnft:proguard-annotations-processor:0.2.0.44'
}
}
}
}
将依赖项添加到项目中的方法与build.gradle文件中的方法相同。您可以看到我在这里使用apt分类器来处理注释处理器。用户需要在项目中应用apt插件才能使其正常工作。然而,我留给您的练习是,您还可以检测apt插件是否已经应用于项目中,如果没有,则自动应用它!这是您的Gradle插件可以为用户处理的另一件事。
现在让我们来看看您希望Gradle插件实际执行的任务。最基本的要求是在注释处理器完成创建单元测试后做出响应。
因此,我们需要首先确定我们正在处理哪种类型的项目。它是一个Android库项目还是一个Android应用程序项目?这很重要,但由于原因比较复杂,我不会在本答案中进行解释,因为这会使这个已经很长的答案变得更加冗长。我只会展示代码并基本解释它的作用:
@Override
void apply(Project project) {
project.afterEvaluate {
project.afterEvaluate {
project.dependencies {
compile 'com.github.wrdlbrnft:proguard-annotations-api:0.2.0.44'
apt 'com.github.wrdlbrnft:proguard-annotations-processor:0.2.0.44'
}
def variants = determineVariants(project)
project.android[variants].all { variant ->
configureVariant(project, variant)
}
}
}
}
private static String determineVariants(Project project) {
if (project.plugins.findPlugin('com.android.application')) {
return 'applicationVariants';
} else if (project.plugins.findPlugin('com.android.library')) {
return 'libraryVariants';
} else {
throw new ProjectConfigurationException('The com.android.application or com.android.library plugin must be applied to the project', null)
}
}
这段代码的作用是检查是否应用了
com.android.library
插件或者
com.android.application
插件,然后针对此情况迭代处理项目的所有变体。这意味着基本上你在build.gradle中指定的所有项目口味和构建类型都是独立配置的,因为它们实际上是不同的构建过程并需要各自的配置。
def
与C#中的
var
关键字类似,可用于声明变量而无需显式指定类型。
project.android[variants].all { variant ->
configureVariant(project, variant)
}
这部分是一个循环,它遍历所有不同的变体,然后调用configureVariant方法。在这个方法中,所有的魔法都发生了,这是你的项目实际重要的部分。让我们看一下基本实现:
private static void configureVariant(Project project, def variant) {
def javaCompile = variant.hasProperty('javaCompiler') ? variant.javaCompiler : variant.javaCompile
javaCompile.doLast {
}
}
现在,该方法中的第一行是一个有用的代码片段,基本上只做了一件事:它返回Java编译任务。我们需要这个任务,因为注释处理是Java编译过程的一部分,一旦编译任务完成,您的注释处理器也完成了。
javaCompile.doLast {}
部分类似于
afterEvaluate
。它允许我们在任务结束时添加自己的代码!因此,在Java编译任务和注释处理完成后,就会执行
doLast
后面括号内的部分!在那里,您现在可以终于为您的项目做您需要做的事情。由于我不知道您需要做什么或如何做,我将给您一个示例:
private static void configureVariant(Project project, def variant) {
def javaCompile = variant.hasProperty('javaCompiler') ? variant.javaCompiler : variant.javaCompile
javaCompile.doLast {
def generatedSourcesFolder = new File(project.buildDir, 'generated/apt')
def targetDirectory = new File(project.buildDir, 'some/other/folder');
if(generatedSourcesFolder.renameTo(targetDirectory)) {
}
}
}
这就是全部内容了!虽然这个回答很长,但只是浅尝辄止,如果我漏掉了什么重要的东西或者你有任何进一步的问题,请随时问我。
最后几件事情:
如果您需要将生成的文件移动到另一个文件夹中,您需要知道在apt文件夹中可能会有许多其他库生成的文件,通常将它们移开不是一个好主意。因此,您需要想出一个系统,以从文件夹中过滤出您的文件 - 例如一些常见的前缀或后缀。这应该不是问题。
还有一件事需要提醒:一旦你在configureVariants()
方法中获取到了javaCompile
任务,你实际上可以为你的注解处理器指定命令行参数,就像@emory所提到的那样。然而,这可能会相当棘手。事实上,这正是android-apt
插件所做的。它通过在javaCompile
任务上指定build/generated/apt
文件夹作为所有注解处理器的输出文件夹来进行指定。再次强调,你不想搞砸它。我不知道有没有一种方法只为一个注解处理器 - 也就是你的注解处理器 - 指定输出文件夹,但可能有一种方法。如果你有时间,你可以查看android-apt
的相关源代码here。处理器输出路径的指定发生在configureVariants
方法下面。
在你的build.gradle中设置Gradle插件项目与任何其他Gradle项目非常相似,实际上非常容易。然而作为参考,这里是我编写Gradle插件所使用的完整build.gradle。如果你需要帮助来配置你的插件发布到jcenter或Gradle插件存储库,或者只是任何一般的配置,你可能会受益于查看:
buildscript {
repositories {
maven {
url "https://plugins.gradle.org/m2/"
}
jcenter()
}
dependencies {
classpath "com.gradle.publish:plugin-publish-plugin:0.9.4"
classpath 'com.novoda:bintray-release:0.3.4'
}
}
apply plugin: "com.gradle.plugin-publish"
apply plugin: 'com.jfrog.bintray'
apply plugin: 'maven-publish'
apply plugin: 'maven'
apply plugin: 'groovy'
dependencies {
compile gradleApi()
compile localGroovy()
}
final bintrayUser = hasProperty('bintray_user') ? property('bintray_user') : ''
final bintrayApiKey = hasProperty('bintray_api_key') ? property('bintray_api_key') : ''
final versionName = hasProperty('version_name') ? property('version_name') : ''
version = versionName
pluginBundle {
vcsUrl = 'https://github.com/Wrdlbrnft/ProguardAnnotations'
website = 'https://github.com/Wrdlbrnft/ProguardAnnotations'
description = 'Makes dealing with Proguard simple and easy!'
plugins {
ProguardAnnotationsPlugin {
id = 'com.github.wrdlbrnft.proguard-annotations'
displayName = 'ProguardAnnotations'
tags = ['android', 'proguard', 'plugin']
}
}
}
task sourcesJar(type: Jar, dependsOn: classes) {
classifier = 'sources'
from sourceSets.main.allSource
}
publishing {
publications {
Bintray(MavenPublication) {
from components.java
groupId 'com.github.wrdlbrnft'
artifactId 'proguard-annotations'
artifact sourcesJar
version versionName
}
}
}
bintray {
user = bintrayUser
key = bintrayApiKey
publications = ['Bintray']
pkg {
repo = 'maven'
name = 'ProguardAnnotationsPlugin'
userOrg = bintrayUser
licenses = ['Apache-2.0']
vcsUrl = 'https://github.com/Wrdlbrnft/ProguardAnnotations'
publicDownloadNumbers = true
version {
name = versionName
released = new Date()
}
}
}
如果您对build.gradle文件中未定义的所有三个或四个变量感到困惑-这些变量是在运行构建时由我的构建服务器注入的。在开发过程中,它们会自动回退到一些默认值。
我希望能帮助您使您的库更出色 :)