Flutter插件schwifty的使用_Schwifty 是一个用于 Flutter 的基于流的状态机。它被设计为一种简化版的 BLoC 模式

Flutter插件schwifty的使用_Schwifty 是一个用于 Flutter 的基于流的状态机。它被设计为一种简化版的 BLoC 模式

Schwifty

Schwifty 是一个用于 Flutter 的基于流的状态机。它被设计为一种简化版的 BLoC 模式，不依赖于上下文并且减少了样板代码。

安装

在你的 pubspec.yaml 文件中添加以下内容：

dependencies:
  schwifty: ^0.0.1

然后运行 flutter pub get 来安装该包。

使用

创建一个 Schwifty 状态流

要创建一个新的状态流，使用 Schwifty 类。这个类有一个单一的方法 create，它接受一个返回状态流的函数。当流首次被监听时，该函数将被调用。

final Schwifty<int> _schwifty = Schwifty<int>('counter');

在这个例子中，我们创建了一个新的 Schwifty 实例来管理整数状态。你需要传递一个唯一的名称给构造函数，并指定实例的值类型，以便识别状态。如果访问已存在的实例，但类型不同，则会抛出异常。

你可以通过 Schwifty 实例的 value 属性访问当前状态的值。

print(_schwifty.value);

你也可以通过构造函数传递初始状态值。

final Schwifty<int> _schwifty = Schwifty<int>('counter')..emit(1);

你还可以通过 previousValue 属性访问前一个状态值。

print(_schwifty.previousValue);

监听状态流

要监听状态流的值，你可以监听 Schwifty 实例的 stream 属性，或者使用 StreamBuilder 或 SchwiftyBuilder 小部件。

使用 stream 属性

_schwifty.stream.listen((value) {
  print(value);
});

使用 StreamBuilder 小部件

StreamBuilder<int>(
  stream: _schwifty.stream,
  builder: (context, snapshot) {
    return Text(snapshot.data.toString());
  },
);

使用 SchwiftyBuilder 小部件

SchwiftyBuilder<int>(
  schwifty: _schwifty,
  builder: (context, schwifty) {
    return Text(schwifty.value.toString());
  },
);

更新状态

你可以通过调用 Schwifty 实例的 emit 方法来更新状态值。

_schwifty.emit(1);

你还可以使用 emitFromFuture 方法从未来更新状态值。这会自动处理加载状态和错误状态。

_schwifty.emitFromFuture(Future.value(1));

最后，你可以使用 emitFromStream 方法从流更新状态值。这会将流置于加载状态，直到流发出一个值或发生错误。

_schwifty.emitFromStream(Stream.value(1));

处理加载和错误状态

当你使用 emitFromFuture 或 emitFromStream 方法时，状态会自动设置为加载状态，直到未来或流发出一个值。如果未来或流抛出错误，状态会被设置为错误状态并包含错误对象。

你可以通过检查 isLoading 和 hasError 属性来判断 Schwifty 实例是否处于加载或错误状态。

if (_schwifty.isLoading) {
  print('Loading...');
}

if (_schwifty.hasError) {
  print('Error: ${_schwifty.error}');
}

处置状态流

要处置状态流，可以调用 Schwifty 实例的 dispose 方法。如果你在一个具有唯一名称的 Schwifty 实例上调用此方法，该实例仍然可以通过名称访问，但流会被关闭且不再发出任何值。

_schwifty.dispose();

SchwiftyBuilder 小部件

SchwiftyBuilder 是一个方便的小部件，它会自动监听状态流并在状态变化时重新构建小部件。

属性包括：

• schwifty: 要使用的 Schwifty 实例。
• builder: 一个接受 BuildContext 和 Schwifty 实例并返回 Widget 的函数。
• loadingBuilder: 一个接受 BuildContext 和 Schwifty 实例并返回 Widget 的函数。这会在状态处于加载状态时被调用。
• errorBuilder: 一个接受 BuildContext、Schwifty 实例和 Object 并返回 Widget 的函数。这会在状态处于错误状态时被调用。
• shouldRebuild: 一个接受 Schwifty 实例并返回 bool 的函数。如果此函数返回 false，则小部件不会被重建。
• onlyRebuildOnValueChange: 一个确定小部件是否仅在状态值改变时才重建的布尔值，默认为 true。
• onlyBuildOnce: 一个确定小部件是否仅在状态有值时只构建一次的布尔值，默认为 false。

SchwiftyBuilder<int>(
  schwifty: _schwifty,
  builder: (context, schwifty) {
    return Text(schwifty.value.toString());
  },
  loadingBuilder: (context, schwifty) {
    return CircularProgressIndicator();
  },
  errorBuilder: (context, schwifty, error) {
    return Text('Error: $error');
  },
  shouldRebuild: (schwifty) {
    return schwifty.value % 2 == 0;
  },
  onlyRebuildOnValueChange: false,
  onlyBuildOnce: true,
);

示例代码

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

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Schwifty Example',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: 'Schwifty Example Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});
  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final Schwifty<int> _schwifty = Schwifty<int>('counter')..emit(0);

  void _incrementCounter() {
    _schwifty.emit((_schwifty.value ?? 0) + 1);
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: SchwiftyBuilder<int>(
          schwifty: _schwifty,
          builder: (context, schwifty) {
            return Text(
              'You have pushed the button this many times: ${schwifty.value}',
            );
          },
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}