Java注解处理时如何获取源码行号？

要在注解编译阶段获取Element对应的源码行号，核心是利用JDK注解处理API中的SourcePositions和Trees工具类，具体实现步骤如下：

1. 初始化工具实例 #

在注解处理器的init方法中，从ProcessingEnvironment获取所需工具类的实例，用于后续定位元素的源码位置：

private Trees trees;
private SourcePositions sourcePositions;

@Override
public synchronized void init(ProcessingEnvironment processingEnv) {
    super.init(processingEnv);
    trees = Trees.instance(processingEnv);
    sourcePositions = processingEnv.getSourcePositions();
}

2. 编写行号获取方法 #

针对目标Element（比如被注解标记的方法、字段），通过以下步骤提取行号：

1. 用Trees.getPath(element)获取元素在抽象语法树（AST）中的TreePath路径；
2. 从TreePath中提取对应整个源码文件的CompilationUnitTree，以及元素对应的具体Tree节点；
3. 调用SourcePositions.getStartPosition()获取元素在源码中的起始偏移量，再通过CompilationUnitTree.getLineMap()将偏移量转换为行号。

示例代码：

private int getElementLineNumber(Element element) {
    TreePath elementPath = trees.getPath(element);
    if (elementPath == null) {
        return -1; // 无法定位的元素返回无效行号
    }

    CompilationUnitTree unitTree = elementPath.getCompilationUnit();
    Tree targetTree = elementPath.getLeaf();
    long startOffset = sourcePositions.getStartPosition(unitTree, targetTree);

    if (startOffset == SourcePositions.NOPOS) {
        return -1;
    }

    // 将字节偏移量转换为源码行号
    return (int) unitTree.getLineMap().getLineNumber(startOffset);
}

3. 生成带行号的常量类 #

拿到行号后，结合元素的类名、方法名，即可生成包含位置信息的静态字符串常量。以下是用JavaPoet简化代码生成的示例（也可手动拼接字符串）：

假设你用@LogLocation注解标记需要生成日志位置的方法，核心生成逻辑如下：

// 遍历所有被@LogLocation注解标记的元素
for (Element element : annotatedElements) {
    String className = element.getEnclosingElement().getSimpleName().toString();
    String methodName = element.getSimpleName().toString();
    int lineNum = getElementLineNumber(element);
    String sourceFileName = unitTree.getSourceFile().getName();

    // 构造格式如 "MyClass.myMethod(MyClass.java:123)" 的常量值
    String logConstantValue = String.format("%s.%s(%s:%d)", className, methodName, sourceFileName, lineNum);

    // 生成常量类
    TypeSpec.Builder constantClass = TypeSpec.classBuilder("LogPositionConstants")
        .addModifiers(Modifier.PUBLIC, Modifier.FINAL);
    constantClass.addField(FieldSpec.builder(String.class, methodName.toUpperCase())
        .addModifiers(Modifier.PUBLIC, Modifier.STATIC, Modifier.FINAL)
        .initializer("$S", logConstantValue)
        .build());

    // 将生成的类写入文件
    JavaFile.builder("com.yourpackage", constantClass.build())
        .build()
        .writeTo(processingEnv.getFiler());
}

注意事项 #

• 仅能获取源码中存在的元素的行号，编译时动态生成的元素（如代理类、处理器生成的类）无法定位行号，会返回-1；
• 确保编译环境正确传递了源码路径，否则CompilationUnitTree无法获取有效的行映射关系；
• 若需要方法的结束行号，可替换为getSourcePositions().getEndPosition()计算。

内容的提问来源于stack exchange，提问作者Thorbjørn Andersen - UFST