2024最新IDEA插件开发+发布全流程 SelectCamelWords[选中驼峰单词]（idea源代码）

news2025/1/21 12:08:38

2024最新IDEA插件开发（发布）-SelectCamelWords[选中驼峰单词]（idea源代码）

参考文档

  • Jetbrains Idea插件开发文档: https://plugins.jetbrains.com/docs/intellij/welcome.html
  • 代码地址：https://github.com/yangfeng20/selected-camel-words
  • 整体流程文档：https://github.com/yangfeng20/idea-plugin-dev-guide/

背景介绍

  • 痛点：在idea开发过程中，希望按需驼峰选中文本。
  • 现在默认是一整个单词选中，只有在设置–>智能按键 中开启了使用"CamelHumps单词"时能够驼峰选中。但是这种情况比较粗暴，直接全局开启了。但是在日常开发中，其实选中大部分是整个单词一起选中。只有少部分情况是按照驼峰选中。

image.png

  • 所以就需要一块插件，能够快捷开关驼峰选中的能力，仅在需要的时候开启。

安装Plugin DevKit插件

  • Idea 2023.3 以下版本可以不用安装当前插件。idea自带。2023.3版本及之后的版本没有当前查询，需要自己安装。

image.png

  • 插件商店搜索Plugin DevKit用于安装插件，安装完成之后建议先重启一下，不然可能开发工具可能出不来。

image.png

开启IDEA内部模式（使用UI检查器定位代码）

  • 主菜单栏–>帮助(Help)–>编辑自定义属性

image.png

  • 输入idea.is.internal=true开启内部模式，重启后生效。
  • 参考链接 https://plugins.jetbrains.com/docs/intellij/enabling-internal.html
  • 后面介绍如何使用UI检查器来定位代码位置

新建插件项目

  • 新建项目选择Idea插件(如果没有Plugin DevKit插件，这里就没有当前选项)。

image.png

  • 同时注意jdk版本需要和idea对应。参考：https://plugins.jetbrains.com/docs/intellij/creating-plugin-project.html#creating-a-plugin-with-new-project-wizard

image.png

修改Gradle相关配置

取消gradle构建

  • 先取消默认的gradle构建。先修改一些配置在重新构建。

修改依赖远程仓库地址

  • 修改build.gradle.kts中的repositories，注释中央仓库（mavenCentral）。配置阿里云地址。
repositories {
    //    mavenCentral()
    maven {
        url = uri("https://maven.aliyun.com/repository/public")
    }
}
  • 如果文件名不是kts结尾，而是gradle结尾，配置可能有些区别。

修改使用本地Idea调试

  • 注释intellij中的version和type（如果指定，需要下载），使用本地安装的idea进行调试。
  • 使用localPath设置本地idea的安装路径。参考：https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#configuration-intellij-extension
intellij {
    localPath.set("D:\\Program Files\\JetBrains\\IntelliJ IDEA 2024.1.2")
    //    version.set("2023.2.6")
    //    type.set("IC") // Target IDE Platform

    plugins.set(listOf(/* Plugin Dependencies */))
}

image.png

重新加载Gradle变更

  • 点击Gradle图标重新加载变更。

image.png

  • 等待构建完成，初次可能比较慢，需要下载依赖等。构建完成之后，文件也就有高亮显示了。

image.png

其他build.gradle相关配置说明

  • https://plugins.jetbrains.com/docs/intellij/tools-gradle-intellij-plugin.html#ide-configuration

plugin.xml解读

  • 参考：https://plugins.jetbrains.com/docs/intellij/plugin-configuration-file.html#configuration-structure-overview
  • plugin.xml文件可以理解是当前插件的相关配置。是插件开发中非常重要的一个文件。

image.png

  • 构建完成之后，它会报错，是因为不能使用默认的模版字符。我们改掉就可以了。

image.png

防止报错

  • kotlin目录名修改为java。选中kotlin目录，按shift+f6修改目录名为java。不修改后面可能会报错。

image.png

创建Action

  • idea中的action概念可以理解为idea中的任意一个动作，点击了某个按钮，就会执行它绑定的Action类的代码。
  • 使用Plugin DevKit 创建一个Action。

image.png

  • 填写actionId，类名，功能名称，功能描述，添加到目标位置。

image.png

  • 创建成功之后就会生成一个Action类和在plugin中注册一个action，表说明他的位置。

image.png

运行插件

  • 点击gradle运行idea插件，它会重新启动一个idea环境，来运行idea插件。

image.png

  • 第一次运行可能较慢，需要等待一会儿。运行成功之后，在工具栏中显示了我们的插件Action。

image.png

  • 点击插件Action，后台也打印了相应的结果。

image.png

找不到你的插件注册的Action，并且控制台报错ClassNotFoundException？

  • 需要将上面说的kotlin目录修改为java。

控制台中文乱码，报错？

  • 修改build.gradle.kts，解决编译中文报错和控制台中文乱码问题。
tasks {
    // Set the JVM compatibility versions
    withType<JavaCompile> {
        sourceCompatibility = "17"
        targetCompatibility = "17"
        // 解决编译时中文报错
        options.encoding = "UTF-8"
    }

    // 添加以下内容，解决运行时控制台中文乱码
    withType<JavaExec> {
        jvmArgs = listOf("-Dfile.encoding=UTF-8", "-Dsun.stdout.encoding=UTF-8", "-Dsun.stderr.encoding=UTF-8")
    }
    ...
}

image.png

定位Action插入位置

  • 我是需要将Action插入到主菜单栏中的Tools菜单，要如何定位呢。这就只要使用我们之前说的内部工具，ui检查器了。
  • 开启内部模式之后，按ctrl+alt+鼠标左键点击ui，就能显示当前ui的详细信息。找到他的Group Id然后创建action时搜索选择就好了。

image.png

定位Idea相关代码

  • 在前面提到，idea设置中的智能按键有提供全局的驼峰选中能力，开启之后的就能够实现驼峰选中了。
  • 我们插件的逻辑也很简单，就是在编辑器中能够快捷开启这个开关。
  • 那我们要如何实现快捷开关呢，其实也很简单，我们只需要去看idea是怎么实现的就好了。

使用ui检查器定位智能按键逻辑

  • 在设置中使用ui检查器定位智能按键的配置类。

image.png

  • 打开idea源代码，搜索类EditorSmartKeysConfigurable

image.png

  • 然后搜索关键字camel，定位到配置，可以看到当前配置项有一个获取配置的方法，和更新配置的方法。然后查看这个editorSettings的来源。可以看到editorSettings的数据源是EditorSettingsExternalizable.getInstance()

image.png

  • 那这样就可以在我的项目中使用当前类的方法去设置快捷开关了。

编写插件逻辑（驼峰选中快捷开关）

  • 在我们的Action中获取到刚刚的编辑器设置，然后对配置项CamelWords的状态取反就可以了。
public class SelectCamelWordsAction extends AnAction {

    @Override
    public void actionPerformed(AnActionEvent e) {
        // 获取到编辑器设置
        EditorSettingsExternalizable editorSettingsExternalizable = EditorSettingsExternalizable.getInstance();
        // 对之前的状态取反
        editorSettingsExternalizable.setCamelWords(!editorSettingsExternalizable.isCamelWords());
    }
}
  • 运行插件，通过ToolMenu中的SelectCamelWords就能够快捷开启关闭驼峰选中的功能。
  • 但是这还是很麻烦啊，不能够快捷启动。接下来就要使用监听器来监听按键实现对应的快捷启动。

使用监听器监听键盘按键

  • 参考文档：https://plugins.jetbrains.com/docs/intellij/plugin-listeners.html#defining-application-level-listeners
  • 在plugin.xml中注册应用激活时监听，并绑定到我们的监听器中。
<applicationListeners>
  <listener class="com.maple.plugindemo.MyKeyListener" topic="com.intellij.openapi.application.ApplicationActivationListener"/>
</applicationListeners>
  • 添加我们的自定义分发器
public class MyKeyListener implements ApplicationActivationListener {
    private final KeyEventDispatcher dispatcher = new MyKeyEventDispatcher();

    @Override
    public void applicationActivated(@NotNull IdeFrame ideFrame) {
        KeyboardFocusManager.getCurrentKeyboardFocusManager().addKeyEventDispatcher(dispatcher);
    }

    @Override
    public void applicationDeactivated(@NotNull IdeFrame ideFrame) {
        KeyboardFocusManager.getCurrentKeyboardFocusManager().removeKeyEventDispatcher(dispatcher);
    }

    private static class MyKeyEventDispatcher implements KeyEventDispatcher {
        // 分发器逻辑
    }
}
  • 在自定义的事件分发器中监听shift+ctrl+win按下，开启驼峰选中。win键抬起，关闭驼峰选中。
private static class MyKeyEventDispatcher implements KeyEventDispatcher {
    private boolean shiftPressed = false;
    private boolean ctrlPressed = false;
    private boolean winPressed = false;

    private final EditorSettingsExternalizable editorSettingsExternalizable = EditorSettingsExternalizable.getInstance();

    @Override
    public boolean dispatchKeyEvent(KeyEvent e) {
        int keyCode = e.getKeyCode();
        int id = e.getID();

        if (id == KeyEvent.KEY_PRESSED) {
            switch (keyCode) {
                case KeyEvent.VK_SHIFT:
                    shiftPressed = true;
                    break;
                case KeyEvent.VK_CONTROL:
                    ctrlPressed = true;
                    break;
                case KeyEvent.VK_WINDOWS:
                    winPressed = true;
                    break;
            }

            if (shiftPressed && ctrlPressed && winPressed) {
                // 开启驼峰选中
                System.out.println("Shift + Ctrl + Win 按下!");
                editorSettingsExternalizable.setCamelWords(true);
            }
        } else if (id == KeyEvent.KEY_RELEASED) {
            switch (keyCode) {
                case KeyEvent.VK_WINDOWS:
                    if (shiftPressed && ctrlPressed) {
                        // 关闭驼峰选中
                        System.out.println("Win 键抬起!");
                        editorSettingsExternalizable.setCamelWords(false);
                    }
                    winPressed = false;
                    break;
                case KeyEvent.VK_SHIFT:
                    shiftPressed = false;
                    break;
                case KeyEvent.VK_CONTROL:
                    ctrlPressed = false;
                    break;
            }
        }
        return false; // 继续分发事件
    }
}
  • 至此，插件逻辑就已经大功告成了。由于我没有mac，不清楚mac的快捷键，就没有适配mac快捷键。大家也可以去我的仓库提交pr。

打包插件

  • 通过gradle的task打包插件。构建jar包，最终会输出到build–>libs下

image.png

本地安装验证

  • 打开插件仓库，选择本地安装，找到打包之后的jar

image.png

  • 安装成功，确认，然后测试插件

image.png

发布插件

  • 进入jetbrains插件开发平台：https://plugins.jetbrains.com/developers/intellij-platform
  • 点击登录，或者注册账号

image.png

  • 点击Upload Plugin上传插件，上传插件jar包，填写相关信息，点击upload Plugin.

image.png

  • 上传成功，等待审核。

image.png

兼容不同的idea版本

  • idea-version参考: https://plugins.jetbrains.com/docs/intellij/plugin-configuration-file.html#idea-plugin__idea-version
  • 内部版本号映射参考：https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html#earlier-versions
  • 修改build.gradle.kts中的patchPluginXml，它用来不是兼容的idea版本。该值会覆盖plugin.xml中的idea-versin标签，所有可以直接把兼容版本写在这里。
patchPluginXml {
    // 最低版本
    sinceBuild.set("232")
    // 最高版本
    untilBuild.set("242.*")
}

<idea-version since-build="232" until-build="242.*"/>
  • 要做到多版本兼容，就是要将最低版本设置的尽可能的小，但是同时需要你设置的版本有你插件当前使用的api。例如applicationListeners就在193.0之后发布，我的最低版本就只能设置193.0。最大版本不设置。

image.png

  • 发布前jetbrains会校验当前插件的兼容性，我这边就是校验通过，显示可以使用的版本。

image.png

后记

  • 插件比较简单，主要是解决开发中的痛点，然后监听按键按下和释放的逻辑是直接让ai写的，可能有一些小bug。
  • 然后mac端我不太清楚选中的快捷键是什么，也就没有做兼容。
  • 感兴趣的话，可以点个在github 点个star。欢迎大家把项目拉下来，然后提交pr。

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

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

如何覆盖!important修饰的属性

如何覆盖!important修饰的属性

最简单的方法 如果这个!important修饰的属性 是自己的写的&#xff0c;去掉这种写法&#xff0c;使用优先级的方式来写这个属性&#xff08;.outter .inner 的优先级就会比 。outter的优先级高&#xff09; 复杂的方法&#xff1a;用魔法打败魔法 但是这个样式来自于全局css&am…
阅读更多...
代码随想录——子集Ⅱ（Leecode 90）

代码随想录——子集Ⅱ（Leecode 90）

题目链接 回溯 class Solution {List<List<Integer>> res new ArrayList<List<Integer>>();List<Integer> list new ArrayList<Integer>();boolean[] used; public List<List<Integer>> subsetsWithDup(int[] nums) {use…
阅读更多...
Maven 插件列表详解

Maven 插件列表详解

Maven 是一个强大的项目管理和构建工具&#xff0c;广泛应用于 Java 项目中。作为一款优秀的构建管理工具&#xff0c;Maven 不仅提供了标准化的项目结构和依赖管理&#xff0c;还通过其丰富的插件系统&#xff0c;极大地扩展了其功能和灵活性。无论是代码编译、测试、打包&…
阅读更多...
第55期|GPTSecurity周报

第55期|GPTSecurity周报

GPTSecurity是一个涵盖了前沿学术研究和实践经验分享的社区&#xff0c;集成了生成预训练Transformer&#xff08;GPT&#xff09;、人工智能生成内容&#xff08;AIGC&#xff09;以及大语言模型&#xff08;LLM&#xff09;等安全领域应用的知识。在这里&#xff0c;您可以找…
阅读更多...
怎样搭建serveru ftp个人服务器

怎样搭建serveru ftp个人服务器

首先说说什么是ftp&#xff1f; FTP协议是专门针对在两个系统之间传输大的文件这种应用开发出来的&#xff0c;它是TCP/IP协议的一部分。FTP的意思就是文件传输协议&#xff0c;用来管理TCP/IP网络上大型文件的快速传输。FTP早也是在Unix上开发出来的&#xff0c;并且很长一段…
阅读更多...
【linux】内核从tcp层调用IP层摸索中

【linux】内核从tcp层调用IP层摸索中

合入代码&#xff1a; 登录 - Gitee.com 这是运行日志&#xff1a; https://gitee.com/r77683962/linux-6.9.0/raw/master/test_log/kern_tcp_ip.log 日志截取部分&#xff08;也不知道对不对&#xff0c;凭感觉走。。。。&#xff09;
阅读更多...
「51媒体」电视台媒体邀约采访报道怎么做？

「51媒体」电视台媒体邀约采访报道怎么做？

传媒如春雨&#xff0c;润物细无声&#xff0c;大家好&#xff0c;我是51媒体网胡老师。 电视台作为地方主流媒体&#xff0c;对于新闻报道有着严格的选题标准和报道流程。如果您希望电视台对某个会议或活动进行报道&#xff0c;可以按这样的方法来做&#xff1a; 1.明确活动信…
阅读更多...
BizDevOps全局建设思路：横向串联，纵向深化

BizDevOps全局建设思路：横向串联，纵向深化

本文来自腾讯蓝鲸智云社区用户&#xff1a;CanWay BizDevOps概述 IT技术交付实践方法在不断迭代中持续优化。在工业化时代&#xff0c;Biz&#xff08;业务&#xff09;、Dev&#xff08;开发&#xff09;、Ops&#xff08;运维&#xff09;三者往往相对分离&#xff0c;甚至有…
阅读更多...
Python3 Matplotlib展示数据

Python3 Matplotlib展示数据

matplotlib 是一个 Python 库&#xff0c;用于创建各种类型的图表和可视化。它提供了一个类似于 MATLAB 的绘图界面&#xff0c;使用户能够轻松地绘制线图、散点图、直方图、饼图等各种图表类型。matplotlib 可以在 Python 脚本、IPython shell、Jupyter Notebook 等环境中使用…
阅读更多...
《梦醒蝶飞：释放Excel函数与公式的力量》3.3常用数学函数：AVERAGE

《梦醒蝶飞：释放Excel函数与公式的力量》3.3常用数学函数：AVERAGE

3.3常用数学函数&#xff1a;AVERAGE 在Excel中&#xff0c;AVERAGE 函数用于计算一系列数值的平均值。这个函数在数据分析中非常有用&#xff0c;因为它可以快速提供数值集的中心趋势。 1)基本语法&#xff1a; AVERAGE(range) 或者 AVERAGE(number1,[number2,...]) ran…
阅读更多...
Jetpack Compose_Alignment对其+Arrangement排列

Jetpack Compose_Alignment对其+Arrangement排列

文章目录 1.Alignment 对齐1.1Alignment 对齐方式1.2AbsoluteAlignment 绝对对齐1.3BiasAlignment 偏差对齐1.4BiasAbsoluteAlignment偏差绝对对齐 2.Arrangement 排列2.1Arrangement 排列方式2.2Arrangement.Horizontal2.3Arrangement.Vertical 1.Alignment 对齐 1.1Alignmen…
阅读更多...
Linux之旅: 基础知识点的终极指南

Linux之旅: 基础知识点的终极指南

文章目录 1、Linux的目录结构2、ls命令3、管理文件和目录4、linux命令使用细节和技巧5、权限管理基本命令6、搜索命令7、管道符与重定向8、压缩和解压命令9、用户及vim编辑器10、用户和用户组管理一、Linux系统用户账号的基本管理二、Linux系统用户组的管理 1、Linux的目录结构…
阅读更多...
大数据集群离线解析经纬度逆编码地址

大数据集群离线解析经纬度逆编码地址

背景 最近有个需要需求把经纬度解析为地址&#xff0c;那么通常解析地址市面上流行的方案就是调取百度、高德地图的接口进行解析。 难点 但是在用这个方案遇到一个问题就是企业认证的百度地图每天的逆编码解析为300w次&#xff0c;qps为100次/秒&#xff0c;对于日增上千万的…
阅读更多...
2025年计算机毕业设计题目参考-简单容易

2025年计算机毕业设计题目参考-简单容易

2025年最新计算机毕业设计题目参考-第二批 以下可以参考 企业员工薪酬关系系统的设计 基于SpringBoot在线远程考试系统 SpringBootVue的乡政府管理系统 springboot青年公寓服务平台 springboot大学生就业需求分析系统 基于Spring Boot的疗养院管理系统 基于SpringBoot的房屋交…
阅读更多...
MySQL全解(基础)-(MySQL的安装与配置,数据库基础操作(CRUD,聚合,约束,联合查询),索引,事务)

MySQL全解(基础)-(MySQL的安装与配置,数据库基础操作(CRUD,聚合,约束,联合查询),索引,事务)

MySQL安装与配置 1.数据库介绍 存储数据用文件就可以了&#xff0c;为什么还要弄个数据库? 文件保存数据有以下几个缺点&#xff1a; 文件的安全性问题 文件不利于数据查询和管理 文件不利于存储海量数据 文件在程序中控制不方便数据库存储介质&#xff1a; 磁盘 内存 为了…
阅读更多...
从ITIL，CMMI到DevOps的实践与思考

从ITIL，CMMI到DevOps的实践与思考

点击进入IT管理资料库 在信息技术迅猛发展的今天&#xff0c;企业对IT运维和管理的要求越来越高。从最早的ITIL&#xff0c;到后来的CMMI&#xff0c;再到现在风靡全球的DevOps&#xff0c;每一个管理框架的出现都代表着一种新的思维和实践模式。ITIL帮助企业建立起系统的IT服…
阅读更多...
微信小程序生命周期分为3种：页面级别，应用级别，组件级别

微信小程序生命周期分为3种：页面级别，应用级别，组件级别

应用级别&#xff1a; onLaunch&#xff0c;onShow&#xff0c;onHide 页面级别&#xff1a;onLoad&#xff0c;onShow&#xff0c;onReady&#xff0c;onHide&#xff0c;onUnload 组件级别&#xff1a;
阅读更多...
Webmin介绍与安装

Webmin介绍与安装

文章目录 前言定义与功能&#xff1a;支持的操作系统&#xff1a;功能特性&#xff1a;插件与模块&#xff1a;使用场景&#xff1a;特点&#xff1a;安装与配置&#xff1a;总结 前言 Webmin是一款功能强大的基于Web的Unix系统管理工具 定义与功能&#xff1a; Webmin允许管…
阅读更多...
HTTP性能测试工具-wrk

HTTP性能测试工具-wrk

wrk性能测试工具详解 wrk是一款轻量级但功能强大的HTTP基准测试工具&#xff0c;主要用于在单机多核CPU环境下对HTTP服务进行性能测试。它通过利用系统自带的高性能I/O机制&#xff08;如epoll、kqueue等&#xff09;&#xff0c;结合多线程和事件模式&#xff0c;能够产生大量…
阅读更多...
SpringMVC系列五: SpringMVC映射请求数据

SpringMVC系列五: SpringMVC映射请求数据

SpringMVC映射请求数据 &#x1f49e;获取参数值说明应用实例 &#x1f49e;获取http请求消息头&#x1f49e;获取JavaBean对象使用场景说明应用实例注意事项和细节 &#x1f49e;获取servlet api说明应用实例注意事项和细节 上一讲, 我们学习的是SpringMVC系列四: Rest-优雅的…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023