添加注解处理器

此页面包含有关如何添加和配置注解处理器作为项目依赖项的详细指南。要了解有关注解处理器的更多信息，请参阅 配置依赖项 中的条目。

如果将注解处理器添加到编译类路径，您将看到类似于以下内容的错误消息

Error: Annotation processors must be explicitly declared now.

要解决此错误，请通过使用 annotationProcessor 配置依赖项来将注解处理器添加到您的项目中，如下所示

dependencies {
    // Adds libraries defining annotations to only the compile classpath.
    compileOnly("com.google.dagger:dagger:version-number")
    // Adds the annotation processor dependency to the annotation processor classpath.
    annotationProcessor("com.google.dagger:dagger-compiler:version-number")
}

dependencies {
    // Adds libraries defining annotations to only the compile classpath.
    compileOnly 'com.google.dagger:dagger:version-number'
    // Adds the annotation processor dependency to the annotation processor classpath.
    annotationProcessor 'com.google.dagger:dagger-compiler:version-number'
}

注意：Gradle 3.0.0+ 的 Android 插件不再支持 android-apt 插件。

将参数传递给注解处理器

如果需要将参数传递给注解处理器，可以使用模块构建配置中的 AnnotationProcessorOptions 块。例如，如果要将原始数据类型作为键值对传递，可以使用 argument 属性，如下所示

android {
    ...
    defaultConfig {
        ...
        javaCompileOptions {
            annotationProcessorOptions {
                arguments += mapOf("key1" to "value1",
                                   "key2" to "value2")
            }
        }
    }
}

android {
    ...
    defaultConfig {
        ...
        javaCompileOptions {
            annotationProcessorOptions {
                argument 'key1', 'value1'
                argument 'key2', 'value2'
            }
        }
    }
}

但是，在使用 Android Gradle 插件 3.2.0 及更高版本时，需要使用 Gradle 的 CommandLineArgumentProvider 接口传递表示文件或目录的处理器参数。

使用 CommandLineArgumentProvider 允许您或注解处理器作者通过将 增量构建属性类型注释 应用于每个参数来提高增量和缓存清理构建的正确性和性能。

例如，下面的类实现了 CommandLineArgumentProvider 并为处理器注释了每个参数。

class MyArgsProvider(
    // Annotates each directory as either an input or output for the
    // annotation processor.
    @get:InputFiles
    // Using this annotation helps Gradle determine which part of the file path
    // should be considered during up-to-date checks.
    @get:PathSensitive(PathSensitivity.RELATIVE)
    val inputDir: FileCollection,

    @get:OutputDirectory
    val outputDir: File
) : CommandLineArgumentProvider {
    // Specifies each directory as a command line argument for the processor.
    // The Android plugin uses this method to pass the arguments to the
    // annotation processor.

    override fun asArguments(): Iterable<String> {
        // Use the form '-Akey[=value]' to pass your options to the Java compiler.
        return listOf("-AinputDir=${inputDir.singleFile.absolutePath}",
                      "-AoutputDir=${outputDir.absolutePath}")
    }
}

android {...}

class MyArgsProvider implements CommandLineArgumentProvider {

    // Annotates each directory as either an input or output for the
    // annotation processor.
    @InputFiles
    // Using this annotation helps Gradle determine which part of the file path
    // should be considered during up-to-date checks.
    @PathSensitive(PathSensitivity.RELATIVE)
    FileCollection inputDir

    @OutputDirectory
    File outputDir

    // The class constructor sets the paths for the input and output directories.
    MyArgsProvider(FileCollection input, File output) {
        inputDir = input
        outputDir = output
    }

    // Specifies each directory as a command line argument for the processor.
    // The Android plugin uses this method to pass the arguments to the
    // annotation processor.
    @Override
    Iterable<String> asArguments() {
        // Use the form '-Akey[=value]' to pass your options to the Java compiler.
        ["-AinputDir=${inputDir.singleFile.absolutePath}",
         "-AoutputDir=${outputDir.absolutePath}"]
    }
}

android {...}

定义一个实现了 CommandLineArgumentProvider 的类后，需要创建一个实例并使用 annotationProcessorOptions.compilerArgumentProvider 方法将其传递给 Android 插件，如下所示。

// This is in your module's build.gradle file.
android {
    defaultConfig {
        javaCompileOptions {
            annotationProcessorOptions {
                // Creates a new MyArgsProvider object, specifies the input and
                // output paths for the constructor, and passes the object
                // to the Android plugin.
                compilerArgumentProvider(MyArgsProvider(files("input/path"),
                                                          file("output/path")))
            }
        }
    }
}

// This is in your module's build.gradle file.
android {
    defaultConfig {
        javaCompileOptions {
            annotationProcessorOptions {
                // Creates a new MyArgsProvider object, specifies the input and
                // output paths for the constructor, and passes the object
                // to the Android plugin.
                compilerArgumentProvider new MyArgsProvider(files("input/path"),
                                         new File("output/path"))
            }
        }
    }
}

要了解有关如何实现 CommandLineArgumentProvider 有助于提高构建性能的更多信息，请阅读 缓存 Java 项目。

禁用注解处理器错误检查

如果对包含不需要的注解处理器的编译类路径存在依赖项，可以通过在 build.gradle.kts 文件中添加以下内容来禁用错误检查。请记住，添加到编译类路径的注解处理器仍未添加到处理器类路径。

android {
    ...
    defaultConfig {
        ...
        javaCompileOptions {
            annotationProcessorOptions {
                argument("includeCompileClasspath", "false")
            }
        }
    }
}

android {
    ...
    defaultConfig {
        ...
        javaCompileOptions {
            annotationProcessorOptions {
                includeCompileClasspath false
            }
        }
    }
}

如果使用 Kotlin 和 kapt

android {
    ...
    defaultConfig {
        ...
        kapt {
            includeCompileClasspath = false
        }
    }
}

android {
    ...
    defaultConfig {
        ...
        kapt {
            includeCompileClasspath false
        }
    }
}

如果您在将项目的注释处理器迁移到处理器类路径后遇到问题，可以通过将includeCompileClasspath设置为true来允许编译类路径上的注释处理器。但是，不建议将此属性设置为true，并且在 Android 插件的未来更新中将删除此选项。