IDEA外掛：快速刪除Java程式碼中的註釋

xiaoxi666發表於2021-02-17

IdeaJava

背景

有時，我們需要刪除Java原始碼中的註釋。目前有不少方法，比如：

實現狀態機。該方式較為通用，適用於多種語言（取決於狀態機支援的註釋符號）。
正則匹配。該方式容易誤判，尤其是容易誤刪字串。
利用第三方庫。該方式侷限性較強，比如不同語言可能有不同的第三方庫。

本文針對Java語言，介紹一種利用第三方庫的方式，可以方便快速地移除程式碼中的註釋。

原理

這個第三方庫叫做JavaParser。它可以分析Java原始碼，並生成語法分析樹（AST），其中註釋也屬於AST中的節點。

因此核心思路即為：

JavaParser解析原始碼並得到AST。
識別出注釋型別的節點並將其刪掉。
將AST中剩餘的節點按一定規則列印出來。

在實踐之前，我們先要了解Java中的幾種註釋型別：

LineComment 單行註釋。
BlockComent 塊註釋。
JavadocComment Java文件註釋。

下面舉個簡單例子，說明三種註釋的區別：

import java.util.ArrayList;
import java.util.stream.Collectors;

/**
 * @author xiaoxi666
 * @date 2021-02-15 17:13
 * 我是 Javadoc 註釋
 */
public class Input {
    /**
     * 我是 Javadoc 註釋
     *
     * @param param1
     * @param param2
     */
    public static void someMethod(String param1, // 我是單行註釋
                                  String param2
// 我是單行註釋 String param3,
/* 我是塊註釋 String param4,
                                  String param5,
                                  String param6 */
        /* 我是塊註釋 String param4 */)
 {
        // 我是單行註釋
        int a = 1;
        /* 我是塊註釋，注意我和Javadoc註釋的區別，我只有一個星號 */
        int b = 2;
        /*
         * 我是塊註釋
         */
        int c = 3;
        String s1 = "// 我是字串中的內容，不是註釋";
        String s2 = "/* 我是字串中的內容，不是註釋 */";
        String s3 = "/** 我是字串中的內容，不是註釋 */";
    }
}

下面我們實踐一下，看看怎麼移除原始碼中的註釋。
我這裡使用maven管理專案，首先引入JavaParser依賴：

<dependencies>
    <dependency>
         <groupId>com.github.javaparser</groupId>
         <artifactId>javaparser-symbol-solver-core</artifactId>
         <version>3.18.0</version>
    </dependency>
</dependencies>

然後編寫核心程式碼：

package core;

import com.github.javaparser.JavaParser;
import com.github.javaparser.ParseResult;
import com.github.javaparser.ParserConfiguration;
import com.github.javaparser.ast.CompilationUnit;
import com.github.javaparser.ast.Node;
import com.github.javaparser.ast.comments.BlockComment;
import com.github.javaparser.ast.comments.Comment;
import com.github.javaparser.ast.comments.LineComment;
import com.github.javaparser.printer.lexicalpreservation.LexicalPreservingPrinter;

import java.util.List;
import java.util.Optional;
import java.util.stream.Collectors;

/**
 * @author xiaoxi666
 * @date 2021-02-15 20:09
 * 幾個註釋的概念：
 * LineComment
 * BlockComment
 * JavadocComment
 */
public final class CommentsRemover {
    private CommentsRemover() {}

    public static String doAction(String content) {
        JavaParser javaParser = createJavaParser();
        ParseResult<CompilationUnit> result = javaParser.parse(content);
        Optional<CompilationUnit> optionalCompilationUnit = result.getResult();
        if (!optionalCompilationUnit.isPresent()) {
            return "";
        }
        CompilationUnit compilationUnit = optionalCompilationUnit.get();
        removeComments(compilationUnit);
        return LexicalPreservingPrinter.print(compilationUnit);
    }

    private static void removeComments(CompilationUnit compilationUnit) {
        List<Comment> comments = compilationUnit.getAllContainedComments();
        List<Comment> unwantedComments = comments
            .stream()
            .filter(CommentsRemover::isValidCommentType)
            .collect(Collectors.toList());
        unwantedComments.forEach(Node::remove);
    }

    /**
     * 建立原始碼解析器。我們設定LexicalPreservationEnabled為true，保留原始碼中的所有語法。
     *
     * @return JavaParser
     */
    private static JavaParser createJavaParser() {
        ParserConfiguration parserConfiguration = new ParserConfiguration();
        parserConfiguration.setLexicalPreservationEnabled(true);
        return new JavaParser(parserConfiguration);
    }

    /**
     * 我們只識別單行註釋和塊註釋
     *
     * @param comment
     * @return true if meet the correct type
     */
    private static boolean isValidCommentType(Comment comment) {
        return comment instanceof LineComment || comment instanceof BlockComment;
    }
}

在上面的程式碼中，我們首先建立JavaParser，再解析原始碼，然後移除單行註釋和塊註釋，最後再用LexicalPreservingPrinter將處理後的原始碼列印出來，這個列印器可以保留原始碼所有詞法，比如空格、換行之類的元素。上述程式碼已有註釋，因此不再詳述。

封裝為IDEA外掛

考慮到我們平時可能會大量使用該功能，因此將其封裝為了IDEA外掛，名為remove.comments。下面簡要介紹該外掛的工作原理及使用方式。PS：本文不會詳細介紹如何編寫IDEA外掛。

IDEA外掛的原理基本都是事件驅動，如下圖所示，我們建立了一個事件監聽器，當檢測到編輯器中點選右鍵後，即可彈出選單，我們的外掛在選單中的第一個位置。

接下來，實現事件處理器：

其中包含兩段核心程式碼：

刪除原始碼註釋。首先讀取當前檔案內容也即原始碼，然後交給前面已經介紹過的CommentsRemover.doAction處理，就拿到了刪除註釋後的原始碼。
格式化程式碼。刪除註釋後，可能會引入多餘的空格，因此我們自動格式化，這樣使用者就不用再手動格式化一次了。

/**
 * 移除程式碼中的註釋
 *
 * @param editor
 * @return true if remove comments successfully
 */
private boolean removeComments(Editor editor) {
    String src = editor.getDocument().getText();
    if (Strings.isNullOrEmpty(src)) {
        return false;
    }
    String dst = CommentsRemover.doAction(checkEndLineAndModifyIfNeed(src));
    if (Strings.isNullOrEmpty(dst)) {
        return false;
    }
    editor.getDocument().setText(dst);
    return true;
}

/**
 * 由於我們保留了原始碼格式，移除註釋之後會引入不必要的空格，因此需要再格式化一下
 *
 * @param editor
 * @param project
 */
private void reformat(Editor editor, Project project) {
    PsiDocumentManager.getInstance(project).commitAllDocuments();
    PsiFile file = PsiDocumentManager.getInstance(project).getPsiFile(editor.getDocument());
    if (file == null) {
        return;
    }
    LastRunReformatCodeOptionsProvider provider = new LastRunReformatCodeOptionsProvider(PropertiesComponent.getInstance());
    ReformatCodeRunOptions currentRunOptions = provider.getLastRunOptions(file);
    TextRangeType processingScope = TextRangeType.WHOLE_FILE;
    currentRunOptions.setProcessingScope(processingScope);
    (new FileInEditorProcessor(file, editor, currentRunOptions)).processCode();
}