極簡Flutter狀態管理庫：consumer

超級大柱子發表於2021-03-21
Flutter

20210304095323160.png

若你覺得 Provider 等狀態管理太繁瑣， consumer 就是為你準備的一款高效能、極簡的狀態管理庫。

consumer 是一個參考 react-consumer 方式的狀態管理, 使用 dart 的 Stream 做釋出訂閱.

類 react 專案，當專案到一定程度，必不可少需要一個狀態管理器，flutter 有著不少狀態管理庫，BLOC、Provider、redux 等等；但是他們現有的問題是沒有給出很便捷的狀態管理優化方案。

consumer 的特點是僅僅是釋出訂閱模式加 StateFulWidget，這比市面上基於 InheritedWidget 進行封裝的狀態管理器的優勢是它不需要一個頂層的提供者模式的包裹。基於此，consumer 可以讓專案更簡單建立子模組的獨立的狀態管理，當然你也可以使用 consumer 的單一模式管理整個專案的狀態。

在這個前提下，我們會發現若專案足夠大，我們需要切分多個子狀態管理，或者一些區域性的狀態管理，這樣可以有效減少事件派發的影響範圍，從而提高效能；consumer 另一個特點是強制使用者描述每個訂閱所使用的物件，這樣 consumer 可以幫助優化效能，攔截不必要的更新。

Feature

  • 僅更新資料變化的區域性
  • 不需要一個頂層的 Provider 包裹物件
  • 可以很輕鬆的給子模組設定獨立的狀態管理
  • 非常易於使用, 僅有 2 個 API: setState、build

API 文件:

安裝 consumer

修改 pubspec.yaml:

dependencies:
  consumer: ^2.2.0
複製程式碼

入門指南

這是一個 Flutter 預設的初始化專案，我們使用 consumer 改造它，移除 StateFulWidget，替換成 StatelessWidget：

import 'package:flutter/material.dart';

void main() => runApp(MyApp());

// *** 定義一個類，描述狀態 ***
class ExampleState {
  int counter = 0;
}

// *** 建立一個 consumer ***
var consumer = Consumer(ExampleState());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Consumer Demo Home Page'),
    );
  }
}

class MyHomePage extends StatelessWidget {
  MyHomePage({Key key, this.title}) : super(key: key);

  final String title;

  _incrementCounter() {
    // *** 使用 setState ，觸發訂閱的元件更新 ***
    consumer.setState((state) => state.counter++);
  }

  @override
  Widget build(BuildContext context) {
    print('整個物件僅更新一次，更新時僅更新訂閱的元件');

    return Scaffold(
      appBar: AppBar(
        title: Text(title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              'You have pushed the button this many times:',
            ),
            // *** 使用 consumer.build 訂閱一個元件 ***
            consumer.build((ctx, state) {
              return Text(
                state.counter.toString(),
                style: Theme.of(context).textTheme.display1,
              );
            }, memo:()=>[state.counter]),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: Icon(Icons.add),
      ),
    );
  }
}

複製程式碼

引數 memo 的作用是什麼？

從 v2.2.0 版本開始 memo 引數是必傳的，這是因為作者認為與其等效能出現問題再去優化，不如從編寫的時候就強制開發者編寫效能已優化的程式碼。

如果你專案有著非常多的狀態訂閱，使用 memo 可以大幅度提高效能.

memo 的概念是來自於 react.Hooks, 它用來描述監聽變化的物件，僅有監聽物件變化時，才會派發更新。

一個原則是，我們在 builder 物件中需要使用什麼屬性，memo 返回的陣列就定義什麼屬性, 我們這裡有一些例子：

如果我們由 consumer.build 建立的兩個 widget：

// *** definition a state ***
class ExampleState {
  List<String> animates = [];
  int age = 0;
  String name = 'dog';
}

// *** create a consumer ***
var consumer = Consumer(ExampleState());

Column(
  children: <Widget>[
    consumer.build((ctx, state) {
        print('Update when state.age change');
        return Text(
          '$state.age',
          style: Theme.of(context).textTheme.display1,
        );
      },
      memo: (state) => [state.age, state.animates],
    ),
    consumer.build((ctx, state) {
        print('Update when state.name change');
        return Text(
          state.name,
          style: Theme.of(context).textTheme.display1,
        );
      },
      memo: (state) => [state.name],
    ),
  ],
);
複製程式碼

然後我們更新 state.name:

consumer.setState((state){
  state.name = 'cat';
});
複製程式碼

此時，當我們更新 state.name，只有訂閱了 memo: (state) => [state.name] 的 widget 會更新，其他 Widget 的更新都會被 consumer 攔截。

完整的使用 consumer 配合 memo 攔截更新的例子

一般來說使用狀態管理都會涉及到跨元件更新，consumer 建議您把相關元件使用的狀態放到一個檔案中，在不同的元件中進行引用:

lib/consumer.dart: 宣告狀態和狀態消費者

import 'package:consumer/consumer.dart';

class ExampleState {
  int counter = 0;
  String time = DateTime.now().toString();
}

var consumer = Consumer(ExampleState());
複製程式碼

lib/main.dart: 使用狀態消費者，繪製需要被狀態接管的元件

import 'package:flutter/material.dart';
import './consumer.dart';

void main() => runApp(MyApp());

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Material App',
      theme: ThemeData(primaryColor: Colors.blue),
      home: Scaffold(
        appBar: AppBar(
          title: Text("hello"),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              Text('counter:'),
              consumer.build(
                (ctx, state) {
                  print("update state.counter");
                  return Text(
                    state.counter.toString(),
                    style: Theme.of(ctx).textTheme.headline4,
                  );
                },
                memo: (state) => [state.counter],
              ),
              Container(
                child: TextButton(
                  onPressed: () {
                    consumer.setState((state) {
                      state.counter += 1;
                    });
                  },
                  child: Text("Only Change counter",
                      style: TextStyle(fontSize: 24)),
                ),
                margin: EdgeInsets.only(top: 20, bottom: 40),
              ),
              Text('time:'),
              consumer.build(
                (ctx, state) {
                  print("update state.time");
                  return Text(
                    state.time.toString(),
                    style: Theme.of(ctx).textTheme.headline4,
                  );
                },
                memo: (state) => [state.time],
              ),
              Container(
                child: TextButton(
                  onPressed: () {
                    consumer.setState((state) {
                      state.time = DateTime.now().toString();
                    });
                  },
                  child:
                      Text("Only Change time", style: TextStyle(fontSize: 24)),
                ),
                margin: EdgeInsets.only(top: 20),
              ),
            ],
          ),
        ),
      ),
    );
  }
}
複製程式碼

為什麼我的使用了 consumer.setState 之後 Widget 並沒有更新？

或許你在 builder 中使用了 state.name, 不過 memo 返回的陣列未包含 state.name:

Center(
  child: consumer.build((ctx, state) {
      return Text(
        state.name,
        style: Theme.of(context).textTheme.display1,
      );
    },
    memo: (state) => [state.age],
  ),
);
複製程式碼

或許你的 memo 未監聽任何物件:

Center(
  child: consumer.build((ctx, state) {
      return Text(
        state.name,
        style: Theme.of(context).textTheme.display1,
      );
    },
    memo: (state) => [],
  ),
);
複製程式碼

或許你僅僅是改變了 List 或 Map 內的物件，但是沒有重新設定一個新的 List 或 Map：

class ExampleState {
  List<String> names = ['dog', 'cat'];
}

var consumer = Consumer(ExampleState());

Center(
  child: consumer.build((ctx, state) {
      return Text(
        state.names[0],
        style: Theme.of(context).textTheme.display1,
      );
    },
    memo: (state) => [state.names],
  ),
);

// 錯誤的更新:
Consumer.setState((state){
  state.names[0] = 'fish'
});

// 正確的更新:
Consumer.setState((state){
  List<String> names = [...state.names];
  names[0] = 'fish'
  state.names = names;
});
複製程式碼

State 小技巧

如果你需要在更新之前做一些計算, 或者更方便處理陣列之類的更新，你可以建立一些函式屬性給 State：

這裡有一個修改 List 資料的例子：

class ExampleState {
  int lastChangeNamesIndex;
  List<String> names = ['dog', 'cat'];

  changeNameAt(int index, String name) {
    lastChangeNamesIndex = index;
    List<String> nextNames = [...names];
    nextNames[index] = name;
    names = nextNames;
  }
}

var consumer = Consumer(ExampleState());

Center(
  child: consumer.build((ctx, state) {
      return Text(
        state.names[state.lastChangeNamesIndex],
        style: Theme.of(context).textTheme.display1,
      );
    },
    memo: (state) => [state.names, state.lastChangeNamesIndex],
  ),
);

// 輕鬆更新 names 和 lastChangeNamesIndex
consumer.setState((state){
  state.changeNameAt(0, 'monkey');
})
複製程式碼

That's all

感謝你閱讀本文件和使用 consumer.

相關文章