IDEA外掛：快速刪除Java程式碼中的註釋
阿新 • • 發佈：2021-02-17
背景
有時，我們需要刪除Java原始碼中的註釋。目前有不少方法，比如：
-
實現狀態機。該方式較為通用，適用於多種語言（取決於狀態機支援的註釋符號）。
-
正則匹配。該方式容易誤判，尤其是容易誤刪字串。
- 利用第三方庫。該方式侷限性較強，比如不同語言可能有不同的第三方庫。
本文針對Java語言，介紹一種利用第三方庫的方式，可以方便快速地移除程式碼中的註釋。
原理 這個第三方庫叫做JavaParser。它可以分析Java原始碼，並生成語法分析樹（AST），其中註釋也屬於AST中的節點。因此核心思路即為：
-
JavaParser解析原始碼並得到AST。
-
識別出注釋型別的節點並將其刪掉。
- 將AST中剩餘的節點按一定規則打印出來。
-
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;在上面的程式碼中，我們首先建立JavaParser，再解析原始碼，然後移除單行註釋和塊註釋，最後再用LexicalPreservingPrinter將處理後的原始碼打印出來，這個列印器可以保留原始碼所有詞法，比如空格、換行之類的元素。上述程式碼已有註釋，因此不再詳述。 封裝為IDEA外掛 考慮到我們平時可能會大量使用該功能，因此將其封裝為了IDEA外掛，名為remove.comments。下面簡要介紹該外掛的工作原理及使用方式。PS：本文不會詳細介紹如何編寫IDEA外掛。
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; } }
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();
}
然後打包外掛：
外掛打包好之後，使用者就可以從本地磁碟安裝了：
在彈出的目錄樹中，選中remove.comments.zip安裝包，確定即可。
重啟IDEA後，可以看到外掛已安裝成功：
此時我們就可以使用該外掛，一鍵刪除程式碼中的註釋了。演示一下效果：
不嚴格效能測試（響應時間包括外掛處理時間和IDEA介面更新時間）：
-
對於500行左右的檔案，響應時間約200ms，幾乎瞬間完成。
-
對於1000行左右的檔案，響應時間約為1s。
-
對於3000行左右的檔案，響應時間約需2s。
- 對於5000行左右的檔案，響應時間約需3s。
總之，日常使用毫無壓力。
總結
本文首先介紹了若干刪除註釋的手段；繼而介紹了一種利用第三方庫JavaParser刪除Java註釋的思路，並加以分析和實踐；最終將其封裝為IDEA外掛，方便其他使用者使用。
另外，由於本人對JavaParser的認知不是特別深入，難免存在未考慮到的場景。若大家在使用過程中發現bug，歡迎到github提issue甚至pr。
資源
原始碼均已放在github：https://github.com/xiaoxi666/remove.comments。
外掛也已經上傳至github，可點選下載。或者關注公眾號「xiaoxi666」，後臺回覆「刪除註釋」，即可收到外掛下載地址。
擴充套件 針對文中提出的第一種狀態機思路，之前也寫文章介紹過。有興趣的讀者可嘗試動手實現一下。連結：https://www.cnblogs.com/xiaoxi666/p/7931763.html 最後 再給自己的公眾號打個廣告，歡迎大家關注我的公眾號：xiaoxi666，一起來玩一起學！ Added to Top StoriesCommentGo to "Discover" > "Top Stories" > "Wow"
"Top Stories" is disabled Enable "Top Stories" in "Settings" > "General" > "Manage Discover" OKPosted
傳送到看一看
IDEA外掛：快速刪除Java程式碼中的註釋 Max 200 characters (already entered characters)Sending