android - Android gradle 中的 apt 依赖范围 - 它的用途是什么？

Question

我有时看到的 android gradle 文件中的 apt 依赖范围是什么？

一个例子看起来像这样？

apply plugin: 'com.android.application'
apply plugin: 'com.neenbedankt.android-apt'
android {
    compileSdkVersion 20
    buildToolsVersion '20.0.0'
    defaultConfig {
        applicationId "org.ligboy.test.card.module1"
        minSdkVersion 14
        targetSdkVersion 20
        versionCode 1
        versionName "1.0"
    }
    buildTypes {
        release {
            runProguard false
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }
}

final DAGGER_VERSION = '2.0.2'

dependencies {  
    compile "com.google.dagger:dagger:${DAGGER_VERSION}"
    apt "com.google.dagger:dagger-compiler:${DAGGER_VERSION}"//what is this scope 
    provided 'org.glassfish:javax.annotation:10.0-b28'
}

并且在顶层 build.gradle 文件中它具有这个全局依赖:

buildscript { 
dependencies {
        classpath 'com.android.tools.build:gradle:1.3.0'
        classpath 'com.neenbedankt.gradle.plugins:android-apt:1.4'
    }
}

注意依赖部分有一个合​​适的范围？我只知道编译、打包和提供的范围。编译在编译时和包中包含依赖项，前提是只在编译时包含库并在打包时间，因此它不包含在最终构建中。而包是相反的，它包括包中的依赖项，而不是在编译时。但是什么是 apt 依赖范围，我们显然需要 com.neenbedankt.android-apt 才能工作，所以我知道它是基于 android 的。

更新:为什么我不能使用 provided 依赖范围而不是 apt 范围？它们有何不同？

我在 dagger dependency scopes 上创建了一个教程对于那些需要更多信息的人。

Answer 1

来自 android-apt project page :

The android-apt plugin assists in working with annotation processors in combination with Android Studio. It has two purposes:

• Allow to configure a compile time only annotation processor as a dependency, not including the artifact in the final APK or library

• Set up the source paths so that code that is generated from the annotation processor is correctly picked up by Android Studio.

您正在使用 Dagger，它使用注释处理来生成代码。注解处理代码不应包含在最终的 APK 中，并且您希望生成的代码对 Android Studio 可见。 android-apt 启用此行为。

这听起来与 provided 范围非常相似，但 apt 在几个关键方面与 provided 不同。第一个区别是 apt 依赖项生成的代码可用于 IDE，而 provided 依赖项生成的代码不可用。

另一个重要的区别是，使用 provided 范围的库中的代码位于 IDE 类路径中(即您可以导入类并尝试使用它们)，而 中的代码apt 依赖不是。使用 provided，如果您实际上没有为引用的依赖项提供 compile 范围的对应项，您的代码将在运行时崩溃。

您可以在 this android-apt issue 上找到关于 apt 与 provided 的讨论。 .

在 Dagger 的情况下，没有理由在您的任何代码中包含注释处理器和代码生成器(provided 范围允许)。因此 apt 范围更合适。

2016 年 10 月更新:您可能不再需要 apt 和 android-apt 插件了。 Android Gradle 插件 2.2 版有一个 annotationProcessor 配置，您应该改用它。

在 What's next for android-apt? 上查看更多信息