使用注释处理生成单元测试
Generate unit test using annotation processing
我一直在寻找有关此事的信息，但找不到任何有用的资源。
我需要使用注释处理生成单元测试。我可以生成一个 class 可以作为单元测试的问题。我不知道该怎么做的是将这些生成的文件放在正确的文件夹中。
默认情况下，输出将位于 build/generated/source/apt/debug 文件夹中，但我需要将这些文件放在 build/generated/source/apt/test 中。我猜。我的意思是我在注释处理之前使用过，但我从未使用过生成单元测试，所以我不知道在何处或如何定位它们的正确方法是什么。
顺便说一下，我正在使用 Android Studio 2.0。
man page 说
-s dir Specify the directory where to place generated source files. The directory must already exist; javac will not create it. If a class
is part of a package, the compiler puts the source file in a
subdirectory reflecting the package name, creating directories as
needed. For example, if you specify -s /home/mysrc and the class is
called com.mypackage.MyClass, then the source file will be placed in
/home/mysrc/com/mypackage/MyClass.java.
我想这就是你要找的。
但是，如果您的一些注释正在生成应该放在一个目录中的单元测试，而您的一些注释正在生成应该放在另一个目录中的生产代码，那么我认为这个解决方案将行不通。
使用 android apt-plugin 解决方案是使用 testApt 而不是 apt，正如在 issue 上所建议的那样。
然而，这提出了将要处理的 类 范围限制到当前测试环境的限制，这不是我需要的，但对大多数用户来说可能没问题。
您的另一个选择是编写一个简单的 Gradle 插件，根据您的需要配置项目。通过编写自己的插件，您可以配置所需的一切，例如为注释处理器添加依赖项，然后修改 javaCompile 任务以将生成的依赖项移动到所需的文件夹。
现在我意识到这可能看起来有些过分，但是 Gradle 插件非常强大并且很容易制作。如果你能克服编写 Groovy 代码的初始学习曲线（我假设你除了在你的 build.gradle 文件中没有使用 Groovy ）那么它可以是一个非常快速和简单的选择做你想做的
在我开始解释如何将 Gradle 插件与您的库结合使用之前，让我解释一下我在做什么：
我曾经写过一个名为 ProguardAnnotations 的库，它需要做的事情比单独使用注释处理器所能做的更多。在我的例子中，我需要配置项目的 proguard 设置以使用由我的注释处理器生成的 proguard 规则文件。实现该插件并没有太多工作，除了配置混淆器设置外，我还可以使用它来将我的注释处理器的依赖项添加到项目中。然后我将插件发布到 Gradle 插件存储库，所以现在要使用我的插件，它会添加所有必需的依赖项并适当地配置项目所有用户必须做的就是将其添加到他们的 build.gradle 文件的顶部:
plugins {
id "com.github.wrdlbrnft.proguard-annotations" version "0.2.0.51"
}
所以您可以看到这如何使您的库的使用变得非常简单。只需添加此 Gradle 即可发挥其魔力并处理所有插件配置。
现在让我们看一下插件本身。作为参考 this link 将带您到我为我的图书馆编写的 Gradle 插件。你的插件最终应该看起来很相似。
让我们先看看项目结构，为了简单起见，我将向您展示我为我的库编写的 Gradle 插件的屏幕截图。这应该是 Gradle 插件所需的最简单设置：
[
这里有三个重要的部分。 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 project: 'com.github.wrdlbrnft.proguard-annotations' 或如上文 plugins 部分中的 id 所示！
最后一部分是 build.gradle 本身。您需要将其配置为能够编译 groovy 代码，并且您需要 Gradle 插件所需的所有依赖项。幸运的是，您只需要五行代码：
apply plugin: 'groovy'
dependencies {
compile gradleApi()
compile localGroovy()
}
在您的 build.gradle 中进行此基本设置并可能稍微调整一下您的 IDE 设置，您应该准备好编写自己的 Gradle 插件。
现在让我们创建插件 class 本身。选择一个包名，如 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
/**
* Created by Xaver Kapeller on 11/06/16.
*/
class YourLibraryPlugin implements Plugin<Project> {
@Override
void apply(Project project) {
}
}
与 Java 相比，您的 Groovy 代码有两点不同：
- 您不需要指定 classes 的可见性。在 Java 代码中不指定任何包本地可见性通常是最好的选择。但是，如果需要，您可以指定 public 可见性，没有任何变化。
- 如果您查看导入，您会发现每行末尾没有分号。在 Groovy 中，分号完全是可选的。你在任何地方都不需要它们。但是拥有也可以。他们只是不需要。
class 本身就是您的主要插件 class。这是您的插件开始发挥其魔力的地方。 apply(Project) 方法会在您的插件应用于项目后立即调用。如果您想详细了解 build.gradle 文件中的 apply plugin: 'com.android.application' 语句的作用 - 现在您有了答案。他们创建插件 class 的实例，并使用 Gradle 项目作为参数调用 apply 方法。
通常您在应用方法中要做的第一件事是：
@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 classifier 作为注释处理器。您的用户需要将 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 {
}
}
现在该方法的第一行是一个有用的代码片段，它主要做一件事：returns 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)) {
// Success!!1 Files moved.
}
}
}
就是这样！虽然这是一个很长的答案，但它只触及了整个主题的表面，所以如果我忘记了一些重要的事情或者您有任何其他问题，请随时提出。
不过还有最后几件事：
如果您需要将生成的文件移动到不同的文件夹，您需要注意 apt 文件夹中可能有许多来自其他库的其他生成文件，通常将它们移走并不是一件好事.所以你需要想出一个系统来从文件夹中过滤你的文件——例如一些常见的前缀或后缀。这应该不是问题。
我需要提及的另一件事：一旦你在 configureVariants() 方法中获得了 javaCompile 任务，你实际上可以为你的注释处理器指定命令行参数，就像 @emory 提到的那样。然而，这可能非常棘手。事实上，这正是 android-apt 插件所做的。它通过在 javaCompile 任务上指定 build/generated/apt 文件夹作为所有注释处理器的输出文件夹。同样，您不想弄乱它。我不知道有什么方法可以只为一个注释处理器（即您的注释处理器）指定输出文件夹，但可能有办法。如果你有时间，你可能想研究一下。你可以看看android-apthere的相关源码。处理器输出路径的指定发生在下面的 configureVariants 方法中。
在您的 build.gradle 中设置一个 Gradle 插件项目与任何其他 Gradle 项目非常相似，实际上非常简单。然而，作为参考，这里是完整的 build.gradle 我用于我编写的 Gradle 插件。如果您需要帮助了解如何设置将插件发布到 jcenter 或 Gradle Plugin Pepository 或任何常规配置，您可能会从中受益：
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 文件中未定义的所有三个或四个变量感到困惑 - 当我 运行 构建时，它们由我的构建服务器注入。他们在开发时自动回退到一些默认值。
我希望我能帮助你让你的图书馆更棒:)
我一直在寻找有关此事的信息，但找不到任何有用的资源。
我需要使用注释处理生成单元测试。我可以生成一个 class 可以作为单元测试的问题。我不知道该怎么做的是将这些生成的文件放在正确的文件夹中。
默认情况下，输出将位于 build/generated/source/apt/debug 文件夹中，但我需要将这些文件放在 build/generated/source/apt/test 中。我猜。我的意思是我在注释处理之前使用过，但我从未使用过生成单元测试，所以我不知道在何处或如何定位它们的正确方法是什么。
顺便说一下，我正在使用 Android Studio 2.0。
man page 说
-s dir Specify the directory where to place generated source files. The directory must already exist; javac will not create it. If a class is part of a package, the compiler puts the source file in a subdirectory reflecting the package name, creating directories as needed. For example, if you specify -s /home/mysrc and the class is called com.mypackage.MyClass, then the source file will be placed in /home/mysrc/com/mypackage/MyClass.java.
我想这就是你要找的。
但是，如果您的一些注释正在生成应该放在一个目录中的单元测试，而您的一些注释正在生成应该放在另一个目录中的生产代码，那么我认为这个解决方案将行不通。
使用 android apt-plugin 解决方案是使用 testApt 而不是 apt，正如在 issue 上所建议的那样。
然而，这提出了将要处理的 类 范围限制到当前测试环境的限制，这不是我需要的，但对大多数用户来说可能没问题。
您的另一个选择是编写一个简单的 Gradle 插件，根据您的需要配置项目。通过编写自己的插件，您可以配置所需的一切，例如为注释处理器添加依赖项，然后修改 javaCompile 任务以将生成的依赖项移动到所需的文件夹。
现在我意识到这可能看起来有些过分，但是 Gradle 插件非常强大并且很容易制作。如果你能克服编写 Groovy 代码的初始学习曲线（我假设你除了在你的 build.gradle 文件中没有使用 Groovy ）那么它可以是一个非常快速和简单的选择做你想做的
在我开始解释如何将 Gradle 插件与您的库结合使用之前，让我解释一下我在做什么：
我曾经写过一个名为 ProguardAnnotations 的库，它需要做的事情比单独使用注释处理器所能做的更多。在我的例子中，我需要配置项目的 proguard 设置以使用由我的注释处理器生成的 proguard 规则文件。实现该插件并没有太多工作，除了配置混淆器设置外，我还可以使用它来将我的注释处理器的依赖项添加到项目中。然后我将插件发布到 Gradle 插件存储库，所以现在要使用我的插件，它会添加所有必需的依赖项并适当地配置项目所有用户必须做的就是将其添加到他们的 build.gradle 文件的顶部:
plugins {
id "com.github.wrdlbrnft.proguard-annotations" version "0.2.0.51"
}
所以您可以看到这如何使您的库的使用变得非常简单。只需添加此 Gradle 即可发挥其魔力并处理所有插件配置。
现在让我们看一下插件本身。作为参考 this link 将带您到我为我的图书馆编写的 Gradle 插件。你的插件最终应该看起来很相似。
让我们先看看项目结构，为了简单起见，我将向您展示我为我的库编写的 Gradle 插件的屏幕截图。这应该是 Gradle 插件所需的最简单设置：
[
这里有三个重要的部分。 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 project: 'com.github.wrdlbrnft.proguard-annotations' 或如上文 plugins 部分中的 id 所示！
最后一部分是 build.gradle 本身。您需要将其配置为能够编译 groovy 代码，并且您需要 Gradle 插件所需的所有依赖项。幸运的是，您只需要五行代码：
apply plugin: 'groovy'
dependencies {
compile gradleApi()
compile localGroovy()
}
在您的 build.gradle 中进行此基本设置并可能稍微调整一下您的 IDE 设置，您应该准备好编写自己的 Gradle 插件。
现在让我们创建插件 class 本身。选择一个包名，如 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
/**
* Created by Xaver Kapeller on 11/06/16.
*/
class YourLibraryPlugin implements Plugin<Project> {
@Override
void apply(Project project) {
}
}
与 Java 相比，您的 Groovy 代码有两点不同：
- 您不需要指定 classes 的可见性。在 Java 代码中不指定任何包本地可见性通常是最好的选择。但是，如果需要，您可以指定 public 可见性，没有任何变化。
- 如果您查看导入，您会发现每行末尾没有分号。在 Groovy 中，分号完全是可选的。你在任何地方都不需要它们。但是拥有也可以。他们只是不需要。
class 本身就是您的主要插件 class。这是您的插件开始发挥其魔力的地方。 apply(Project) 方法会在您的插件应用于项目后立即调用。如果您想详细了解 build.gradle 文件中的 apply plugin: 'com.android.application' 语句的作用 - 现在您有了答案。他们创建插件 class 的实例，并使用 Gradle 项目作为参数调用 apply 方法。
通常您在应用方法中要做的第一件事是：
@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 classifier 作为注释处理器。您的用户需要将 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 {
}
}
现在该方法的第一行是一个有用的代码片段，它主要做一件事：returns 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)) {
// Success!!1 Files moved.
}
}
}
就是这样！虽然这是一个很长的答案，但它只触及了整个主题的表面，所以如果我忘记了一些重要的事情或者您有任何其他问题，请随时提出。
不过还有最后几件事：
如果您需要将生成的文件移动到不同的文件夹，您需要注意 apt 文件夹中可能有许多来自其他库的其他生成文件，通常将它们移走并不是一件好事.所以你需要想出一个系统来从文件夹中过滤你的文件——例如一些常见的前缀或后缀。这应该不是问题。
我需要提及的另一件事：一旦你在 configureVariants() 方法中获得了 javaCompile 任务，你实际上可以为你的注释处理器指定命令行参数，就像 @emory 提到的那样。然而，这可能非常棘手。事实上，这正是 android-apt 插件所做的。它通过在 javaCompile 任务上指定 build/generated/apt 文件夹作为所有注释处理器的输出文件夹。同样，您不想弄乱它。我不知道有什么方法可以只为一个注释处理器（即您的注释处理器）指定输出文件夹，但可能有办法。如果你有时间，你可能想研究一下。你可以看看android-apthere的相关源码。处理器输出路径的指定发生在下面的 configureVariants 方法中。
在您的 build.gradle 中设置一个 Gradle 插件项目与任何其他 Gradle 项目非常相似，实际上非常简单。然而，作为参考，这里是完整的 build.gradle 我用于我编写的 Gradle 插件。如果您需要帮助了解如何设置将插件发布到 jcenter 或 Gradle Plugin Pepository 或任何常规配置，您可能会从中受益：
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 文件中未定义的所有三个或四个变量感到困惑 - 当我 运行 构建时，它们由我的构建服务器注入。他们在开发时自动回退到一些默认值。
我希望我能帮助你让你的图书馆更棒:)