Flutter微服务集成插件micro_serve的使用

Micro Serve

micro_serve 包为 Flutter 设计，用于初始化一个高效管理请求和服务器端操作的 HTTP 服务器，使用的是原始 Dart 代码。

特性

• HTTP处理：

  • 管理传入的 HTTP 请求并发送响应。

• 路由：

  • 定义路由（GET、POST、PUT、DELETE、PATCH）并将其链接到请求处理器。

• 请求解析：

  • 读取和解析来自请求的查询参数、头部和正文。

• 响应处理：

  • 创建并发送带有状态码和内容的响应。

• 错误处理：

  • 优雅地管理错误并发送适当的错误响应。

开始使用

添加包到 pubspec.yaml 文件：

dependencies:
  micro_serve: <最新版本>

Android 配置

在 AndroidManifest.xml 中添加权限：

<manifest xmlns:android="..." >
  <uses-permission android:name="android.permission.INTERNET"/> <!-- 添加此行 -->
  <application....>
</manifest>

macOS 配置

允许网络访问在相关的 *.entitlements 文件中：

<key>com.apple.security.network.client</key>
<true/>

导入包

import 'package:micro_serve/micro_serve.dart';

初始化服务器

void main() {
  final MicroServe server = MicroServe();

  server.get("/test", (ServerContext serverContext) async {
    final Response response = Response(
      statusCode: 200,
      data: "Welcome Micro-Serve",
    );
    serverContext.send(response);
  });

  server.listen(ipAddress: "127.0.0.1", port: 3000);
}

使用示例

创建 MicroServe 对象

final MicroServe _server = MicroServe();

启动服务器函数

void _serverOn() async {
  // 定义路由
  _server.get("/", _welcome);
  _server.post("/create", _createTask);
  _server.get("/read", _readTasks);
  _server.put("/update", _updateTask);
  _server.delete("/delete", _deleteTask);

  // 获取 WiFi IP 地址
  final String? lanWifiIp = await Network.getIp(NetworkType.wlan);
  const int port = 3000;

  // 服务器启动
  _server.listen(
    ipAddress: lanWifiIp,
    port: port,
    callBack: (isServerInitiated) {
      if (isServerInitiated) {
        setState(() {});
      } else {
        // print("Something went wrong");
      }
    },
  );
}

关闭服务器函数

void _serverOff() async {
  await _server.close();
  setState(() {});
}

处理器函数

void _welcome(ServerContext serverContext) async {
  Response response = Response(
    statusCode: 200,
    data: {
      "message": "Server is Running...",
      "clientIp": serverContext.connectionInfo.address,
    },
  );
  serverContext.send(response);
}

void _createTask(ServerContext serverContext) async {
  final Request request = serverContext.request;
  final Task newTask = Task.fromJson(jsonDecode(request.body));

  Response response = Response();
  if (_taskStore.containsKey(newTask.id)) {
    response.statusCode = HttpStatus.conflict_409.code;
    response.data = {"message": "already exist"};
  } else {
    _taskStore[newTask.id] = newTask;
    final Map responseBody = {
      "message": "created successfully",
      "total": _taskStore.length,
    };
    response.statusCode = HttpStatus.created_201.code;
    response.data = responseBody;
  }

  serverContext.send(response);
}

void _readTasks(ServerContext serverContext) async {
  final List<Map> taskList = [];

  for (Task task in _taskStore.values) {
    taskList.add(task.toJson());
  }

  final Map data = {
    "message": "fetched successfully",
    "data": taskList,
  };
  Response response = Response(
    statusCode: HttpStatus.ok_200.code,
    data: data,
  );

  serverContext.send(response);
}

void _updateTask(ServerContext serverContext) async {
  final Request request = serverContext.request;

  final int id = int.parse(request.queryParams["id"]!);
  final String name = jsonDecode(request.body)["name"];
  final bool isDone = jsonDecode(request.body)["isDone"];
  final String? apiKey = request.headers["api-key"];

  final Response response = Response();

  if (apiKey != "abcd1234") {
    response.statusCode = HttpStatus.unauthorized_401.code;
    response.data = {"message": "invalid api key"};
  } else if (!_taskStore.containsKey(id)) {
    response.statusCode = HttpStatus.notFound_404.code;
    response.data = {"message": "not found"};
  } else {
    _taskStore[id]!.name = name;
    _taskStore[id]!.isDone = isDone;

    response.statusCode = HttpStatus.accepted_202.code;
    response.data = {"message": "updated successfully"};
  }

  serverContext.send(response);
}

void _deleteTask(ServerContext serverContext) async {
  final Request request = serverContext.request;
  final int taskId = int.parse(request.queryParams["id"]!);

  final Response response = Response();
  if (!_taskStore.containsKey(taskId)) {
    response.statusCode = HttpStatus.notFound_404.code;
    response.data = {"message": "not found"};
  } else {
    _taskStore.remove(taskId);

    final Map responseBody = {
      "message": "deleted successfully",
      "total": _taskStore.length,
    };
    response.statusCode = HttpStatus.accepted_202.code;
    response.data = responseBody;
  }

  serverContext.send(response);
}