@ equinor/ 组合框架- 模块

融合框架核心模块系统. 这个软件包定义了每个Fusion框架模块所依赖的合同,基础类和管弦逻辑.

使用此软件包 正在编写新模块 或者需要了解模块生命周期是如何运作的。 应用程序开发人员通常通过更高层次的软件包,例如 @equinor/fusion-framework-react。 。 。 .

关键概念

模块

A 类 Module 是宣告名称、可选配置厂、 initialize 方法,以及可选的生命周期钩(postConfigure, (中文(简体) ), postInitialize, (中文(简体) ), dispose) (中文(简体) ). 模块是Fusion应用程序的构件.

模块配置器

ModulesConfigurator 协调整个模块生命周期:

1. 配置 - 每个模块的 configure() 工厂创建一个配置构建器; 注册回调使其变异; postConfigure() 钩而跑.
2. 初始化 - 模块同时初始化;跨模块依赖性通过 requireInstance()。 。 。 .
3. 初始化后 – 说吧 – postInitialize() 钩子和 onInitialized 调用运行.
4. 插件 – 注册插件在每个模块准备好后连接主机级副作用.

结果是密封 ModulesInstance 其属性名称与模块密钥相匹配,其值为初始化提供者.

Basefig 构建器

用于构建模块配置的抽象类声明. 子类暴露出打入的设置方法(例如. setBaseUrl用于注册回调。 在初始化过程中,框架收集了所有已注册的回调,解析,并将结果合并为一个配置对象.

BaseModule 创建器

模块提供者摘要基础类(运行时实例由 initialize()) (中文(简体) ). 它管理着一个 Subscription 自动拆卸的容器 SemanticVersion 用于兼容性检查.

文档

安装

pnpm add @equinor/fusion-framework-module

快速启动——定义模块

import {
  type Module,
  BaseConfigBuilder,
  type ConfigBuilderCallback,
} from '@equinor/fusion-framework-module';
import { BaseModuleProvider } from '@equinor/fusion-framework-module/provider';

// 1. Define the configuration shape
interface GreeterConfig {
  greeting: string;
}

// 2. Create a config builder
class GreeterConfigurator extends BaseConfigBuilder<GreeterConfig> {
  setGreeting(cb: ConfigBuilderCallback<string>) {
    this._set('greeting', cb);
  }
}

// 3. Create a provider
class GreeterProvider extends BaseModuleProvider<GreeterConfig> {
  #config: GreeterConfig;

  greet(name: string): string {
    return `${this.#config.greeting}, ${name}!`;
  }

  constructor(args: { version: string; config: GreeterConfig }) {
    super(args);
    this.#config = args.config;
  }
}

// 4. Define the module
export const greeterModule: Module<'greeter', GreeterProvider, GreeterConfigurator> = {
  name: 'greeter',
  configure: () => new GreeterConfigurator(),
  initialize: async ({ config }) => {
    const resolved = await config.createConfigAsync({
      config: {},
      hasModule: () => false,
      requireInstance: () => Promise.reject('no modules'),
    });
    return new GreeterProvider({ version: '1.0.0', config: resolved });
  },
};

出口

主要入口点@equinor/fusion-framework-module(中文(简体) )

配置子路径( S)@equinor/fusion-framework-module/configurator(中文(简体) )

子路径( E)@equinor/fusion-framework-module/plugins(中文(简体) )

提供子路径@equinor/fusion-framework-module/provider(中文(简体) )

模块周期

┌─────────────────────────────────────────────────────┐
│                  ModulesConfigurator                 │
├──────────┬──────────────────────────┬────────────────┤
│ Phase    │ Module Hook              │ Consumer Hook  │
├──────────┼──────────────────────────┼────────────────┤
│ Configure│ module.configure()       │ addConfig()    │
│          │ module.postConfigure()   │ onConfigured() │
├──────────┼──────────────────────────┼────────────────┤
│ Init     │ module.initialize()      │                │
│          │ module.postInitialize()  │ onInitialized()│
├──────────┼──────────────────────────┼────────────────┤
│ Plugin   │                          │ registerPlugin │
├──────────┼──────────────────────────┼────────────────┤
│ Dispose  │ module.dispose()         │ instance.      │
│          │                          │  dispose()     │
└──────────┴──────────────────────────┴────────────────┘

有需要的跨模块依赖性

模块同时初始化 。 使用 requireInstance(name, timeout?) 内部 initialize 等待依赖:

initialize: async ({ config, requireInstance, hasModule }) => {
  // Wait for the event module (with optional timeout in ms)
  const event = await requireInstance('event', 5000);
  return new MyProvider(config, event);
},

requireInstance 返回当请求的模块完成初始化时解析的许诺。 如果模块没有注册,承诺会拒绝.

启动和完整模块映射

postInitialize 运行后 全部 模块已初始化。 它收到满分 modules 地图,使它成为跨模块接线的正确位置,这取决于每个模块是否准备好:

postInitialize: async ({ instance, modules }) => {
  // All modules are available here
  modules.event.addEventListener('onContextChanged', (e) => {
    instance.handleContextChange(e.detail);
  });
},

configure 财务报告和审定财务报表 initialize 是两个需要的钩. postConfigure, (中文(简体) ), postInitialize,以及 dispose 是可选的.

插件和主机级副作用

使用 registerPlugin 用于在制作前需要完整的模块实例的应用程序自有接线。 插件运行后 postInitialize 财务报告和审定财务报表 onInitialized,但在 initialize() 决定。 返回已撕毁的回调, 以清理订阅、 全球收听器、 计时器或处理时的遥测绑定 .

import { createPlugin } from '@equinor/fusion-framework-module/plugins';

const contextTelemetryPlugin = createPlugin<[typeof eventModule, typeof telemetryModule]>(
  'contextTelemetry',
  (modules) => modules.event.addEventListener('context:changed', (event) => {
    modules.telemetry.track('context.changed', event.detail);
  }),
);

configurator.registerPlugin(contextTelemetryPlugin);

见 插件 用于拆解规则、失败行为和API参考.

事件在 configurator.event$ 用于遥测和调试的整个生命周期.

相关软件包

• @equinor/fusion-framework-react - 消费模块的反应装订和钩子
• @equinor/fusion-framework-module-http – HTTP 客户端模块基于此系统
• @equinor/fusion-framework-module-service-discovery - 服务发现模块