tom是一個著名的開源編輯器，是由Chris Wanstrath在2008年作為其個人的編外項目發展而來。據說在今年（2022）年底，這款編輯器也將進入關停狀態。而且目前大部分程序員都把VS Code作為其最主要的開發工作，但是Atom本身的設計和代碼實現都是非常優秀的，通過閱讀它的源碼，我們還是可以學到很多相關的編程技巧。

主流程分析

atom的代碼結構非常清晰，整個項目可以分為兩個部分，一個是atom本身的代碼，另一個是atom的插件。atom本身的代碼又可以分為兩部分，一個是atom的核心業務邏輯，另一個是atom的UI代碼。核心業務邏輯主要

是用來設置環境變量，調度窗口、調度系統資源等等。UI代碼則主要負責處理atom的界面，比如菜單欄，工具欄，狀態欄等等。

作為使用electron框架編寫的應用程序，整體都是使用js來寫的（早期是使用coffee來編寫的)，可以從其目錄中看到，整個項目的目錄結構如下：

|-src // 核心業務邏輯
|-|-main-process
|-|-|-atom-application.js
|-|-|-atom-environment.js
|-|-|-atom-window.js
|-static // UI代碼
|-packages // 其它擴展包
...

眾所周知，用Electron框架寫成的應用，都可以分為主線程和渲染進程。對應到atom中，主線程的代碼都是在src/main-process目錄下，而渲染線程的代碼則是直接src目錄下。靜態UI資源則在static目錄下。

我們先從主線程的入口代碼開始看起，代碼位于src/main-process/main.js路徑下：

// 命令行工具入口,
const args = yargs(process.argv)
  // Don't handle --help or --version here; they will be handled later.
  .help(false)
  .version(false)
  .alias('d', 'dev')
  .alias('t', 'test')
  .alias('r', 'resource-path').argv;
// 下面省略大量代碼，主要用于處理命令行參數，用來專門處理使用命令行打開atom的情況
// 真正的入口
const start = require(path.join(resourcePath, 'src', 'main-process', 'start'));
start(resourcePath, devResourcePath, startTime);

可以從上面代碼看出，其實真正的處理入口還是在start函數中(src/main-process/start.js)：

module.exports = function start(resourcePath, devResourcePath, startTime) {
  // 處理錯誤情況
  process.on('uncaughtException', function(error = {}) {
  });
  process.on('unhandledRejection', function(error = {}) {
  });
  // 初始化各種參數
  app.commandLine.appendSwitch('enable-experimental-web-platform-features');
  const args = parseCommandLine(process.argv.slice(1));
  const previousConsoleLog = console.log;
  console.log = nslog;
  args.resourcePath = normalizeDriveLetterName(resourcePath);
  args.devResourcePath = normalizeDriveLetterName(devResourcePath);
  atomPaths.setAtomHome(app.getPath('home'));
  atomPaths.setUserData(app);
  const config = getConfig();
  const colorProfile = config.get('core.colorProfile');
  if (colorProfile && colorProfile !== 'default') {
    app.commandLine.appendSwitch('force-color-profile', colorProfile);
  }
  if (handleStartupEventWithSquirrel()) {
    return;
  } else if (args.test && args.mainProcess) {
    // 處理測試情況
    app.setPath(
      'userData',
      temp.mkdirSync('atom-user-data-dir-for-main-process-tests')
    );
    console.log = previousConsoleLog;
    app.on('ready', function() {
      const testRunner = require(path.join(
        args.resourcePath,
        'spec/main-process/mocha-test-runner'
      ));
      testRunner(args.pathsToOpen);
    });
    return;
  }
  const releaseChannel = getReleaseChannel(app.getVersion());
  let appUserModelId = 'com.squirrel.atom.' + process.arch;
  if (releaseChannel !== 'stable') {
    appUserModelId += `-${releaseChannel}`;
  }
  // 這個方法可以防止win10在任務欄中顯示重復的atom圖標
  app.setAppUserModelId(appUserModelId);
  app.on('open-file', addPathToOpen);
  app.on('open-url', addUrlToOpen);
  // 當應用關閉的時候，需要上報一些數據
  app.on('will-finish-launching', () =>
    startCrashReporter({
      uploadToServer: config.get('core.telemetryConsent') === 'limited',
      releaseChannel
    })
  );
  if (args.userDataDir != null) {
    app.setPath('userData', args.userDataDir);
  } else if (args.test || args.benchmark || args.benchmarkTest) {
    app.setPath('userData', temp.mkdirSync('atom-test-data'));
  }
  app.on('ready', function() {
    app.removeListener('open-file', addPathToOpen);
    app.removeListener('open-url', addUrlToOpen);
    // 構造一個atomApplication對象
    const AtomApplication = require(path.join(
      args.resourcePath,
      'src',
      'main-process',
      'atom-application'
    ));
    // 并將之前的參數傳入
    AtomApplication.open(args);
  });
};

從上面代碼可以看出，前置處理也是各種參數的初始化，以及為了便于測試，做的一些定制處理。在應用初始化結束后，就會動態加載應用模塊，構造 AtomApplication 實例。可以注意到，這里使用按需加載的目的是希望能夠在需要的時候才會去加載對應的模塊，這樣可以減少內存的占用。

接著，我們來看一下atom-application.js的代碼，這塊代碼量比較大，是整個atom的核心代碼，我們先來看一下整體的結構：

// 是一個單列模式, 繼承自`EventEmitter`模塊，主要因為內部會大量應用事件處理機制來分發邏輯。
class AtomApplication extends EventEmitter {
    static open(options) {
        // 初始化一些參數
        // 創建一個atomApplication對象
        // 并將之前的參數傳入
        return new AtomApplication(options);
    }
    exit(status) {
        app.exit(status);
      }
      constructor(options){}
    async initialize(options) {}
}

程序啟動的入口只有AtomApplication.open這一個方法，這個方法會創建一個AtomApplication對象，然后調用它的initialize方法，層層遞進，再調用創建窗口、加載配置等方法，最終完成程序的啟動。

其中，比較值得注意的是使用了一個叫做event-kit的模塊。它是一個事件處理器模塊，提供了一個事件處理器的抽象，可以讓我們更容易地處理事件。最重要的作用是它實現了CompositeDisposable類，可以在需要的時候，釋放資源。雖然javascript是一個有垃圾回收機制的語言，但是如果沒有手動釋放一些資源的話，會造成大量的內存占用。

在使用過程中，也十分簡單

class AtomApplication extends EventEmitter {
  // 省略其它代碼
  constructor(options) {
      // 省略其它代碼
      this.disposable = new CompositeDisposable();
  }
  async destroy() {
    const windowsClosePromises = this.getAllWindows().map(window => {
      window.close();
      return window.closedPromise;
    });
    await Promise.all(windowsClosePromises);
    // 在銷毀的時候統一釋放
    this.disposable.dispose();
  }
  // 注冊事件處理函數
  handleEvents() {
      // 省略其它代碼,
    // 在注冊事件回調的時候，直接將對象添加到disposable的依賴中去
    this.disposable.add(
      ipcHelpers.on(app, 'before-quit', async event => {...})
    );
  }
}

擴展機制

atom作為一個編輯器，它的擴展機制是非常重要的。和其他的IDE類似，擴展機制也是使用的微內核模式（或者插件模式）來實現。微內核架構是一種十分常見的軟件架構，它將應用系統分為兩個部分：一個微內核和一組外部的插件。微內核負責管理插件，提供插件之間的通信機制，以及提供一些基礎的服務。插件則負責提供具體的功能。這樣的架構可以讓我們更容易地擴展軟件的功能，而不需要修改軟件的核心代碼。

在atom中，插件主要是通過package類來實現的。package是atom擴展的基本單元，它可以包含一些功能，比如語法高亮、代碼提示、代碼格式化等等，也提供了讓第三方開發者擴展的能力。那么這些擴展是如何加載的呢？我們先來看一下package-manager.js的代碼：

// 可以加載、激活、停用、卸載包
// 加載包讀取并解析包的元數據和資源，例如快捷鍵、菜單、樣式表等
// 激活包注冊加載的資源并調用包的主模塊的`activate()`方法
// 停用包取消注冊包的資源并調用包的主模塊的`deactivate()`方法
// 卸載包從包管理器中完全移除
// 可以通過`core.disabledPackages`配置項和調用`enablePackage()/disablePackage()`方法來啟用/禁用包
class PackageManager {
  preloadPackage(packageName, pack) {
    ...
  }
  loadPackages() {
    ...
  }
  enablePackage(packageName) {
    ...
  }
  // 觸發事件，用來注冊回調
  onDidActivatePackage(callback) {
  }
}

這個包管理器類PackageManager，可以管理擴展包的整個生命周期，主要負責包的加載、卸載、更新等操作。而所有的包都綁定在主內核的atom.packages這個全局變量上，我們可以通過這個變量來訪問應用上加載的所有擴展。

那么packageManager是如何負責管理包的安裝和卸載呢？：

class PackageManager {
    constructor(packages) {
        this.packages = packages;
    }
    getPackages() {
        return this.packages;
    }
    getPackage(name) {
        return this.packages.find(pkg => pkg.name === name);
    }
    // 禁用包，從內存中將包去除，然后通知應用程序或者擴展來執行禁用操作
    async deactivatePackage(name, suppressSerialization) {
        const pack = this.getLoadedPackage(name);
        if (pack == null) {
          return;
        }
        if (!suppressSerialization && this.isPackageActive(pack.name)) {
          this.serializePackage(pack);
        }
        const deactivationResult = pack.deactivate();
        if (deactivationResult && typeof deactivationResult.then === 'function') {
          await deactivationResult;
        }
        delete this.activePackages[pack.name];
        delete this.activatingPackages[pack.name];
        this.emitter.emit('did-deactivate-package', pack);
      }
}

比如在擴展ui-watcher中，就可以在監聽到did-deactivate-package事件后，執行一些清理操作：

watchForPackageChanges() {
    this.subscriptions.add(
      atom.packages.onDidDeactivatePackage(pack => {
        // This only handles packages - onDidChangeActiveThemes handles themes
        const watcher = this.watchedPackages.get(pack.name);
        if (watcher) watcher.destroy();
        this.watchedPackages.delete(pack.name);
      })
    );
}

Package類，則包含了包的基礎信息，包括鍵位設置、配置、樣式等，并且有完整的生命周期。

class Package {
    constructor(params) {
      this.config = params.config;
      this.packageManager = params.packageManager;
      this.styleManager = params.styleManager;
      this.commandRegistry = params.commandRegistry;
      this.keymapManager = params.keymapManager;
      this.notificationManager = params.notificationManager;
      this.grammarRegistry = params.grammarRegistry;
      this.themeManager = params.themeManager;
      this.menuManager = params.menuManager;
      this.contextMenuManager = params.contextMenuManager;
      this.deserializerManager = params.deserializerManager;
      this.viewRegistry = params.viewRegistry;
      this.emitter = new Emitter();
      // 此處省略大量的細節
    }
    preload() {
        // do something
    }
    load() {
        // do something
    }
    unload() {
        // do something
    }
    activate() {
        // do something
    }
    deactivate() {
        // do something
    }
    finishLoading() {
        // do something
    }
}

Package(擴展)實例本身要和主應用進行通信，atom是直接通過全局對象的方式進行調用的，這樣做的好處是不用考慮通信的問題，但是也有一些弊端，比如不方便重構等。

在應用入口處，會將PackageManager實例掛載在應用實例上。后續我們可以通過atom.packages來訪問包管理器實例，從而獲取包的信息。

// atom-application.js
this.packages = new PackageManager({
    ... // 一堆的配置
});
this.packages.initialize(...);

而在渲染進程中，可以通過在window上掛載atom對象來訪問包管理器實例，從而獲取所有擴展包的信息，進行預加載操作。

// initialize-application-window.js
/ 初始化 AtomEnvironment
global.atom = new AtomEnvironment({
  clipboard,
  applicationDelegate: new ApplicationDelegate(),
  enablePersistence: true
});
TextEditor.setScheduler(global.atom.views);
// 初始化應用窗口
global.atom.preloadPackages();
// ... 省略大量代碼
module.exports = function({ blobStore }) {
 // 省略大量代碼
 // 在startEditorWindows內部，當窗口初始化完成后，會正式調用`loadPackages`方法來加載所有的擴展包
 return global.atom.startEditorWindow().then(function() {
    // Workaround for focus getting cleared upon window creation
    const windowFocused = function() {
      window.removeEventListener('focus', windowFocused);
      setTimeout(() => document.querySelector('atom-workspace').focus(), 0);
    };
    window.addEventListener('focus', windowFocused);
    ipcRenderer.on('environment', (event, env) => updateProcessEnv(env));
  });
}

總體而言，atom的擴展機制還是比較簡單的，在各種擴展的生命周期中，都可以通過事件來進行通信，從而實現各種功能。這樣一種實現，其實也可以在我們日常工作過程中加以借鑒。