Flutter动画效果插件spinify的使用

Flutter动画效果插件spinify的使用

Spinify 是一个 Dart 和 Flutter 库，提供了对 Centrifugo 的高效客户端实现。Centrifugo 是一个可扩展的实时消息服务器。这个库允许你将你的 Dart 或 Flutter 应用连接到 Centrifugo 服务器和 Centrifuge 库，从而实现实时更新、存在信息、历史记录获取等。

安装

首先，在 pubspec.yaml 文件中添加依赖并指定版本：

dependencies:
  spinify: ^X.Y.Z  # 替换为实际版本号

然后运行以下命令以获取包：

flutter pub get

示例代码

下面是一个简单的 Spinify 使用示例：

// 创建 Spinify 客户端实例
final client = Spinify();

// 连接到指定的 URL
await client.connect(url);

// 在这里可以进行其他操作，例如订阅频道、发布消息等

// 关闭连接
await client.close();

以下是带有自定义配置的 Spinify 使用示例：

import 'dart:convert' as utf8;
import 'dart:io' as io;

// 创建自定义 HTTP 客户端
final httpClient = io.HttpClient(
  context: io.SecurityContext(
    withTrustedRoots: true,
  )..setTrustedCertificatesBytes([/* bytes array */]), // 设置受信任的证书
);

// 创建 Spinify 客户端实例，并传入自定义配置
final client = Spinify(
  config: SpinifyConfig(
    client: (name: 'app', version: '1.0.0'), // 客户端名称和版本
    timeout: const Duration(seconds: 15), // 超时时间
    serverPingDelay: const Duration(seconds: 8), // 服务器 ping 延迟
    connectionRetryInterval: (
      min: const Duration(milliseconds: 250),
      max: const Duration(seconds: 15),
    ), // 连接重试间隔
    getToken: () async => '<token>', // 获取令牌
    getPayload: () async => utf8.encode('Hello, World!'), // 获取负载
    codec: SpinifyProtobufCodec(), // 使用 Protobuf 编码器
    transportBuilder: SpinifyTransportAdapter.vm(
      compression: io.CompressionOptions.compressionDefault,
      customClient: httpClient, // 自定义 HTTP 客户端
      userAgent: 'Dart', // 用户代理
    ),
    logger: (level, event, message, context) => print('[$event] $message'), // 日志记录
  ),
);

订阅一个频道的示例：

// 创建一个新的订阅
final sub = client.newSubscription('notifications:index');

// 监听频道上的发布事件，并打印解码后的消息
sub.stream.publication().map((p) => utf8.decode(p.data)).listen(print);

// 订阅频道
await sub.subscribe();

// 发布消息到频道
await sub.publish(utf8.encode('Hello, World!'));

// 取消订阅
await sub.unsubscribe();

完整示例 Demo

以下是一个完整的 Flutter 应用程序示例，展示了如何使用 Spinify 插件进行连接、订阅和发布消息：

import 'dart:convert' as utf8;
import 'dart:io' as io;
import 'package:flutter/material.dart';
import 'package:spinify/spinify.dart';

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

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

class SpinifyDemo extends StatefulWidget {
  [@override](/user/override)
  _SpinifyDemoState createState() => _SpinifyDemoState();
}

class _SpinifyDemoState extends State<SpinifyDemo> {
  late Spinify client;
  bool isConnected = false;

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

  void initSpinify() async {
    final httpClient = io.HttpClient(
      context: io.SecurityContext(
        withTrustedRoots: true,
      )..setTrustedCertificatesBytes([/* bytes array */]),
    );

    client = Spinify(
      config: SpinifyConfig(
        client: (name: 'app', version: '1.0.0'),
        timeout: const Duration(seconds: 15),
        serverPingDelay: const Duration(seconds: 8),
        connectionRetryInterval: (
          min: const Duration(milliseconds: 250),
          max: const Duration(seconds: 15),
        ),
        getToken: () async => '<token>',
        getPayload: () async => utf8.encode('Hello, World!'),
        codec: SpinifyProtobufCodec(),
        transportBuilder: SpinifyTransportAdapter.vm(
          compression: io.CompressionOptions.compressionDefault,
          customClient: httpClient,
          userAgent: 'Dart',
        ),
        logger: (level, event, message, context) => print('[$event] $message'),
      ),
    );

    await client.connect('ws://your-centrifugo-server-url');
    setState(() {
      isConnected = true;
    });

    final sub = client.newSubscription('notifications:index');
    sub.stream.publication().map((p) => utf8.decode(p.data)).listen((msg) {
      print('Received message: $msg');
    });
    await sub.subscribe();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Spinify Demo'),
      ),
      body: Center(
        child: isConnected
            ? Text('Connected to Spinify')
            : Text('Connecting...'),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () async {
          if (isConnected) {
            final sub = client.newSubscription('notifications:index');
            await sub.publish(utf8.encode('Hello from Flutter!'));
            print('Message sent!');
          }
        },
        tooltip: 'Send Message',
        child: Icon(Icons.send),
      ),
    );
  }

  [@override](/user/override)
  void dispose() {
    client.close();
    super.dispose();
  }
}