Flutter未知功能插件w_module的潜在使用

Flutter未知功能插件w_module的潜在使用

概述

w_module 是一个用于Dart应用程序的模块化框架，它提供了良好的生命周期管理，适用于模块化的Dart应用程序。w_module 与 w_flux 库配合使用效果更佳，后者定义了应用架构。w_module 定义了模块的公共接口，并确保数据在模块内外的流动方式，同时提供了一个通用的模块生命周期，便于动态加载和卸载复杂的模块层次结构。

模块结构

w_module 的 Module 类封装了一个逻辑功能单元，并暴露了一个离散的公共接口给消费者。Module 扩展了 LifecycleModule，以确保其加载/卸载过程遵循明确定义的生命周期。模块的公共接口由 api、events 和 components 组成：

• API：暴露可以用于修改或查询模块数据的公共方法。
• Events：暴露可以监听的事件流，以通知内部模块状态的变化。
• Components：暴露与React-Dart兼容的UI组件工厂，用于渲染模块数据。

示例代码

以下是一个完整的示例demo，展示了如何使用 w_module 创建一个模块，并集成 w_flux 内部机制。

import 'package:w_module/w_module.dart';
import 'package:w_flux/w_flux.dart';

// 定义DispatchKey
final DispatchKey sampleDispatchKey = DispatchKey('sampleModule');

// 定义Actions
class SampleActions extends Actions {
  final Action<String> setSampleValue = Action<String>();
}

// 定义Store
class SampleStore extends Store {
  String _sampleValue = 'initial value';

  final SampleEvents _events;
  final DispatchKey _dispatchKey;

  SampleStore(SampleActions actions, this._events, this._dispatchKey) {
    actions.setSampleValue.listen(_setSampleValue);
  }

  void _setSampleValue(String newValue) {
    _sampleValue = newValue;
    _events.valueChanged(_sampleValue, _dispatchKey);
    trigger();
  }

  String get sampleValue => _sampleValue;
}

// 定义API
class SampleApi {
  final SampleActions _actions;
  final SampleStore _store;

  SampleApi(this._actions, this._store);

  void setSampleValue(String newValue) {
    _actions.setSampleValue(newValue);
  }

  String get sampleValue => _store.sampleValue;
}

// 定义Events
class SampleEvents extends EventsCollection {
  final Event<String> valueChanged = Event<String>();

  SampleEvents(DispatchKey key) : super(key) {
    manageEvent(valueChanged);
  }
}

// 定义Components
class SampleComponents implements ModuleComponents {
  final SampleActions _actions;
  final SampleStore _store;

  SampleComponents(this._actions, this._store);

  [@override](/user/override)
  ReactComponent content() {
    return SampleComponent({'actions': _actions, 'store': _store});
  }
}

// 定义Module
class SampleModule extends Module {
  final String name = 'SampleModule';

  SampleActions _actions;
  SampleStore _store;

  SampleApi _api;
  SampleApi get api => _api;

  SampleEvents _events;
  SampleEvents get events => _events;

  SampleComponents _components;
  SampleComponents get components => _components;

  SampleModule() {
    _actions = SampleActions();
    _events = SampleEvents(sampleDispatchKey);
    _store = SampleStore(_actions, _events, sampleDispatchKey);
    _components = SampleComponents(_actions, _store);
    _api = SampleApi(_actions, _store);
  }

  [@override](/user/override)
  Future<void> onLoad() async {
    print('SampleModule is loading...');
    // 可以在这里执行初始化逻辑
    await super.onLoad();
  }

  [@override](/user/override)
  Future<void> onUnload() async {
    print('SampleModule is unloading...');
    // 可以在这里执行清理逻辑
    await super.onUnload();
  }
}

// 使用Module
void main() {
  final sampleModule = SampleModule();

  // 监听模块事件
  sampleModule.events.valueChanged.listen((newValue) {
    print('Value changed to: $newValue');
  });

  // 调用API方法
  sampleModule.api.setSampleValue('new value');

  // 加载模块
  sampleModule.load().then((_) {
    print('Module loaded successfully');
  });

  // 卸载模块
  sampleModule.unload().then((_) {
    print('Module unloaded successfully');
  });
}