Flutter网络通信插件socketnotifs的使用

Flutter网络通信插件SocketNotifs的使用

简介

SocketNotifs 是一个用于Flutter应用程序的Dart插件，它简化了WebSocket连接，并提供了通知功能。目前该插件仅支持Android平台，iOS平台由于Apple的APN系统限制，暂时不支持。

功能

• 无缝建立WebSocket连接。
• 完整的Android端实现，包括所需的权限和服务。

安装

在 pubspec.yaml 文件中添加依赖项：

dependencies:
  socketnotifs: <latest_version>

然后运行以下命令以获取依赖项：

flutter pub get

使用示例

下面是一个最小化的示例代码，展示了如何使用 SocketNotifs 插件：

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

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

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

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  @override
  void initState() {
    super.initState();
    // 连接到WebSocket服务器
    SocketNotifs.connectToWebSocket("ws://10.0.2.2:4000");
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: const Center(
          child: Text('Running on: drugs\n'), // 这里可以替换为实际的内容
        ),
      ),
    );
  }
}

Android权限

为了使用此插件，确保在 AndroidManifest.xml 文件中添加以下权限：

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.FOREGROUND_SERVICE_DATA_SYNC" />

<application>
    <service
        android:name="com.example.socketnotifs.WebSocketService"
        android:exported="true"
        android:foregroundServiceType="dataSync" />
</application>

服务器端示例（JavaScript）

以下是一个简单的Node.js服务器端示例，用于通过WebSocket发送通知：

const WebSocket = require("ws");
const express = require("express");
const app = express();
const port = 4000;

// 初始化WebSocket服务器
const wss = new WebSocket.Server({ noServer: true });

// WebSocket连接处理
wss.on("connection", (ws) => {
  console.log("Client connected");

  ws.on("close", () => {
    console.log("Client disconnected");
  });
});

// 升级HTTP服务器为WebSocket
app.server = app.listen(port, () => {
  console.log(`Server is listening on port ${port}`);
});

app.server.on("upgrade", (request, socket, head) => {
  wss.handleUpgrade(request, socket, head, (ws) => {
    wss.emit("connection", ws, request);
  });
});

function broadcastMessage(message, title) {
  wss.clients.forEach((client) => {
    if (client.readyState === WebSocket.OPEN) {
      client.send(JSON.stringify({ message, title }));
    }
  });
}

setInterval(() => {
  broadcastMessage("This is a test notification message!", "example");
  console.log("Broadcasting message...");
}, 5000);

路线图

• 已完成：
  • Android端实现。

贡献

欢迎贡献！如果您有任何问题或改进建议，请随时提交issue或pull request。

许可证

本项目采用MIT许可证。

完整示例Demo

为了帮助您更好地理解如何使用 SocketNotifs 插件，以下是一个完整的示例项目，包含客户端和服务器端代码。

客户端代码（Flutter）

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

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

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

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _message = "Waiting for notifications...";

  @override
  void initState() {
    super.initState();
    // 连接到WebSocket服务器
    SocketNotifs.connectToWebSocket("ws://10.0.2.2:4000");

    // 监听来自服务器的通知
    SocketNotifs.onNotificationReceived.listen((notification) {
      setState(() {
        _message = "${notification.title}: ${notification.message}";
      });
    });
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('SocketNotifs Example'),
        ),
        body: Center(
          child: Text(_message),
        ),
      ),
    );
  }
}

服务器端代码（Node.js）

const WebSocket = require("ws");
const express = require("express");
const app = express();
const port = 4000;

// 初始化WebSocket服务器
const wss = new WebSocket.Server({ noServer: true });

// WebSocket连接处理
wss.on("connection", (ws) => {
  console.log("Client connected");

  ws.on("close", () => {
    console.log("Client disconnected");
  });
});

// 升级HTTP服务器为WebSocket
app.server = app.listen(port, () => {
  console.log(`Server is listening on port ${port}`);
});

app.server.on("upgrade", (request, socket, head) => {
  wss.handleUpgrade(request, socket, head, (ws) => {
    wss.emit("connection", ws, request);
  });
});

function broadcastMessage(message, title) {
  wss.clients.forEach((client) => {
    if (client.readyState === WebSocket.OPEN) {
      client.send(JSON.stringify({ message, title }));
    }
  });
}

setInterval(() => {
  broadcastMessage("This is a test notification message!", "example");
  console.log("Broadcasting message...");
}, 5000);