收藏！这些 IDE 使用技巧，你都知道吗
作者 |?璞珂
來源 | 阿里巴巴云原生公眾號
背景
1. 目的
欲善其事，先利其器。對于研發(fā)同學(xué)，在日常的開發(fā)工作中，我們與之打交道最多的便是編程的 IDE。能否高效和靈活的使用 IDE，將對我們的工作效率起著舉足輕重的作用。
研發(fā)同學(xué)在開發(fā)中最主要做的兩件事分別是架構(gòu)設(shè)計和編碼，前者主要取決于大量的項目經(jīng)驗積累和個人的思考深度，也是作為研發(fā)的核心競爭力，短時間內(nèi)很難快速求成；后者主要取決于日常的編碼練習(xí)和一定程度的 IDE 信息差，能夠通過下文中介紹的一系列技巧進行能力的快速補齊和鞏固加強。
本文的主要目的有兩方面：
-
一方面，對 IDE 的快捷操作和高效技巧，結(jié)合自己多年的實踐和理解，進行一次系統(tǒng)性的總結(jié)和梳理。
-
另一方面，希望通過本文系統(tǒng)性的梳理，能夠幫助更多的同學(xué)提高研發(fā)效率，無論你是剛?cè)胧植痪玫男氯?#xff0c;還是有著多年開發(fā)經(jīng)驗的專家，相信你都能夠在本文中發(fā)現(xiàn)一片新天地，讓你能夠有更多的時間和精力去做更有意義的事情。
2. 定位
網(wǎng)上很多技術(shù)網(wǎng)站和個人博客，對于 IDE 各種技巧和便捷操作總結(jié)得非常具體且詳細，對于單點的詳盡程度都是極具參考和學(xué)習(xí)價值的。但其對應(yīng)的問題是，這些很多很優(yōu)秀的文章，出自于不同的手筆，有各自的行文風(fēng)格，且分散在各個網(wǎng)站的散點，難以系統(tǒng)化。
我對本文的定位是，將各種技巧以大分類的形式進行收攏和聚合，以幫助大家構(gòu)建和完善整體的知識體系，大幅度提高開發(fā)效率。對于每個分類點到即止，替代咀嚼式灌輸方式的是，盡量使用漸進式引導(dǎo)的方式。
3. 普適性
JetBrains 系列的 IDE 產(chǎn)品眾多，除了下圖之外，還有其他未列入的，如 Google 二次開發(fā)的 Android Studio 等。雖然歸為多個產(chǎn)品實例，但這些 IDE 的內(nèi)核都是一樣的，只是在內(nèi)核的基礎(chǔ)上額外添加了各自的語言特性。本文將以使用量最高的一款I(lǐng)DE——IDEA 為例進行展開，文中提到的絕大多數(shù)能力和技巧，在其他 IDE 均同樣適用，一通則百通。
Postfix Completion
1. 介紹
Postfix Completion (下稱 Postfix) 是一種通過 . + 模板 Key 來對當前已經(jīng)輸出的表達式，添加和應(yīng)用預(yù)設(shè)代碼模板的編碼增強能力。
其核心要解決的問題是，將編碼過程中一些通用的代碼結(jié)構(gòu)范式進行抽象和沉淀，并能在同類型的場景下，通過 . + 模板 Key 的方式進行喚醒和復(fù)用。
舉個例子，現(xiàn)在需要完成下面一段代碼的編寫，為了對 name 參數(shù)進行判空保護：
if (name != null) {}在普通文本編輯器中，其中 if 2 次，name 4 次，(){}!= 共 6 次，再加空格 Tab 和光標切換，一共需要按鍵 23 次。
在 IDEA 編輯器中，不使用 Postfix 時，一共需要按鍵 20 次，不考慮代碼格式化的情況可以減少到 16 次。
在 IDEA 編輯器中，使用 Postfix 時，只需要 8 次，如下圖：
在這個例子中，可以對比出使用 Postfix 前后的效果，使用之后在編碼中減少了一半的手動按鍵操作，且生成的代碼是自帶格式化的。在實際的編碼過程中，各項目大小和復(fù)雜度差異性雖然很大，但細化到這種基本單位的編程范式時，它們都是融會貫通的。
與上例中 nn 并列的 Postfix，IDEA 給我們預(yù)設(shè)的還有很多，下面對一些非常高頻使用的 Postfix 進行梳理。
2. 梳理
1）var
快速定義一個局部變量，自帶 IDE 的類型推斷：
2）notnull
快速進行 NPE 的判空保護：
3）nn
同 notnull，是它的簡寫，推薦用這個，更加便捷：
4）try catch
快速對當前語句添加 try catch 異常捕獲，同時 IDE 還會對 catch 中的 Exception 自動做類型推斷：
5）cast
快速實現(xiàn)類型強轉(zhuǎn)，不需要反復(fù)使用()包裹和光標切換；配合instanceof使用時還能自動實現(xiàn)cast類型的推斷：
6）if
快速實現(xiàn) if 判斷的代碼范式：
7）throw
快速實現(xiàn)拋異常：
8）for
快速實現(xiàn)集合或數(shù)組的迭代：
9）fori
快速實現(xiàn)集合或數(shù)組的帶索引值迭代；同時對整型數(shù)字也支持：
10）sout/soutv
快速實現(xiàn)（不帶參數(shù)/帶參數(shù)）的打印功能：
11）return
快速實現(xiàn)方法中的值返回邏輯：
12）format
快速實現(xiàn)字符串格式化：
3. 高級用法
擔心系統(tǒng)預(yù)設(shè)的 Postfix 不足以滿足我們的編碼需求，IDEA 還提供了 Postfix 的自定義功能。
這里我以自定義一個對集合判空的代碼范式，來舉例說明自定義 Postfix 的流程：
- 進入 IDE 設(shè)置界面，然后依次進入 Editor => General => Postfix Completion => 面板左下角加號 => Java：
- 在彈起的頁面中，按照下圖進行配置，然后保存退出設(shè)置頁。
此時我們自定義的 isempty 這個 Postfix 即完成了，下面來看下實際使用的效果：
在實際開發(fā)過程中，對于根據(jù)已經(jīng)輸入的表達式就能決定接下來代碼格式的功能，我們都能使用這種自定義方式進行代碼的抽象和復(fù)用。
接下來介紹 IDE 中一種跟 Postfix 功能很相像，但靈活度更高的能力 —— Live Template。
Live Template
1. 介紹
介紹之前可以先看一段簡短的編碼過程：
上面這段編碼中，我先后使用了 Live Template 的以下三個模板能力：
- psfs：定義字符串常量
- main：添加入口函數(shù)
- sout：實現(xiàn)日志輸出
這里我們將其和上面提到的 Postfix 對比來看，兩者都是提供代碼級別模板的功能。不同的是，Postfix 需要一個已經(jīng)輸入的表達式和 . + 模板 Key 來進行觸發(fā)，而 Live Template 不需要這些，它僅僅需要**模板 Key?**即可觸發(fā)。
Live Template 提供的預(yù)設(shè)模板要比 Postfix 要高出一個數(shù)量級，因此這里我就不進行一一演示，我們可以進行設(shè)置面板，然后按照 Editor => Live Templates 的路徑自行查看，如下圖：
2. 高級用法
和 Postfix 一樣，Live Template 也支持自定義模板，但它的自定義模板相對來說更加靈活和開放，甚至支持我們直接植入腳本。鑒于 Live Template 的高度靈活性，單獨介紹這塊會占據(jù)大量的篇幅，因此這里我將從幾個實際的案例場景來開拓一下思路，而具體自定義拓展過程就不詳細展開介紹了。
1）Key?值映射
將 DB 中查詢到 List 結(jié)構(gòu)的數(shù)據(jù)，根據(jù) Key 值映射轉(zhuǎn)化為 Map<K, T> 結(jié)構(gòu)的數(shù)據(jù)，以便于進行后續(xù)的數(shù)據(jù)填充邏輯：
2）DB 批量查詢
在數(shù)據(jù)查詢時，我們會有根據(jù) ID 主鍵進行批量 DB 數(shù)據(jù)查詢的訴求，如下：
List<User> users = userMapper.queryUserByIds(userIds);這種寫法會有一個弊端，就是當 userIds 大到一定的量級時，該查詢會變得非常耗時。
對于該問題其中一個解法是，將這個大的 userIds 拆分成多個批次，然后讓這多個批次異步并行去查詢。這里便使用 Live Template 來抽取一個針對該場景的代碼模板，如下：
按照該模板，我們的查詢語句將變成這樣：
List<User> users = batchQuery(userIds, 100, userMapper::queryUserByIds, null);可以看到，和之前相比，多傳一個分批的 size 參數(shù)，同時還支持指定的異步任務(wù)調(diào)度器的自定義配置，而返回結(jié)果和之前的查詢方式保持完全一致，不需要外部有額外的適配工作。
3）腳本植入
這個功能是我非常看好 Live Template 的主要原因，它的靈活性和拓展性也主要來源于這里。它支持我們通過一個**模板 Key?**來喚起和執(zhí)行一段腳本，這也就意味著，我們的自定義的 Live Template 模板是可編程的，極大程度提高了該模板的拓展性。
單描述功能會有些空洞，這里我結(jié)合一個實際案例進行介紹，我們來實現(xiàn)一個跨電腦的代碼共享功能：
- 首先，使用 python 的 flask 框架寫一個極簡的服務(wù)端應(yīng)用并啟動，提供最簡單的 push 和 pull 的能力，如下：
- 然后，我們來通過 groovy 腳本實現(xiàn)一個代碼 pull 的模板，這里應(yīng)用了 Live Template 的 groovy script 能力，對應(yīng)腳本如下：
- 最后，再實現(xiàn)代碼 push 的模板，腳本如下（下面的代碼入?yún)?#xff0c;是通過剪切板賦值傳遞過來的）：
此時就已經(jīng)完成了跨設(shè)備的代碼分享功能，為方便演示，這里就用 People1 和 People2 兩個類來模擬兩臺獨立的電腦。People1 將自己的一段代碼復(fù)制到剪切板中，然后通過 push 模板調(diào)用 push 接口來將這段代碼上傳到 Python 服務(wù)應(yīng)用中；People2 再通過 pull 腳本來調(diào)用服務(wù)端的 pull 接口，訪問到 People1 上傳的代碼并輸入到當前的代碼編輯器中，實現(xiàn)效果如下圖：
這里的代碼共享只是一個引子，除此之外，我們還能寫很多有意思的腳本，比如在 IDE 中查天氣、通過 IDE 聊天等等，自行腦補拓展。
介紹完 Live Template 之后，接下來介紹文件級別的模板 —— File Template。
File Template
1. 介紹
File Template，顧名思義，對應(yīng)文件級別的模板。對于該模板，我們使用腳本的主要在于兩個場景，分別是文件頭和文件的自定義，下面結(jié)合案例依次展開。
2. 自定義文件頭
按照下圖的路徑，來更改文件頭的格式，IDE 就會在我們新建一個類或接口時，根據(jù)這里的配置格式來自動生成對應(yīng)的文件注釋頭。
3. 抽象通用 Controller
看下面一段代碼，這是一個針對于 User 這個 domain 的增刪改查接口類：
package com.alibaba.ide.code.controller;import com.alibaba.ide.code.entity.Result; import com.alibaba.ide.code.entity.User; import com.alibaba.ide.code.service.Condition; import com.alibaba.ide.code.service.UserService; import org.springframework.web.bind.annotation.*;import javax.annotation.Resource; import java.io.Serializable; import java.util.List;/*** @author puke* @version 2021/2/9*/ @RestController @RequestMapping("api/user") public class UserController {@Resourceprivate UserService userService;@PostMappingpublic Result<User> create(@RequestBody User record) {User user = userService.insert(record);return Result.success(user);}@PutMappingpublic Result<User> update(@RequestBody User record) {User user = userService.update(record);return Result.success(user);}@DeleteMapping("{id}")public Result<Void> deleteById(@PathVariable Serializable id) {boolean success = userService.deleteById(id);return success ? Result.success() : Result.fail();}@GetMapping("{id}")public Result<User> queryById(@PathVariable Serializable id) {User user = userService.queryById(id);return Result.success(user);}@GetMappingpublic Result<List<User>> queryByCondition(Condition<User> condition) {List<User> list = userService.queryByCondition(condition);return Result.success(list);} }仔細看這段代碼會發(fā)現(xiàn)，如果基于該接口再新增另一個 domain 對應(yīng)的 Controller 接口類，代碼中的基本結(jié)構(gòu)和邏輯都是可以復(fù)用的。此時，便是 File Template 排上用場的地方，我們定義一個通用的 Controller 模板，將共性的部分抽象到模板里，再將差異性的部分通過模板入?yún)?Subject 變量傳入進來（注，這里需要用到 Velocity 模板的知識）。
#set($SubjectOfLowerFirst = ${Subject.substring(0,1).toLowerCase()} + $Subject.substring(1)) package ${PACKAGE_NAME};import com.alibaba.ide.code.entity.Result; import com.alibaba.ide.code.entity.${Subject}; import com.alibaba.ide.code.service.Condition; import com.alibaba.ide.code.service.${Subject}Service; import org.springframework.web.bind.annotation.*;import javax.annotation.Resource; import java.io.Serializable; import java.util.List;#parse("File Header.java") @RestController @RequestMapping("api/${SubjectOfLowerFirst}") public class ${Subject}Controller {@Resourceprivate ${Subject}Service ${SubjectOfLowerFirst}Service;@PostMappingpublic Result<${Subject}> create(@RequestBody ${Subject} record) {${Subject} ${SubjectOfLowerFirst} = ${SubjectOfLowerFirst}Service.insert(record);return Result.success(${SubjectOfLowerFirst});}@PutMappingpublic Result<${Subject}> update(@RequestBody ${Subject} record) {${Subject} ${SubjectOfLowerFirst} = ${SubjectOfLowerFirst}Service.update(record);return Result.success(${SubjectOfLowerFirst});}@DeleteMapping("{id}")public Result<Void> deleteById(@PathVariable Serializable id) {boolean success = ${SubjectOfLowerFirst}Service.deleteById(id);return success ? Result.success() : Result.fail();}@GetMapping("{id}")public Result<${Subject}> queryById(@PathVariable Serializable id) {${Subject} ${SubjectOfLowerFirst} = ${SubjectOfLowerFirst}Service.queryById(id);return Result.success(${SubjectOfLowerFirst});}@GetMappingpublic Result<List<${Subject}>> queryByCondition(Condition<${Subject}> condition) {List<${Subject}> list = ${SubjectOfLowerFirst}Service.queryByCondition(condition);return Result.success(list);} }模板定義完成，接下來看一下實際的使用效果：
這里使用 Goods 作為新的 domain 對象，可以看到，生成的 Controller 代碼已經(jīng)具備 UserController 的全部能力，并且生成的代碼全部都是 Goods 相關(guān)的 api，這樣就實現(xiàn)了 File Template 的橫向遷移能力。
低頻高效快捷鍵
1. 介紹
IDEA 中的快捷鍵多達上百個，我們很難把每個都記清楚，網(wǎng)上也有很多對應(yīng)的總結(jié)。這里我主要梳理一些，大家使用相對比較低頻，但又非常高效的快捷鍵。
2. 梳理
1）選擇重復(fù)元素：Control + G
通常情況下，我們可以使用 Shift + F6 對類名、方法名和變量名進行批量更改，但對于其他元素進行批量更改時，該快捷鍵特別合適，且不限編程語言。
2）批量框選：Option + 鼠標左鍵拖拽
對于"對齊"的代碼進行批量更改的最優(yōu)解，沒有之一：
3）整行移動：Option + Shift + ↑/↓
快速調(diào)整代碼執(zhí)行順序，免除繁瑣的剪切粘貼過程：
4）整行/塊復(fù)制：Command + D
對于整行/塊的復(fù)制，效率遠高于純手動的復(fù)制粘貼：
5）展開/收起：Command + . or Command + Shift + +/-
前者，快速顯示/隱藏當前方法體；后者，快速概覽當前類的所有方法：
6）修改方法簽名：Command + F6
在方法被多文件或多處調(diào)用時，該方式替換效率極高：
7）查看歷史剪切板：Command + Shift + V
開發(fā)中經(jīng)常會出現(xiàn)需要復(fù)制多個文本的訴求，而PC默認的剪切板只能保存一個，該功能專門用來解決這個痛點：
8）代碼抽取
代碼抽取主要用在代碼重構(gòu)的時候，以最快速度達到我們抽取一個變量、方法的目的。
- 抽局部變量：Command + Option + V
- 抽成員變量：Command + Option + F
- 抽靜態(tài)常量：Command + Option + C
- 抽方法入?yún)?#xff1a;Command + Option + P
- 抽方法：Command + Option + M
代碼調(diào)試
代碼調(diào)試在開發(fā)中使用的非常多，常規(guī)的單步、多步、進入、跳出操作這里也不特殊說明了。
有一點值得說的就是，利用條件斷點來實現(xiàn)運行期的代碼植入功能，先看下圖：
[外鏈圖片轉(zhuǎn)存失敗,源站可能有防盜鏈機制,建議將圖片保存下來直接上傳(img-ITZpSjjx-1615189285046)(https://ucc.alicdn.com/pic/developer-ecology/8e5353bdaf7746cf92b2c7132d0bbf2a.gif)]
可以看到，Debug 模式運行時，我們能動態(tài)改變 age 變量的值，本來被賦值為 20 的，結(jié)果輸出出來卻是 10。
這個是我在開發(fā)中無意間發(fā)現(xiàn)的一個功能，算是一個 Trick 了。但這個功能在實際的開發(fā)過程中特別有用，尤其針對于一些代碼改動后再次運行的成本比較高的場景。比如 Android 開發(fā)過程中，能夠在不重新打整包的情況下，動態(tài)修改頁面中各個元素的樣式、接口的請求、數(shù)據(jù)的內(nèi)容等等；再比如服務(wù)端場景中，如果我們的應(yīng)用支持 Debug 模式，則可以通過該功能實現(xiàn)應(yīng)用無需重新部署的情況下，進行動態(tài)更改上下文邏輯的操作。
寫在最后
跬步至千里，小流成江海，開發(fā)工作有大小，業(yè)務(wù)需求有緩急，但終究要落到眼下，從一磚一瓦的基石開始，從一行一列的編碼開始，希望本文中能幫助到更多的研發(fā)同學(xué)。
總結(jié)
以上是生活随笔為你收集整理的收藏！这些 IDE 使用技巧，你都知道吗的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： Alluxio 助力 Kubernete
- 下一篇： KubeNode：阿里巴巴云原生 容器基