通用線程規(guī)則

原文鏈接:
http://www.jetbrains.org/intellij/sdk/docs/basics/architectural_overview/general_threading_rules.html

插件應(yīng)該使用ApplicationManager.getApplication().invokeLater()而不是標(biāo)準(zhǔn)的SwingUtilities.invokeLater()傳遞控制從后臺(tái)線程到事件分發(fā)線程。這個(gè)API允許調(diào)用指定modality state,即允許調(diào)用執(zhí)行的模態(tài)對(duì)話框的堆棧。 傳遞ModalityState.NON_MODAL意味著在所有模態(tài)對(duì)話框關(guān)閉后執(zhí)行操作。 傳遞ModalityState.stateForComponent()意味著可以在指定的組件(對(duì)話框的一部分)仍然可見時(shí)執(zhí)行操作。

讀/寫鎖

通常情況下,*IntelliJ平臺(tái) *中代碼相關(guān)的數(shù)據(jù)結(jié)構(gòu)由一個(gè)單獨(dú)的讀寫鎖監(jiān)控。這適用于PSI,VFS和項(xiàng)目根模型。

可以從任何線程讀取數(shù)據(jù),從UI線程讀取數(shù)據(jù)不需要任何特殊的工作。但是,從任何其它線程的讀操作都需要使用ApplicationManager.getApplication().runReadAction()包裹,或者簡短一點(diǎn)使用ReadAction.run/compute

只允許從UI線程寫數(shù)據(jù),寫操作必須被ApplicationManager.getApplication().runWriteAction()包裹,或者簡短一點(diǎn)使用WriteAction.run/compute

除此之外,修改模型只允許從寫安全上下文中進(jìn)行,包括用戶操作,安全上下文中的invokeLater調(diào)用(查閱下一部分)和事務(wù)(TransactionGuard.submitTransaction)。你可能無法從UI渲染器或SwingUtilities.invokeLater調(diào)用中修改PSI、VFS或項(xiàng)目模型。更多詳情請(qǐng)查閱TransactionGuard文檔。

你不能在讀寫操作之外訪問模型。相關(guān)對(duì)象不能保證在幾個(gè)連續(xù)的讀取操作之間存在。 所以根據(jù)經(jīng)驗(yàn),每當(dāng)你開始一個(gè)讀取操作前都應(yīng)確認(rèn)說操作的PSI / VFS /項(xiàng)目/模塊是否仍然有效。

invokeLater

插件應(yīng)該使用ApplicationManager.getApplication().invokeLater()而不是標(biāo)準(zhǔn)的SwingUtilities.invokeLater()傳遞控制從后臺(tái)線程到事件分發(fā)線程。這個(gè)API允許調(diào)用指定模態(tài)狀態(tài),即允許調(diào)用執(zhí)行的模態(tài)對(duì)話框的堆棧。

  • 傳遞ModalityState.NON_MODAL意味著在所有模態(tài)對(duì)話框關(guān)閉后執(zhí)行操作。注意這個(gè)狀態(tài)幾乎是不合適的,因?yàn)槿绻魏未蜷_的(不相關(guān)的)項(xiàng)目顯示一個(gè)每個(gè)項(xiàng)目的模式對(duì)話框,該操作將在其關(guān)閉后執(zhí)行。
  • 傳遞ModalityState.stateForComponent()意味著當(dāng)頂層顯示的對(duì)話框包含指定組件或是指定組件父對(duì)話框之一時(shí)執(zhí)行操作。
  • 如果沒有傳遞模態(tài)狀態(tài),ModalityState.defaultModalityState()將會(huì)被使用。大多數(shù)情況下這是最佳選擇,這時(shí)來自UI線程的調(diào)用將使用當(dāng)前模態(tài)狀態(tài),并且對(duì)用ProgressManager啟動(dòng)的后臺(tái)進(jìn)程有特殊處理:來自此進(jìn)程的invokeLater可能會(huì)運(yùn)行在進(jìn)程啟動(dòng)時(shí)的相同對(duì)話框。
  • ModalityState.any()意味著runnable將會(huì)被盡快執(zhí)行而不管模態(tài)對(duì)話框。請(qǐng)注意此時(shí)runnable中禁止修改PSI、VFS或項(xiàng)目模型。更多詳情請(qǐng)查閱TransactionGuard文檔。

如果你的UI線程活動(dòng)需要訪問基于文件的索引(如正在進(jìn)行項(xiàng)目范圍的PSI分析,解析引用等等),請(qǐng)使用DumbService#smartInvokeLater。這樣,你的活動(dòng)將在所有可能的索引進(jìn)程完成后運(yùn)行。

防止UI凍結(jié)

后臺(tái)線程不應(yīng)執(zhí)行長時(shí)間的讀取操作。原因是如果UI線程需要寫操作(如用戶輸入某些東西),它必須盡快獲取控制權(quán),否則在所有后臺(tái)線程都釋放讀操作之前UI將被凍結(jié)。

最著名的方法是每當(dāng)即將發(fā)生寫操作時(shí)取消后臺(tái)讀取操作,稍后重新啟動(dòng)后臺(tái)讀取操作。 編輯器高亮顯示,代碼補(bǔ)全,轉(zhuǎn)到類/文件等操作都是這樣的。 有兩種推薦的方法:

  • 如果你正在UI線程,插件一個(gè)ReadTask并將它傳到ProgressIndicatorUtils.schedule*方法中的其中一個(gè)。在onCanceled中, 如果活動(dòng)需要重新啟動(dòng)再次安排它執(zhí)行。
  • 如果你已經(jīng)在后臺(tái)線程,在循環(huán)中使用ProgressManager.getInstance().runInReadActionWithWriteActionPriority(),直到它通過或整個(gè)活動(dòng)被廢棄。

在這兩種方法中,每個(gè)讀取操作的開始你應(yīng)該總是檢查所用對(duì)象是否仍然有效,整個(gè)操作是否仍然有意義(即未被用戶取消,項(xiàng)目未被關(guān)閉等)。

如果你正在進(jìn)行的活動(dòng)必須訪問基于文件的索引(如正在進(jìn)行項(xiàng)目范圍的PSI分析,解析引用等等),你應(yīng)該重寫ReadTask#runBackgroundProcess并使用"smart-mode"讀取操作:DumbService.getInstance(project).runReadActionInSmartMode(() -> performInReadAction(indicator))

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,106評(píng)論 6 542
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 99,441評(píng)論 3 429
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,211評(píng)論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,736評(píng)論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 72,475評(píng)論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,834評(píng)論 1 328
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,829評(píng)論 3 446
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 43,009評(píng)論 0 290
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,559評(píng)論 1 335
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 41,306評(píng)論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 43,516評(píng)論 1 374
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,038評(píng)論 5 363
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,728評(píng)論 3 348
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,132評(píng)論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,443評(píng)論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 52,249評(píng)論 3 399
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 48,484評(píng)論 2 379

推薦閱讀更多精彩內(nèi)容