Flutter原生API访问插件raw_api_server的使用

Flutter原生API访问插件raw_api_server的使用

raw_api_server 是一个用于构建基于Socket的简单API的Dart包。

特性

  • 声明式
  • 轻量级
  • 可扩展
  • 通过请求中的某些 uint8 确定操作(默认为4字节)

开始使用

首先在你的 pubspec.yaml 文件中添加 raw_api_server 包:

dependencies:
  raw_api_server: ^x.x.x

然后运行以下命令以安装包:

dart pub get

使用方法

服务器端

最基本的服务端实现如下所示:

import 'dart:io';
import 'package:raw_api_server/raw_api_server.dart';

// 定义我们的API服务器实例
final server = RawApiServer(
  port: 6543,
  onConnect: (socket) => stdout.writeln('Connected: ${socket.remoteAddress.address}'),
  onDisconnect: (socket) => stdout.writeln('Disconnected: ${socket.remoteAddress.address}'),
  endpoints: [
    ApiEndpoint(
      id: 0,
      handler: (socket, data) {
        // 将数据从Uint8List转换为字符串
        final message = String.fromCharCodes(data);
        // 回复客户端
        socket.write('你发送的消息是:$message');
      },
    ),
  ],
);

void main() async {
  // 启动服务器
  await server.start();
}

上述代码中的 endpoints 参数期望一个类型为 ApiEndpoint 的列表。每个端点包含一个 id 以标识我们期望的操作,并且有一个处理请求的函数。

注意: 端点的 id 必须是唯一的。

客户端

存在一个基本的Socket包装器,可以与 raw_api_server 进行一些简单的Dart兼容性处理。

import 'dart:io';
import 'package:raw_api_server/raw_api_server.dart';

// 定义客户端实例
final client = RawApiClient(
  port: 6543,
  host: 'localhost',
  onConnect: (socket) => stdout.writeln('Client connected to ${socket.remoteAddress.address}'),
  onReceive: (socket, data) {
    // 将接收到的数据从Uint8List转换为字符串
    stdout.writeln('Client received: ${String.fromCharCodes(data)}');
  },
  onDisconnect: (socket) => stdout.writeln('Client disconnected from server'),
);

void main() async {
  // 连接到服务器
  await client.connect();

  // 发送请求
  client.sendRequest(ApiRequest.fromUtf8(id: 0, data: 'Hello world'));

  // 给服务器足够的时间来响应
  await Future<void>.delayed(const Duration(seconds: 1));

  // 断开连接
  client.disconnect();
}

以上代码展示了如何创建一个客户端并连接到服务器,发送请求并接收响应。

完整示例

以下是完整的示例代码,它展示了如何同时启动服务器和连接客户端。

import 'dart:io';
import 'package:raw_api_server/raw_api_server.dart';

// 定义我们的API服务器实例
final server = RawApiServer(
  port: 6543,
  onConnect: (socket) => stdout.writeln('Connected: ${socket.remoteAddress.address}'),
  onDisconnect: (socket) => stdout.writeln('Disconnected: ${socket.remoteAddress.address}'),
  endpoints: [
    ApiEndpoint(
      id: 0,
      handler: (socket, data) {
        // 将数据从Uint8List转换为字符串
        final message = String.fromCharCodes(data);
        // 回复客户端
        socket.write('你发送的消息是:$message');
      },
    ),
  ],
);

// 定义客户端实例
final client = RawApiClient(
  port: 6543,
  host: 'localhost',
  onConnect: (socket) => stdout.writeln('Client connected to ${socket.remoteAddress.address}'),
  onReceive: (socket, data) {
    // 将接收到的数据从Uint8List转换为字符串
    stdout.writeln('Client received: ${String.fromCharCodes(data)}');
  },
  onDisconnect: (socket) => stdout.writeln('Client disconnected from server'),
);

void main() async {
  // 启动服务器
  await server.start();

  // 连接到服务器
  await client.connect();

  // 发送请求
  client.sendRequest(ApiRequest.fromUtf8(id: 0, data: 'Hello world'));

  // 给服务器足够的时间来响应
  await Future<void>.delayed(const Duration(seconds: 1));

  // 断开连接
  client.disconnect();

  // 停止服务器
  await server.stop();
}

更多关于Flutter原生API访问插件raw_api_server的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter原生API访问插件raw_api_server的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


raw_api_server 是一个用于在 Flutter 中直接访问原生 API 的插件。它允许你通过 Dart 代码直接调用 Android 和 iOS 的原生 API,而不需要编写平台特定的代码(如 Kotlin/Java 或 Swift/Objective-C)。这对于需要直接访问某些原生功能但又不想编写大量平台代码的开发者来说非常有用。

安装 raw_api_server 插件

首先,你需要在 pubspec.yaml 文件中添加 raw_api_server 插件的依赖:

dependencies:
  flutter:
    sdk: flutter
  raw_api_server: ^0.0.1  # 请检查最新版本

然后运行 flutter pub get 来安装插件。

使用 raw_api_server 插件

raw_api_server 插件的主要功能是通过 RawApiServer 类来访问原生 API。你可以使用它来调用 Android 和 iOS 的原生方法。

1. 初始化 RawApiServer

在使用 RawApiServer 之前,你需要初始化它。通常,你可以在 main.dart 文件中进行初始化:

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

void main() {
  RawApiServer.initialize();
  runApp(MyApp());
}

2. 调用原生 API

你可以使用 RawApiServer 来调用原生 API。以下是一个简单的示例,展示了如何调用原生的 Toast 功能(Android 平台):

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Raw API Server Example'),
        ),
        body: Center(
          child: ElevatedButton(
            onPressed: () async {
              // 调用原生 API 显示 Toast
              await RawApiServer.invokeMethod('showToast', {'message': 'Hello from Flutter!'});
            },
            child: Text('Show Toast'),
          ),
        ),
      ),
    );
  }
}

3. 在原生端实现方法

为了在 Android 端实现 showToast 方法,你需要在 MainActivity.kt 中添加以下代码:

import io.flutter.embedding.android.FlutterActivity
import io.flutter.embedding.engine.FlutterEngine
import io.flutter.plugin.common.MethodChannel
import android.widget.Toast

class MainActivity: FlutterActivity() {
    private val CHANNEL = "raw_api_server"

    override fun configureFlutterEngine(flutterEngine: FlutterEngine) {
        super.configureFlutterEngine(flutterEngine)
        MethodChannel(flutterEngine.dartExecutor.binaryMessenger, CHANNEL).setMethodCallHandler { call, result ->
            when (call.method) {
                "showToast" -> {
                    val message = call.argument<String>("message")
                    Toast.makeText(this, message, Toast.LENGTH_SHORT).show()
                    result.success(null)
                }
                else -> {
                    result.notImplemented()
                }
            }
        }
    }
}

在 iOS 端,你需要在 AppDelegate.swift 中添加以下代码:

import UIKit
import Flutter

[@UIApplicationMain](/user/UIApplicationMain)
[@objc](/user/objc) class AppDelegate: FlutterAppDelegate {
    override func application(
        _ application: UIApplication,
        didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
    ) -> Bool {
        let controller : FlutterViewController = window?.rootViewController as! FlutterViewController
        let channel = FlutterMethodChannel(name: "raw_api_server",
                                              binaryMessenger: controller.binaryMessenger)
        channel.setMethodCallHandler({
            (call: FlutterMethodCall, result: @escaping FlutterResult) -> Void in
            if call.method == "showToast" {
                if let message = call.arguments as? String {
                    let alert = UIAlertController(title: nil, message: message, preferredStyle: .alert)
                    self.window?.rootViewController?.present(alert, animated: true, completion: nil)
                    DispatchQueue.main.asyncAfter(deadline: .now() + 2) {
                        alert.dismiss(animated: true, completion: nil)
                    }
                    result(nil)
                }
            } else {
                result(FlutterMethodNotImplemented)
            }
        })

        GeneratedPluginRegistrant.register(with: self)
        return super.application(application, didFinishLaunchingWithOptions: launchOptions)
    }
}
回到顶部