IntelliJ IDE 插件开发 | （四）开发一个时间管理大师插件

系列文章

  • IntelliJ IDE 插件开发 |（一）快速入门
  • IntelliJ IDE 插件开发 |（二）UI 界面与数据持久化
  • IntelliJ IDE 插件开发 |（三）消息通知与事件监听
  • IntelliJ IDE 插件开发 |（四）开发一个时间管理大师插件

前言

在上篇文章的结尾提到本文将参考 VS Code 中 TimerMaster 插件的实现效果来实现一个在 IDEA 中统计编码情况的插件，TimerMaster 的效果如下：

image-20231225092034655

image-20231225092049204

本文最终实现的插件效果如下（增加了 CV 操作和代码提交的统计😎）：

image-20231228112248383

Clip_20231225_092825

由于本文涉及到大部分知识都是在前几篇文章中介绍过的，因此本文只对关键功能点和实现方式进行介绍，一些基础知识和配置就不再讲解，该插件的完整代码已上传到GitHub。

实现思路

在开发前，正如前言中提到的，是参考 TimerMaster 的实现效果。因此首先确认了要实现的功能如下：

  1. 可以统计当天、昨天、过去七天和每天平均的代码活动。
  2. 统计项包括编辑器使用/活跃时间、添加/删除的代码行数、总的键入数、扩展增加了 CV(懂得都懂) 和代码提交活动的统计。
  3. 通过点击右键菜单项后在控制台进行展示。

对于第一点，主要通过本地持久化数据进行实现，当天数据和历史数据分别进行存储(选择了 JSON 格式进行存储)，然后按需取用进行统计即可。

对于第二点，涉及的功能较多，这里分开进行介绍：

  • 编辑器使用/活跃时间

    增加一个对项目生命周期的监听器，在启动事件中注册一个定时任务，每隔 n 秒(可配置)将使用时间增加 n 秒。增加一个对文档和游标位置的监听器，只要有文档操作或者游标的移动都认为是活跃状态，然后更新最新操作时间，在定时任务中会将当前时间和最新操作时间进行比较，如果不大于 m 秒(可配置)就认为编辑器处于活跃状态，并将活跃时间增加 n 秒。

  • 添加/删除的代码行数、总的键入数

    通过增加对文档的监听器，根据变更内容中的换行数目得到添加/删除的代码行数，同时根据变更内容长度是否为 1 或者为空白符来决定是否增加键入数。

  • CV 统计

    增加一个对复制粘贴事件的监听器，分别在复制和粘贴事件中增加相应的次数。

  • 代码提交统计

    监听自带 GIT 插件提供的 PUSH 事件监听器，在提交完成事件中增加对提交提交次数的统计。

对于第三点，只需要增加一个 action 并绑定到右键菜单，然后通过 ToolWindowFactory 获取到控制台视图来输出计算得到的结果即可。

根据个人需求，统计每天最早/最晚运行时间、活跃时间段、数据云存储等也很容易实现，本文就不进行拓展了。

代码实现及讲解

配置界面

在实现思路中提到了定时器间隔和代码活跃时间间隔是可配置的，由于界面比较简单，这里使用了 Kotlin UI DSL 的方式(参考第二篇文章使用 Swing UI 的拖拽方式也很容易实现)，对应代码及效果如下：

// TimerMasterConfig 中部分代码

private var panel = panel { 
    row("更新间隔(秒): ") {
        intTextField()
            .bindIntText(model::updateInterval)
            .comment("<icon src='AllIcons.General.Information'>&nbsp;不设置或者小于 10, 最终都为 10.")
    }
    
    row("活跃间隔(秒): ") {
        intTextField()
            .bindIntText(model::activeInterval)
            .comment("<icon src='AllIcons.General.Information'>&nbsp;不设置或者小于 30, 最终都为 30.")
    }
}

image-20231228124547932

存储方式及格式

根据要存储的数据，定义了一个统计数据类，并增加了一个创建时间便于归档：

data class StatisticsData(
    var runTime: Long = 0,
    var activeTime: Long = 0,
    var keyCount: Long = 0,
    var addLineCount: Long = 0,
    var removeLineCount: Long = 0,
    var copyCount: Long = 0,
    var pasteCount: Long = 0,
    var pushCount: Long = 0,
    var createDate: String = Utils.getTodayYmd()
)

同时为了便于解析和处理，在进行本地持久化的时候，使用了 GSON 库来进行数据的 JSON (反)序列化操作。

编辑器运行/活跃时间

在前文中提到这里是通过在项目启动事件中增加定时任务来实现的，先展示代码：

class ProjectStartListener: ProjectActivity, Disposable {
    
    private val state = TimerMasterState.getInstance()

    override suspend fun execute(project: Project) {
        while (true) {
            delay(TimeUnit.SECONDS.toMillis(state.updateInterval.toLong()))
            run {
                // 避免多个项目运行时间统计多次, 增加满足以下规则才进行时间统计: 
                // 当前项目与配置信息一致, 或配置信息为空, 或配置信息内的项目不处于打开状态
                val projectPath = project.locationHash
                val firstOrNull = ProjectManager.getInstance().openProjects.firstOrNull { it.locationHash == state.runProjectPath }
                // 判断编辑器是否处于活跃状态
                val active = (System.currentTimeMillis() - state.activeTime) / 1000 <= state.activeInterval
                state.runProjectPath.takeIf { it == projectPath || it.isBlank() || firstOrNull == null }?.let { 
                    state.runProjectPath = projectPath
                    val data = Utils.parse(state.statisticsData, TypeToken.get(StatisticsData::class.java))
                    if (data.createDate == Utils.getTodayYmd()) {
                        // 计算运行和活跃时间
                        data.runTime += state.updateInterval
                        if (active) {
                            data.activeTime += state.updateInterval
                        }
                        state.statisticsData = Utils.stringify(data)
                    } else {
                        // 存储的如果不是当日的数据, 则将数据加入到历史数据, 然后再初始化数据
                        val arr = Utils.parse(state.historyData, object : TypeToken<MutableList<String>>() {})
                        arr.add(state.statisticsData)
                        state.historyData = Utils.stringify(arr)
                        val newData = StatisticsData()
                        newData.runTime = state.updateInterval.toLong()
                        if (active) {
                            newData.activeTime = state.updateInterval.toLong()
                        }
                        state.statisticsData = Utils.stringify(newData)
                    }
                }
            }
        }
    }

    override fun dispose() {
    }

}

增加以下配置：

<extensions defaultExtensionNs="com.intellij">
	<postStartupActivity
        implementation="cn.butterfly.timermaster.listener.ProjectStartListener"/>
</extensions>

这里需要注意的是我们可能会同时打开多个项目，因此为了避免运行和活跃时间被多次计算，这里通过使用 runProjectPath 来存储当前项目路径的 hash 值，只有该值为空（暂无运行的项目）或者该值不空但打开的项目中没有等于该值的项目（项目打开后又关闭）时才会更新该值为当前运行项目的路径 hash 值。相应地，也只有满足以上条件才会统计运行和活跃时间，同时根据 createDate 字段来决定是在当日数据上进行累积，还是归档该数据然后初始化今日数据。

添加/删除的代码行数、总的键入数

这里是在编辑器创建事件中，对相应的文档和光标移动增加监听器来统计添加/删除的代码行数、总的键入数，此外还会更新编辑器活跃时间（Utils.initData() 中进行记录），代码如下：

class EditorListener: EditorFactoryListener, BulkAwareDocumentListener, CaretListener {
    
    private val state = TimerMasterState.getInstance()
    
    private val fileSet = mutableSetOf<String>()

    override fun editorCreated(event: EditorFactoryEvent) {
        // 避免重复增加监听器
        val file = FileDocumentManager.getInstance().getFile(event.editor.document) ?: return
        if (file.path in fileSet) {
            return
        }
        fileSet.add(file.path)
        // 监听编辑操作
        event.editor.document.addDocumentListener(this)
        // 监听光标移动事件
        event.editor.caretModel.addCaretListener(this)
    }

    override fun documentChangedNonBulk(event: DocumentEvent) {
        val data = Utils.initData()
        event.takeIf { (it.oldFragment.isNotEmpty() or it.newFragment.isNotEmpty()) or !it.isWholeTextReplaced }?.let {
            // 只对字符长度为 1 和非空空白符的情况进行统计
            if (it.newFragment.isNotEmpty() && (it.newFragment.length == 1 || it.newFragment.trim().isEmpty())) {
                ++data.keyCount
            }
            // 根据文档代码段变更信息判断是新增还是删除行
            if (it.oldFragment.contains('\n')) {
                data.removeLineCount += it.oldFragment.count { item -> item == '\n' }
            }
            if (it.newFragment.contains('\n')) {
                data.addLineCount += it.newFragment.count { item -> item == '\n' }
            }
        }
        state.statisticsData = Utils.stringify(data)
    }

    override fun caretPositionChanged(event: CaretEvent) {
        state.statisticsData = Utils.stringify(Utils.initData())
    }
    
}

增加以下配置：

<extensions defaultExtensionNs="com.intellij">
	<editorFactoryListener implementation="cn.butterfly.timermaster.listener.EditorListener"/>
</extensions>

结合注释，代码不难理解，这里不再介绍。

CV 统计

关于复制粘贴的统计也很简单，官方给我们提供了相应的扩展点，我们增加相应的实现即可：

class CopyPasteListener: CopyPastePreProcessor {
    
    private val state = TimerMasterState.getInstance()
    
    override fun preprocessOnCopy(p0: PsiFile?, p1: IntArray?, p2: IntArray?, p3: String?): String? {
        val data = Utils.initData()
        ++data.copyCount
        state.statisticsData = Utils.stringify(data)
        return null
    }
    override fun preprocessOnPaste(p0: Project?, p1: PsiFile?, p2: Editor?, text: String?, p4: RawText?): String {
        val data = Utils.initData()
        ++data.pasteCount
        state.statisticsData = Utils.stringify(data)
        return text ?: ""
    }

}

增加以下配置：

<extensions defaultExtensionNs="com.intellij">
    <copyPastePreProcessor
        implementation="cn.butterfly.timermaster.listener.CopyPasteListener"/>
</extensions>

而如何知道官方给我们提供了哪些扩展点，在上一篇文章中也说明查看官方文档即可，例如复制粘贴的扩展点：

image-20231228132128049

代码提交统计

这里使用的GitPushListener也是在上述官方文档中提供的：

image-20231228132534460

使用方式也很简单：

class GitListener: GitPushListener {
    
    private val state = TimerMasterState.getInstance()
    
    override fun onCompleted(repository: GitRepository, pushResult: GitPushRepoResult) {
        val data = Utils.initData()
        ++data.pushCount
        state.statisticsData = Utils.stringify(data)
    }
    
}

增加以下配置：

<depends>Git4Idea</depends>

<projectListeners>
    <listener class="cn.butterfly.timermaster.listener.GitListener"
              topic="git4idea.push.GitPushListener"/>
</projectListeners>

build.gradle.kts中也需要增加以下配置：

intellij {
    // 用到的插件
    plugins.set(listOf("Git4Idea"))
}

由于GitPushListener是自带 GIT 插件所提供的监听器，因此还增加了第一行，其中Git4Idea是 GIT 的插件 id：

image-20231228132835555

展示报告

有了以上获取和存储数据的基础，这里就很简单了，关于得到展示数据的方式这里就不介绍了，大家可以去查看TimerMasterOutputAction的源码，这里主要介绍如何在控制台进行报告的输出。

其实控制台视图也可以看作是第二篇文章中提到的侧边栏，因此也需要继承实现ToolWindowFactory：

class ConsoleWindow: ToolWindowFactory {
    
    override fun createToolWindowContent(project: Project, toolWindow: ToolWindow) {
        if (Utils.getConsoleViews()[project] == null) {
            Utils.createToolWindow(project, toolWindow)
        }
        Utils.toolWindows[project] = toolWindow
    }

}

// Utils 中的方法
fun createToolWindow(project: Project, toolWindow: ToolWindow) {
    val consoleView = TextConsoleBuilderFactory.getInstance().createBuilder(project).console
    consoleViews[project] = consoleView
    val content = toolWindow.contentManager.factory.createContent(consoleView.component, "TimerMaster Output", false)
    content.component.isVisible = true
    content.isCloseable = true
    toolWindow.contentManager.addContent(content)
}

// 在控制台中显示信息
fun consoleInfo(project: Project, msg: String) {
    if (consoleViews[project] == null) {
        ToolWindowManager.getInstance(project).getToolWindow("TimerMaster Console")
            ?.let { createToolWindow(project, it) }
    }
    consoleViews[project]?.clear()
    consoleViews[project]?.print(msg, ConsoleViewContentType.NORMAL_OUTPUT)
    // 显示控制台窗口, 减去手动点击侧边栏按钮的操作
    toolWindows[project]?.activate(null, false)
}

这里需要注意的是由于可能多个项目都打开了该控制台视图，因此需要使用一个 map 继续保存，避免内容错乱。

最后以一个动图结尾：

动画

总结

本文通过实现一个对代码活动统计的插件算是对前几篇文章的一个总结，目前只在本地运行测试了几天，可能有一些不妥的实现方式和 BUG，欢迎一起交流讨论。另外截止到本篇，关于 IntelliJ 平台插件开发的基础知识也算告一段落，后续文章则优先讲解关于虚拟文件、PSI和编辑器操作相关的知识，而关于国际化、主题插件开发等则看情况夹杂在其中进行讲解。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/276378.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

Docker七 | 搭建Swarm集群

Docker七 | 搭建Swarm集群

目录 创建Swarm集群 创建管理节点 增加工作节点 查看集群 部署服务 新建服务 查看服务 服务伸缩 增加服务 减少服务 删除服务 创建Swarm集群 创建管理节点 在192.168.117.131下执行docker swarm init命令的节点自动成为管理节点 [rootlocalhost ~]# docker swar…
阅读更多...
TransNeXt：稳健的注视感知ViT学习笔记

TransNeXt：稳健的注视感知ViT学习笔记

论文地址&#xff1a;https://arxiv.org/pdf/2311.17132.pdf 代码地址&#xff1a; GitHub - DaiShiResearch/TransNeXt: Code release for TransNeXt model 可以直接在ImageNet上训练的分类代码&#xff1a;GitHub - athrunsunny/TransNext-classify 代码中读取数据的部分修改…
阅读更多...
【数据采集与预处理】数据接入工具Kafka

【数据采集与预处理】数据接入工具Kafka

目录 一、Kafka简介 &#xff08;一&#xff09;消息队列 &#xff08;二&#xff09;什么是Kafka 二、Kafka架构 三、Kafka工作流程分析 &#xff08;一&#xff09;Kafka核心组成 &#xff08;二&#xff09;写入流程 &#xff08;三&#xff09;Zookeeper 存储结构 …
阅读更多...
检测如下MHA运行条件【踩坑记录】

检测如下MHA运行条件【踩坑记录】

【masterha_check_ssh --conf/etc/mha/app1.cnf&#xff1a;SSH免密登录】 【错误信息1】 [error][/usr/share/perl5/vendor_perl/MHA/SSHCheck.pm, ln111] SSH connection from root10.0.0.53(10.0.0.53:22) to root10.0.0.51(10.0.0.51:22) failed! 【错误反馈】就是服务器…
阅读更多...
2023年山东省高职组区块链技术竞赛任务书

2023年山东省高职组区块链技术竞赛任务书

2023年山东省高职组区块链技术任务书 目录 模块一&#xff1a;区块链产品方案设计及系统运维 任务1-1&#xff1a;区块链产品需求分析与方案设计 任务1-2&#xff1a;区块链系统部署与运维 任务1-3&#xff1a;区块链系统测试 模块二&#xff1a;智能合约开发与测试 任务2-1&am…
阅读更多...
DRF从入门到精通六（排序组件、过滤组件、分页组件、异常处理）

DRF从入门到精通六（排序组件、过滤组件、分页组件、异常处理）

文章目录 一、排序组件继承GenericAPIView使用DRF内置排序组件继承APIView编写排序 二、过滤组件继承GenericAPIView使用DRF内置过滤器实现过滤使用第三方模块django-filter实现and关系的过滤自定制过滤类排序搭配过滤使用 三、分页组件分页器一&#xff1a;Pagination&#xf…
阅读更多...
Unity 创建/删除/启用/禁用组件的惯用方法

Unity 创建/删除/启用/禁用组件的惯用方法

1、创建组件&#xff1a; Unity 创建组件可以通过编辑器中的"Add Component"创建&#xff0c;或者代码动态创建&#xff1a;GameObject.AddComponent<T>()&#xff0c;如&#xff1a; ameObject.AddComponent<Rigidbody>(); 2、删除组件&#xff1a; …
阅读更多...
中介者模式-Mediator Pattern-1

中介者模式-Mediator Pattern-1

如果在一个系统中对象之间的联系呈现为网状结构&#xff0c; 对象之间存在大量的多对多联系&#xff0c;将导致系统非常复杂。 这些对象既会影响别的对象&#xff0c;也会被别的对象所影响。 这些对象称为同事对象&#xff0c;它们之间通过彼此的相互作用实现系统的行为。 在网…
阅读更多...
同义词替换降低论文相似度的注意事项 papergpt

同义词替换降低论文相似度的注意事项 papergpt

大家好&#xff0c;今天来聊聊同义词替换降低论文相似度的注意事项&#xff0c;希望能给大家提供一点参考。 以下是针对论文重复率高的情况&#xff0c;提供一些修改建议和技巧&#xff0c;可以借助此类工具&#xff1a; 标题&#xff1a;同义词替换降低论文相似度的注意事项 …
阅读更多...
【Java系列】多线程案例学习——基于阻塞队列实现生产者消费者模型

【Java系列】多线程案例学习——基于阻塞队列实现生产者消费者模型

个人主页&#xff1a;兜里有颗棉花糖 欢迎 点赞&#x1f44d; 收藏✨ 留言✉ 加关注&#x1f493;本文由 兜里有颗棉花糖 原创 收录于专栏【Java系列专栏】【JaveEE学习专栏】 本专栏旨在分享学习JavaEE的一点学习心得&#xff0c;欢迎大家在评论区交流讨论&#x1f48c; 目录…
阅读更多...
案例260:基于微信小程序的签到系统的设计与实现

案例260:基于微信小程序的签到系统的设计与实现

文末获取源码 开发语言&#xff1a;Java 框架&#xff1a;springboot JDK版本&#xff1a;JDK1.8 数据库&#xff1a;mysql 5.7 开发软件&#xff1a;eclipse/myeclipse/idea Maven包&#xff1a;Maven3.5.4 小程序框架&#xff1a;uniapp 小程序开发软件&#xff1a;HBuilder …
阅读更多...
git 常用命令总结

git 常用命令总结

git 工作原理图&#xff1a; git 常用命令及解释: 命令解释例子git init在当前目录初始化一个新的 Git 仓库。git initgit clone <repository>克隆一个远程仓库到本地。git clone https://github.com/example/repository.gitgit add <file>将文件的变化添加到暂存…
阅读更多...
分享44个PyQt5源码总有一个是你想要的

分享44个PyQt5源码总有一个是你想要的

分享44个PyQt5源码总有一个是你想要的 学习知识费力气&#xff0c;收集整理更不易。 知识付费甚欢喜&#xff0c;为咱码农谋福利。 链接&#xff1a;https://pan.baidu.com/s/1_5H_0Ydg0XUa1fz5Jok51Q?pwd6666 提取码&#xff1a;6666 项目名称 B站直播弹幕姬&#xff…
阅读更多...
哪种猫粮比较好？怎样囤性价比高的主食冻干品牌 ？

哪种猫粮比较好？怎样囤性价比高的主食冻干品牌 ？

在过去的100多年里&#xff0c;猫咪主食市场一直被膨化猫粮主导。然而&#xff0c;随着猫咪频频出现猝死、失明、发育不良以及营养不良等问题&#xff0c;猫主人们开始质疑膨化粮是否最适合猫咪。于是&#xff0c;从上世纪90年代开始&#xff0c;出现了生骨肉喂养。生骨肉确实是…
阅读更多...
XV7081BB陀螺仪传感器

XV7081BB陀螺仪传感器

XV7081BB是一款用于自动化机器的数字输出型陀螺仪传感器&#xff0c;具有卓越的性能&#xff0c;尤其是偏置输出稳定性和低噪声。特点如下&#xff1a; 优良的偏置温度系数为0.0024(/s)/C。 ●低角度随机游走0.065/√h ●SPI/IC串行接口 集成的用户可选择的数字滤波器 ●角…
阅读更多...
E : DS查找—二叉树平衡因子

E : DS查找—二叉树平衡因子

Description 二叉树用数组存储&#xff0c;将二叉树的结点数据依次自上而下,自左至右存储到数组中&#xff0c;一般二叉树与完全二叉树对比&#xff0c;比完全二叉树缺少的结点在数组中用0来表示。 计算二叉树每个结点的平衡因子&#xff0c;并按后序遍历的顺序输出结点的平衡…
阅读更多...
mybatisX自动生成sql语句，尝试测试方法报错

mybatisX自动生成sql语句，尝试测试方法报错

今天我使用mybatisx自定义mapper方法生成sql语句后&#xff0c;在测试时报错 错误是MyBatis 无法找到映射的语句&#xff08;Statement&#xff09;引起的 我是这样操作的&#xff0c;在mapper接口自定义了一个方法 然后alt加enter&#xff0c;自动生成sql 结果 mapper.xml文件…
阅读更多...
31.Java程序设计-基于Springboot的鲜花商城系统的设计与实现

31.Java程序设计-基于Springboot的鲜花商城系统的设计与实现

引言 背景介绍&#xff1a;鲜花商城系统的兴起和发展。研究目的&#xff1a;设计并实现一个基于Spring Boot的鲜花商城系统。论文结构概述。 文献综述 回顾相关鲜花商城系统的设计与实现。分析不同系统的优缺点。强调Spring Boot在系统设计中的优越性。 系统设计 需求分析 用户…
阅读更多...
css中sprite（css精灵）是什么,有什么优缺点

css中sprite（css精灵）是什么,有什么优缺点

概念 将多个小图片拼接到一个图片中 。通过 background-position 和元素尺寸调节需要显示的背景图案。 优点 减少 HTTP 请求数&#xff0c;极大地提高页面加载速度 增加图片信息重复度&#xff0c;提高压缩比&#xff0c;减少图片大小 更换⻛格方便&#xff0c; 只需在一张或…
阅读更多...
mysql保姆安装教程

mysql保姆安装教程

一.下载install文件 1.进入Mysql官网&#xff0c;点击下载 2.选择MySQL Installer for Windows 3.推荐选择第二个安装包 4.不登陆&#xff0c;开始下载 5.等待下载完成 二.安装前的配置 通过电脑“设置”&#xff0c;检查电脑是否包含中文名&#xff0c;如果包含请重命名 …
阅读更多...
最新文章

Copyright @ 2022~2023