idea插件开发api

idea插件开发api

前言

在看完 IDEA 插件开发简易教程后,小伙伴们是否迫不及待的想自己上手整一个插件了?心里规划好了一二三,但是却不知道从哪里开始下手。下面我分享下自己整理的一些常用的 API。

AnAction操作

  1. 创建Action集成并实现其方法. 在方法中可以获取到对象. 代码如下:

  1. 其他方式

获取PsiClass

PsiClass为java类或者接口


Psixxx操作

PsiClass操作API

源码有注释且比较清楚, 此处仅记录我用到的一部分


PsiField操作


PsiElement操作

PsiClass和PsiField都实现了PsiElement


PsiType操作

PsiType支持常用基本类型, 但是当创建对象时则不支持.需要自己创建


其他API

XML 文件操作

参考地址:https://jetbrains.org/intellij/sdk/docs/reference_guide/frameworks_and_external_apis/xml_dom_api.html

以 Mapper.xml 举例声明接口,继承 DomElement,并配idea插件开发api合 @Attribute、@SubTag 、@SubTagsList 注解定义一个 xml model,其中需要注意 @SubTagsList 方法要使用复数形式。


搜索文件

比如想搜索项目中的所有 xml 文件,上面使用 Mapper 接口定义了 Mapper.xml 的结构,就可以利用 DomService 搜索所有的 Mapper.xml:


写入文件

需要调用进行异步写入.


通知

在操作成功之后,在 IDEA 右下角通知用户,使用 NotificationGroup 类即可。


也可以定义为工具类,如下


总结

基本上常用的就是这些了,也可以查找官方文档,官方文档现在还是比较全面的,地址在相关资料中。也可以 Clone Toolkit 这个插件源码,源码中有一些注释。在其他优秀的插件中,同样可有相关使用方法。

相关资料

  • Toolkit: https://github.com/liuzhihang/toolkit
  • copy-as-json: https://github.com/liuzhihang/copy-as-json
  • IntelliJ Platform SDK: https://jetbrains.org/intellij/sdk/docs/intro/welcome.html

今天的文章
idea插件开发api分享到此就结束了,感谢您的阅读。

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。
如需转载请保留出处:https://bianchenghao.cn/134087.html

(0)
编程小号编程小号
上一篇 2024-09-06 15:17
下一篇 2024-09-06 15:46

相关推荐