Insertion automatique de code Java basée sur l'Arbre syntaxique

L'insertion de code est un moyen courant de tester et de localiser les problèmes,En insérant le code correspondant à l'emplacement du Code（“Pile”）,Pour imprimer ou recueillir les données dont nous avons besoin.

Insertion automatique de pieux,C'est - à - dire à un endroit précis du Code,Insérer automatiquement une ou plusieurs lignes de code dont nous avons besoin.D'habitude, nous mettons des piles sur le Code compilé,L'avantage est d'éviter l'intrusion dans le code source,Dans une certaine mesure, les différents styles de Code des développeurs sont masqués.Ici.,Nous nous concentrons sur une autre façon d'insérer des pieux dans le code source,Si l'intrusion dans le Code n'est pas prise en compte,Il est donc plus intuitif d'insérer des pieux directement dans le code source,Il est plus facile de contrôler et de déboguer,Plus grande flexibilité,Et l'approche que cet article va introduire ne tient pas compte des différents styles de code.

Exigences relatives à l'insertion des pieux

package com.ast.pkg;

public class ASTDemo {
    int intData = 0;
    double floatData = 0;
    String strData = "";

    //construction
    public ASTDemo() {
        this.intData = 123;
        this.floatData = 3.14;
        this.strData = "It's been a long time.";
    }

    public void setIntData(int data) {
        this.intData = data;
    }

    public String getStrData() {
        return this.strData;
    }

    public void methodDemo(String param1, String param2) {
        if (null == param1 || null == param2) {
            return;
        }

        if (param1.length() > param2.length()) {
            strData = strData + param1;
        } else {
            strData = strData + param2;
        }
    }
}

Apparemment., On n'a pas pu mettre le pieu directement , Parce que de cette façon, même si vous pouvez localiser exactement la première ligne de chaque méthode , Toujours pas universel , Le même Code est écrit différemment , Ou ajouter une structure de code complexe , Ou une autre habitude d'écrire , Non seulement la première ligne du Code n'est pas reconnue , Même le réaménagement ,C'est très compliqué.. Ensuite, changeons d'avis et mettons les pieux .

JavaComposition du Code

• Nom du paquet

• Nom de la classe

• Trois attributs dans la classe

• Une méthode de construction à l'intérieur d'une classe et les déclarations qu'elle contient

• Trois méthodes communes dans la classe et les déclarations qu'elles contiennent

  
  Selon leur relation d'inclusion , Vous pouvez dessiner un tel arbre ： 

  

  
  

Arbre de syntaxe abstrait

Celui - ci là - haut"Arbre" C'est très intuitif , Mais cela montre aussi que le Code peut être abstrait sous forme d'arbre . Ensuite, nous dessinons l'arbre à une plus petite granularité .

      Arbre de syntaxe abstrait（AST） Est une représentation abstraite de la syntaxe source , Il représente la structure du Code sous forme d'arbre .En fait,Eclipse Le code source est déjà disponible ASTReprésentation, Pour aider les développeurs à être plus complets 、 Analyse claire de la structure et des relations du Code .
      Ce que nous allons réaliser ici, c'est l'insertion automatique de pieux , Ce qui signifie que nous devons analyser la structure du Code en temps réel , Ensuite, insérez le code préparé au bon endroit , Et assurez - vous que le Code post - pile peut être compilé 、Mise en œuvre.

JavaParser

• Maven

<dependency>
    <groupId>com.github.javaparser</groupId>
    <artifactId>javaparser-core-serialization</artifactId>
    <version>3.6.5</version>
</dependency>
<dependency>
    <groupId>com.github.javaparser</groupId>
    <artifactId>javaparser-core</artifactId>
    <version>3.6.5</version>
</dependency>

• Gradle

implementation 'com.github.javaparser:javaparser-symbol-solver-core:3.6.5'
implementation 'com.github.javaparser:javaparser-core:3.6.5'

Notez que la version référencée ne doit pas être inférieure à 3.6.4, Sinon, il y aura toutes sortes de problèmes difficiles .

2）AnalyseJavaCode source
      DépendanceJavaParserOutils,On a juste besoin d'entrer.".java"Flux d'entrée du fichier, Pour compléter l'analyse du code source .

String javaFilePath = "ASTDemo.java";
FileInputStream in = null;
        
try {
    in = new FileInputStream(javaFilePath);
    CompilationUnit compilationUnit =   JavaParser.parse(in);
} catch (FileNotFoundException e) {
    e.printStackTrace();
} finally {
    if (null != in) {
        try {
            in.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

JavaParserDansparseMéthodes, Génère un arbre de code basé sur le code source ,EtCompilationUnitType de retour.CompilationUnitClasse àcom.github.javaparser.astSous le sac., Introduction normale JavaParserOn peut l'utiliser.. En interrompant la forme du point , Regardons la composition de l'objet ：

Pour les structures arborescentes , L'attribut le plus facile à comprendre est childNodeC'est,Au noeud racinecompilationUnit Il y a deux noeuds enfants sur , L'un est le nom du paquet auquel il appartient ,L'un estASTDemoCatégorie, Il y a sept autres noeuds enfants sous le noeud de classe , En plus du noeud nom de classe ,En plus6 Les noeuds représentent chacun trois variables d'attribut de classe , Une méthode de construction et trois méthodes ordinaires .
      Spécifique à une méthode ,ParmethodDemo(String, String)Par exemple,Il a5Sous - noeud：

Nom de la méthode ,Deux paramètres,Valeur de retour et corps de la méthode,Nous le savons tous., Le Code dans cette méthode est ：

if (null == param1 || null == param2) {
    return;
}
if (param1.length() > param2.length()) {
    strData = strData + param1;
} else {
    strData = strData + param2;
}

Continuez à suivre vers l'intérieur , Il y a deux sous - noeuds sous le noeud corps de la méthode , Chacun représente deux if

Et ainsi de suite., Quand vous affinez une déclaration , Encore une structure similaire , Par exemple, un énoncé d'affectation strData = strData + param1; Utilisez cette instruction comme noeud racine pour contenir deux noeuds enfants , À gauche et à droite de l'assignation ：

"="En tant que“Affectation(ASSIGN)”Fonctionnement, Sauvegardé sur le noeud racine operatorDans les propriétés：

De même pour"="À droite.,Il y a deux noeudsstrDataEtparam2, Et le logo PLUSFonctionnementopratorPropriétés：

Vous pouvez voir que l'arbre de syntaxe abstrait contient toutes les informations du code source ,Dans cet arbre, Nous pouvons localiser avec précision n'importe quelle structure de code que nous devons identifier .

Traverser l'arbre de syntaxe

VoidVisitorAdapterDevisit La méthode est définie pour chaque type , Ce que nous devons identifier ici, c'est la méthode de construction et la méthode ordinaire ,Ainsi, la réalisationConstructorDeclarationEtMethodDeclaration Deux types suffisent .

VoidVisitorAdapter<Object> adapter = new VoidVisitorAdapter<Object>() { 
    public void visit(MethodDeclaration methodDeclaration, Object obj) {
        ......
    }
    public void visit(ConstructureDeclaration methodDeclaration, Object obj) {
        ......
    }
};

visit La méthode est la logique de traitement lorsqu'un noeud de type correspondant est rencontré . Il faut donc qu'on y mette des pieux .

String pileContent = "System.out.println(...)";
ExpressionStmt expressionStmt = new ExpressionStmt();
expressionStmt.setExpression(pileContent);

Et puis..., On va mettre ce noeud au bon endroit , L'exigence est la première ligne de chaque Code de méthode , Convertir en Arbre syntaxique, c'est - à - dire ajouter ce noeud avant le premier enfant du noeud corps de la méthode ：

methodDeclaration.getBody().get().getStatements().add(0, expressionStmt);

Ce qui est particulièrement important ici, c'est que, Si c'est la méthode de construction de la Sous - classe ,Parce que l'appel
super() À la première ligne , On peut donc juger si la première ligne de la méthode de construction est superMéthodes, Alors ce noeud doit être inséré dans la deuxième position ,Sinon, une erreur sera signalée lors de la compilation.
On peut appeleradapterDevisitMéthodes, Objet d'arbre syntaxique généré avant de passer ,Commencez à traverser：

adapter.visit(compilationUnit, null);

Après avoir traversé , Le Code par défaut est inséré sous chaque noeud de méthode .
Enfin,AppelezCompilationUnitDetoString() La méthode transforme l'arbre de code en source , Imprimé au même endroit ".java"Dans le document, Et écraser les données originales , Achèvement de l'insertion automatique des pieux .