IDEA插件：快速删除Java代码中的注释

时间  2021-02-17
标签 html java git github maven 编辑器 ide 性能 测试 栏目 Eclipse 繁體版
原文   原文链接

背景

有时，咱们须要删除Java源代码中的注释。目前有很多方法，好比：html

  • 实现状态机。该方式较为通用，适用于多种语言（取决于状态机支持的注释符号）。java

  • 正则匹配。该方式容易误判，尤为是容易误删字符串。git

  • 利用第三方库。该方式局限性较强，好比不一样语言可能有不一样的第三方库。

本文针对Java语言，介绍一种利用第三方库的方式，能够方便快速地移除代码中的注释。github

原理
 
这个第三方库叫作JavaParser。它能够分析Java源码，并生成语法分析树（AST），其中注释也属于AST中的节点。

所以核心思路即为：maven

  1. JavaParser解析源码并获得AST。编辑器

  2. 识别出注释类型的节点并将其删掉。ide

  3. 将AST中剩余的节点按必定规则打印出来。
在实践以前，咱们先要了解Java中的几种注释类型：

  • LineComment 单行注释。性能

  • BlockComent 块注释。测试

  • JavadocComment Java文档注释。ui

下面举个简单例子，说明三种注释的区别： 
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插件的原理基本都是事件驱动，以下图所示，咱们建立了一个事件监听器，当检测到编辑器中点击右键后，便可弹出菜单，咱们的插件在菜单中的第一个位置。

Image

接下来，实现事件处理器：

其中包含两段核心代码：

  • 删除源码注释。首先读取当前文件内容也即源码，而后交给前面已经介绍过的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();
}
而后打包插件：

Image
 
插件打包好以后，用户就能够从本地磁盘安装了：
 
Image

在弹出的目录树中，选中remove.comments.zip安装包，肯定便可。

重启IDEA后，能够看到插件已安装成功：

Image

此时咱们就能够使用该插件，一键删除代码中的注释了。演示一下效果：

Image

Image

不严格性能测试（响应时间包括插件处理时间和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」，后台回复「删除注释」，便可收到插件下载地址。

扩展
 
针对文中提出的第一种状态机思路，以前也写文章介绍过。有兴趣的读者可尝试动手实现一下。连接：http://www.javashuo.com/article/p-gqtqfiwc-ck.html
 
 
最后
 
再给本身的公众号打个广告，欢迎你们关注个人公众号：xiaoxi666，一块儿来玩一块儿学！
 
相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程