API 文档 | CompileOptions |
---|
Java 编译的主要选项。
属性 | 描述 |
annotationProcessorPath | 用于加载注解处理器的类路径。此路径也用于注解处理器发现。 |
bootstrapClasspath | 用于编译器进程的引导类路径。默认为 |
compilerArgs | 返回要传递给编译器的任何额外参数。默认为空列表。DSL 不支持的编译器参数可以在这里添加。例如,可以传递较新 Java 版本中添加的 |
compilerArgumentProviders | 编译器参数提供程序。 |
调试 | 指示是否在生成的类文件中包含调试信息。默认为 |
debugOptions | 返回用于生成调试信息的选项。 |
deprecation | 指示是否记录已弃用成员或类使用情况的详细信息。默认为 |
编码 | 读取源文件时使用的字符编码。默认为 |
extensionDirs | 用于编译器进程的扩展目录。默认为 |
failOnError | 指示编译失败时是否终止构建。默认为 |
fork | 指示是否在自己的进程中运行编译器。请注意,这不一定意味着每个编译任务都会创建一个新进程。默认为 |
forkOptions | 返回用于在子进程中运行编译器的选项。 |
generatedSourceOutputDirectory | 放置注解处理器生成的源文件的目录。 |
headerOutputDirectory | 如果此选项设置为非空目录,它将传递给 Java 编译器的 `-h` 选项,提示它将原生头文件生成到该目录。 |
incremental | 告知是否使用增量编译功能。请参见 |
incrementalAfterFailure | 孵化中 用于在失败后启用或禁用增量编译。 |
javaModuleMainClass | 设置 Java 模块的主类,如果该模块应该可执行。 |
javaModuleVersion | 设置 Java 模块的版本。 |
listFiles | 指示是否记录要编译的文件。默认为 |
release | 配置此编译任务的 Java 语言版本( |
sourcepath | 用于编译的源路径。 |
verbose | 指示是否生成详细输出。默认为 |
warnings | 指示是否记录警告消息。默认为 |
FileCollection
annotationProcessorPath
用于加载注解处理器的类路径。此路径也用于注解处理器发现。
- 默认与
java
插件一起使用 sourceSet
.annotationProcessorPath
返回要传递给编译器的任何额外参数。默认为空列表。DSL 不支持的编译器参数可以在这里添加。例如,可以传递较新 Java 版本中添加的 --enable-preview
选项
compilerArgs.add("--enable-preview")
请注意,如果添加了 --release
,则 -target
和 -source
将被忽略。
- 默认与
java
插件一起使用 []
指示是否在生成的类文件中包含调试信息。默认为 true
。有关将生成哪些调试信息,请参见 DebugOptions.getDebugLevel()
。
- 默认与
java
插件一起使用 true
DebugOptions
debugOptions
(只读)
返回用于生成调试信息的选项。
ForkOptions
forkOptions
(只读)
返回用于在子进程中运行编译器的选项。
DirectoryProperty
generatedSourceOutputDirectory
放置注解处理器生成的源文件的目录。
- 默认与
java
插件一起使用 ${project.layout.buildDirectory}
/generated/sources/annotationProcessor/${sourceDirectorySet.name}
/${sourceSet.name}
DirectoryProperty
headerOutputDirectory
如果此选项设置为非空目录,它将传递给 Java 编译器的 `-h` 选项,提示它将原生头文件生成到该目录。
- 默认与
java
插件一起使用 ${project.layout.buildDirectory}
/generated/sources/headers/${sourceDirectorySet.name}
/${sourceSet.name}
注意:此属性处于孵化中,可能会在 Gradle 的未来版本中更改。
用于在失败后启用或禁用增量编译。
默认情况下,Java 和 Groovy 在失败后启用增量编译。它对 Scala 没有影响。如果未启用增量编译,则它没有影响。
当使用 Java 命令行编译器时,即当自定义 java home 传递给 forkOptions.javaHome 或 javac 传递给 forkOptions.executable 时,此优化会自动禁用,因为编译器不是通过编译器 API 调用的。
- 默认与
java
插件一起使用 true
配置此编译任务的 Java 语言版本(--release
编译器标志)。
如果设置,它将优先于 AbstractCompile.getSourceCompatibility()
和 AbstractCompile.getTargetCompatibility()
设置。
此选项仅由 JavaCompile
任务考虑。
FileCollection
sourcepath
用于编译的源路径。
源路径指示必要时可能编译的源文件的位置。它实际上是类路径的补充,其中要编译的类以源形式存在。它不指示实际的主要编译源。
对于使用依赖管理的新式构建,Java 编译器的源路径功能很少需要。
源路径的默认值为 null
,表示空源路径。请注意,这与 javac
的 -sourcepath
选项的默认值不同,后者是使用 -classpath
指定的值。如果您希望使用任何源路径,则必须明确设置。
- 默认与
java
插件一起使用 null