vscode 插件原理淺析與實戰

背景

作爲一位前端同學肯定對 vscode 不陌生，相信每位同學電腦上也都有五花八門的個性化配置，那麼我們是藉助什麼東西做到的呢？那就是它豐富的插件生態。本次將講述插件基本原理並從一個簡單的 case 瞭解如何製作一個的vscode插件

是什麼實現了 vscode

Electron

vscode 底層通過 electron 開發實現，electron 的核心構成分別是：chromium、nodejs、native-api

Chromium（ ui 視圖） ：通過 web 技術棧編寫實現 ui 界面，其與 chrome 的區別是開放開源、無需安裝可直接使用（可以簡單理解 chromium 是 beta 體驗版 chrome，新特性會優先在 chromium 中體驗並在穩定後更新至 chrome 中）。

Nodejs （操作桌面文件系統） ：通過 node-gyp 編譯，主要用來操作文件系統和調用本地網絡。

Native-API（操作系統緯度 api ）：使用 Nodejs-C++ Addon 調用操作系統 API（Nodejs-C++ Addon 插件是一種動態鏈接庫，採用 C/C++ 語言編寫，可以通過 require() 將插件加載進 NodeJS 中進行使用），可以理解是對 Nodejs 接口的能力拓展。

Electron 多進程：

主進程（main）：每一個 Electron 應用只會啓動一個主進程。
渲染進程（render）：主進程會通過 Chromium 的 api 創建任意多個 web 頁面，每一個工作區（workbench）對應一個進程，同時是 BrowserWindow 實例，由於 chromeium（chrome）也是多進程的，所以每個頁面都單獨運行在各自的渲染進程中。

例：

// 主進程
const { ipcMain } = require('electron');

// 主進程響應事件
ipcMain.on('main_msg', (event, arg) => {
  console.log(arg); // ping
  event.reply('renderer-msg-reply', 'pong');
})

// 渲染進程（子進程）
const { ipcRenderer } = require('electron');

// 渲染進程響應事件
ipcRenderer.on('renderer-msg-reply', (event, arg) => {
  console.log(arg); // pong
})

// 觸發主進程響應事件
ipcRenderer.send('main_msg', 'ping');

對於 vscode 還會有一些其他的進程，比如：

插件進程（Extension）：fork 渲染進程，每個插件都運行在一個 NodeJS 宿主環境中，即插件間共享進程
Debug 進程：一個特殊的插件進程。
Search 進程：搜索是密集型任務，單獨佔用一個進程。
。。。

通俗意義上， electron 就是給你搞了一個 Chrome 瀏覽器的殼子，只是比傳統網頁多了一個訪問桌面文件的功能。

vscode 插件加載基本原理

https://github.com/microsoft/vscode/tree/main

插件的結構

├── extensions----------------------------------vscode內置插件
├── src
│   ├── main.js--------------------------------入口文件
│   ├── bootstrap-fork.js----------------------衍生子進程（渲染進程）
│   ├── vs
│   │   └── workbench-------------------------工作臺
│   │   ├── base
│   │   │   ├── browser----------------------瀏覽器api，可操作dom
│   │   │   ├── common-----------------------公共js代碼
│   │   │   ├── node-------------------------nodejs api
│   │   ├── code
│   │   │   ├── electron-browser-------------electron渲染進程
│   │   │   ├── electron-main----------------electron主進程

插件加載過程

初始化插件服務

在插件初始化構造函數中通過_initialize初始化插件服務。

// src/vs/workbench/services/extensions/electron-browser/extensionService.ts
// 通過監聽生命週期函數，創建ExtensionHostManager
export class ExtensionService extends AbstractExtensionService implements IExtensionService {
    constructor() {
        this._lifecycleService.when(LifecyclePhase.Ready).then(() => {
            // reschedule to ensure this runs after restoring viewlets, panels, and editors
            runWhenIdle(() => {
                this ._initialize() ; // 初始化插件服務
            }, 50 /*max delay*/);
        });
    }
}

// src/vs/workbench/services/extensions/common/abstractExtensionService.ts
// 啓動初始化插件服務方法
protected async _initialize(): Promise<void> {
    perf.mark('code/willLoadExtensions');
    this ._startExtensionHosts( true , []) ;
    // ...
}

private _startExtensionHosts(isInitialStart: boolean, initialActivationEvents: string[]): void {
    // 創建插件進程，分別爲LocalProcessExtensionHost（本地插件，如個人插件）、RemoteExtensionHost（遠程插件，如WSL Remote）、WebWorkerExtensionHost（web worker進程）
    const extensionHosts = this._createExtensionHosts(isInitialStart);
    extensionHosts.forEach((extensionHost) => {
        // 創建ExtensionHostManager
        const processManager: IExtensionHostManager = createExtensionHostManager(this._instantiationService, extensionHost, isInitialStart, initialActivationEvents, this._acquireInternalAPI());
        processManager.onDidExit(([code, signal]) => this._onExtensionHostCrashOrExit(processManager, code, signal));
        processManager.onDidChangeResponsiveState((responsiveState) => { this._onDidChangeResponsiveChange.fire({ isResponsive: responsiveState === ResponsiveState.Responsive }); });
        this._extensionHostManagers.push(processManager);
    });
}

fork 渲染進程

fork 渲染進程，並加載 extensionHostProcess。由於 vscode 考慮插件可能會影響啓動性能和 IDE 自身的穩定性，所以通過進程隔離來解決這個問題，插件進程 fork 渲染進程，保證每個插件都運行在一個 nodejs 宿主環境中，不影響 IDE 及其啓動時間。

// src/vs/workbench/services/extensions/common/extensionHostManager.ts
// 啓動fork渲染進程
class ExtensionHostManager extends Disposable {
  constructor() {
      this._proxy = this._extensionHost.start() !.then();
  }
}

// src/vs/workbench/services/extensions/electron-browser/localProcessExtensionHost.ts
class LocalProcessExtensionHost implements IExtensionHost {
  public start(): Promise<IMessagePassingProtocol> | null {
    // ...
    const opts = {
      env: objects.mixin(objects.deepClone(process.env), {
        // 加載插件進程，指明插件進程入口
        AMD_ENTRYPOINT: 'vs/workbench/services/extensions/node/extensionHostProcess',
      }),
    }

    // 衍生子進程（渲染進程）
    this._extensionHostProcess = fork(getPathFromAmdModule(require, 'bootstrap-fork'), ['--type=extensionHost'], opts);
  }
}

初始化插件激活邏輯

// src/vs/workbench/services/extensions/node/extensionHostProcess.ts
import { startExtensionHostProcess } from "vs/workbench/services/extensions/node/extensionHostProcessSetup";
startExtensionHostProcess().catch((err) => console.log(err));

// src/vs/workbench/services/extensions/node/extensionHostProcessSetup.ts
export async function startExtensionHostProcess(): Promise<void> {
    const extensionHostMain = new ExtensionHostMain(
        renderer.protocol,
        initData,
        hostUtils,
        uriTransformer
    );
}

// src/vs/workbench/services/extensions/common/extensionHostMain.ts
export class ExtensionHostMain {
  constructor() {
    // 必須在創建extensionService之後再調用initialize，因爲initialize本身會依賴extensionService的實例
    this._extensionService = instaService.invokeFunction(accessor => accessor.get(IExtHostExtensionService));
    this._extensionService.initialize();
  }
}

插件激活

// src/vs/workbench/api/node/extHost.services.ts
import { ExtHostExtensionService } from 'vs/workbench/api/node/extHostExtensionService';

// 註冊插件服務
registerSingleton(IExtHostExtensionService, ExtHostExtensionService);

繼承 AbstractExtHostExtensionService

// src/vs/workbench/api/node/extHostExtensionService.ts
export class ExtHostExtensionService extends AbstractExtHostExtensionService {
    // ...
}

// src/vs/workbench/api/common/extHostExtensionService.ts
abstract class AbstractExtHostExtensionService extends Disposable {
  constructor() {
    this._activator = this._register(new ExtensionsActivator());
  }

  // 根據activationEvent事件名激活插件，如onCommand
  private _activateByEvent(activationEvent: string, startup: boolean): Promise<void> {
    return this._activator.activateByEvent(activationEvent, startup);
  }
}

加載流程

簡單實戰

背景：實現選擇指定目錄右鍵自動生成 lynx 頁面基本目錄結構的插件。

目標拆解：

選擇自定義目錄，添加右鍵點擊菜單
輸入 lynx 頁面名稱
按照模版生成對應文件

環境準備

nodejs
vscode
安裝 Yeoman[1] 和 VS Code Extension Generator[2]
```
npm install -g yo generator-code
```
初始化項目工程
```
yo code
```

具體實現

// package.json
{
 "name": "lynxlowcode",
 "displayName": "LynxLowcode",
 "description": "",
 "version": "0.0.2",
 "engines": {
  "vscode": "^1.62.0"
 },
 "categories": [
  "Other"
 ],
 "activationEvents": [
  "onCommand:lynxlowcode.newLynxComponent"
 ],
 "main": "./out/extension.js",
 "contributes": {
  "commands": [
   {
    "command": "lynxlowcode.newLynxComponent",
    "title": "新建Lynx組件"
   }
  ],
  "menus": {
   "explorer/context": [
    {
     "command": "lynxlowcode.newLynxComponent",
     "group": "z_commands",
     "when": "explorerResourceIsFolder"
    }
   ]
  }
 },
 "scripts": {
  "vscode:prepublish": "npm run compile",
  "compile": "tsc -p ./",
  "watch": "tsc -watch -p ./",
  "pretest": "npm run compile && npm run lint",
  "lint": "eslint src --ext ts",
  "test": "node ./out/test/runTest.js"
 },
 "devDependencies": {
  "@types/fs-extra": "^9.0.13",
  "@types/glob": "^7.1.4",
  "@types/mocha": "^9.0.0",
  "@types/node": "14.x",
  "@types/vscode": "^1.62.0",
  "@typescript-eslint/eslint-plugin": "^4.31.1",
  "@typescript-eslint/parser": "^4.31.1",
  "@vscode/test-electron": "^1.6.2",
  "eslint": "^7.32.0",
  "fs-extra": "^10.0.1",
  "glob": "^7.1.7",
  "mocha": "^9.1.1",
  "typescript": "^4.4.3"
 },
 "dependencies": {
  "import": "^0.0.6",
  "path": "^0.12.7"
 }
}

main：指定了插件的入口函數。

activationEvents：指定觸發事件，當指定事件發生時才觸發插件執行。需額外關注*這個特殊的插件類型，因爲他在初始化完成後就會觸發插件執行，並不需要任何自定義觸發事件。

contributes：描述插件的拓展點，用於定義插件要擴展 vscode 哪部分功能，如 commands 命令面板、menus 資源管理面板等。

聲明指令

初始化插件項目成功後會看到上圖的目錄結構，其中我們需要重點關注 src 目錄和 package.json 文件，其中 src 目錄下的 extension.ts 文件爲入口文件，包含activate和deactivate分別作爲插件啓動和插件卸載時的生命週期函數，可以將邏輯直接寫在兩個函數內也可抽象後在其中調用。

同時我們希望插件在適當的時機啓動activate或關閉deactivate，vscode 也給我們提供了多種onXXX的事件作爲多種執行時機的入口方法。那麼我們該如何使用這些事件呢？

事件列表

// 當打開特定語言時，插件被激活
onLanguage
// 當調用命令時，插件被激活
onCommand
// 當調試時，插件被激活
onDebug
// 打開文件夾且該文件夾包含設置的文件名模式時，插件被激活
workspaceContains
// 每當讀取特定文件夾 or 文件時，插件被激活
onFileSystem
// 在側邊欄展開指定id的視圖時，插件被激活
onView
// 在基於vscode或 vscode-insiders協議的url打開時（類似schema），插件被激活
onUri
// 在打開自定義設置viewType的 webview 時，插件被激活
onWebviewPanel
// 在打開自定義設置viewType的自定義編輯器，插件被激活
onCustomEditor
// 每當擴展請求具有authentication.getSession()匹配的providerId時，插件被激活
onAuthenticationRequest
// 在vscode啓動一段時間後，插件被激活，類似 * 但不會影響vscode啓動速度
onStartupFinished
// 在所有插件都被激活後，插件被激活，會影響vscode啓動速度，不推薦使用
*

如何使用這些事件呢？我們以 onCommand 爲例。首先需要在 package.json 文件中註冊activationEvents和commands。

{
    "activationEvents": [
      "onCommand:lynxlowcode.newLynxComponent" // 註冊命令事件
     ],
    "contributes": {
      // 標識命令增加了哪些功能
      "commands": [
       {
        "command": "lynxlowcode.newLynxComponent",
        "title": "新建Lynx組件" // 可根據title使用command + shift + p進行搜索
       }
      ]
     }
 // ...
}

然後在 extension.ts 文件的activate方法中編寫自定義邏輯。

// extension.ts
import * as vscode from 'vscode';

// this method is called when your extension is activated
export function activate(context: vscode.ExtensionContext) {
  // 爲命令添加事件
  let init = vscode.commands.registerCommand('lynxlowcode.newLynxComponent', () => {
    newLynxComponent(); // 此處是我們的自定義邏輯
  });
  // 事件回調棧
  context.subscriptions.push(init);
}

// this method is called when your extension is deactivated
export function deactivate() {}

// package.json
{
 // ...
 "menus": {
   "explorer/context": [
    {
     "command": "lynxlowcode.newLynxComponent",
     "group": "z_commands", // 位於命令容器面板
     "when": "explorerResourceIsFolder" // 資源管理器爲目錄
    }
   ]
  }
}

喚起組件名稱輸入面板

// extension.ts
import * as vscode from 'vscode';
import { openInputBox } from './openInputBox';

// this method is called when your extension is activated
export function activate(context: vscode.ExtensionContext) {
  let newLynxComponent = vscode.commands.registerCommand('lynxlowcode.newLynxComponent', (file: vscode.Uri) => {
    /** 喚起輸入框 */
    openInputBox(file);
  });
  context.subscriptions.push(newLynxComponent);
}

// this method is called when your extension is deactivated
export function deactivate() {}

// openInputBox.ts
import { window, InputBoxOptions, InputBox, Uri } from 'vscode';
import { pathExists } from 'fs-extra';
import { join } from 'path';
import { createTemplate } from './createTemplate';

/**
 * 喚起輸入組件名稱面板
 */
export const openInputBox = (file: Uri): void => {
  /** 新建輸入框對象 */
  const inputBox = window.createInputBox();

  /** 配置placeholder */
  inputBox.placeholder = '請輸入你的組件名稱，按Enter確認';

  /** 獲取輸入框的值 */
  const inputValue = inputBox.value;

  /** input值更新回調 */
  inputBox.onDidChangeValue(async (value: string) => {
    /** 判斷輸入的名稱是否爲空 */
    if (value.length < 1) {
      return '組件名稱不能爲空！！！';
    }

    /** 獲取最終組件完整路徑 */
    const location = join(file.fsPath, value);

    /** 判斷該完整路徑是否已經存在 */
    if (await pathExists(location)) {
      return `該 ${location}路徑已經存在，請換一個名稱或路徑！！！`;
    }
  }),

  /** input框隱藏回調 */
  inputBox.onDidHide(() => {
    /** 重置輸入框值 */
    inputBox.value = '';

    /** 重置爲可用 */
    inputBox.enabled = true;

    /** 重置爲空閒 */
    inputBox.busy = false;
  });

  /** 確認回調 */
  inputBox.onDidAccept(async () => {
    /** 禁用輸入框，防止用戶再次輸入 */
    inputBox.enabled = false;

    /** 將輸入框置爲繁忙，等待最終創建結果 */
    inputBox.busy = true;

    const result = createTemplate();

    if(result) {
      inputBox.hide();
      window.showInformationMessage('創建成功成功，請查看！！！');
    } else {
      window.showInformationMessage('創建失敗，請重試！！！');
    }
    inputBox.enabled = true;
    inputBox.busy = false;
  });

  /** 展示input輸入框 */
  inputBox.show();
};

根據輸入面板創建模版文件

import fs from 'fs';
/**
 * 創建模版文件
 */
export const createTemplate = (location: string, name: string) => {
  /** 同步創建文件夾 */
  const mkdirResult = fs.mkdirSync(location, {
    recursive: true
  });

  /** 創建文件夾失敗 */
  if (!mkdirResult) {
    return false;
  }
  try {
    /** 新建tsx文件並寫入內容 */
    fs.writeFileSync(`${location}/index.tsx`, `
import { Component } from '@byted-lynx/react-runtime';
import './index.scss';

interface ${name}PropsType {}

interface ${name}StateType {}

export default class ${name} extends Component<${name}PropsType, ${name}StateType> {
  constructor(props: ${name}PropsType) {
    super(props);
    this.state = {};
  }
  render(): JSX.IntrinsicElements {
    return (
      <view>
        <text>${name}組件</text>
      </view>
    );
  }
}
  `);
  /** 新建scss文件 */
  fs.writeFileSync(`${location}/index.scss`, '');
  return true;
  } catch (e) {
    console.log(e);
    return false;
  }
};

可優化點

增加模版類型
通過下載模版替代寫入字符串文本

歡迎關注公衆號 ELab 團隊 收穫大廠一手好文章~

參考資料

[1]

Yeoman: https://yeoman.io/

[2]

VS Code Extension Generator: https://www.npmjs.com/package/generator-code

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/4MmBSD-d-9T5-kFhcWNlTA

背景