intelliJ IDEA插件开发 获取当天文件的所有备注,方法,IF语名

package com.xpfirst;

import com.intellij.openapi.actionSystem.AnAction;
import com.intellij.openapi.actionSystem.AnActionEvent;
import com.intellij.openapi.actionSystem.PlatformDataKeys;
import com.intellij.openapi.editor.Document;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.project.Project;
import com.intellij.psi.*;
import com.intellij.psi.util.PsiUtilBase;

import javax.swing.tree.DefaultMutableTreeNode;
import java.io.CharArrayReader;
import java.io.IOException;
import java.io.LineNumberReader;

/*
 * @author gaojindan
 * @date 2019/4/3 0003 16:17
 * @des
 */
public class FunCheck extends AnAction{
    private final MyToolWin myToolWin = new MyToolWin();

    //root node
    private final DefaultMutableTreeNode rootNode = new DefaultMutableTreeNode("检查结果");
    //行node
    private final DefaultMutableTreeNode lineNode = new DefaultMutableTreeNode("行数超过80");
    //注释node
    private final DefaultMutableTreeNode commentNode = new DefaultMutableTreeNode("注释不规范");
    //if node
    private final DefaultMutableTreeNode ifNode = new DefaultMutableTreeNode("if语句不规范");

    /**
     * @author gaojindan
     * @date 2019/3/11 0011 17:08
     * @des 流程列表
     * @param  anActionEvent:目录ID
     * @return
     */
    @Override
    public void actionPerformed(AnActionEvent anActionEvent) {
        rootNode.removeAllChildren();
        lineNode.removeAllChildren();
        commentNode.removeAllChildren();
        ifNode.removeAllChildren();
        // 获取当前的project对象
        Project project = anActionEvent.getProject();
        // 获取当前文件对象
        Editor editor = anActionEvent.getData(PlatformDataKeys.EDITOR);
        PsiFile psiFile = PsiUtilBase.getPsiFileInEditor(editor, project);
        String fileName = psiFile.getName();
        Document document = PsiDocumentManager.getInstance(project).getDocument(psiFile);
        DefaultMutableTreeNode fileNode = new DefaultMutableTreeNode(fileName);
        // 遍历当前对象的所有属性
        for (PsiElement psiElement : psiFile.getChildren()) {
            System.out.println(psiElement);

            if (psiElement instanceof PsiClass){
                PsiClass psiClass = (PsiClass) psiElement;

                // 获取注释
                checkClassComment(document,psiClass);
                // 方法列表
                PsiMethod[] methods = psiClass.getMethods();
                for (PsiMethod psiMethod : methods) {
                    // 获取备注
                    checkMethodComment(document,psiMethod);
                    // 获取大括号里的内容
                    PsiCodeBlock psiCodeBlock = psiMethod.getBody();
                    String codeText = psiCodeBlock.getText();
                    long lineCount = getLineNumberByIo(codeText);
                    System.out.println("行数:" + lineCount);
                    // 行数大于80了,发出警告
                    if (lineCount > 80){
                        // 行号
                        int lineNumbers = document.getLineNumber(psiMethod.getTextOffset());
                        String text = psiMethod.getName()+"方法超过80行(line "+(lineNumbers+1)+")";
                        DefaultMutableTreeNode tmpTreeNode = new DefaultMutableTreeNode(text);
                        lineNode.add(tmpTreeNode);
                    }
                    // 检查if语句是否合格
                    checkIfStatement(document,psiCodeBlock);
                }
            }
        }
        // 显示输出内容
        rootNode.add(lineNode);
        rootNode.add(commentNode);
        rootNode.add(ifNode);
        fileNode.add(rootNode);
        myToolWin.addLineNode(fileNode);
        myToolWin.showToolWin(project);

    }

    /**
     * @author gaojindan
     * @date 2019/3/11 0011 17:08
     * @des 检查If语句规则
     * @param  psiElement:元素
     * @return
     */
    private void checkIfStatement(Document document,PsiElement psiElement){
        PsiElement[] psiElements =  psiElement.getChildren();
        for (PsiElement element : psiElements){
            // 如果是if语句
            if (element instanceof PsiIfStatement){
                PsiIfStatement psiIfStatement = (PsiIfStatement)element;
                PsiStatement thenSt = psiIfStatement.getThenBranch();
                String thenText = thenSt.getText();
                // 没有大括号
                if (!thenText.startsWith("{")){
                    int lineNumbers = document.getLineNumber(thenSt.getTextOffset());
                    String text = "if后面没有使用大括号(line "+(lineNumbers)+")";
                    DefaultMutableTreeNode tmpTreeNode = new DefaultMutableTreeNode(text);
                    ifNode.add(tmpTreeNode);
                }
                // else语句
                PsiStatement elseSt = psiIfStatement.getElseBranch();
                if (elseSt != null){
                    // else语句
                    if (elseSt instanceof PsiExpressionStatement){
                        if (!elseSt.getText().startsWith("{")){
                            int lineNumbers = document.getLineNumber(elseSt.getTextOffset());
                            String text = "else 后面没有使用大括号(line "+(lineNumbers)+")";
                            DefaultMutableTreeNode tmpTreeNode = new DefaultMutableTreeNode(text);
                            ifNode.add(tmpTreeNode);
                        }
                    }
                    // else if语句
                    if (elseSt instanceof PsiIfStatement){
                        PsiIfStatement elseIfSt = (PsiIfStatement)elseSt;
                        thenSt = elseIfSt.getThenBranch();
                        thenText = thenSt.getText();
                        // 没有大括号
                        if (!thenText.startsWith("{")){
                            int lineNumbers = document.getLineNumber(thenSt.getTextOffset());
                            String text = "if后面没有使用大括号(line "+(lineNumbers)+")";
                            DefaultMutableTreeNode tmpTreeNode = new DefaultMutableTreeNode(text);
                            ifNode.add(tmpTreeNode);
                        }
                    }
                    // 递归else内容
                    checkIfStatement(document,elseSt);
                }

                // 递归if语句内容
                checkIfStatement(document,thenSt);
            }
        }
    }

    /**
     * @author gaojindan
     * @date 2019/3/11 0011 17:08
     * @des 检查类的注释规则
     * @param  psiClass:元素
     * @return
     */
    private void checkClassComment(Document document, PsiClass psiClass){
        PsiComment classComment = null;
        for (PsiElement tmpEle : psiClass.getChildren()) {
            if (tmpEle instanceof PsiComment){
                classComment = (PsiComment) tmpEle;
                int lineNumbers = document.getLineNumber(classComment.getTextOffset());
                // 注释的内容
                String tmpText = classComment.getText();
                if (tmpText.indexOf("* @author") < 0){
                    // 没有找到作者
                    String text = psiClass.getName()+"类没有找到作者(line "+(lineNumbers+1)+")";
                    addCommentNode(text);
                }
                if (tmpText.indexOf("* @date") < 0 &&tmpText.indexOf("* @time") < 0){
                    // 没有找到日期
                    String text = psiClass.getName()+"类没有找到日期(line "+(lineNumbers+1)+")";
                    addCommentNode(text);
                }
                if (tmpText.indexOf("* @des") < 0 &&tmpText.indexOf("* @describe") < 0){
                    // 没有找到描述
                    String text = psiClass.getName()+"类没有找到描述(line "+(lineNumbers+1)+")";
                    addCommentNode(text);
                }
            }
        }
        if (classComment == null){
            // 没有注释
            int lineNumbers = document.getLineNumber(psiClass.getTextOffset());
            String text = psiClass.getName()+"类没有注释(line "+(lineNumbers+1)+")";
            DefaultMutableTreeNode tmpTreeNode = new DefaultMutableTreeNode(text);
            commentNode.add(tmpTreeNode);
        }
    }

    /**
     * @author gaojindan
     * @date 2019/3/11 0011 17:08
     * @des 检查方法的注释规则
     * @param  psiMethod:元素
     * @return
     */
    private void checkMethodComment(Document document, PsiMethod psiMethod){
        PsiComment classComment = null;
        for (PsiElement tmpEle : psiMethod.getChildren()) {
            if (tmpEle instanceof PsiComment){
                classComment = (PsiComment) tmpEle;
                int lineNumbers = document.getLineNumber(classComment.getTextOffset());
                // 注释的内容
                String tmpText = classComment.getText();
                if (tmpText.indexOf("* @author") < 0){
                    // 没有找到作者
                    String text = psiMethod.getName()+"方法没有找到作者(line "+(lineNumbers+1)+")";
                    addCommentNode(text);
                }
                if (tmpText.indexOf("* @date") < 0 &&tmpText.indexOf("* @time") < 0){
                    // 没有找到日期
                    String text = psiMethod.getName()+"方法没有找到日期(line "+(lineNumbers+1)+")";
                    addCommentNode(text);
                }
                if (tmpText.indexOf("* @des") < 0 &&tmpText.indexOf("* @describe") < 0){
                    // 没有找到描述
                    String text = psiMethod.getName()+"方法没有找到描述(line "+(lineNumbers+1)+")";
                    addCommentNode(text);
                }
            }
        }
        if (classComment == null){
            // 没有注释
            int lineNumbers = document.getLineNumber(psiMethod.getTextOffset());
            String text = psiMethod.getName()+"方法没有注释(line "+(lineNumbers+1)+")";
            DefaultMutableTreeNode tmpTreeNode = new DefaultMutableTreeNode(text);
            commentNode.add(tmpTreeNode);
        }
    }
    /**
     * @author gaojindan
     * @date 2019/3/11 0011 17:08
     * @des 添加注释node
     * @param  text:标题
     * @return
     */
    private void addCommentNode(String text){
        DefaultMutableTreeNode tmpTreeNode = new DefaultMutableTreeNode(text);
        commentNode.add(tmpTreeNode);
    }

    /**
     * @author gaojindan
     * @date 2019/3/11 0011 17:08
     * @des 流程列表
     * @param  str:目录ID
     * @return 行数
     */
    public long getLineNumberByIo(String str){
        LineNumberReader lnr = new LineNumberReader(new CharArrayReader(str.toCharArray()));
        try {
            lnr.skip(Long.MAX_VALUE);
            lnr.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
        return lnr.getLineNumber() + 1;
    }
}

 

  • 2
    点赞
  • 6
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
IntelliJ IDEA 是一款非常流行的 Java 开发工具,它提供了丰富的插件机制,使得开发人员可以方便地扩展 IntelliJ IDEA 的功能。本文将介绍 IntelliJ IDEA 插件开发的基本流程和注意事项。 1. 开发环境搭建 首先,需要安装 IntelliJ IDEA,并在其基础上安装开发插件所需的 SDK 和插件开发工具。可以从 IntelliJ IDEA插件仓库中搜索并安装 Plugin Development Kit 插件,该插件开发者提供了一系列插件开发所需的工具和 API。 2. 创建插件项目 在 IntelliJ IDEA 中创建一个插件项目,可以使用插件开发工具提供的模板来快速创建。在创建插件项目时,需要选择插件类型和插件的基础语言,如 Java、Kotlin 等。 3. 开发插件功能 在插件项目中,可以通过编写代码、配置文件等方式来实现插件的功能。常见的插件功能包括添加自定义菜单、快捷键、工具栏等,还可以通过调用 IntelliJ IDEA 的 API 实现更加复杂的功能,如代码分析、重构等。 4. 调试和测试 在开发插件时,可以通过调试工具来验证代码是否正确。在 IntelliJ IDEA 中,可以使用插件开发工具提供的 Run/Debug Configuration 来配置插件的运行和调试环境。此外,还可以使用单元测试和集成测试来验证插件的功能是否正确。 5. 发布和分发 当插件开发完成后,需要将其打包发布到 IntelliJ IDEA 插件仓库中,以供其他用户使用。在发布前,需要对插件进行一些必要的检查,如检查插件的兼容性、安全性等。发布完成后,可以将插件的信息分享到开发者社区等平台,以便更多的用户了解和使用。 总结 IntelliJ IDEA 插件开发需要掌握 Java 开发技术和 IntelliJ IDEA 插件开发工具的使用。开发者应该了解插件开发的基本流程和注意事项,以便能够快速开发出高质量的插件,并满足用户需求。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值