原文鏈接：
http://www.jetbrains.org/intellij/sdk/docs/basics/indexing_and_psi_stubs/file_based_indexes.html
基于文件的索引基于Map/Reduce架構(gòu)。 每個(gè)索引具有某種類型的鍵和某種類型的值。
鍵是以后用來(lái)從索引檢索數(shù)據(jù)兽泄。
例如： 單詞索引的鍵是單詞本身玻熙。
值是與索引中的鍵相關(guān)聯(lián)的任意數(shù)據(jù)。
例如： 單詞索引的值是指示該單詞（代碼瓤摧，字符串字面量或注釋）在哪個(gè)上下文中出現(xiàn)的掩碼忿危。
在最簡(jiǎn)單的情況下，當(dāng)我們只需要知道在數(shù)據(jù)出現(xiàn)在那些文件中時(shí)铣卡，值的類型是Void并且不存儲(chǔ)在索引中链韭。
當(dāng)索引文件時(shí)，它接收文件的內(nèi)容并返回一個(gè)從文件中找到的鍵到關(guān)聯(lián)值的映射煮落。
當(dāng)訪問(wèn)索引時(shí)敞峭，你可以指定感興趣的鍵便會(huì)返回鍵出現(xiàn)的文件列表和與每個(gè)文件關(guān)聯(lián)的值。
實(shí)現(xiàn)基于文件的索引
一個(gè)相當(dāng)簡(jiǎn)單的基于文件索引的實(shí)現(xiàn)是UI Designer bound forms index蝉仇。參考它作為一個(gè)例子來(lái)更好地理解這個(gè)主題旋讹。
每個(gè)特定的索引實(shí)現(xiàn)是一個(gè)繼承FileBasedIndexExtension的類。 基于文件的索引應(yīng)該注冊(cè)<fileBasedIndex>擴(kuò)展點(diǎn)轿衔。
基于文件的實(shí)現(xiàn)包含以下主要部分：
-
getIndexer()返回索引器類沉迹，其負(fù)責(zé)根據(jù)文件內(nèi)容實(shí)際構(gòu)建一組鍵/值對(duì)； -
getKeyDescriptor()返回鍵描述符害驹，其負(fù)責(zé)比較鍵并將其存儲(chǔ)為序列化的二進(jìn)制格式鞭呕。
可能最常用的KeyDescriptor實(shí)現(xiàn)是EnumeratorStringDescriptor，其設(shè)計(jì)為高效地存儲(chǔ)標(biāo)識(shí)符裙秋。
-
getValueExternalizer()返回值序列化程序琅拌，它負(fù)責(zé)以序列化的二進(jìn)制格式存儲(chǔ)值。 -
getInputFilter()允許僅將索引限制到某一組文件摘刑。 -
getVersion()返回索引實(shí)現(xiàn)的版本进宝。如果當(dāng)前版本與用于構(gòu)建索引的索引實(shí)現(xiàn)的版本不同，索引將會(huì)自動(dòng)重建枷恕。
如果不需要任何值與文件關(guān)聯(lián)（即值類型為Void）党晋，你可以使用ScalarIndexExtension作為基類來(lái)簡(jiǎn)化實(shí)現(xiàn)。
注意
DataIndexer.map()返回的數(shù)據(jù)必須僅依賴于傳遞給方法的輸入數(shù)據(jù)徐块，不能依賴于任何外部文件未玻。 否則當(dāng)外部數(shù)據(jù)更改時(shí)，你的索引將無(wú)法正確更新并且索引中將有過(guò)期數(shù)據(jù)胡控。
注意 請(qǐng)查閱
com.intellij.util.indexing.DebugAssertions了解如何在開(kāi)發(fā)期間啟用額外調(diào)試斷言以斷言正確的索引實(shí)現(xiàn)扳剿。
訪問(wèn)基于文件的索引
訪問(wèn)基于文件的索引是通過(guò)FileBasedIndex類進(jìn)行的。
支持的主要操作如下：
-
getAllKeys()和processAllKeys()允許獲取指定項(xiàng)目部分文件中找到的所有鍵的列表昼激。
注意 返回的數(shù)據(jù)保證包含在最新項(xiàng)目?jī)?nèi)容中找到的所有鍵庇绽，但也可能包含項(xiàng)目中當(dāng)前未找到的其它鍵伙判。
-
getValues()允許獲取與指定鍵關(guān)聯(lián)的所有值但是不包含文件中找到的茎截； -
getContainingFiles()允許獲取遇到指定鍵的所有文件； -
processValues()允許遍歷遇到指定鍵的所有文件并同時(shí)訪問(wèn)相關(guān)的值健霹。
注意 嵌套索引訪問(wèn)是禁止的因?yàn)樗赡軐?dǎo)致死鎖凡傅。 首先從索引A收集所有必要的數(shù)據(jù)辟狈，然后在訪問(wèn)索引B時(shí)處理結(jié)果。
標(biāo)準(zhǔn)索引
*IntelliJ平臺(tái) *包含許多標(biāo)準(zhǔn)的基于文件的索引。插件開(kāi)發(fā)者最有用的索引是：
- 單詞索引
- 文件名索引
通常哼转，單詞索引應(yīng)該被間接訪問(wèn)但可以使用PsiSearchHelper類中的輔助方法明未。
第二個(gè)索引是FilenameIndex。它提供了一種快速方法來(lái)查找與特定文件名匹配的所有文件壹蔓。FileTypeIndex提供了類似的目標(biāo)：它允許快速找到特定文件類型的所有文件亚隅。
