intellij 插件结构(文件结构以及概念层面上的结构)

1、插件内的文件

2、插件类加载器

3、插件组件(component)

4、插件的扩展以及扩展点(Extensions、Extension Points)

5、插件的Action

6、插件的Service

7、插件配置文件结构

8、插件依赖

插件内的文件

有两种方式组织你的插件目录内的文件。

1、插件相关的 jar 文件放在插件根目录下

2、jar 文件放在 lib 文件夹下

如下:实际上,大部分都是插件目录下放个lib文件夹,把插件放到 lib 下。

我们通过 idea 的 build 菜单的 "prepare plugin moudle xxx for deployment" 生成的插件文件内,解压也是一个 lib 文件夹,里面放插件。

除此之外,plugin.xml 文件应该放在 META-INF 文件夹下保存。

插件类加载器

每一个插件都可以有一个独立的类加载器,这样的好处是,允许不同插件可以使用不同版本的库。

默认情况下,插件不会使用 IDE 的类加载器,所以 plugin.xml 中的 depends 的 <depends>com.intellij.modules.platform</depends> 如果不加上去,插件打包之后并不会生效。

你也可以使用 <depends> 元素来指定一个或多个当前插件所依赖的插件,这样一来,我们就可以在当前插件使用其他插件的类加载器,这样我们就可以引用其他插件里面定义的类。

插件组件

插件组件是插件集成的基础概念,有三种组件:

1、应用级组件(Application level components):IDE 启动的时候会创建和初始化。我们可以通过Application 实例来获取这些组件。(通过 ApplicationManager获取Application实例,application.getComponent(Class))

2、项目级组件(Project level components):该类组件为每个 Project 实例创建。我们可以通个 Project 实例来获取这些组件。(通过 Project project = anActionEvent.getData(PlatformDataKeys.PROJECT); 获取 Project 实例,project.getComponent(Class))

3、模块级组件(Module level components):该类组件为每个 project 的 Moudule 创建。我们可以通过 Module 实例来获取这些组件。

我们插件定义的每一个组件(component) 应该在配置文件中配置相关的接口(可选)和实现类,如下:

<application-components>
    <component>
      <implementation-class>com.eleven24.HelloWorldRegistration</implementation-class>
    </component>
  </application-components>

配置的实现类将会被用于组件实例化。

两个相同级的组件不能有相同的接口类。

每个组件有一个唯一的名字用来作为外部标识或者内部需要,通过组件的 getComponentName() 返回:

public class HelloWorldRegistration implements ApplicationComponent {
    @NotNull
    public String getComponentName() {
        return "HelloWorldPlugin";
    }
}

  

组件命名

推荐使用 <plugin_name>.<component_name> 的方式命名。

应用级组件

一个应用级的组件实现类可以选择是否去实现 ApplicationComponent接口。

一个没有任何依赖的组件应该有一个空参数的构造方法用以实例化。如果组件依赖其他组件,可以在构造方法参数中指定依赖的组件。IntelliJ Platform 会确保以正确的顺序来实例化组件,以保证我们组件可以正确实例化。

应用级组件必须在 plugin.xml的 <application-components> 块中注册。

项目级组件

一个 Project 级的组件可以选择是否去实现 ProjectComponent接口。

一个 project 级的组件如果需要 Project 实例,可以在该组件类的构造方法中指定一个 Project 类型的参数。同时如果依赖其他组件也可以指定其他 Application level 或者 Project level 的组件作为构造方法参数。

project 级组件必须在 plugin.xml 的 <project-components> 块中注册。

模块级组件

一个 Module 级的组件可以选择是否去实现  ModuleComponent接口。

一个 Module 级组件可以在构造方法指定一个 Module 类型的参数。同时如果依赖其他组件,也可以指定 application level、projetc level 或 module level 组件作为参数。

module 级组件必须在 plugin.xml 的 <module-components> 块中注册。

组件状态的持久化

如果组件类实现了  JDOMExternalizable或者  PersistentStateComponent 接口,组件的状态将会自动保存和加载。

当组件类实现了  PersistentStateComponent 接口,组件状态会保存在一个 xml 文件中,你可以通过 @State 和 @Storage 注解来指明当前的状态。

当组件实现了 JDOMExternalizable 接口,组件将会在下面的文件中保存它们的状态:

- project 级的组件的状态会保存在 .ipr 文件中,如果 plugin.xml 的 workspace 选项被设置为 true,将会被保存在 .iws 文件而不是 .ipr 文件中。

- module 级的组件状态将会保存在 .iml 文件中

更多信息可查看:Persisting State of Components

插件默认配置

定义在 <component_name>.xml 文件中,该文件需要放在 默认 package 的 classpath 下。

如果插件有默认配置,readExternal() 将会被调用两次:

1、第一次读取默认配置

2、第二次读取保存的配置

插件组件生命周期

组件按下面的顺序加载:

1、创建 - 构造方法被调用

2、初始化 - initComponent 方法被调用(前提是实现了  ApplicationComponent 接口)

3、配置 - readExternal 方法被调用(前提是实现了  JDOMExternalizable 接口),或者 loadState  被调用 (组件实现了  PersistentStateComponent 接口)

4、对于 module 组件, 如果一个模块被添加到 project, ModuleComponent 接口的 moduleAdded 方法将会被调用。

5、对于 project 组件,如果一个 project 被加载完, ProjectComponent 接口的 projectOpened  方法将会被调用。

组件按下面的顺序卸载:

1、保存配置 - writeExternal  被调用(如果该组件实现了 JDOMExternalizable 接口),getState  被调用(如果组件实现了 PersistentStateComponent 接口)

2、清理 -  组件的 disposeComponent 方法被调用

注意,不能在组件的构造方法中使用 getComponent() 方法去获取其他组件,如果你需要获取其他组件,可以将它们加到构造方法的参数中,或者在 initComponent  方法再进行此种操作。

todo: 添加例子

原文地址:https://www.cnblogs.com/eleven24/p/8290193.html

时间: 2024-10-13 01:43:08

intellij 插件结构(文件结构以及概念层面上的结构)的相关文章

python中基于descriptor的一些概念(上)

@python中基于descriptor的一些概念(上) python中基于descriptor的一些概念(上) 1. 前言 2. 新式类与经典类 2.1 内置的object对象 2.2 类的方法 2.2.1 静态方法 2.2.2 类方法 2.3 新式类(new-style class) 2.3.1 __init__方法 2.3.2 __new__静态方法 2.4. 新式类的实例 2.4.1 Property 2.4.2 __slots__属性 2.4.3 __getattribute__方法

全文检索概念,Lucene大致结构

1.1 常见的全文检索 1) 在window系统中,可以指定磁盘中的某一个位置来搜索你想要得到的东西. 2) 在myeclipse中,点击Help->Help Contents,可以利用搜索功能找到你要查询的帮助文档. 3) 在百度和google 中,可以搜索互联网中的信息,有:网页.pdf.word音频.视频等内容. 4) 在bbs系统中,有搜索文章的功能. 以上的查询功能都相似,都是查询的文本内容,查询方法也相似即找出含有指定字符串的资源.只不过是查询的范围不一样.(硬盘.帮助文件.互联网)

DB层面上的设计 分库分表 读写分离 集群化 负载均衡

第1章  引言 随着互联网应用的广泛普及,海量数据的存储和访问成为了系统设计的瓶颈问题.对于一个大型的 互联网应用,每天几十亿的PV无疑对数据库造成了相当高的负载.对于系统的稳定性和扩展性造成了极大的问题.通过数据切分来提高网站性能,横向扩展数据层 已经成为架构研发人员首选的方式.水平切分数据库,可以降低单台机器的负载,同时最大限度的降低了了宕机造成的损失.通过负载均衡策略,有效的降低了单台 机器的访问负载,降低了宕机的可能性:通过集群方案,解决了数据库宕机带来的单点数据库不能访问的问题:通过读

(转)技术人,不要总在很初级的层面上谈管理

无意间瞄到<[畅言]管理是权力的游戏吗?>,引起了我一些“新仇旧恨”,就也来吐槽一把.但吐槽的点倒不是权力不权力的,这是一点意思也没有的问题,在大多数人这个层次上(包括大多管理者)谈权力,形象来讲就和一般人老想象皇帝每天吃猪肉炖粉条一样,差太远,扯下去也没意思. 我想说的是技术人对管理的认知. 遇到问题谈问题 层次性很差 最常见的谈管理场景是一个人从技术转到管理岗位,接下来实践了几个项目,有成功的也有失败的,总结了经验后,就开始分享管理的成功经验.我偶尔翻到很多关于管理的文字都给我这么一种感觉

JavaWeb的几个概念和TOMCAT目录结构以及WEB开发的目录结构

JavaWeb的几个概念和TOMCAT目录结构 一.JavaWeb应用的概念: 在Sun的Java Servlet规范中,对Java Web应用作了这样的定义:“Java Web应用由一组Servlet.HTML页.类.以及其它可以被绑定的资源构成.它可以在各种供应商提供的实现Servlet规范的Servlet容器中运行” Java Web应用中可以包含如下内容: -- Servlet -- JSP -- 实用类 -- 静态文档如HTML.图片等 -- 描述Web应用的信息(web.xml) 二

C和指针 (pointers on C)——第十章:结构体和联合(上)

第十章 结构和联合 这个部分先介绍了.运算符,可以供直接访问,还介绍了->运算符,它代替结构体指针的间接访问操作(*struct).xxx 这一章新手理解起来不算太难,没有学过操作系统的话理解位段.对齐等概念会有一些问题. 越发的说明了指针和内存绝对是C的核心. 总结: 结构声明列出了结构包含的成员列表,不同类型的值可以存储在一起. 不同的结构声明即使他们的成员列表相同也被认为是不同的类型. 声明结构时使用typedef创建一种新类型是一个好方法. typedef struct { int a;

JQUERY插件JqueryAjaxFileUplaoder----更简单的异步文件上传

异步上传相信大家都做过类似的功能,JqueryAjaxFileUploader为我们提供了更简单的实现和使用方式.不过既然是JQUERY的插件那么它所依赖的环境大家都懂得.JqueryAjaxFileUploader并不华丽,也没有提供美化文件上传控件的css,它并不像jQuery File Upload(喜欢的同学可以去尝试下),提供了美观的样式和专门的图片预览.多任务上传等等, JqueryAjaxFileUploader 所拥有的很简单,只是异步上传文件的功能,当然这并不排除由你亲自为它披

IntelliJ插件安装

1. 插件管理器在线安装 在IntelliJ插件管理页面([FileàSettingsàIDE SettingsàPlugins]),点击[Browse repositories-]按钮,在搜索框内输入Genymotion,从搜索结果中选择自己想要安装的插件,在右侧页面点击[Install plugin]按钮等待下载并安装. 2. 插件管理器离线安装 点击插件管理器[Install plugin from disk]按钮,找到所下载好的jar/zip文件点击OK/Apply按钮后重启Intell

架构师什么样的技能最重要? 在比较高的层面上把握全局

http://www.nowamagic.net/librarys/veda/detail/2184软件架构师的定义乃至所需要的特质历来众说纷纭.下面从一些另类的角度来做点分析. 从产生根源来看,程序规模越大,参与人员越多,越需要架构师:程序越小,参与人员越精英化,架构师存在价值越小. 这不难理解,大军团作战,总不好一窝蜂就上去了,总要有些规则,总要有人把握全局.架构师就是在比较高的层面上把握全局的这个人.从这个角度来看,对架构师而言选择最重要,因为站的高,所以选择具有非常大的价值. 注意不是U