Flutter数据通信插件flutter_channel_json的使用

flutter_channel_json是一个用于标准化 Flutter 方法通道数据传输格式的插件，通常与 fluent_channel_event_bus`一起使用。

添加依赖

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

dependencies:
  flutter_channel_json: ^版本号

然后执行以下命令以安装依赖：

flutter pub get

如何使用它？

Dart

首先，在 Dart 文件中导入插件：

import 'package:flutter_channel_json/flutter_channel_json.dart';

默认初始化

const json = FlutterChannelJson(
  code: 300,
  message: 'message',
  success: false,
  data: 2,
);

根据字典初始化

final json = FlutterChannelJson.fromJson({
  'code': 300,
  'message': 'message',
  'data': 2,
  'success': false,
});

基于 JSON 字符串初始化

final json = FlutterChannelJson.fromJsonString(
  '{"code": 300, "message": "message", "data": 2, "success": false}',
);

将对象转换为字典

final json = const FlutterChannelJson(
  code: 300,
  message: 'message',
  success: false,
  data: 2,
).toJson();

将对象转换为字符串

final json = const FlutterChannelJson(
  code: 300,
  message: 'message',
  success: false,
  data: 2,
).toJsonString();

初始化成功类型

final json = FlutterChannelJson.success(2);

初始化失败类型

final json = FlutterChannelJson.failure('message');

Swift

默认初始化

let json = FlutterChannelJson(code: 300,
                              message: "message",
                              data: 2,
                              success: false)

初始化成功类型

let json = FlutterChannelJson(success: 2)

初始化失败类型

let json = FlutterChannelJson(failure: "message", code: 300)

根据字典初始化

let json = FlutterChannelJson<Int>(json: ["code": 300,
                                          "message": "message",
                                          "data": 2,
                                          "success": false])

基于 JSON 字符串初始化

let json = try? FlutterChannelJson<Int>(jsonString: "{\"code\":300,\"message\":\"message\",\"data\":2,\"success\":false}")

对象转 JSON 字符串

let json = FlutterChannelJson(code: 300,
                              message: "message",
                              data: 2,
                              success: false)
let jsonString = json.toJsonString()

对象转字典

let json = FlutterChannelJson(code: 300,
                              message: "message",
                              data: 2,
                              success: false)
let jsonMap = json.toJson()

Kotlin

默认初始化

val json = FlutterChannelJson(code = 300, message = "message", data = 2, success = false)

初始化成功类型

val json = FlutterChannelJson(data = 2)

初始化失败类型

val json = FlutterChannelJson<Int>(message = "message")

基于 JSON 字符串初始化

val json = FlutterChannelJson(jsonString = "{\"code\":300,\"message\":\"message\",\"data\":2,\"success\":false}", Int::class.java)

根据字典初始化

val map: Map<String, Any> = mapOf("code" to 300, "message" to "message", "data" to 2, "success" to false)
val json = FlutterChannelJson<Int>(json = map)

对象转 JSON 字符串

val json = FlutterChannelJson(code = 300, message = "message", data = 2, success = false).toJsonString()

对象转字典

val json = FlutterChannelJson(code = 300, message = "message", data = 2, success = false)
val map = json.toJson()

完整示例 Demo

以下是一个完整的 Flutter 示例代码，展示如何使用 flutter_channel_json 插件进行数据通信。

示例代码

// main.dart
import 'package:flutter/material.dart';
import 'package:flutter_channel_json/flutter_channel_json.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('flutter_channel_json 示例')),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              ElevatedButton(
                onPressed: () {
                  // 初始化 JSON 数据
                  final json = FlutterChannelJson.success(2);
                  print('Success JSON: $json');

                  // 转换为字典
                  final jsonData = json.toJson();
                  print('JSON to Map: $jsonData');

                  // 转换为字符串
                  final jsonString = json.toJsonString();
                  print('JSON to String: $jsonString');
                },
                child: Text('发送成功数据'),
              ),
              SizedBox(height: 20),
              ElevatedButton(
                onPressed: () {
                  // 初始化 JSON 数据
                  final json = FlutterChannelJson.failure('请求失败');
                  print('Failure JSON: $json');

                  // 转换为字典
                  final jsonData = json.toJson();
                  print('JSON to Map: $jsonData');

                  // 转换为字符串
                  final jsonString = json.toJsonString();
                  print('JSON to String: $jsonString');
                },
                child: Text('发送失败数据'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}

运行效果

运行上述代码后，点击按钮将分别打印成功和失败的 JSON 数据，并将其转换为字典和字符串。以下是控制台输出示例：

Success JSON: FlutterChannelJson(success: true, code: null, message: null, data: 2)
JSON to Map: {success: true, data: 2}
JSON to String: {"success":true,"data":2}

Failure JSON: FlutterChannelJson(success: false, code: 300, message: 请求失败, data: null)
JSON to Map: {success: false, code: 300, message: 请求失败}
JSON to String: {"success":false,"code":300,"message":"请求失败"}