如何让自定义注解处理器支持依赖项目配置（Gradle环境）

我们有如下小型系统：

• 包含注解处理器用于生成Java代码的Java项目，命名为"A"
• 依赖"A"并使用其注解处理器的Java项目，命名为"B"
• 使用Gradle构建工具

我们希望为"A"提供特定配置文件（例如指定生成类的后缀或附加注解），由于"A"需作为多个项目的依赖，配置文件必须放在"B"中，最优位置是resources目录。预期流程如下：

1. 构建项目"B"
2. 触发"A"的注解处理流程
3. "A"读取"B"中的配置文件
4. 生成的类输出到"B"的构建目录

目前流程其他环节均正常，但"A"无法读取该配置文件。

核心疑问：如何在项目"B"的构建过程中向"A"传递配置信息？仅提供配置文件路径即可，或有其他配置注解处理器的方式？

补充说明 #

"A"中的注解处理器示例代码：

@SupportedAnnotationTypes("...")
public class BlocklyAnnotationProcessor extends AbstractProcessor {

    @SneakyThrows
    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);
        // <-- 此处需要读取配置文件
        
        this.do.fancyStuff();
    }
}

配置文件为YAML格式，示例：

processor:
  suffix: Impl

项目结构：

project_A
  └── src
      └── java
          └── AnnotationProcessor.java
project_B
  └── src
      ├── java
      │   └── ClassToBeProcessedByA.java
      └── resources
          └── my_config_to_be_read_by_A.yml

方法1：通过Gradle传递配置文件路径 #

在项目"B"的构建脚本中，给注解处理器添加编译参数，直接指定配置文件的绝对路径：

Groovy DSL 示例 #

tasks.withType(JavaCompile) {
    options.compilerArgs += [
        "-Aprocessor.config.path=${project.projectDir}/src/main/resources/my_config_to_be_read_by_A.yml"
    ]
}

Kotlin DSL 示例 #

tasks.withType<JavaCompile> {
    options.compilerArgs.add(
        "-Aprocessor.config.path=${project.projectDir}/src/main/resources/my_config_to_be_read_by_A.yml"
    )
}

然后在"A"的注解处理器中读取该参数并加载配置：

@SneakyThrows
@Override
public synchronized void init(ProcessingEnvironment processingEnv) {
    super.init(processingEnv);
    // 获取传递的配置文件路径
    String configPath = processingEnv.getOptions().get("processor.config.path");
    if (configPath != null) {
        File configFile = new File(configPath);
        // 用SnakeYAML解析YAML文件（需提前引入依赖）
        Yaml yaml = new Yaml();
        Map<String, Object> configMap = yaml.load(new FileInputStream(configFile));
        String suffix = (String) ((Map) configMap.get("processor")).get("suffix");
        // 后续使用配置信息
    }
    this.do.fancyStuff();
}

注意：要在"A"的build.gradle中添加YAML解析依赖：

implementation 'org.yaml:snakeyaml:2.2'

方法2：从类路径直接读取配置文件 #

利用注解处理器的ProcessingEnvironment获取类加载器，直接从类路径读取"B"中resources目录下的配置文件：

@SneakyThrows
@Override
public synchronized void init(ProcessingEnvironment processingEnv) {
    super.init(processingEnv);
    // 从类路径加载配置文件
    InputStream inputStream = processingEnv.getClassLoader().getResourceAsStream("my_config_to_be_read_by_A.yml");
    if (inputStream != null) {
        Yaml yaml = new Yaml();
        Map<String, Object> configMap = yaml.load(inputStream);
        String suffix = (String) ((Map) configMap.get("processor")).get("suffix");
        // 后续使用配置信息
    }
    this.do.fancyStuff();
}

这种方式无需额外的Gradle配置，但要处理配置文件不存在的null情况。

方法3：声明支持的处理器参数（可选） #

在"A"的注解处理器类上添加@SupportedOptions注解，明确声明支持的配置参数，让构建工具和IDE识别合法参数，避免警告：

@SupportedAnnotationTypes("...")
@SupportedOptions("processor.config.path") // 声明支持的参数
public class BlocklyAnnotationProcessor extends AbstractProcessor {
    // ... 处理器代码
}

内容的提问来源于stack exchange，提问作者FeXseven