使用ANTLR进行Java源文件的静态分析

时间:2012-05-09 20:22:06

标签: java antlr

是否有人有完整的实现(可能是github或googlecode)来使用ANTLR语法文件和Java源代码来分析Java源代码。例如,我想简单地计算变量,方法等的数量。

还使用最新版本的ANTLR。

1 个答案:

答案 0 :(得分:12)

我以为在午休时间我会对此采取行动。这可能无法完全解决您的问题,但它可能会为您提供一个起点。该示例假设您在同一目录中执行所有操作。

  1. 从GitHub下载ANTLR source。来自ANTLR站点的预编译“完整”JAR包含已知错误。 GitHub仓库有修复。

  2. 解压缩ANTLR tarball。

    % tar xzf antlr-antlr3-release-3.4-150-g8312471.tar.gz
  3. 构建ANTLR“完整”JAR。

    % cd antlr-antlr3-8312471
    % mvn -N install
    % mvn -Dmaven.test.skip=true
    % mvn -Dmaven.test.skip=true package assembly:assembly
    % cd -
  4. 下载Java grammar。还有其他人,但我知道这个有效。

  5. 将语法编译为Java源代码。

    % mkdir com/habelitz/jsobjectizer/unmarshaller/antlrbridge/generated
    % mv *.g com/habelitz/jsobjectizer/unmarshaller/antlrbridge/generated
    % java -classpath antlr-antlr3-8312471/target/antlr-master-3.4.1-SNAPSHOT-completejar.jar org.antlr.Tool -o com/habelitz/jsobjectizer/unmarshaller/antlrbridge/generated Java.g
  6. 编译Java源代码。

    % javac -classpath antlr-antlr3-8312471/target/antlr-master-3.4.1-SNAPSHOT-completejar.jar com/habelitz/jsobjectizer/unmarshaller/antlrbridge/generated/*.java
  7. 添加以下源文件Main.java。

    import java.io.IOException;
    import java.util.List;
    import org.antlr.runtime.*; import org.antlr.runtime.tree.*;
    import com.habelitz.jsobjectizer.unmarshaller.antlrbridge.generated.*;
    public class Main { public static void main(String... args) throws NoSuchFieldException, IllegalAccessException, IOException, RecognitionException { JavaLexer lexer = new JavaLexer(new ANTLRFileStream(args[1], "UTF-8")); JavaParser parser = new JavaParser(new CommonTokenStream(lexer)); CommonTree tree = (CommonTree)(parser.javaSource().getTree()); int type = ((Integer)(JavaParser.class.getDeclaredField(args[0]).get(null))).intValue(); System.out.println(count(tree, type)); } private static int count(CommonTree tree, int type) { int count = 0; List children = tree.getChildren(); if (children != null) { for (Object child : children) { count += count((CommonTree)(child), type); } } return ((tree.getType() != type) ? count : count + 1); } }
  8. 编译。

    % javac -classpath .:antlr-antlr3-8312471/target/antlr-master-3.4.1-SNAPSHOT-completejar.jar Main.java
  9. 选择要计算的Java源类型;例如,VAR_DECLARATORFUNCTION_METHOD_DECLVOID_METHOD_DECL

    % cat com/habelitz/jsobjectizer/unmarshaller/antlrbridge/generated/Java.tokens
  10. 运行任何文件,包括最近创建的Main.java。

    % java -classpath .:antlr-antlr3-8312471/target/antlr-master-3.4.1-SNAPSHOT-completejar.jar Main VAR_DECLARATOR Main.java
    6
  11. 当然,这是不完美的。如果仔细观察,您可能已经注意到增强型for语句的局部变量未计算在内。为此,您需要使用FOR_EACH类型,而不是VAR_DECLARATOR

    您需要很好地理解Java源代码的元素,并能够对这些特定语法的定义如何匹配进行合理的猜测。您也无法进行参考计数。声明很简单,但计算字段的使用,例如,需要参考解析。 p.C.f是否引用包f内的类C的静态字段p,还是引用存储的对象的实例字段f通过类C的静态字段p?基本解析器不解析像Java这样复杂的语言的引用,因为一般情况可能非常困难。如果你想要这种级别的控制,你需要使用编译器(或更接近它的东西)。 Eclipse编译器是一种流行的选择。

    我还应该提到除了ANTLR之外还有其他选择。 JavaCC是另一个解析器生成器。静态分析工具PMD使用JavaCC作为其解析器生成器,允许您编写可用于您指定的计数类型的自定义规则。