Flutter事件发布订阅插件controller_pubsub的使用

发布于 1周前 作者 eggper 来自 Flutter

Flutter事件发布订阅插件controller_pubsub的使用

特性

  • Controller监听器: 一个mixin类，允许类监听控制器的通知。
  • Controller发布者: 一个mixin类，提供一种订阅控制器的机制。
  • Controller观察者: 一个单例类，作为管理控制器通知的中央枢纽。

开始使用

  1. 在pubspec.yaml文件中添加依赖：
dependencies:
  controller_pubsub: ^0.0.3

使用方法

以下是一些简短且有用的示例，供用户参考。更长的例子可以添加到/example文件夹中。

/// 这是一个如何使用[ControllerPublisher] mixin类的示例。
class AuthBloc extends Bloc<AuthEvent, AuthState>
    with ControllerPublisher<AuthBloc> {
  final IAuthRepository _authRepository;
  AuthBloc(this._authRepository) : super(const AuthState.initial()) {
    on<AuthEvent>(
      (event, emit) async {
        await event.map(
          authCheckRequested: (e) async {
            final result = await _authRepository.isSignIn();
            emit(
              result
                  ? const AuthState.authenticated()
                  : const AuthState.initial(),
            );
            if (result) {
              notifySubscribers('Hi there!');  // 这将通知该控制器的所有订阅者。
            }
          },
        );
      },
    );
  }
}

/// 这是一个如何使用[ControllerListener] mixin类的示例。
class LogInBloc extends Bloc<LogInEvent, LogInState>
    with ControllerSubscriber<AuthBloc> {

  [@override](/user/override)
  void handleNotification([value]) {
    print(value); // 当[AuthBloc]通知此控制器时，这将打印'Hi there!'。
    super.handleNotification(value);
  }

  [@override](/user/override)
  LogInBloc(this._signInRepository) : super(LogInState.initial()) {
    addListener(this); // 别忘了将监听器添加到控制器。
    ....
  }

  [@override](/user/override)
  Future<void> close() {
    removeListener(this); // 别忘了从控制器中移除监听器。
    return super.close();
  }
}

更多关于Flutter事件发布订阅插件controller_pubsub的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter事件发布订阅插件controller_pubsub的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然，以下是如何在Flutter中使用controller_pubsub插件来实现事件发布和订阅的示例代码。这个插件允许你在Flutter应用中轻松地进行事件驱动编程。

首先，确保你已经在pubspec.yaml文件中添加了controller_pubsub依赖：

dependencies:
  flutter:
    sdk: flutter
  controller_pubsub: ^最新版本号  # 请替换为当前最新版本号

然后运行flutter pub get来安装依赖。

接下来，让我们编写一些代码来演示如何使用controller_pubsub。

1. 创建一个事件类

首先，定义一个事件类。这个类可以是任何你想要传递的数据结构。例如，我们可以创建一个简单的MessageEvent类：

class MessageEvent {
  final String message;

  MessageEvent(this.message);
}

2. 设置事件发布者和订阅者

接下来，在你的Flutter应用中设置事件发布者和订阅者。通常，你会在一个状态管理类中处理这些逻辑，比如使用ChangeNotifier或直接在某个Widget中处理。

####发布者代码示例：

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

class EventPublisher {
  final PubSub<MessageEvent> _pubSub = PubSub<MessageEvent>();

  void publishMessage(String message) {
    _pubSub.publish(MessageEvent(message));
  }

  Stream<MessageEvent> subscribeToMessages() {
    return _pubSub.stream;
  }
}

####订阅者代码示例：

import 'package:flutter/material.dart';
import 'package:controller_pubsub/controller_pubsub.dart';
import 'message_event.dart'; // 导入上面定义的MessageEvent类
import 'event_publisher.dart'; // 导入上面定义的EventPublisher类

class MessageSubscriber extends StatefulWidget {
  @override
  _MessageSubscriberState createState() => _MessageSubscriberState();
}

class _MessageSubscriberState extends State<MessageSubscriber> {
  final EventPublisher _eventPublisher = EventPublisher();
  String _latestMessage = 'No messages yet.';

  @override
  void initState() {
    super.initState();
    // 订阅消息流
    _eventPublisher.subscribeToMessages().listen((event) {
      setState(() {
        _latestMessage = event.message;
      });
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Message Subscriber'),
      ),
      body: Center(
        child: Text(_latestMessage),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () {
          // 假设这里有一个按钮点击事件，发布一条消息
          _eventPublisher.publishMessage('Hello, Flutter!');
        },
        tooltip: 'Send message',
        child: Icon(Icons.send),
      ),
    );
  }
}

3. 使用订阅者Widget

最后，在你的主应用入口（通常是main.dart）中使用这个订阅者Widget：

import 'package:flutter/material.dart';
import 'message_subscriber.dart'; // 导入上面定义的MessageSubscriber类

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

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

这个示例展示了如何使用controller_pubsub插件在Flutter中实现事件发布和订阅。发布者EventPublisher类负责发布事件，而订阅者MessageSubscriber类则订阅这些事件并在UI中更新显示。你可以根据实际需求扩展和修改这个基础示例。

回到顶部