件开发

插件开发的基础知识这部分内容对开发一些小功能的插件的开发已经足够。

不过如果想要开发一些与具体编程语言相关的、提升开发效率的插件例如MybatisX那么前几篇的内容就不足以支撑了。

而从本篇开始则会介绍实现相关功能所需要的知识

VFS、编辑器、PSI、自定义语言等最后再以两三个插件的实战开发例如老生常谈的代码生成进行结尾本文涉及到的完整代码已上传到GitHub。

VFSVirtual

以及文件变更事件让开发人员可以专注于对文件的处理。

此外之所以使用虚拟二字也是因为我们在对文件操作时并没有直接修改源文件而是修改了源文件所对应的快照然后

VFS

文件快照是应用级别的因此一个文件即使被多个项目使用也只会对应一份快照。

文件快照内容和源文件内容并非实时对应例如文件已从资源管理器中删除但

IntelliJ

去感知文件的变化基于时间戳可以通过下述步骤去查看被监听的文件根节点

val

e.getData(PlatformDataKeys.VIRTUAL_FILE)

virtualFile?.let

ContextAPIActionAnActionEvent.getData(PlatformDataKeys.VIRTUAL_FILE)

AnActionEvent.getData(PlatformDataKeys.VIRTUAL_FILE_ARRAY)

for

selectionDocumentFileDocumentManager.getFile()PSI

FilePsiFile.getVirtualFile()(may

return

NameFilenameIndex.getVirtualFilesByName()Local

File

PathLocalFileSystem.findFileByIoFile()

VirtualFileManager.findFileByNioPath()/refreshAndFindFileByNioPath()

(2020.2)

在上面的示例中就是使用的第一种方式AnActionEvent.getData(PlatformDataKeys.VIRTUAL_FILE)

VirtualFile

e.getData(PlatformDataKeys.VIRTUAL_FILE)virtualFile?.let

{it.refresh(true,

${it.timeStamp}.trimIndent())}}}

}监听文件变更事件

{project.messageBus.connect().subscribe(VirtualFileManager.VFS_CHANGES,

object

的监听是应用级别因此当打开多个项目的时候每个项目中的文件变更事件都会被所有的项目共享因此需要注意对文件进行过滤处理。

通过以上简单的代码我们就可以获取所有的文件变更事件做我们想做的事了例如统一在文件前增加版权信息。

编辑器

对象主要是对其文档和光标活动的监听。

而本文文章则会详细介绍关于

Editor

中的一些基础概念主要是几个模型对象和文档对象在正式介绍前先说一下获取

Editor

FileEditorManager.getInstance(project).selectedEditor

Action

e.getData(PlatformDataKeys.EDITOR)下面正式开始介绍

Editor

对象主要提供了获取和替换文件文本的一些方法还可以添加对文档内容的监听

CaretModel(插入符模型)

Position(视觉位置)。

下面以一个简单的代码样例展示区别

val

e.getData(PlatformDataKeys.EDITOR)

return

Utils.info(逻辑位置:br/${-.repeat(20)}br/行号:

${caretModel.logicalPosition.line

1}br/列号:

${caretModel.logicalPosition.column

1}br/br/视觉位置:br/${-.repeat(20)}br/行号:

${caretModel.visualPosition.line

1}br/列号:

${caretModel.visualPosition.column

1}br/

.trimIndent())可以看出来逻辑位置对应光标在文件中所处的真实位置5

3。

除此之外可以看到上述代码中不管是caretModel.logicalPosition还是caretModel.visualPosition在获取行号和列号的时候都在结果加

开始计算。

这里要注意的是上面的折叠代码只是影响视觉位置结果的一种情况如果文件开启自动断行Soft-Wrap

使用类似阿拉伯语这种右向文字也会影响逻辑位置和视觉位置的结果。

除了以上两种定位方式我们还可以通过caretModel.offset直接获取光标所在位置的全局偏移量

alt

结合鼠标左键进行多行选择每一个光标的位置也是按照上述规则进行计算

Utils.info(偏移量:br/${-.repeat(20)}br/偏移量:

Doucument

WriteCommandAction.runWriteCommandAction

WriteCommandAction.runWriteCommandAction(e.project)

{//

庄周de蝴蝶document.insertString(caretModel.offset,

msg)caretModel.moveToOffset(caretModel.offset

msg.length)

}上述代码实现了在光标处插入指定文本信息并移动光标位置的效果。

InlayModel(嵌入模型)

InlayModel(嵌入模型)用于在代码行中嵌入各种信息例如下图中msg:就属于嵌入信息通过使用嵌入信息可以在不改变文本内容的情况下给用户一个直观的提示内容

InlayModel

inlayModel.getInlineElementsInRange(0,

editor.document.textLength).forEach

Disposer.dispose(it)

inlayModel.getBlockElementsInRange(0,

editor.document.textLength).forEach

Disposer.dispose(it)

caretModel.visualPosition.column

inlayModel.addInlineElement(offset,

DemoRender(editor,

inlayModel.addBlockElement(offset,

InlayProperties(),DemoRender(editor,

mutableListOf(first

caretModel.moveToVisualPosition(VisualPosition(caretModel.visualPosition.line,

column))class

editor.colorsScheme.editorFontSize)override

fun

super.calcHeightInPixels(inlay)

renderText.sizeelse

super.calcHeightInPixels(inlay)}}override

fun

Graphics2DGraphicsUtil.setupAAPainting(g2)textAttributes.foregroundColor

JBColor.GRAYval

editor.lineHeight.toDouble()val

fontBaseline

ceil(font.createGlyphVector(getFontMetrics().fontRenderContext,

linePadding

editor.settings.getTabSize(editor.project)val

startOffset

lineOffset).toFloat())g2.translate(0.0,

lineHeight)}}else

getFontMetrics().stringWidth(text)

}private

FontInfo.getFontRenderContext(editor.contentComponent)val

context

FontRenderContext(editorContext.transform,

AntialiasingType.getKeyForCurrentScope(false),

editorContext.fractionalMetricsHint)return

context)}

SoftWrapModel(自动断行模型)主要用于获取自动断行相关信息其包含的方法较少也很少会用到简单了解即可如下是一个简单的使用及效果

val

${softWrapModel.isSoftWrappingEnabled}br/当前行是否存在自动断行:

${softWrapModel.getSoftWrapsForLine(caretModel.offset).isNotEmpty()}br/

.trimIndent())MarkupModel(标记模型)

MarkupModel(标记模型)主要用于用于将指定行或者某个区间设置为高亮下面直接展示其使用方式和效果很容易理解和使用

val

markupModel.removeAllHighlighters()

设置当前行为红色高亮背景

caretModel.logicalPosition.line

markupModel.addLineHighlighter(line,

lineAttr)//

HighlighterTargetArea.EXACT_RANGE

则为精确范围

HighlighterTargetArea.LINES_IN_RANGE

val

markupModel.addRangeHighlighter(0,

rangeAttr,

HighlighterTargetArea.EXACT_RANGE)SelectionModel(选中模型)

SelectionModel(选中模型)用于处理编辑器中文本选中相关的操作下面是一个简单的使用样例

先移除所有文本选中,

selectionModel.removeSelection(true)

${selectionModel.selectedText}br/选中文本的开始和结束位置:

(${selectionModel.selectionStart},

${selectionModel.selectionEnd})br/

.trimIndent())FoldingModel(折叠模型)

FoldingModel(折叠模型)用于对代码块进行折叠操作通过结合

SelectionModel可以很方便地对选中的文本进行折叠下面是使用方式及效果

val

foldingModel.runBatchFoldingOperation

{//

移除所有的折叠foldingModel.allFoldRegions.forEach

foldingModel.removeFoldRegion(it)

}//

对选中文本进行折叠并设置显示的提示文本foldingModel.addFoldRegion(selectionModel.selectionStart,

庄周de蝴蝶)

IndentsModel(缩进模型)用于获取文本中的缩进信息使用方式也很简单如下所示

val

.trimIndent())ScrollingModel(滚动模型)

ScrollingModel(滚动模型)可以用于获取编辑器的可视区域范围以及执行滚动操作使用方法如下

val

scrollingModel.scrollToCaret(ScrollType.CENTER)

scrollingModel.runActionOnScrollingFinished

{scrollingModel.visibleArea.let

(${it.x},

中的事件监听当时只介绍了项目的启用与关闭事件这里再简单介绍一下关于编辑器的事件。

EditorActionHandler

平台默认为我们提供了一些编辑器事件例如复制、粘贴等可以在IdeActions类中看到

相应地使用方式也很简单只需要实现

注册复制监听EditorActionManager.getInstance().setActionHandler(IdeActions.ACTION_EDITOR_COPY,

this)}override

selectionModeleditor.selectionModel.copySelectionToClipboard()//

显示复制文本Messages.showInfoMessage(Copy

text:

${CopyPasteManager.getInstance().getContentsString(DataFlavor.stringFlavor)},

Copy)}

}这里需要注意的是在重写了编辑器的事件后这里是复制事件则该事件就不再生效了因此这里通过editor.selectionModel.copySelectionToClipboard()这行代码手动了复制的操作在重写其它编辑器事件的时候也需要注意这个问题。

TypedHandlerDelegate

来对键盘中输入的字符进行监听无法监听空白字符例如回车、TAB等也无法在出现编码提示时进行监听

class

{Messages.showInfoMessage(Input

character:

Result.CONTINUE}}同时需要在plugin.xml中进行配置

extensions

defaultExtensionNscom.intellijtypedHandler

implementationcn.butterfly.vfs.listener.KeyboardListener/

/extensions总结

和编辑器相关的知识其中编辑器相关的内容则需要重点关注这是开发各类插件都离开的东西毕竟我们开发的插件大多都要和编辑器里的代码打交道同时如果有错误之处也欢迎一起交流讨论。

题外话

的知识不过想一下还是决定先写一篇在第三篇文章中提到的关于内部工具能极大提升初学者开发插件的效率我个人是这么认为的使用的文章然后再继续介绍关于

PSI