插件扩展与扩展点

原文链接:
http://www.jetbrains.org/intellij/sdk/docs/basics/plugin_structure/plugin_extensions_and_extension_points.html

IntelliJ平台 提供了扩展扩展点的概念,允许插件与其他插件或IDE相互配合。

扩展点

如果你想允许其它扩展扩展你的插件的功能,你必须在插件中声明一个或一系列的扩展点。每个扩展点都要定义一个允许访问的类或接口。

扩展

如果你想要你的插件扩展其它插件或IntelliJ平台 的功能,你必须声明一个或一系列的扩展

如何声明扩展或扩展点

您可以分别在插件配置文件plugin.xml中的<extensions><extensionPoints>部分声明扩展和扩展点。

声明扩展点

<extensionPoints>部分, 插入一个子元素<extensionPoint>,分别在namebeanClassinterface属性定义扩展点名称和允许扩展插件功能的bean类名或接口名。

要阐明此过程,请查看以下plugin.xml文件的示例代码片段:

<extensionPoints>
  <extensionPoint name="MyExtensionPoint1" beanClass="MyPlugin.MyBeanClass1">
  <extensionPoint name="MyExtensionPoint2" interface="MyPlugin.MyInterface">
</extensionPoints>
  • interface属性设置一个要扩展此扩展点的插件必须要实现的接口;
  • beanClass属性设置一个使用@Attribute注解一个或多个属性的bean类。

要扩展此扩展点的插件会从plugin.xml文件中读取这些属性。

要阐明此过程,查看以下使用以上plugin.xml文件的示例 MyBeanClass1 bean类:

public class MyBeanClass1 extends AbstractExtensionPointBean {
  @Attribute("key")
  public String key;

  @Attribute("implementationClass")
  public String implementationClass;

  public String getKey() {
    return key;
  }

  public String getClass() {
    return implementationClass;
  }
}

注意:要声明一个设计用来访问MyExtensionPoint1扩展点的扩展 ,你的plugin.xml文件必须包含具有设置适当值(查看以下示例)的keyimplementationClass属性的<MyExtensionPoint1>标签。

声明扩展

  1. 对于<extensions>元素,设置xmlns (不推荐使用)或defaultExtensionNs属性为以下值:
    • com.intellij,如果你的插件要扩展IntelliJ平台核心功能;
    • {ID of a plugin},如果你的插件要扩展其它插件的功能。
  2. 新增<extensions>子元素。 子元素的名称必须与你想要访问的扩展点的名字匹配。
  3. 根据扩展点的类型:
    • 如果扩展点使用interface属性声明,对于新增的子元素设置implementation属性为实现指定接口的类名。
    • 如果扩展点使用beanClass属性声明,对于新增的子元素设置所有在指定bean类用@Attribute 注解的属性。

要阐明此过程,请查看以下plugin.xml文件的示例代码片段,它定义了两个设计用来访问*IntelliJ平台 *appStarterapplicationConfigurable扩展点的扩展和一个设计用来访问测试插件MyExtensionPoint1扩展点的扩展:

<!-- 声明访问IntelliJ平台扩展点的扩展
     这些扩展点使用"interface"属性声明
-->
  <extensions defaultExtensionNs="com.intellij">
    <appStarter implementation="MyTestPackage.MyTestExtension1" />
    <applicationConfigurable implementation="MyTestPackage.MyTestExtension2" />
  </extensions>

<!--声明访问自定义插件扩展点的扩展
     MyExtensionPoint1扩展点使用*beanClass*属性声明
-->
  <extensions defaultExtensionNs="MyPluginID">
     <MyExtensionPoint1 key="keyValue" implementationClass="MyTestPackage.MyClassImpl"></MyExtensionPoint1>
  </extensions>

如何得到扩展点列表?

要获得IntelliJ平台 核心的可用扩展点,查看以下XML配置文件的<extensionPoints>部分:

更多信息和示例

更多关于如何扩展IDEA核心的示例插件和详细说明,请参阅自定义IDEA设置对话框和创建工具窗口。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,163评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,301评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,089评论 0 352
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,093评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,110评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,079评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,005评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,840评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,278评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,497评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,667评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,394评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,980评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,628评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,649评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,548评论 2 352

推荐阅读更多精彩内容