feat(@142vip/egg): 优化插件注册机制和类型支持

Author: mmdapl

packages/egg/src/plugin/logger.ts

@@ -1,9 +1,4 @@
-interface EggCoreLogger {
-  info: (msg: any, ...args: any[]) => void
-  warn: (msg: any, ...args: any[]) => void
-  error: (msg: any, ...args: any[]) => void
-  debug: (msg: any, ...args: any[]) => void
-}
+import type { EggApp, EggCoreLogger, PluginConfig } from '../egg.interface'
 
 /**
  * egg插件日志
@@ -13,17 +8,17 @@ export class VipEggPluginLogger {
   private readonly logger: EggCoreLogger
   private readonly pluginName: string
 
-  constructor(pluginName: string, logger: EggCoreLogger) {
-    this.logger = logger
-    this.pluginName = pluginName
+  constructor(pluginConfig: PluginConfig, app: EggApp) {
+    this.logger = app.coreLogger
+    this.pluginName = pluginConfig.pluginName
   }
 
   /**
    * 单例对象
    */
-  public static getInstance(pluginName: string, logger: EggCoreLogger) {
+  public static getInstance(pluginConfig: PluginConfig, app: EggApp): VipEggPluginLogger {
     if (this.instance == null) {
-      this.instance = new VipEggPluginLogger(pluginName, logger)
+      this.instance = new VipEggPluginLogger(pluginConfig, app)
     }
     return this.instance
   }

packages/egg/src/plugin/register.ts

@@ -1,9 +1,5 @@
-interface EggApp {
-  config: EggConfig
-  addSingleton: (pluginName: string, createInstance: CreateInstance) => void
-}
-type CreateInstance = (config: any, app: EggApp) => any
-type EggConfig = Record<string, any>
+import { VipLodash } from '@142vip/utils'
+import type { CreatePluginInstance, EggApp } from '../egg.interface'
 
 /**
  * 注册的Egg插件key
@@ -26,7 +22,7 @@ export enum RegisterEggPluginName {
  * @param app
  * @param createInstance
  */
-export function registerPlugin(name: RegisterEggPluginName, app: EggApp, createInstance: CreateInstance) {
+export function registerPlugin(name: RegisterEggPluginName, app: EggApp, createInstance: CreatePluginInstance) {
   // 配置 agent 或者 app 才加载单例
   if (app.config[name] != null) {
     app.addSingleton(name, createInstance)
@@ -57,5 +53,92 @@ export function defaultPluginConfig(pluginName: RegisterEggPluginName, userConfi
     loaders: [PluginLoader.APP],
   }
 
-  return Object.assign({}, defaultConfig, userConfig)
+  return VipLodash.merge(defaultConfig, userConfig)
+}
+
+/**
+ * egg启动的生命周期
+ * - 参考：https://www.eggjs.org/zh-CN/basics/app-start
+ */
+export class EggPluginBoot {
+  private readonly appOrAgent: EggApp
+  private readonly pluginName: RegisterEggPluginName
+  private readonly createEggPluginInstance: CreatePluginInstance
+  constructor(eggPlugin: {
+    pluginName: RegisterEggPluginName
+    appOrAgent: EggApp
+    createEggPluginInstance: CreatePluginInstance
+  }) {
+    this.pluginName = eggPlugin.pluginName
+    this.appOrAgent = eggPlugin.appOrAgent
+    this.createEggPluginInstance = eggPlugin.createEggPluginInstance
+  }
+
+  /**
+   * 此时 config 文件已经被读取并合并，但还并未生效
+   * 这是应用层修改配置的最后机会
+   * 注意：此函数只支持同步调用
+   */
+  configWillLoad(): void {
+
+  }
+
+  /**
+   * 所有配置已经加载完毕
+   * 可以用来加载应用自定义的文件，启动自定义服务
+   */
+  public async didLoad(): Promise<void> {
+    // app.加载
+    if (this.loaderPlugin(PluginLoader.APP)) {
+      this.registerPlugin()
+    }
+
+    // agent.js加载
+    if (this.loaderPlugin(PluginLoader.AGENT)) {
+      this.registerPlugin()
+    }
+  }
+
+  /**
+   * 所有插件已启动完毕，但应用整体尚未 ready
+   * 可进行数据初始化等操作，这些操作成功后才启动应用
+   */
+
+  public async willReady(): Promise<void> {
+
+  }
+
+  /**
+   * 应用已启动完毕
+   */
+  public async didReady(): Promise<void> {
+
+  }
+
+  /**
+   * http/https 服务器已启动，开始接收外部请求
+   * 此时可以从 app.server 获取 server 实例
+   */
+  public async serverDidReady(): Promise<void> {
+
+  }
+
+  /**
+   * 是否加载插件
+   */
+  private loaderPlugin(loader: PluginLoader = PluginLoader.APP) {
+    // 获取加载配置，默认app.js
+    const { loaders = [] } = this.appOrAgent.config[this.pluginName]
+    return loaders.includes(loader)
+  }
+
+  /**
+   * 注册插件
+   */
+  private registerPlugin(): void {
+    // 配置 agent 或者 app 才加载单例
+    if (this.appOrAgent.config[this.pluginName] != null) {
+      this.appOrAgent.addSingleton(this.pluginName, this.createEggPluginInstance)
+    }
+  }
 }