基于文件的索引

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

基于文件的索引基于Map/Reduce架构。 每个索引具有某种类型的键和某种类型的值。

键是以后用来从索引检索数据。

例如: 单词索引的键是单词本身。

值是与索引中的键相关联的任意数据。

例如: 单词索引的值是指示该单词(代码,字符串字面量或注释)在哪个上下文中出现的掩码。

在最简单的情况下,当我们只需要知道在数据出现在那些文件中时,值的类型是Void并且不存储在索引中。

当索引文件时,它接收文件的内容并返回一个从文件中找到的键到关联值的映射。

当访问索引时,你可以指定感兴趣的键便会返回键出现的文件列表和与每个文件关联的值。

实现基于文件的索引

一个相当简单的基于文件索引的实现是UI Designer bound forms index。参考它作为一个例子来更好地理解这个主题。

每个特定的索引实现是一个继承FileBasedIndexExtension的类。 基于文件的索引应该注册<fileBasedIndex>扩展点。

基于文件的实现包含以下主要部分:

  • getIndexer()返回索引器类,其负责根据文件内容实际构建一组键/值对;
  • getKeyDescriptor()返回键描述符,其负责比较键并将其存储为序列化的二进制格式。

可能最常用的KeyDescriptor实现是EnumeratorStringDescriptor,其设计为高效地存储标识符。

  • getValueExternalizer()返回值序列化程序,它负责以序列化的二进制格式存储值。
  • getInputFilter()允许仅将索引限制到某一组文件。
  • getVersion()返回索引实现的版本。如果当前版本与用于构建索引的索引实现的版本不同,索引将会自动重建。

如果不需要任何值与文件关联(即值类型为Void),你可以使用ScalarIndexExtension作为基类来简化实现。

注意 DataIndexer.map()返回的数据必须仅依赖于传递给方法的输入数据,不能依赖于任何外部文件。 否则当外部数据更改时,你的索引将无法正确更新并且索引中将有过期数据。

注意 请查阅com.intellij.util.indexing.DebugAssertions了解如何在开发期间启用额外调试断言以断言正确的索引实现。

访问基于文件的索引

访问基于文件的索引是通过FileBasedIndex类进行的。

支持的主要操作如下:

  • getAllKeys()processAllKeys()允许获取指定项目部分文件中找到的所有键的列表。

注意 返回的数据保证包含在最新项目内容中找到的所有键,但也可能包含项目中当前未找到的其它键。

  • getValues()允许获取与指定键关联的所有值但是不包含文件中找到的;
  • getContainingFiles()允许获取遇到指定键的所有文件;
  • processValues()允许遍历遇到指定键的所有文件并同时访问相关的值。

注意 嵌套索引访问是禁止的因为它可能导致死锁。 首先从索引A收集所有必要的数据,然后在访问索引B时处理结果。

标准索引

*IntelliJ平台 *包含许多标准的基于文件的索引。插件开发者最有用的索引是:

  • 单词索引
  • 文件名索引

通常,单词索引应该被间接访问但可以使用PsiSearchHelper类中的辅助方法。

第二个索引是FilenameIndex。它提供了一种快速方法来查找与特定文件名匹配的所有文件。FileTypeIndex提供了类似的目标:它允许快速找到特定文件类型的所有文件。

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

推荐阅读更多精彩内容