欢迎加入开源鸿蒙跨平台社区:https://openharmonycrossplatform.csdn.net

在这里插入图片描述

前言

在现代 App 中,“实时通信”已成标配(IM 聊天、股票行情、订单状态推送)。
虽然 WebSocket 协议提供了全双工通信的通道,但它只是 TCP 之上的一个薄层,缺乏“消息路由”、“订阅/发布”等高级语义。

STOMP (Simple Text Oriented Messaging Protocol) 是一种基于文本的消息协议,它定义了 CONNECT, SUBSCRIBE, SEND 等命令,常与 Spring Boot 后端(Spring WebSocket)配合使用。

stomp_dart_client 是 Flutter 生态中最成熟的 STOMP 客户端实现。

对于 OpenHarmony 开发者,该库底层依赖通用的 WebSocket 连接。只要鸿蒙系统提供了标准的网络访问能力,该库就能无缝运行,帮助你低成本对接现有的企业级消息后台。

一、核心原理与流程

STOMP 把通信过程标准化了:

消息队列 (RabbitMQ/Spring) 鸿蒙 App 消息队列 (RabbitMQ/Spring) 鸿蒙 App 建立连接后维持心跳 par [双向通信] CONNECT (login, passcode) CONNECTED (session-id) SUBSCRIBE (destination: /topic/news) MESSAGE (body: "Breaking News!") SEND (destination: /app/chat, body: "Hi") DISCONNECT

二、OpenHarmony 适配说明

stomp_dart_client 默认使用 dart:io 中的 WebSocket 进行连接。
OpenHarmony 环境中,这通常是可行的,因为鸿蒙的 Dart Runtime 完整支持 dart:io 网络栈。

注意点(鸿蒙特有)

  1. 网络权限:确保 module.json5 中声明了 Internet 权限。
  2. 后台保活:WebSocket 如果进入后台,鸿蒙系统可能会挂起网络。如果需要后台接收消息,可能需要结合鸿蒙的长连接推送服务(Push Kit),或者申请后台运行任务。STOMP 客户端自身的重连机制(Reconnect)非常重要,必须配置。

三、基础用例

3.1 基础配置与连接

import 'package:stomp_dart_client/stomp_dart_client.dart';

void connectToChat() {
  final client = StompClient(
    config: StompConfig(
      url: 'ws://localhost:8080/ws',
      onConnect: (StompFrame frame) {
        print('✅ 连接成功: ${frame.headers}');
      },
      onWebSocketError: (dynamic error) => print('❌ 连接错误: $error'),
      stompConnectHeaders: {'Authorization': 'Bearer xxx'},
    ),
  );

  client.activate();
}

在这里插入图片描述

3.2 消息发送 (SEND)

void sendMessage(StompClient client) {
  client.send(
    destination: '/app/send/message',
    body: '{"text": "Hello HarmonyOS"}',
    headers: {'priority': 'high'},
  );
}

在这里插入图片描述

3.3 订阅频道 (SUBSCRIBE)

void listenToTopic(StompClient client) {
  client.subscribe(
    destination: '/topic/public',
    callback: (StompFrame frame) {
      if (frame.body != null) {
        print('收到广播: ${frame.body}');
      }
    },
  );
}

在这里插入图片描述

四、完整实战示例:鸿蒙股票行情看板

这个示例展示了如何在 Flutter 页面生命周期中管理 STOMP 连接,并在 UI 销毁时正确断开,防止内存泄漏。这是实际开发中的标准模式。

import 'dart:async';
import 'dart:convert';
import 'package:stomp_dart_client/stomp_dart_client.dart';

// 模拟的 UI 状态类
class StockTickerState {
  StompClient? _client;
  final _streamController = StreamController<String>.broadcast();
  
  // 对外暴露的数据流
  Stream<String> get stockStream => _streamController.stream;

  // 1. 初始化连接
  void initState() {
    print('正在初始化 STOMP 服务...');
    _client = StompClient(
      config: StompConfig(
        url: 'wss://api.example.com/stocks', // wss 安全连接
        onConnect: _onConnect,
        beforeConnect: () async {
          print('准备连接...');
          await Future.delayed(const Duration(milliseconds: 200));
        },
        onDisconnect: (f) => print('已断开'),
        stompConnectHeaders: {'client-id': 'ohos-device-001'},
        webSocketConnectHeaders: {'upgrade': 'websocket'},
      ),
    );
    
    _client?.activate();
  }

  // 2. 连接成功后的回调
  void _onConnect(StompFrame frame) {
    print('STOMP Connected!');
    
    // 订阅具体股票代码
    _client?.subscribe(
      destination: '/topic/market/BTC-USD',
      callback: (frame) {
        if (frame.body != null) {
          final data = json.decode(frame.body!);
          final price = data['price'];
          // 推送到 Stream 更新 UI
          _streamController.add("BTC: \$$price");
        }
      },
    );
  }

  // 3. 资源销毁
  void dispose() {
    print('销毁服务,断开连接...');
    _client?.deactivate();
    _streamController.close();
  }
}

// 模拟 App 运行
void main() async {
  final state = StockTickerState();
  state.initState();

  // 模拟 UI 监听数据
  state.stockStream.listen((priceDisplay) {
    print('UI 更新 -> $priceDisplay');
  });

  // 模拟 5秒后用户退出页面
  await Future.delayed(Duration(seconds: 5));
  state.dispose();
}

五、总结

stomp_dart_client 是一个健壮性极高的库,它自带了自动重连心跳检测等生产环境必须的功能。
对于 OpenHarmony 开发者来说,使用由于 STOMP 协议的文本特性,它比二进制协议更易调试(可以直接看日志)。

如果你的鸿蒙应用需要接入现有的 Java/Spring 微服务体系,这个库是首选方案,它能让你用最低的成本复用现有的 WebSocket 后端架构。

在这里插入图片描述

Logo

作为“人工智能6S店”的官方数字引擎,为AI开发者与企业提供一个覆盖软硬件全栈、一站式门户。

更多推荐