如何从 java.lang.Class 对象获取源文件名/行号

Question

给定java.lang.Class 对象，是否有可能获取源文件名和声明类的行号？

数据应该在.class 文件的调试信息中可用。我所知道的JDK返回此类调试信息的唯一地方是java.lang.StackTraceElement，但我不确定是否可以强制Java为任意类创建java.lang.StackTraceElement实例，因为我们没有执行方法在课堂上。

我的确切用例是一个匿名内部类，它有一个编译器生成的名称。我想知道类声明的文件名和行号。

我不喜欢使用字节码操作框架，但如果需要，我可以回退到它。

Answer 1

这个问题的答案归结为您对实现侦听器的代码有多少控制权。你是对的，没有方法就不可能创建堆栈跟踪。

一般技术是在构造函数中创建一个 Exception()，但不要抛出它。这包含堆栈跟踪信息，您可以根据需要使用这些信息。这将为您提供构造函数的行号，而不是类的行号。请注意，这种方法也不是特别高效，因为创建堆栈跟踪的成本很高。

您需要：

1. 强制在构造函数中执行一些代码（如果您的 Listener 是您控制的抽象类，则相对容易）
2. 以某种方式检测代码（这里的治疗方法似乎比疾病更糟糕）。
3. 对类的命名方式做出一些假设。
4. 读取 jar（与 javac -p 执行相同操作）

对于 1)，您只需将异常创建放在抽象类中，然后子类调用构造函数：

class Top {
    Top() {
        new Exception().printStackTrace(System.out);
    }
}

class Bottom extends Top {
    public static void main(String[] args) {
        new Bottom();
    }
}

这会产生类似：

java.lang.Exception
    at uk.co.farwell.stackoverflow.Top.<init>(Top.java:4)
    at uk.co.farwell.stackoverflow.Bottom.<init>(Bottom.java: 11)
    at uk.co.farwell.stackoverflow.Bottom.main(Bottom.java: 18)

一般来说，遵循一些命名规则：如果你有一个名为Actor的外部类和一​​个名为Consumer的内部类，那么编译后的类将称为Actor$Consumer。匿名内部类是按照它们在文件中出现的顺序命名的，所以 Actor$1 将在 Actor$2 之前出现在文件中。我不认为这实际上是在任何地方指定的，所以这可能只是一个约定，如果您正在使用多个 jvm 等进行复杂的操作，则不应依赖它。

正如 jmg 所指出的，您可以在同一个文件中定义多个顶级类。如果你有一个公共类 Foo，它必须在 Foo.java 中定义，但一个非公共类可以包含在另一个文件中。上面的方法可以解决这个问题。

解释：

如果你反汇编java（javap -c -verbose），你会看到调试信息中有行号，但它们只适用于方法。使用以下内部类：

static class Consumer implements Runnable {
    public void run() {
        // stuff
    }
}

javap 输出包含：

uk.co.farwell.stackoverflow.Actors$Consumer();
  Code:
   Stack=1, Locals=1, Args_size=1
   0:   aload_0
   1:   invokespecial   #10; //Method java/lang/Object."<init>":()V
   4:   return
  LineNumberTable: 
   line 20: 0

  LocalVariableTable: 
   Start  Length  Slot  Name   Signature
   0      5      0    this       Luk/co/farwell/stackoverflow/Actors$Consumer;

LineNumberTable 包含适用于方法的行号列表。所以我的 Consumer 构造函数从第 20 行开始。但这是构造函数的第一行，而不是类的第一行。它只是同一行，因为我使用的是默认构造函数。如果我添加一个构造函数，那么行号将会改变。编译器不存储声明类的行。因此，如果不解析 java 本身，您将无法找到声明类的位置。你根本没有可用的信息。

但是，如果您使用的是匿名内部类，例如：

Runnable run = new Runnable() {
    public void run() {
    }
};

那么构造函数和类的行号会匹配[*]，所以这会给你一个行号。

[*] 除非“new”和“Runnable()”在不同的行。

Answer 2

你可以找到uut当前的代码行：

Throwable t = new Throwable();
System.out.println(t.getStackTrace()[0].getLineNumber());

但看起来StackTraceElements 是由Throwable 内部的原生JDK 方法创建的。

public synchronized native Throwable fillInStackTrace();

如果您使用字节码操作框架，向创建 throwable 的类添加方法，您将无法获得正确的类声明代码行。

Answer 3

您可以通过调用getStackTrace() 从任何线程获取堆栈跟踪。因此，对于当前线程，您必须调用 Thread.currentThread().getStackTrace()。

Answer 4

出于您的目的，仅为其堆栈跟踪生成异常是正确的答案。

但在这不起作用的情况下，您也可以使用Apache BCEL 来分析Java 字节码。如果这听起来像是矫枉过正，那么您可能是对的。

public boolean isScala(Class jvmClass) {
   JavaClass bpelClass = Repository.lookupClass(jvmClass.getName());
   return (bpelClass.getFileName().endsWith(".scala");
}

（警告：我尚未测试此代码。）

另一种选择是构建自定义 doclet 以在编译时收集适当的元数据。我过去曾将它用于需要在运行时了解特定超类的所有子类的应用程序。将它们添加到工厂方法太笨拙了，这也让我可以直接链接到 javadoc。

现在我正在使用 Scala 编写新代码，我正在考虑使用类似上述的技术，并通过搜索构建目录来生成类列表。

Answer 5

我就是这样做的：

import java.io.PrintWriter;
import java.io.StringWriter;

/**
 * This class is used to determine where an object is instantiated from by extending it. 
 */
public abstract class StackTracer {

    protected StackTracer() {
        System.out.println( shortenedStackTrace( new Exception(), 6 ) );
    }

    public static String shortenedStackTrace(Exception e, int maxLines) {
        StringWriter writer = new StringWriter();
        e.printStackTrace( new PrintWriter(writer) );
        String[] lines = writer.toString().split("\n");
        StringBuilder sb = new StringBuilder();
        for (int i = 0; i < Math.min(lines.length, maxLines); i++) {
            sb.append(lines[i]).append("\n");
        }
        return sb.toString();
    }

}

编辑：回想起来，我现在可能会使用 AOP 来执行此操作。事实上，对this project 进行一些小改动，我或许可以做到。 Here is a stack question 有提示。

Answer 6

这个答案不包括行号，但它满足了我的需要，应该适用于你拥有的任何源文件。

这是针对具有多个项目的 IDE 根据类文件查找源文件位置的答案。它利用类加载器和您的 java 项目约定来解决这个问题。

您需要更新源文件夹 (src) 和输出文件夹 (bin) 以符合您的约定。您必须提供自己的

实现

String searchReplace(old, new, inside)

这里是代码

public static String sourceFileFromClass(Class<?> clazz) {
    String answer = null;
    try {
        if (clazz.getEnclosingClass() != null) {
            clazz = clazz.getEnclosingClass();
        }
        String simpleName = clazz.getSimpleName();

        // the .class file should exist from where it was loaded!
        URL url = clazz.getResource(simpleName + ".class");
        String sourceFile = searchReplace(".class", ".java", url.toString());
        sourceFile = searchReplace("file:/", "", sourceFile);
        sourceFile = searchReplace("/bin/", "/src/", sourceFile);
        if( new java.io.File(sourceFile).exists() ) {
            answer = sourceFile;
        }
    }
    catch (Exception ex) {
        // ignore
    }

    return answer;
}

Answer 7

是否可以给定一个 java.lang.Class 实例来获取源文件名和声明该类的行号？

源文件在大多数情况下与类名密切相关。该文件中只有一行声明了该类。这种明确的信息不需要在调试信息中编码。

数据应该在 .class 文件的调试信息中可用

为什么？