Flutter Node.js互操作插件node_interop的使用

简介

node_interop 是一个允许你在Dart中编写应用程序并在NodeJS环境中运行的库。它提供了与核心Node API和内置模块交互的JavaScript绑定和一些实用工具。

关键链接

• build_node_compilers：将Dart应用程序编译为Node模块。
• node_io：提供类似Dart的Node I/O系统体验。
• node_http：提供Dart风格的HTTP客户端。

使用示例

示例1：简单的Hello World应用

import 'package:node_interop/node.dart';

void main() {
  print("Hello world, I'm currently in ${process.cwd()}.");
}

这个应用可以通过build_node_compilers编译并在Node环境中执行。

示例2：读取当前工作目录并打印JSON格式内容

// Copyright (c) 2018, Anatoly Pulyaevskiy. All rights reserved. Use of this source code
// is governed by a BSD-style license that can be found in the LICENSE file.

import 'dart:convert';
import 'package:node_interop/fs.dart';
import 'package:node_interop/node.dart';

/// Simple example of reading contents of current working directory and
/// printing out as nicely indented JSON.
void main() {
  final contents = List<String>.from(fs.readdirSync(process.cwd()));
  final json = JsonEncoder.withIndent('  ');
  print(json.convert(contents));
}

示例3：创建自定义可写流

import 'dart:js_util'; // provides callConstructor()
import 'package:node_interop/stream.dart';

Writable createWritable(WritableOptions options) {
  return callConstructor(stream.Writable, [options]);
}

void main() {
  var writable = createWritable({'objectMode': true});
  writable.on('finish', () => print('All writes are now complete.'));
  writable.write('some data');
  writable.end();
}

库结构

每个内置的Node模块在lib/文件夹中都有一个对应的Dart文件。例如，要访问Node的os模块，可以使用以下导入：

import 'package:node_interop/os.dart';

导入后不需要再通过require来引入模块。每个库文件（如os.dart）暴露了一个同名的库级属性，可以直接使用该模块的功能。

对于带有下划线的库（如child_process），库级属性会将下划线转换为驼峰命名法以符合Dart代码风格规则：

import 'package:node_interop/child_process.dart';

void main() {
  childProcess.execSync('ls -la');
}

注意事项

由于大多数Node.js对象不是全局对象，因此它们在库中被声明为@anonymous，这使得无法直接使用new Something()来实例化新对象。作为替代方案，每个模块提供了一个createX()库函数来创建自定义对象。

例如，stream模块提供了createReadable和createWritable来创建自定义的Readable和Writable流：

import 'dart:js_util'; // provides callConstructor()

/// The "stream" module's object as returned from [require] call.
StreamModule get stream => _stream ??= require('stream');
StreamModule _stream;

@JS()
@anonymous
abstract class StreamModule {
  /// Reference to constructor function of [Writable].
  dynamic get Writable;

  /// Reference to constructor function of [Readable].
  dynamic get Readable;
}

/// Creates custom [Writable] stream with provided [options].
///
/// This is the same as `callConstructor(stream.Writable, [options]);`.
Writable createWritable(WritableOptions options) {
  return callConstructor(stream.Writable, [options]);
}

状态

版本1.0.0被认为是稳定的，但尚未完全实现所有功能。建议检查1.0.0-dev.*版本以获取最新的更新和bug修复。每次发布后，请查看CHANGELOG.md以了解所有重要的更改和升级说明。

支持的Node.js模块

以下是已经提供绑定的内置Node.js模块列表：

• ✅ buffer
• ✅ child_process
• ❌ cluster
• ✅ console
• ✅ dns
• ❌ domain
• ✅ events
• ✅ fs
• ✅ http
• ✅ https
• ✅ module
• ✅ net
• ✅ os
• ✅ path
• ✅ process
• ✅ querystring
• ❌ readline
• ✅ stream
• ❌ string_decoder
• ✅ timers
• ✅ tls
• ❌ tty
• ❌ dgram
• ❌ url
• ❌ util
• ❌ v8
• ❌ vm
• ❌ zlib

如果发现任何问题或有新的需求，请在issue tracker中提交。

希望这些信息能帮助你更好地理解和使用node_interop插件！