搜索插件、代码仓与 APP 分类

插件详情v2.0.3

flutter_client_sse

Dart 包,用于帮助消费 SSE API。它通过返回事件、ID 和数据的解析模型来消费服务器发送事件。

AndroidiOSWebmacOSWindowsLinux
近 30 天下载
4.5万
喜欢数
110
Pub 分数
150

安装插件

flutter pub add flutter_client_sse

插件介绍

基于插件公开信息、社区数据与项目使用情况整理的选型参考。

一个用于简化在Flutter应用中消费服务器发送事件(SSE)API的Dart包。它从服务器流式传输事件数据,并将每个事件解析为结构化组件,如事件类型、ID和有效载荷。非常适合实时更新,例如实时通知、股票价格或聊天消息,支持所有主要平台,包括Android、iOS、Web、macOS、Windows和Linux。该包抽象了底层HTTP处理,为开发者提供了一个简洁的接口来响应传入的事件。

适合场景

  • 实时通知
  • 实时数据流
  • 聊天应用
  • 股票价格更新
  • 状态监控
  • 事件驱动的UI

主要特点

  • 解析事件 ID、类型和数据
  • 支持跨平台部署
  • 基于流的事件处理
  • 简单 API 集成
  • 自动重连尝试
  • 基于模型的响应解析

适合对象

  • 实时应用开发
  • 后端到前端的事件通信
  • 需要实时更新的应用程序
  • 使用 SSE API 的开发人员
  • 跨平台项目与实时数据

使用建议

  • 需要服务器端SSE支持
  • 仅限单向服务器到客户端通信
  • 可能需要自定义错误处理
  • 不适用于双向通信
  • 依赖稳定的网络连接

原始 README

以下为关联源码仓库的 README 原文快照,最新内容请访问源码仓库。

Flutter Client SSE

Dart package to help consume Server Sent Events

Features:
  • Consumes server sent events
  • Returns parsed model of the event, id and the data

Getting Started

Import

Add the following import in the pubspec.yaml file

client_sse:
    git:
      url: https://github.com/pratikbaid3/flutter_client_sse
      path:
Example
///GET REQUEST
SSEClient.subscribeToSSE(
    method: SSERequestType.GET,
    url:
    'http://192.168.1.2:3000/api/activity-stream?historySnapshot=FIVE_MINUTE',
    header: {
        "Cookie":
        'jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InRlc3QiLCJpYXQiOjE2NDMyMTAyMzEsImV4cCI6MTY0MzgxNTAzMX0.U0aCAM2fKE1OVnGFbgAU_UVBvNwOMMquvPY8QaLD138; Path=/; Expires=Wed, 02 Feb 2022 15:17:11 GMT; HttpOnly; SameSite=Strict',
        "Accept": "text/event-stream",
        "Cache-Control": "no-cache",
    }).listen((event) {
        print('Id: ' + event.id!);
        print('Event: ' + event.event!);
        print('Data: ' + event.data!);
    },
);

///POST REQUEST
SSEClient.subscribeToSSE(
    method: SSERequestType.POST,
    url:
    'http://192.168.1.2:3000/api/activity-stream?historySnapshot=FIVE_MINUTE',
    header: {
        "Cookie":
        'jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InRlc3QiLCJpYXQiOjE2NDMyMTAyMzEsImV4cCI6MTY0MzgxNTAzMX0.U0aCAM2fKE1OVnGFbgAU_UVBvNwOMMquvPY8QaLD138; Path=/; Expires=Wed, 02 Feb 2022 15:17:11 GMT; HttpOnly; SameSite=Strict',
        "Accept": "text/event-stream",
        "Cache-Control": "no-cache",
    },
    body: {
        "name": "Hello",
        "customerInfo": {"age": 25, "height": 168}
    }).listen((event) {
            print('Id: ' + event.id!);
            print('Event: ' + event.event!);
            print('Data: ' + event.data!);
    },
);

Running Sample Backend

Nest The backend is in NestJS serving a single SSE api.

Installation

$ yarn install

Running the app

# development
$ yarn run start

# watch mode
$ yarn run start:dev

所属分类

依赖

依赖清单 1 项

源码仓库

使用此插件的项目

暂无相关数据。