配置注释处理器
最后修改时间:2023 年 8 月 23 日您可以配置 IntelliJ IDEA 在编译期间处理自定义注释。在编译时生成代码来处理注释的过程称为注释处理。
注解处理器可以根据注解验证、生成和修改您的代码,这可以帮助您显着减少需要编写的代码量。注释处理器可以存储在您的项目中。在这种情况下,IntelliJ IDEA 从类路径获取它。如果注释处理器存储在项目外部,则需要手动添加注释处理器 JAR 的路径。
当您通过Maven或Gradle项目中的构建脚本添加注释处理器时,IntelliJ IDEA 会自动启用注释处理并在注释处理器设置中添加适当的路径。
注释处理配置文件
注释配置文件是一组用于注释处理的配置选项。这些选项包括注释处理输出的位置、特定注释处理器及其参数。
默认配置文件始终存在。组成项目的所有模块都使用默认配置文件。您可以创建一个新的配置文件,将多个模块分组到其下,并为指定的模块组配置注释处理。
配置注释配置文件
按打开 IDE 设置,然后选择“构建”、“执行”、“部署”| 编译器| 注释处理器。CtrlAlt0S
在“注释处理器”页面上,单击页面底部的 。
在创建新配置文件对话框中,指定配置文件名称。
要将模块移至创建的配置文件,请选择所需的模块,单击( ) 并选择目标配置文件。F6
笔记
如果删除 ( ) 配置文件,则与已删除配置文件关联的所有模块都将移至默认配置文件。
配置配置文件的注释处理
选择所需的注释配置文件。
选择启用注释处理并配置以下选项:
从项目类路径获取处理器:如果您使用自定义注释处理器作为项目的一部分,或者如果处理器存储在作为库附加到所有相应模块的.jar文件中,请启用此选项。
处理器路径:选择此选项并指定注释处理器的路径(如果注释处理器存储在项目外部)。
如果Gradle 项目具有
annotationProcessor
在build.gradle文件中指定的依赖项,则此字段将包含导入 Gradle 项目时 Gradle 使用的注释处理器的路径。当您使用 Gradle 构建此类项目时,IntelliJ IDEA 会在项目工具窗口的构建目录内生成相应的子目录。对于Maven 项目,该字段将包含pom.xml中指定的注释处理器的路径。
使用 --processor-module-path 编译器选项(适用于 java 9 及更高版本):假设指定的路径是模块路径:包含打包的 Java 模块的 JAR 或目录的路径。为了被发现并从模块路径运行,注释处理器应该打包为 Java 模块,并在模块声明中向ServiceLoader注册。
相对于存储生成的源:使用模块输出目录和模块内容根选项来定义注释处理器生成的源的存储位置,并覆盖配置文件的默认行为。
笔记
当您重建项目时,存储生成的源的目录将像普通输出目录一样被清理。因此不建议将非生成的源存储在此类目录中。
生产源和测试源:使用这些字段指定存储注释处理器输出的目录的名称。如果该字段留空,注释处理器生成的文件将存储在项目输出目录下。当指定名称时,自动注释处理后将在内容根下创建具有该名称的目录。
处理器 FQ 名称:指定要启动的处理器的完全限定名称。如果未指定任何内容,则 IntelliJ IDEA 将启动在指定位置检测到的所有处理器。
注释处理器选项:使用此区域将处理器运行选项配置为
-key=value
、 或key=value
。使用空格分隔各个选项。
感谢您的反馈意见!