Flutter实时通信插件pusher_client_fixed的使用

概述

pusher_client_fixed 是一个用于Flutter应用的Pusher Channels客户端插件，支持Android和iOS平台。它封装了 pusher-websocket-java 和 pusher-websocket-swift，允许开发者在Flutter应用中实现实时通信功能。

安装

在你的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  pusher_client_fixed: ^0.0.4

然后运行 flutter pub get 来安装插件。

配置

iOS配置

1. 在 ios/Podfile 中设置最低部署目标为9.0：

   platform :ios, '9.0'
   

2. 如果你使用本地的Pusher服务器（如 laravel-websockets），需要在 ios/Runner/Info.plist 中添加以下内容：

   <key>NSAppTransportSecurity</key>
   <dict>
       <key>NSAllowsArbitraryLoads</key>
       <true/>
   </dict>
   

Android配置

如果启用了代码混淆（R8或proguard），需要在 android/app/build.gradle 中添加混淆规则：

buildTypes {
  release {
    minifyEnabled true
    proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
  }
}

然后在 android/app/proguard-rules.pro 中添加：

-keep class com.github.chinloyal.pusher_client.** { *; }

示例代码

以下是一个完整的示例，展示如何使用 pusher_client_fixed 插件来订阅私有频道并监听事件。

import 'dart:developer';

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

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

const String appId = "1321495";
const String key = "037c47e0cbdc81fb7144";
const String cluster = "mt1";
const String hostEndPoint = "172.17.96.1";
const String hostAuthEndPoint = "http://$hostEndPoint/broadcasting/auth";
const String token = "2|2gAA0Z1w43jasatIFaw0MD3H8LSDeGIoK2sCtTDw6ac6eb51";
const String channelName = 'private-messages';
const String eventName = 'MessageCreatedEvent';

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

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

class _MyAppState extends State<MyApp> {
  late PusherClient pusherClient;
  late Channel channel;

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

  void initPusher() {
    pusherClient = PusherClient(
      key,
      PusherOptions(
        cluster: cluster,
        auth: PusherAuth(
          hostAuthEndPoint,
          headers: {'Authorization': 'Bearer $token'},
        ),
      ),
      autoConnect: false,
      enableLogging: true,
    );

    pusherClient.connect();

    pusherClient.onConnectionStateChange((state) {
      log(
        "previousState: ${state?.previousState}, currentState: ${state?.currentState}, socketId: ${pusherClient.getSocketId()}",
      );
      if (state?.currentState == 'CONNECTED') {
        channel = pusherClient.subscribe(channelName);

        channel.bind(eventName, (event) {
          log('${event?.data}');
        });
      }
    });

    pusherClient.onConnectionError((error) {
      log("error: ${error?.message}");
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Flutter Pusher Client Example'),
        ),
        body: const Center(
          child: Text('Listening to Pusher events...'),
        ),
      ),
    );
  }

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