Node.js实用的内置API(二)

本文涉及的产品
云解析 DNS,旗舰版 1个月
全局流量管理 GTM,标准版 1个月
公共DNS(含HTTPDNS解析),每月1000万次HTTP解析
简介: 在构建 Node.js 应用程序时,了解 Node.js 开箱即用的实用程序和 API 有助于满足常见用例和开发需求。在文中《Node.js实用的内置API(一)》介绍了两个,本文继续介绍其他实用内置API。

在构建 Node.js 应用程序时,了解 Node.js 开箱即用的实用程序和 API 有助于满足常见用例和开发需求。在文中《Node.js实用的内置API(一)》介绍了两个,本文继续介绍其他实用内置API。

  • util:提供了各种有用的 JavaScript 方法,其中最有用的是 util.promisify(function),它采用错误优先的回调样式函数并返回基于 Promise 的函数。
  • URL:另一个全局对象,安全地创建、解析和修改 Web URL。它对于从 URL 中快速提取协议、端口、参数和 hash 非常有用,而无需借助正则表达式。
  • 文件系统:可以创建、读取、更新和删除文件、目录和权限。

Util

util 模块提供了各种有用的 JavaScript 方法,其中最有用的是 util.promisify(function),它采用错误优先的回调样式函数并返回基于 Promise 的函数。Util 模块还可以帮助处理常见模式,例如解码文本、类型检查和检查对象。

  • util.callbackify(function):接受一个返回承诺的函数并返回一个基于回调的函数。
  • util.isDeepStrictEqual(object1, object2):当两个对象之间存在深度相等时返回 true(所有子属性必须匹配)。
  • util.format(format, [args]):使用类似 printf-like-format 返回一个字符串
  • util.inspect(object, options):返回用于调试的对象的字符串表示形式,类似于使用 console.dir(object, { depth: null, color: true });
  • util.stripVTControlCharacters(str):从字符串中去除 ANSI 转义符
  • util.types:为常见的 JavaScript 和 Node.js 值提供类型检查,如下:
import util from "util";
util.types.isDate(new Date()); // true
util.types.isMap(new Map()); // true
util.types.isRegExp(/abc/); // true
util.types.isAsyncFunction(async () => {}); // true

URL

URL 是另一个全局对象,安全地创建、解析和修改 Web URL。它对于从 URL 中快速提取协议、端口、参数和 hash 非常有用,而无需借助正则表达式。如下:

{
    href: "https: //example.org:8000/path/?abc=123#target",
    origin: "https: //example.org:8000",
    protocol: "https:",
    username: "",
    password: "",
    host: "example.org: 8000",
    hostname: "example.org",
    port: "8000",
    pathname: "/path/",
    search: "?abc=123",
    hash: "#target",
}

可以查看和更改任何属性,如下:

const myUrl = "https://example.org:8001/path/?abc=123#target";
myURL.port = 8001;
console.log(myURL.href); // https://example.org:8001/path/?abc=123#target

然后,可以使用 URLSearchParamsAPI 修改查询字符串值,如下:

myURL.searchParams.delete("abc");
myURL.searchParams.append("xyz", 987);
console.log(myURL.search); // ?xyz=987

dns 模块提供名称解析功能,可以查找 IP 地址、名称服务器、TXT 记录和其他域信息。

文件系统 API

文件系统 APIfs 可以创建、读取、更新和删除文件、目录和权限。 Node.js 运行时的最新版本在 fs/promises 中提供了基于 Promise 的函数,这使得管理异步文件操作变得更加容易。

经常将 fspath 结合使用来解析不同操作系统上的文件名。

以下代码模块使用 stataccess 方法返回有关文件系统对象的信息:

import { constants as fsConstants } from "fs";
import { access, stat } from "fs/promises";
export async function getFileInfo(file) {
    const fileInfo = {};
    try {
        const info = await stat(file);
        fileInfo.isFile = info.isFile();
        fileInfo.isDir = info.isDirectory();
    } catch (e) {
        return { new: true };
    }
    try {
        await access(file, fsConstants.R_OK);
        fileInfo.canRead = true;
    } catch (e) {}
    try {
        await access(file, fsConstants.W_OK);
        fileInfo.canWrite = true;
    } catch (e) {}
    return fileInfo;
}

当传递一个文件名时,该函数返回一个包含该文件信息的对象,如下:

{
  isFile: true,
  isDir: false,
  canRead: true,
  canWrite: true
}

主程序 filecompress.js 脚本使用 path.resolve() 将命令行上传递的输入和输出文件名解析为绝对文件路径,然后使用 getFileInfo() 获取信息:

#!/usr/bin/env node
import path from "path";
import { readFile, writeFile } from "fs/promises";
import { getFileInfo } from "./lib/fileinfo.js";
// check files
const input = path.resolve(process.argv[2] || "");
const output = path.resolve(process.argv[3] || "");
const [inputInfo, outputInfo] = await Promise.all([
    getFileInfo(input),
    getFileInfo(output),
]);
const error = [];

该代码验证路径并在必要时以错误消息终止:

if (outputInfo.isDir && outputInfo.canWrite && inputInfo.isFile) {
    output = path.resolve(output, path.basename(input));
}
if (!inputInfo.isFile || !inputInfo.canRead)
    error.push(`cannot read input file ${input}`);
if (input === output) error.push("input and output files cannot be the same");
if (error.length) {
    console.log("Usage: ./filecompress.js [input file] [output file|dir]");
    console.error("\n  " + error.join("\n  "));
    process.exit(1);
}

使用 readFile() 将整个文件读入名为 content 的字符串:

console.log(`processing ${input}`);
let content;
try {
    content = await readFile(input, { encoding: "utf8" });
} catch (e) {
    console.log(e);
    process.exit(1);
}
const lengthOrig = content.length;
console.log(`file size  ${lengthOrig}`);

JavaScript 正则表达式然后删除注释和空格:

content = content
    .replace(/\n\s+/g, "\n") // 移除行前置空格
    .replace(/\/\/.*?\n/g, "") // 移除单行注释
    .replace(/\s+/g, " ") // 移除空格
    .replace(/\/\*.*?\*\//g, "") // 移除块注释 /* 注释 */
    .replace(/<!--.*?-->/g, "") // 移除HTML注释 <!-- 注释 -->
    .replace(/\s*([<>(){}}[\]])\s*/g, "$1") // 移除括号周围的空格
    .trim();
const lengthNew = content.length;

使用 writeFile() 将生成的字符串输出到文件中,并且状态消息会显示保存:

const lengthNew = content.length;
// write file
console.log(`outputting ${output}`);
console.log(
    `file size  ${lengthNew} - saved ${Math.round(
        ((lengthOrig - lengthNew) / lengthOrig) * 100
    )}%`
);
try {
    content = await writeFile(output, content);
} catch (e) {
    console.log(e);
    process.exit(1);
}

使用示例 HTML 文件运行项目代码:

node filecompress.js ./test/example.html ./test/output.html


相关文章
|
2天前
|
JSON JavaScript API
深入浅出Node.js:从零开始构建RESTful API
【10月更文挑战第39天】 在数字化时代的浪潮中,API(应用程序编程接口)已成为连接不同软件应用的桥梁。本文将带领读者从零基础出发,逐步深入Node.js的世界,最终实现一个功能完备的RESTful API。通过实践,我们将探索如何利用Node.js的异步特性和强大的生态系统来构建高效、可扩展的服务。准备好迎接代码和概念的碰撞,一起解锁后端开发的新篇章。
|
12天前
|
JavaScript 中间件 API
Node.js进阶:Koa框架下的RESTful API设计与实现
【10月更文挑战第28天】本文介绍了如何在Koa框架下设计与实现RESTful API。首先概述了Koa框架的特点,接着讲解了RESTful API的设计原则,包括无状态和统一接口。最后,通过一个简单的博客系统示例,详细展示了如何使用Koa和koa-router实现常见的CRUD操作,包括获取、创建、更新和删除文章。
34 4
|
5天前
|
JavaScript 前端开发 NoSQL
深入浅出:使用Node.js构建RESTful API
【10月更文挑战第35天】在数字时代的浪潮中,后端技术如同海洋中稳固的灯塔,为前端应用提供数据和逻辑支撑。本文旨在通过浅显易懂的方式,带领读者了解如何利用Node.js这一强大的后端平台,搭建一个高效、可靠的RESTful API。我们将从基础概念入手,逐步深入到代码实践,最终实现一个简单的API示例。这不仅是对技术的探索,也是对知识传递方式的一次创新尝试。让我们一起启航,探索Node.js的奥秘,解锁后端开发的无限可能。
|
28天前
|
JSON JavaScript 前端开发
使用JavaScript和Node.js构建简单的RESTful API服务器
【10月更文挑战第12天】使用JavaScript和Node.js构建简单的RESTful API服务器
16 0
|
1月前
|
JSON JavaScript API
Node.js RESTful API
10月更文挑战第8天
13 0
|
4月前
|
JavaScript Java 测试技术
基于springboot+vue.js+uniapp的客户关系管理系统附带文章源码部署视频讲解等
基于springboot+vue.js+uniapp的客户关系管理系统附带文章源码部署视频讲解等
95 2
|
4月前
|
JavaScript Java 测试技术
基于springboot+vue.js+uniapp的小区物流配送系统附带文章源码部署视频讲解等
基于springboot+vue.js+uniapp的小区物流配送系统附带文章源码部署视频讲解等
118 4
|
4月前
|
JavaScript Java 测试技术
基于springboot+vue.js+uniapp的宠物援助平台附带文章源码部署视频讲解等
基于springboot+vue.js+uniapp的宠物援助平台附带文章源码部署视频讲解等
81 4