likes
comments
collection
share

Node.js TypeScript#1. Modules, process参数, 文件系统基础

作者站长头像
站长
· 阅读数 29

这个系列是翻译文章，虽然是翻译，但有些地方还是做了一些修改。如果你想要看原版，那可以根据这个链接去查找。

在这个系列中，我们介绍了Node.js的核心概念。一般来说，在这个系列中，我们关注的是Node.js的环境，而不是JavaScript本身，同时使用TypeScript的静态类型优势。它涵盖了文件系统、事件循环和工作线程等方面。在本文中，我们创建了一个脚本，可以根据执行时传递的参数创建和读取文件。虽然我们在这里没有创建任何特定的Web应用程序，但我们学习了Node.js如何处理文件和服务器连接，这在许多情况下可能会有帮助。

Node基础

首先，让我们详细解释一下Node.js是什么，因为有时会被误解。简而言之，它是一个可以在浏览器外运行JavaScript的环境。现在在写前端项目时，大多都会用到node，因为他附带了Node Package Manager。你可以使用一个简单的命令来查询:

node -v

Modules

接下来让我们从一段比较奇特的代码开始来了解Node的模块是如何工作的

console.log('hello');
return;
console.log('world!');

这个例子可能看起来有点奇怪，因为ECMAScript规范规定如下：

如果一个ECMAScript程序包含不在FunctionBody内的return语句，则被视为语法错误。

当你运行它时，你会发现没有报错信息显示并且会输出hello。这是因为在Node.js中，每个文件都被视为一个独立的模块。在底层，Node.js将它们包装在一个类似这样的函数中：

function (exports, require, module, __filename, __dirname) {
  // code of the module
}

由于这个特性，顶层变量的作用域仅限于模块内部，而不是整个项目的全局作用域。可以使用模块对象来导出值：

utilities.js

function add (a, b) {
  return a + b;
}

function subtract (a, b) {
  return a - b;
}

module.exports = {
  add,
  subtract,
};

要想访问上面utilities.js中导出的模块，我们需要使用require函数; main.js

const { add, subtract } = require('./utilities.js');

console.log(add(1,2)); // 3
console.log(subtract(2,1)); // 1

这个模块系统是CommonJS 规范的实现

Node.js调用包装我们模块的函数的方式是，将this关键字引用到module.exports。我们只需要在utilities.js中加上这段，就可以很轻松的证明：

console.log(this === module.exports)

上述经常会导致混淆，因为如果在控制台中运行Node.js，this关键字会引用全局对象。

全局对象

作为一个JS开发者，你会比较熟悉浏览器中的window对象。在Nodejs中，我们有global对象。

当你在命令行运行Node或者是一个文件，Node不会将你的代码包装在一个module中。当在命令行中使用Node，你是在全局作用域(global scope)，this关键字指向global对象。然后，用var声明的变量被附加到global对象上,你可在终端中运行node，然后执行下面代码验证:

> this === global
// true
> var key = 'hello world';
> global.key
// 'hello world'

global对象在所有模块间共享。如果在这个对象中添加属性，它可以在所有地方访问

Process参数

process对象时global对象中的一个属性，因此你可以程序中的任何位置使用它。它非常有用，当我们需要收集有关 Node.js 应用程序环境的信息时，例如当前安装的 Node.js 版本。

在这个系列中将会深入讲解process对象，而今天我们专注于process.argv属性。该属性包含一个数组，其中包含启动Node.js进程时传递的命令行参数。

第一个元素与process.execPath相同，它保存了启动 Node.js 进程的可执行文件的绝对路径名。

第二个元素是被执行的 JavaScript 文件的路径，而其余的process.argv 元素则是任何其他的命令行参数。

main.js

process.argv.forEach(argument => console.log(argument));

执行main.js node ./main.js one two three

然后输出如下信息:

/Users/xxx/.nvm/versions/node/v14.19.1/bin/node
/Users/xxx/Documents/practice/Demos/node/main.js
one
two
three

运行一个Node.js的 Ts项目

首先需要pnpm初始化我们的项目，然后安装typescript和ts-node

pnpm init

pnpm i ts-node typescript @types/node -D

然后在package.json中添加一个新的脚本来运行ts-node

"scripts": {
  "start": "ts-node ./main.ts"
}

然后再在根目录添加一个tsconfig.json,内容如下:

{
  "compilerOptions": {
    "sourceMap": true,
    "target": "ESNext",
    "alwaysStrict": true,
    "noImplicitAny": true,
  },
  "exclude": [
    "node_modules"
  ]
}

现在，就可以在Node中使用Typescript了。

我们可以使用ES6的import/export代替module.exports/require了。因为我们使用了ts-node，它可以将我们的ts代码编译为CommonJS规范的代码

文件系统

fs模块为我们提供了和文件交互的API。所有的操作都支持同步和异步。但是，强烈建议使用异步函数来为我们的程序提供更高的性能。

异步函数总是把一个回调作为它的最后一个参数。让我们使用Typescript来创建我们的第一个脚本。

writeFile

import * as fs from 'fs';

fs.writeFile('./newFile.txt', 'hello-world', (error: any) => {
  if (error) {
    console.log(error);
    return
  }
  console.log('File created successfully');
});

要在TypeScript中使用文件系统模块，我们首先需要导入它。由于它是使用CommonJS规范的导出方式创建的，我们可以使用 import * as fs 来导入整个模块。

这个方法有三个参数

  1. 文件路径
  2. 要写入的输入，可以是string, buffer等。但是不能为null
  3. 回调函数

当然，相比较回调的写法，我们还可以使用async/await这种语法糖来更简洁的编写上面的代码

async function writeFile() {
  console.log(2)
  try {
    await fs.promises.writeFile('./newFile.txt', 'hello-world');
    console.log('File created successfully')
  } catch (err) {
    console.log(err)
  }
  console.log(3)
}
writeFile()
console.log(1)

在该示例中，使用fs.promises.writeFile()方法来写文件。该方法返回一个Promise对象，因此可以使用await关键字等待其执行完毕。await关键字会阻塞当前的异步函数,也就是我们自己定义的writeFile，但不会阻塞整个进程，因此不会对其他的操作产生影响。

这里的不阻塞整个进程我们可以通过输出来验证。这段代码的输出如下：

2
1
File created successfully
3

使用文字来描述就是:

  1. 这段脚本执行到了writeFile方法，输出2
  2. 发现了await关键词。阻塞当前异步函数writeFile,交出权限给主线程
  3. 主线程执行逻辑，执行完后发现还有未执行的异步函数
  4. 回到对应的异步函数，然后输出File created successfully
  5. 最后输出3

为了重新创建一些bash的功能，让我们使用 process.argv 传递额外的参数到我们的脚本中。我们从一个简单版本的touch脚本开始，它创建一个空文件：

main.ts

import touch from './utils/touch';

const command = process.argv[2];
const path = process.argv[3];
const content = process.argv[4] || '';

if (command && path) {
  switch (command) {
    case 'touch': {
      touch(path, content);
      break;
    }
    default: {
      console.log('Unknown command');
    }
  }
} else {
  console.log('Command missing');
}

utils/touch.ts

import * as fs from 'fs';

export default async function touch(path: string, content: string) {
  try {
    await fs.promises.writeFile(path, content);
    console.log('File created successfully')
  } catch(err) {
    console.log(err)
  }
}

然后，在运行的命令后加上命令行参数:

pnpm start touch ./file.txt haaaaa

然后，会创建一个file.txt文件，内容为haaaaa

readFile

我们实现的第二个函数为cat。他可以读取一个文件

utils/cat.ts

import * as fs from 'fs';

export default async function cat(path: string) {
  try {
    const content = await fs.promises.readFile(path, {encoding: 'utf-8'})
    console.log(content)
  } catch(err) {
    console.log(err);
  }
}

修改main.ts，添加一个case分支:

case 'cat': {
  cat(path);
  break;
}

然后运行

pnpm start cat ./file.txt

上面的命令读取的是./file.txt路径下的文件。readFile方法的第二个参数是一个带有额外选项的对象。我们用它来定义一个文件的编码。没有它，readFile函数的结果是一个Buffer。

文件系统可以做得更多，我们将在该系列的后续部分介绍流和文件描述符等功能。

总结

在这篇文章中，我们介绍了TypeScript Node.js的基础知识。其中包括模块的工作原理、全局对象是什么、文件系统的基础知识以及如何在运行Node.js TypeScript脚本时传递额外的参数

转载自:https://juejin.cn/post/7217100608776257597
评论
请登录