IntelliJ插件开发 - Disposer and Disposable

简介

IntelliJ平台简化了资源的清理过程，如果你开发的插件所创建的一些资源的生命周期和某个父对象一致，则这些资源应当注册到Disposer中，进行生命周期绑定。
Disposer管理的资源中，最常见的就是各种listener（监听器），除此之外，一些其他类型可能也需要被Disposer管理：

• 文件句柄、数据库连接
• 缓存以及一些其他比较重要的数据结构

Disposer是一个单例对象，它内部维护着Disposable实例树。一个Disposable实例指的是任何实现了Disposable.dispose()方法的对象，这个方法中定义了在生命周期结束后的释放资源动作。

对象自动销毁

大部分实现了Disposable接口的对象，都会被intelliJ平台自动销毁。例如，我们最常用的service，应用级别的service (applicationService) 会在IDE被关闭或者你的插件服务被卸载的时候销毁，项目级别的service (projectService) 会在项目被关闭或插件服务被卸载的时候销毁。

在 plugin.xml 中注册的扩展不会自动被清理。如果扩展需要执行一些代码来清理它，则需要定义一个service并将代码放在其 dispose() 方法中，或者把某个service作为它的父Disposable对象绑定。

销毁顺序

Disposer单例模式保证了子Disposable对象的寿命不会比父Disposable长。Disposer将Disposable对象的关系维护成了一棵树，确保了子对象先销毁。

使用方法

绑定父Disposable对象

// 语法
Disposer.register(parentDisposable, childDisposable);

// 在project关闭后，执行自定义逻辑
Disposer.register(project, () -> {
	// do something logic
});

手动创建Disposable
addXxxListner方法，如果传入一个父Disposable对象，则在父Disposable对象销毁时，会调用removeXxxListener方法。

Disposable editorDisposable = Disposer.newDisposable("myDisposable");
EditorUtil.disposeWithEditor(editor, editorDisposable);
editor.getDocument().addDocumentListener(new MyDocumentListener(), editorDisposable);

选择合适的父Disposable对象

• 需要贯穿整个插件生命周期的资源，使用application/project级别的服务
• 弹窗（Dialog）展示期间需要的资源，使用DialogWrapper.getDisposable()
• 对于需要Tool Window Tab展示时候需要的资源，使用Content#setDisposer(), Content是 IntelliJ IDEA 中的一个概念，它表示一个可视化区域，例如一个工具窗口或一个编辑器。Content 可以包含多个 View，每个 View 都表示一个可视化组件，例如一个工具窗口中的标签页或一个编辑器中的文本区域。
• 对于一些生命周期比较短的资源，使用Disposer.newDisposable()，然后手动调用Disposable.dispose()来销毁它。最好还是将他们与project对象绑定进行保底，以免带来不必要的内存泄漏。

不能作为父Disposable的对象

• Project、Application
  虽然他们实现了Disposable接口，但是如果将他们作为父Disposable对象，如果插件被unload的时候，这些对象不会被销毁从而造成内存泄漏。

参考文献

https://plugins.jetbrains.com/docs/intellij/disposers.html#registering-listeners-with-parent-disposable