编译时如何添加import语句？Plugin实现致编译产物丢失求助

嘿，你踩了Javac Plugin开发里一个容易忽略的坑——你的现有代码把编译单元里的非Import节点（比如A.java里的类定义）全都过滤掉了，这就是为什么target目录空了、A.class没生成的核心原因！

问题出在哪？ #

看你这段代码：

List<JCTree> imports = jcCompilationUnit.defs.stream()
        .filter(def -> def.hasTag(JCTree.Tag.IMPORT))
        .collect(Collectors.toList());
// ... 添加新Import后
jcCompilationUnit.defs = List.from(imports);

你只保留了原有的Import节点，把包声明、类定义这些关键编译内容都丢了，javac编译的时候根本找不到要编译的类，自然不会生成.class文件。

正确的实现方式 #

我们要做的是保留所有原有节点，只是在合适的位置插入新的Import语句。下面是修正后的代码：

private void generateImport(CompilationUnitTree compilationUnitTree) {
    var jcCompilationUnit = (JCTree.JCCompilationUnit) compilationUnitTree;
    // 先把原有所有节点复制到新列表，避免丢失类定义等核心内容
    List<JCTree> newDefs = new ArrayList<>(jcCompilationUnit.defs);
    
    // 创建要添加的java.util.List导入节点
    JCTree.JCImport listImport = treeMaker.Import(
            treeMaker.Select(
                    treeMaker.Ident(names.fromString("java.util")),
                    names.fromString("List")
            ), false );
    
    // 找到合规的插入位置：在最后一个Import语句之后，类定义之前
    int insertPos = 0;
    for (int i = 0; i < newDefs.size(); i++) {
        JCTree def = newDefs.get(i);
        if (def.hasTag(JCTree.Tag.IMPORT)) {
            insertPos = i + 1;
        } else {
            // 遇到非Import节点就停止，符合Java代码规范中Import的位置要求
            break;
        }
    }
    
    // 插入新的Import语句
    newDefs.add(insertPos, listImport);
    
    // 更新编译单元的defs，用javac内部的不可变列表包装以适配其结构
    jcCompilationUnit.defs = List.from(newDefs);
}

关键细节提醒 #

1. 必须保留所有节点：绝对不能过滤掉defs里的非Import节点，这些是javac编译的核心内容（类、包声明等），丢了就等于没有可编译的目标。
2. 合规的插入位置：按照Java代码规范，Import应该放在包声明之后、类定义之前，我们找到最后一个Import的位置插入，保证代码结构合理。
3. 适配javac内部结构：List.from(newDefs)是javac提供的不可变列表实现，符合其内部数据结构要求，避免出现未知异常。

额外验证步骤 #

为了确保你的插件能正常工作，还要注意：

• 正确注册TaskListener，在语法树解析完成后修改：

@Override
public void init(JavacTask task, String... args) {
    task.addTaskListener(new TaskListener() {
        @Override
        public void finished(TaskEvent event) {
            // 在PARSE阶段修改语法树，此时结构已经完整
            if (event.getKind() == TaskEvent.Kind.PARSE) {
                generateImport(event.getCompilationUnit());
            }
        }
        // 其他方法可以留空或者使用默认实现
    });
}

• 配置Maven编译器插件加载你的插件：

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-compiler-plugin</artifactId>
    <version>3.11.0</version>
    <configuration>
        <source>1.8</source> <!-- 对应你的项目JDK版本 -->
        <target>1.8</target>
        <compilerArgs>
            <arg>-Xplugin:你的插件名称</arg>
        </compilerArgs>
        <annotationProcessorPaths>
            <path>
                <groupId>你的插件groupId</groupId>
                <artifactId>你的插件artifactId</artifactId>
                <version>你的插件版本</version>
            </path>
        </annotationProcessorPaths>
    </configuration>
</plugin>

这样修改后，编译时就能正确添加import java.util.List;，同时保留原有的类定义，正常生成A.class文件了。

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