Flutter功能未知插件centrifuge的介绍与使用

centrifuge 是一个用于连接 Centrifugo 服务器和 Centrifuge 库的 WebSocket 客户端。该库目前尚未发布 v1 版本，API 仍在演进中。补丁版本更新仅包含向后兼容的更改，次要版本更新可能包含不向后兼容的 API 更改。

简介

• Centrifugo 服务器
• Centrifuge 库

在开始使用此 SDK 之前，建议阅读 客户端 SDK API 规范 以了解其行为。规范涵盖了常见的 SDK 行为，描述了客户端和订阅状态转换、主要选项和方法。

此外，请查看 SDK 功能矩阵 以了解此 SDK 实现的功能。

注意：自定义 WebSocket 连接升级头只能在支持 dart:io 的平台上设置。因此，在 Web 平台上配置的 Client 中设置的自定义标头将被忽略。

兼容性

最新版的 centrifuge-dart 兼容：

• Centrifugo 服务器 v5 和 v4
• Centrifuge >= 0.25.0

对于 Centrifugo v2、v3 和 Centrifuge < 0.25.0，应使用 centrifuge-dart v0.8.0。

示例

以下是一些示例应用程序：

• example/flutter_app：简单的聊天应用程序
• example/chat_app：另一个聊天示例
• example/console：简单的控制台应用程序

后台使用

当移动应用程序进入后台时，操作系统对持久连接有特定限制，这些连接可能会被静默关闭。因此，在大多数情况下，当应用程序进入后台时需要断开与服务器的连接，并在应用程序返回前台时重新连接。

维护者/贡献者的说明

如何更新 protobuf 定义

1. 安装 protoc 编译器。
2. 安装 protoc_plugin（通过命令 dart pub global activate protoc_plugin）。
3. 进入 lib/src/proto 目录并运行 protoc --dart_out=. -I . client.proto。
4. 返回根目录并运行 dartfmt -w lib/ test/（通过命令 dart pub global activate dart_style 安装 dartfmt）。

如何发布

1. 更新变更日志。
2. 在 pubspec.yaml 中更新版本号，推送到仓库并创建新标签。
3. 运行 dart pub publish。

作者

German Saprykin, saprykin.h@gmail.com

示例代码

下面是一个简单的 Flutter 应用程序示例，展示如何使用 centrifuge 插件进行 WebSocket 连接：

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

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

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

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

  final String title;

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

class _MyHomePageState extends State<MyHomePage> {
  late Client _client;
  String _message = 'No message received';

  [@override](/user/override)
  void initState() {
    super.initState();

    // 初始化 Centrifuge 客户端
    _client = Client('ws://localhost:8000/connection/websocket', options: ClientOptions());

    // 连接到服务器
    _client.connect();

    // 订阅频道
    var subscription = _client.newSubscription('chat:index');

    subscription.onData((data) {
      setState(() {
        _message = data['message'];
      });
    });

    subscription.subscribe();

    // 处理连接事件
    _client.onConnect((event) {
      print('Connected to server');
    });

    _client.onDisconnect((event) {
      print('Disconnected from server');
    });
  }

  [@override](/user/override)
  void dispose() {
    _client.disconnect();
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              'Message:',
            ),
            Text(
              '$_message',
              style: Theme.of(context).textTheme.headline4,
            ),
          ],
        ),
      ),
    );
  }
}