IDEA插件之快速刪除Java代碼中的注釋

更新時(shí)間：2021年02月18日 10:54:57 作者：xiaoxi666

這篇文章主要介紹了IDEA插件之快速刪除Java代碼中的注釋,本文給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

背景

有時(shí)，我們需要?jiǎng)h除Java源代碼中的注釋。目前有不少方法，比如：

實(shí)現(xiàn)狀態(tài)機(jī)。該方式較為通用，適用于多種語(yǔ)言（取決于狀態(tài)機(jī)支持的注釋符號(hào)）。
正則匹配。該方式容易誤判，尤其是容易誤刪字符串。
利用第三方庫(kù)。該方式局限性較強(qiáng)，比如不同語(yǔ)言可能有不同的第三方庫(kù)。

本文針對(duì)Java語(yǔ)言，介紹一種利用第三方庫(kù)的方式，可以方便快速地移除代碼中的注釋。

原理

這個(gè)第三方庫(kù)叫做JavaParser。它可以分析Java源碼，并生成語(yǔ)法分析樹（AST），其中注釋也屬于AST中的節(jié)點(diǎn)。

因此核心思路即為：

JavaParser解析源碼并得到AST。
識(shí)別出注釋類型的節(jié)點(diǎn)并將其刪掉。
將AST中剩余的節(jié)點(diǎn)按一定規(guī)則打印出來(lái)。

在實(shí)踐之前，我們先要了解Java中的幾種注釋類型：

LineComment 單行注釋。
BlockComent 塊注釋。
JavadocComment Java文檔注釋。

下面舉個(gè)簡(jiǎn)單例子，說(shuō)明三種注釋的區(qū)別：

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注釋的區(qū)別，我只有一個(gè)星號(hào) */
    int b = 2;
    /*
     * 我是塊注釋
     */
    int c = 3;
    String s1 = "http:// 我是字符串中的內(nèi)容，不是注釋";
    String s2 = "/* 我是字符串中的內(nèi)容，不是注釋 */";
    String s3 = "/** 我是字符串中的內(nèi)容，不是注釋 */";
  }
}

下面我們實(shí)踐一下，看看怎么移除源碼中的注釋。
我這里使用maven管理項(xiàng)目，首先引入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
 * 幾個(gè)注釋的概念：
 * 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);
  }

  /**
   * 創(chuàng)建源碼解析器。我們?cè)O(shè)置LexicalPreservationEnabled為true，保留源碼中的所有語(yǔ)法。
   *
   * @return JavaParser
   */
  private static JavaParser createJavaParser() {
    ParserConfiguration parserConfiguration = new ParserConfiguration();
    parserConfiguration.setLexicalPreservationEnabled(true);
    return new JavaParser(parserConfiguration);
  }

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

在上面的代碼中，我們首先創(chuàng)建JavaParser，再解析源碼，然后移除單行注釋和塊注釋，最后再用LexicalPreservingPrinter將處理后的源碼打印出來(lái)，這個(gè)打印器可以保留源代碼所有詞法，比如空格、換行之類的元素。上述代碼已有注釋，因此不再詳述。

封裝為IDEA插件

考慮到我們平時(shí)可能會(huì)大量使用該功能，因此將其封裝為了IDEA插件，名為remove.comments。下面簡(jiǎn)要介紹該插件的工作原理及使用方式。

PS：本文不會(huì)詳細(xì)介紹如何編寫IDEA插件。

IDEA插件的原理基本都是事件驅(qū)動(dòng)，如下圖所示，我們創(chuàng)建了一個(gè)事件監(jiān)聽器，當(dāng)檢測(cè)到編輯器中點(diǎn)擊右鍵后，即可彈出菜單，我們的插件在菜單中的第一個(gè)位置。

接下來(lái)，實(shí)現(xiàn)事件處理器：

其中包含兩段核心代碼：

刪除源碼注釋。首先讀取當(dāng)前文件內(nèi)容也即源碼，然后交給前面已經(jīng)介紹過(guò)的CommentsRemover.doAction處理，就拿到了刪除注釋后的源碼。
格式化代碼。刪除注釋后，可能會(huì)引入多余的空格，因此我們自動(dòng)格式化，這樣用戶就不用再手動(dòng)格式化一次了。

/**
 * 移除代碼中的注釋
 *
 * @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;
}

/**
 * 由于我們保留了源碼格式，移除注釋之后會(huì)引入不必要的空格，因此需要再格式化一下
 *
 * @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();
}

然后打包插件：