搜索插件、代码仓与 APP 分类

插件详情v2.2.1

momentum

Flutter 的 MVC 模式。用作状态管理、依赖注入和服务定位器。

AndroidiOSWebmacOSWindowsLinux
近 30 天下载
118
喜欢数
97
Pub 分数
140

安装插件

flutter pub add momentum

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

Momentum 是一个 Flutter 包,实现了模型-视图-控制器(MVC)模式,作为状态管理、依赖注入和服务定位的统一解决方案。它通过专用的模型、视图和控制器层分离关注点,简化了应用程序架构,使代码更具可扩展性和可维护性。Momentum 可与 Flutter 的组件树无缝集成,并支持所有主要平台,包括 Android、iOS、Web、macOS、Windows 和 Linux。其轻量级设计促进了代码的清晰组织和组件间高效的数据流。

适合场景

  • 构建可扩展的 Flutter 应用程序
  • 管理复杂的应用程序状态
  • 实现依赖注入
  • 替换多个状态管理解决方案
  • 创建模块化和可测试的代码

主要特点

  • 内置的 MVC 架构
  • 集成依赖注入
  • 服务定位器功能
  • 跨平台支持
  • 最小化样板代码
  • 自动控制器生命周期管理

适合对象

  • 寻求结构化应用架构的开发者
  • 希望统一状态和依赖管理的团队
  • 需要可维护且模块化代码的项目
  • Flutter 应用针对多个平台
  • 偏好 MVC 而非其他模式的开发者

使用建议

  • 对于不熟悉MVC的开发人员来说,学习曲线
  • 与替代方案相比,社区采用率有限
  • 可能需要重构现有代码库
  • 最适合中大型项目
  • 不适合简单的或原型应用

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

MVC pattern for flutter. Works as state management, dependency injection and service locator.

Pub Version Test GitHub stars GitHub license GitHub last commit


Model View Controller

Here's a diagram describing the flow between the state (model), widget (view) and the logic (controller):

Both MomentumController and MomentumModel are abstract classes that needs to be implemented. A pair of model and controller is called a component. MomentumBuilder is simply a widget. This is used to listen to controllers for rebuilds and accessing models to display their values.

Example

If you want to see a full code example that runs. Visit the example tab for more details or you can visit the official webpage. Otherwise, if you only want to see a glimpse of how momentum works, read the Overview and FAQs below.

Advance Example: Listify (clone the repo and run the app, requires Flutter 2.0.0)

Overview

MomentumModel - the data or state. Must be Immutable.

class ProfileModel extends MomentumModel<ProfileController> {
  // ...

  final int userId;
  final String username;

  // ...
}

MomentumBuilder - the view or widget to display the state.

MomentumBuilder(
  controllers: [ProfileController], /// injects both `ProfileController` and `ProfileModel`.
  builder: (context, snapshot) {
    var profileState = snapshot<ProfileModel>(); /// grab the `ProfileModel` using snapshot.
    var username = profileState.username;
    return // some widgets here ...
  }
)

MomentumController - the logic to manipulate the model or state.

class ProfileController extends MomentumController<ProfileModel> {
  // ...

  Future<void> loadProfile() async {
    var profile = await http.get(...);
    // update the model's properties.
    model.update(
      userId: profile.userId,
      username: profile.username,
    );
  }

  // ...
}

FAQs

How to rebuild the widget?

Calling model.update(...) from inside the controller rebuilds all the MomentumBuilders that are listening to it.


How to access the model object?

It is automatically provided by MomentumController for you to use. Inside a controller class, you can access it directly. It's never null.


How to initialize the model or state?

By implementing the T init() method which is required by MomentumController. Like this:

class ShopController extends MomentumController<ShopModel> {

  @override
  ShopModel init() {
    return ShopModel(
      this, // required
      shopList: [],
      productList: [],
    );
  }
}

Can I access the model properties inside my controller?

Of course. The model object is already provided by MomentumController meaning you can also directly access its properties like this:

class ShopController extends MomentumController<ShopModel> {

  bool hasProducts() {
    return model.productList.isNotEmpty;
  }
}

Is there a special setup required for Momentum to run?

Yes, definitely. This is the required setup for Momentum in a flutter app:

void main() {
  runApp(momentum());
}

Momentum momentum() {
  return Momentum(
    child: MyApp(),
    controllers: [
      ProfileController(),
      ShopController(),
    ],
    // and more optional parameters here.
  );
}

Testing

Momentum is highly testable. This is how a basic widget testing for momentum would look like:

void main() {

  testWidgets('should display username', (tester) async {
    var profileCtrl = ProfileController();

    await tester.pumpWidget(
      Momentum(
        child: MyApp(),
        controllers: [profileCtrl],
      ),
    );
    await tester.pumpAndSettle();

    profileCtrl.updateUsername("johndoe");
    await tester.pumpAndSettle(); // ensure rebuilds

    expect(profileCtrl.model.username, "johndoe"); // unit check
    expect(find.text("johndoe"), findsOneWidget); // widget check
  });
}

Or you might not be a fan of widget testing and only want to test your components:

void main() {

  test('should display username', () async {
    var profileCtrl = ProfileController();

    var tester = MomentumTester(
      Momentum(
        controllers: [profileCtrl],
      ),
    );
    await tester.init();

    profileCtrl.updateUsername("johndoe");
    expect(profileCtrl.model.username, "johndoe"); // unit check
  });
}

Other optional features

  • Routing - Navigation system that supports persistence. The app will open the page where the user left off.
  • Event System - For showing dialogs, prompts, navigation, alerts.
  • Persistence State - Restore state when the app opens again.
  • Testing - Tests your widgets and logic. Built-in helper class for unit testing.

Momentum leverages the power of setState(..) and StatefulWidget behind the scenes. The feature Event System uses Stream.

Router issues

  • The router doesn't support named routes yet.
  • The parameter handling for router is slightly verbose. And might be complicated for some. But it works magically.
  • Needs to explicitly implement RouterPage widget in order to handle the system's back button.
  • (FIXED ✅) The router breaks after hot reload. Only a problem during development but it should work in normal execution.

API Reference

Visit the official webpage of momentum to browse the full api reference, guides, and examples.


Thanks for checking out momentum. I hope you try it soon and don't hesitate to file on issue on github. I always check them everyday.

所属分类

依赖

依赖清单 1 项

源码仓库

使用此插件的项目