Flutter Tizen平台消息通信插件messageport_tizen的使用

messageport_tizen

此插件为Tizen平台上Flutter应用之间的通信提供了支持。

使用方法

首先，在Dart文件中导入该包：

import 'package:messageport_tizen/messageport_tizen.dart';

创建本地端口

使用LocalPort.create()方法创建一个本地端口。

String portName = 'servicePort';
LocalPort localPort = await LocalPort.create(portName);

当消息到达本地端口时，可以注册回调函数以处理接收到的消息：

void onMessage(Object message, [RemotePort remotePort]) {
  // 处理接收到的消息。
}
...
localPort.register(onMessage);

当不再需要时，使用LocalPort.unregister()取消注册端口：

localPort.unregister();

连接到远程端口

要连接到远程应用程序中已注册的端口，使用RemotePort.connect()方法：

String portName = 'servicePort';
String remoteAppId = 'remote.app.id';
RemotePort remotePort = await RemotePort.connect(remoteAppId, portName);

发送消息

向远程应用程序发送消息，使用RemotePort.send()方法：

final message = {'a': 1, 'b': 2, 'c': 3};
await remotePort.send(message);

使用本地端口发送消息

在发送消息时包含本地端口信息，使用RemotePort.sendWithLocalPort()方法。远程应用程序接收到的本地端口可用于发送响应：

final message = 'This is a string message';
await remotePort.sendWithLocalPort(message, localPort);

支持的数据类型

该插件使用Flutter的StandardMessageCodec将传输的数据编码为二进制。支持的数据类型包括：

• null
• bool
• int, double
• String
• Uint8List, Int32List, Int64List, Float64List
• 上述类型的列表和映射

如需了解有关Tizen消息端口API的更多信息，请访问Tizen文档：消息端口。

完整示例代码

以下是一个完整的示例代码，展示了如何使用messageport_tizen插件实现Flutter Tizen平台上的消息通信。

示例代码：main.dart

// Copyright 2021 Samsung Electronics Co., Ltd. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// ignore_for_file: public_member_api_docs

import 'package:flutter/material.dart';

import 'package:messageport_tizen/messageport_tizen.dart';

const String kPortName = 'servicePort';
const String kRemoteAppId = 'org.tizen.messageport_tizen_example';

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

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

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

class _MyAppState extends State<MyApp> {
  LocalPort? _localPort;
  RemotePort? _remotePort;
  int _responseCount = 0;

  void onMessage(dynamic message, [RemotePort? remotePort]) {
    _log('Message received: $message');

    if (remotePort != null) {
      _responseCount++;
      remotePort.send('Response: $_responseCount');
    }
  }

  Widget _textButton(String text, void Function() onPressed, bool enabled) {
    return Container(
      margin: const EdgeInsets.all(5),
      child: ElevatedButton(
        onPressed: enabled ? onPressed : null,
        child: Text(text),
      ),
    );
  }

  Widget _localPortRegisterButtons() {
    return Row(
      mainAxisAlignment: MainAxisAlignment.spaceEvenly,
      children: <Widget>[
        _textButton(
          'Register',
          () async {
            try {
              _localPort?.register(onMessage);
              _log('Local port registration done');
              setState(() {});
            } catch (error) {
              _log(error.toString());
            }
          },
          _localPort != null && !_localPort!.registered,
        ),
        _textButton(
          'Unregister',
          () async {
            try {
              _localPort?.unregister();
              _log('Local port unregistration done');
              setState(() {});
            } catch (error) {
              _log(error.toString());
            }
          },
          _localPort?.registered ?? false,
        ),
      ],
    );
  }

  Widget _remotePortButtons() {
    return Row(
      mainAxisAlignment: MainAxisAlignment.spaceEvenly,
      children: <Widget>[
        _textButton(
          'Connect to remote',
          () async {
            try {
              _remotePort = await RemotePort.connect(kRemoteAppId, kPortName);
              _log('Connected to remote port');
              setState(() {});
            } catch (error) {
              _log(error.toString());
            }
          },
          (_localPort?.registered ?? false) && _remotePort == null,
        ),
        _textButton(
          'Check remote',
          () async {
            try {
              final bool status = await _remotePort!.check();
              _log('Remote port status: ${status ? 'open' : 'closed'}');
              setState(() {});
            } catch (error) {
              _log(error.toString());
            }
          },
          _remotePort != null,
        ),
      ],
    );
  }

  final Map<String, Object> _sendOptions = <String, Object>{
    'bool': true,
    'int': 134,
    'double': 157.986,
    'String': 'Test message',
    'List': <int>[1, 2, 3],
    'Map': <String, int>{'a': 1, 'b': 2, 'c': 3}
  };
  bool _attachLocalPort = false;

  Widget _sendButtons() {
    return Column(
      children: <Widget>[
        Row(
          children: <Widget>[
            Checkbox(
              value: _attachLocalPort,
              onChanged: (bool? value) {
                setState(() {
                  _attachLocalPort = value ?? false;
                });
              },
            ),
            const Text('Attach local port'),
          ],
        ),
        GridView.builder(
          shrinkWrap: true,
          gridDelegate: const SliverGridDelegateWithFixedCrossAxisCount(
            crossAxisCount: 3,
            mainAxisExtent: 40,
          ),
          itemCount: _sendOptions.length,
          itemBuilder: (BuildContext context, int index) {
            final String key = _sendOptions.keys.elementAt(index);
            return _textButton(
              key,
              () async {
                try {
                  final Object value = _sendOptions[key]!;
                  if (_attachLocalPort) {
                    await _remotePort?.sendWithLocalPort(value, _localPort!);
                  } else {
                    await _remotePort?.send(value);
                  }
                } catch (error) {
                  _log(error.toString());
                }
              },
              _remotePort != null && (_localPort?.registered ?? false),
            );
          },
        ),
      ],
    );
  }

  final List<String> _logs = <String>[];

  void _log(String log) {
    final String date = '${DateTime.now().hour.toString().padLeft(2, '0')}:'
        '${DateTime.now().minute.toString().padLeft(2, '0')}:'
        '${DateTime.now().second.toString().padLeft(2, '0')}.'
        '${DateTime.now().millisecond.toString().padLeft(3, '0')}';
    setState(() {
      _logs.add('$date: $log');
    });
    debugPrint('$date: $log');
  }

  Widget _logger(BuildContext context) {
    return Expanded(
      child: Container(
        padding: const EdgeInsets.all(5),
        child: GestureDetector(
          onTap: () {
            setState(() {
              _logs.clear();
            });
          },
          child: ListView.builder(
            itemCount: _logs.length,
            itemBuilder: (BuildContext context, int index) {
              return Text(
                _logs[index],
                style: const TextStyle(fontSize: 10),
              );
            },
          ),
        ),
      ),
    );
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Tizen MessagePort Example'),
        ),
        body: Column(children: <Widget>[
          _textButton(
            'Create local port',
            () async {
              _localPort = await LocalPort.create(kPortName);
              setState(() {});
            },
            _localPort == null,
          ),
          _localPortRegisterButtons(),
          _remotePortButtons(),
          _sendButtons(),
          _logger(context),
        ]),
      ),
    );
  }

  [@override](/user/override)
  void dispose() {
    super.dispose();
    _localPort?.unregister();
  }
}