把VS Code打造成Java開發IDE

zhang發表於2020-09-24
JavaIDE

近期，公司推行正版化，本人使用的是JetBrains教育版，是不允許進行商業開發的，因此開啟了艱難的備用IDE選型之路。最終，我選定了輕量級的Visual Studio Code（以下簡稱VS Code）。

各種IDE選型比較的過程就不贅述了，Eclipse、NetBeans、Srping Tools Suite等等，只能說青菜蘿蔔各有所愛。

外掛淘沙

眾所周知，VS Code是一款輕量級的通用編輯器，和Eclipse一樣全靠海量的外掛擴充套件，網上各類外掛推薦文章又都是面向VS Code的最大IDE使用者群-前端開發人員的。

無奈之下只能逐一試驗，又開始了一輪外掛淘沙的過程，最終篩選出幾十款外掛，詳見vscode-java-dev-tools-pack/README.md。

定製Extension Pack

外掛是篩選出來了，但是幾十款外掛總不能每次都一個一個去點選安裝吧，而且也難以維護。

幸而VS Code自身提供了一種叫Extension Pack的外掛，這種外掛的目的就是為了彙集一批外掛到一起而設計的，安裝了一個Extension Pack就會自動安裝Pack內的全部外掛。

VS Code提供了一套nodejs工具用於輔助開發者建立擴充套件，同時官方文件中提供了簡單明瞭的文件說明以及豐富的samples，samples包括Command、Color Theme、Tree View等等，本文僅做Extension Pack的示例。

環境準備

環境依賴 nodejs 以及 Git，以MacOS為例，通過Homebrew安裝：

brew install node git

然後通過 npm 安裝Yeoman和VS Code Extension Generator：

npm install -g yo generator-code

工程初始化

呼叫Yeoman生成新的Extension Pack

$ yo code


     _-----_     ╭──────────────────────────╮
    |       |    │   Welcome to the Visual  │
    |--(o)--|    │   Studio Code Extension  │
   `---------´   │        generator!        │
    ( _´U`_ )    ╰──────────────────────────╯
    /___A___\   /
     |  ~  |
   __'.___.'__
 ´   `  |° ´ Y `

? What type of extension do you want to create?
  New Extension (TypeScript)
  New Extension (JavaScript)
  New Color Theme
  New Language Support
  New Code Snippets
  New Keymap
❯ New Extension Pack
  New Language Pack (Localization)

回車後會提問是否要將當前已安裝的擴充套件安裝到新的Extension Pack中，選擇Yes會報錯

? What type of extension do you want to create? New Extension Pack
? Add the currently installed extensions to the extension pack? Yes
Error code

Command failed: code --list-extensions
/bin/sh: code: command not found

這是因為我的VS Code並不是通過命令列安裝的，如果要使用code命令就需要通過命令列安裝VS Code，然後重新執行yo code。

MacOS上通過Homebrew安裝vs code：

brew cask install visual-studio-code

當然也可以選擇不自動安裝已有擴充套件，同樣可以順利進行後面的配置。

? What type of extension do you want to create? New Extension Pack
? Add the currently installed extensions to the extension pack? No
? What's the name of your extension? vscode-java-dev-tools-pack
? What's the identifier of your extension? vscode-java-dev-tools-pack
? What's the description of your extension? Some Java develop support tools extension pack.
? Initialize a git repository? Yes
   create vscode-java-dev-tools-pack/.vscode/launch.json
   create vscode-java-dev-tools-pack/package.json
   create vscode-java-dev-tools-pack/vsc-extension-quickstart.md
   create vscode-java-dev-tools-pack/README.md
   create vscode-java-dev-tools-pack/CHANGELOG.md
   create vscode-java-dev-tools-pack/.vscodeignore
   create vscode-java-dev-tools-pack/.gitignore
   create vscode-java-dev-tools-pack/.gitattributes

Your extension vscode-java-dev-tools-pack has been created!

To start editing with Visual Studio Code, use the following commands:

     cd vscode-java-dev-tools-pack
     code .

Open vsc-extension-quickstart.md inside the new extension for further instructions
on how to modify, test and publish your extension.

For more information, also visit http://code.visualstudio.com and follow us @code.

通過Yeoman工具，我們配置了name、identifier、description，並且工具自動生成了一個本地git倉庫，工程目錄結構如下：

$ tree -a -L 1
.
├── .git
├── .gitattributes
├── .gitignore
├── .vscode
├── .vscodeignore
├── CHANGELOG.md
├── README.md
├── package.json
└── vsc-extension-quickstart.md
  • CHANGELOG.md 釋出變更記錄，在Visutal Studio Code Marketplace的詳情頁中有該檔案的連結。
  • README.md 在Visutal Studio Code Marketplace的擴充套件詳情，作用類似GitHub Page。
  • package.json 擴充套件的 manifest檔案，定義了擴充套件的相關屬性。
  • vsc-extension-quickstart.md 針對生成的工程中檔案的簡易說明文件。

package.json

作為Extension Pack型別的VS Code 擴充套件來說，只需要維護package.json就行，package.json中的各項欄位可以參考VS Code的官方文件Extension Manifest。

也可以參考我的vscode-java-dev-tools-pack/package.json，這是一個比較完整的Demo。

package & publish

微軟關於外掛打包釋出可以參考文件Publishing Extensions。

微軟提供了vsce這款命令列工具方便開發者進行打包和釋出：

npm install -g vsce

安裝完成後，cd到工程目錄下，進行打包生成.vsix檔案

$ vsce package
 DONE  Packaged: /Users/larva-zhang/vscode-java-dev-tools-pack/vscode-java-dev-tools-pack-0.0.1.vsix (7 files, 16.7KB)

注意版本號，是根據package.json檔案中的version來生成的，version必須是major.minor.stage的格式

package成功後，需要去vs code建立一個publisher，推薦通過瀏覽器訪問management page建立，比較直觀。

也可以通過vsce命令列建立，詳見Create a publisher

有了publisher後就能進行publish了，還是在management page頁面，通過上傳.vsix檔案的方式即可，當vs code校驗通過後就會發布到Visual Studio Code Marketplace。

publish同樣可以通過vsce命令列進行，詳見Log in to a publisher

總結

外掛安裝完成後還是需要逐一去配置除錯的，這個沒法自動化，畢竟各人喜好不同，不過大多數外掛都是開箱即用的。

作為開源的輕量級通用編輯器，VS Code的Java開發體驗確實不如JetBrains，但和Eclipse一樣勝在開源免費，所以還是可堪一用的。

最後給我的Extension Pack打個廣告Java Dev Tools Pack
，如有好的外掛推薦也歡迎提PR給我。

相關文章