[ASTParser 1]ASTParser でクラス名やフィールド、メソッドの概要を取得する | 坂道で
Amebaホームピグアメブロ
芸能人ブログ人気ブログ
新規登録
ログイン

坂道で

ゆるめ

[ASTParser 1]ASTParser でクラス名やフィールド、メソッドの概要を取得する

このテーマ[Java / ASTParser]では、EclipseのASTParserという機能を利用してJavaソースコードの解析や変換の方法について、ユルク解説していく。

「ASTP・・・なんぞや？」という人は「Javaのソースコードから色々な情報を取得できるライブラリ」程度の認識でいいと思う。
もう少し詳しく知りたい場合は「Eclipse/プラグイン開発のTIPS集/ソースコードを解析するパーサASTParser」 あたりを読めばいいと思う。
セットアップ(?)の仕方は「EclipseのASTParserを単体で使う」が分かりやすい。

とりあえずサンプルコードの紹介と解説をしていく。
文字数の都合上、全てのコードをこのページに貼り付けることができない為、全体を眺めたい場合は、Githubのリポジトリの方を見て欲しい。
下に、サンプルコアとなる2つのファイル Sample1.java と SampleVisitor1.java を貼りつけている。

大雑把に言えば、Sample1.java には主にオマジナイASTParserでソースコードを解析する為の環境設定のような処理が記述されている。
そして、もう一方の SampleVisitor1.java でクラスの情報の取得を行なっている。

Sample1.java
  1. package info.haxahaxa.astparser.sample;
  3. import info.haxahaxa.astparser.Envs;
  4. import info.haxahaxa.astparser.SourceFile;
  5. import info.haxahaxa.astparser.sample.visitor.*;
  7. import java.io.File;
  9. import org.eclipse.core.runtime.NullProgressMonitor;
  10. import org.eclipse.jdt.core.dom.AST;
  11. import org.eclipse.jdt.core.dom.ASTParser;
  12. import org.eclipse.jdt.core.dom.ASTVisitor;
  13. import org.eclipse.jdt.core.dom.CompilationUnit;
  16. /**
  17. * クラス名やフィールド，メソッドの概要を表示するサンプル
  18. *
  19. * @author satanabe1
  20. *
  21. */
  22. public class Sample1 {
  23.     private static ASTVisitor visitor = new SampleVisitor1();
  25.     public static void main(String[] args) throws Exception {
  26.         SourceFile sourceFile = new SourceFile("src" + File.separator
  27.                 + "samples" + File.separator + "AntFileGen.java");
  28.         CompilationUnit unit;
  29.         ASTParser astParser = ASTParser.newParser(AST.JLS4);
  30.         // 以下の setBindingsRecovery setStatementsRecovery はおまじない．
  31.         // 完成しているソースコードを解析する時は呼ぶ必要ない．
  32.         // 詳しく知りたいならば，IMBのASTParser関連のドキュメントとかを参照すべき．
  33.         astParser.setBindingsRecovery(true);
  34.         astParser.setStatementsRecovery(true);
  35.         // 次の setResolveBindings と setEnvironment が重要！！
  36.         // setResolveBindings(true) をしておかないとまともに解析はできない．
  37.         // setResolveBindings をまともに機能させるために setEnvironment が必要．
  38.         astParser.setResolveBindings(true);
  39.         // setEnvironment の第一引数にはクラスパスの配列．第二引数にはソースコードを検索するパスの配列
  40.         // 第三第四については何も考えず null, true ．納得いかない時はIBMのASTPa...
  41.         astParser.setEnvironment(Envs.getClassPath(), Envs.getSourcePath(),
  42.                 null, true);
  44.         // 解析対象のソースコードの入力とか
  45.         astParser.setUnitName(sourceFile.getFilePath());// なんでもいいから名前を設定しておく
  46.         astParser.setSource(sourceFile.getSourceCode().toCharArray());// 解析対象コードを設定する
  47.         unit = (CompilationUnit) astParser.createAST(new NullProgressMonitor());
  48.         unit.recordModifications();// ASTへの操作履歴のようなものを有効に
  49.         // 解析実行
  50.         unit.accept(visitor);
  51.     }
  52. }

SampleVisitor1.java
  1. package info.haxahaxa.astparser.sample.visitor;
  3. import info.haxahaxa.astparser.PrintUtil;
  5. import java.util.List;
  7. import org.eclipse.jdt.core.dom.ASTVisitor;
  8. import org.eclipse.jdt.core.dom.FieldDeclaration;
  9. import org.eclipse.jdt.core.dom.ITypeBinding;
  10. import org.eclipse.jdt.core.dom.IVariableBinding;
  11. import org.eclipse.jdt.core.dom.MethodDeclaration;
  12. import org.eclipse.jdt.core.dom.TypeDeclaration;
  13. import org.eclipse.jdt.core.dom.VariableDeclarationFragment;
  16. /**
  17. * クラス名やフィールド，メソッドの概要を表示するサンプル
  18. *
  19. * @author satanabe1
  20. *
  21. */
  22. public class SampleVisitor1 extends ASTVisitor {
  23.     /**
  24.      * クラス宣言が見つかると呼ばれるメソッド
  25.      */
  26.     public boolean visit(TypeDeclaration node) {
  27.         PrintUtil.printTitle("クラス宣言");
  29.         ITypeBinding typeBinding = node.resolveBinding();// 詳細な情報をITypeBindingインスタンスを使って取得したい
  30.         ITypeBinding superClass = typeBinding.getSuperclass();// 親クラスの取得
  31.         ITypeBinding[] interfaces = typeBinding.getInterfaces();// インターフェースの取得
  32.         String className = typeBinding.getBinaryName();// クラス名の取得
  33.         int modifiers = typeBinding.getModifiers();// "public static"とかの識別子
  35.         PrintUtil.printMessage("ClassName", className);
  36.         PrintUtil.printModifiers("Modifiers", modifiers);
  37.         PrintUtil.printMessage("SuperClass", superClass.getBinaryName());
  38.         PrintUtil.printMessage("Interfaces", interfaces);
  39.         return super.visit(node);
  40.     }
  42.     /**
  43.      * フィールド宣言が見つかると呼ばれるメソッド
  44.      */
  45.     public boolean visit(FieldDeclaration node) {
  46.         PrintUtil.printTitle("フィールド宣言");
  47.         PrintUtil.printModifiers("Modifiers", node.getModifiers());
  48.         PrintUtil.printMessage("Type", node.getType().toString());
  50.         List fragments = node.fragments();
  51.         for (Object frg : fragments) {
  52.             if (frg instanceof VariableDeclarationFragment) {
  53.                 IVariableBinding variableBinding = ((VariableDeclarationFragment) frg)
  54.                         .resolveBinding();
  55.                 PrintUtil.printMessage("Name", variableBinding.getName());
  56.             }
  57.         }
  58.         return super.visit(node);
  59.     }
  61.     /**
  62.      * メソッド宣言が見つかると呼ばれるメソッド
  63.      */
  64.     public boolean visit(MethodDeclaration node) {
  65.         PrintUtil.printTitle("メソッド宣言");
  66.         PrintUtil.printMessage("MethodName", node.getName()
  67.                 .getFullyQualifiedName());
  68.         PrintUtil.printModifiers("Modifiers", node.getModifiers());
  69.         PrintUtil.printMessage("ReturnType", node.getReturnType2() + "");
  70.         PrintUtil.printMessage("Parameters", node.parameters().toString());
  71.         return super.visit(node);
  72.     }
  73. }

Sample1.java のmainメソッド内の処理で注目すべきポイントとしては、
  1. ASTParserクラスのインスタンスに対してsetResolveBindingsとかsetEnvironmentとかのメソッドで環境設定
  2. 更に前述のインスタンスに対してsetSourceメソッドで解析対象のソースコードをセット(46行目)
  3. CompilationUnitのインスタンスを取得してacceptメソッドで解析実行(50行目)
くらい。 基本的にはこの一連の処理が定型と考えていいと思う。

SampleVisitor1.java の注目すべきポイントは2つ。
  1. ASTVisitorクラスを継承(22行目)
  2. boolean visit(型名 node) メソッドの宣言  (26/45/64行目)
このクラスで宣言されている3つのvisitメソッドはいずれもASTVisitorクラスのvisitメソッドをオーバーライドしている。
ここで覚えておくべき事としては、ASTVisitorクラスのvisitメソッドをオーバーライドすることで、
visitメソッドの引数の型に該当するソースコードを解析した時、勝手にそのvisitメソッドが実行されると言うこと。
つまり、自分が解析したい構文のvisitメソッドを作ってやれば簡単に解析できる。


解析に方法についてはもっと詳しいサイトがたくさんあるので、そちらに任せる。
次回からソースコードの変換について紹介しようと思う。