Node.js util.getSystemErrorName() 方法

2025 年 5 月 7 日 | 阅读 4 分钟

在本文中，我们将讨论 Node.js 中的 util.getSystemErrorName() 方法，包括其主要特性、语法、参数和示例。

Node.js util.getSystemErrorName() 方法是什么？

util.getSystemErrorName() 方法最早在 v9.7.0 版本中引入，是 Node.js 内置 util 模块的一部分。它将数字系统错误号转换为人类可读的错误名称。这种技术对于处理低级系统编程或与包含系统级错误的 Node.js API 交互的开发者来说可能特别有用。通过提供系统错误代码（例如 1、2、3），此方法会生成相应的错误名称，如 EPERM 或 ENOENT。

例如，它将 2 转换为 ENOENT。它对于跨平台的日志记录、调试和低级系统故障的控制特别有用。通过抽象化跨平台错误代码的差异，它确保了 Windows、Linux 和 macOS 之间的一致行为。该技术增强了代码的可读性和简化的错误处理，对于与系统级 API 交互的应用程序很有优势。其功能和易用性使其成为使用 Node.js 的开发者的重要工具。

主要特点

Node.js 中 util.getSystemErrorName() 方法的几个主要特性如下：

通过将数字错误代码转换为描述性错误标签，可以更轻松地处理错误。
跨平台兼容性： 确保在多种操作系统（例如 Windows、Linux、macOS）上性能一致。
可读性提高： 它有助于理解系统错误的报告和调试。

语法

它具有以下语法：

 
util.getSystemErrorName( err )
const { getSystemErrorName } = require('util');
const errorName = getSystemErrorName(errCode);   

参数

errCode： 我们希望以数字形式翻译的错误代码。

返回值： 系统错误名称以字符串形式返回。

关键点

特定于平台的错误代码： 操作系统可能对它们有不同的数值代码和名称。然而，util.getSystemErrorName() 抽象了这些差异。
在 Node.js 9.7.0 版本中引入： Node.js 的 9.7.0 及更高版本支持此技术。

一些系统错误

EACCES（权限被拒绝）： 当尝试访问权限被禁止的文件时，会返回此错误。
EADDRINUSE（地址已在使用中）： 当服务器（net、http 或 https）尝试绑定到本地地址时，由于本地安装系统上的另一个服务器已在使用该地址而失败。
ECONNRESET： ECONNRESET，也称为对端强制重置连接，发生在对端突然断开连接时，通常是由于重启或超时。
EISDIR（是目录）： 如果操作需要文件但返回了目录的路径名，则称为 EISDIR（是目录）。
ENOENT（无此文件或目录）： 当路径名的组件不存在时，fs 操作通常会引发 ENOENT（无此文件或目录）错误，表明提供的路径无法找到任何实体（文件或目录）。
ENOTDIR（不是目录）： ENOTDIR（不是目录）用于指示路径名的部分存在但不是目录。
ENOTEMPTY（目录非空）： ENOTEMPTY（目录非空）是预期目录非空的结果。

示例 1

让我们通过一个例子来演示 Node.js 的 util.getSystemErrorName() 函数。

 
// Import the getSystemErrorName method from the 'util' module
const { getSystemErrorName } = require('util');

// Example: Use valid negative system error codes
const errorCode1 = -2;
const errorCode2 = -13;

// Get the system error names
const errorName1 = getSystemErrorName(errorCode1);
const errorName2 = getSystemErrorName(errorCode2);

// Display the results
console.log(`Error Code: ${errorCode1} corresponds to ${errorName1}`);
// Output: Error Code: -2 corresponds to ENOENT (on most platforms)

console.log(`Error Code: ${errorCode2} corresponds to ${errorName2}`);
// Output: Error Code: -13 corresponds to EACCES (on most platforms)

// Example: Handling an unknown error code
const unknownErrorCode = -9999;
const unknownErrorName = getSystemErrorName(unknownErrorCode);
console.log(`Error Code: ${unknownErrorCode} corresponds to ${unknownErrorName}`);   

输出

 
Error Code: -2 corresponds to ENOENT
Error Code: -13 corresponds to EACCES
Error Code: -9999 corresponds to Unknown system error -9999

说明

导入方法： 使用 util 模块导入 getSystemErrorName 方法。
提供错误代码： 将数字系统错误代码作为参数提供，例如 -2 表示 ENOENT，-13 表示 EACCES。
输出： 显示关联的系统错误的名称。
特定于平台的行为： 操作系统可能产生略有不同的结果。

示例 2

让我们通过另一个例子来演示 Node.js 的 util.getSystemErrorName() 函数。

 
// Importing File System module
const fs = require('fs');

// Importing Utilities module
const { getSystemErrorName } = require('util');

// Reading the contents of a directory
fs.readdir('./example_folder', (error, fileList) => {
    if (error) {
        // Get the system error name
        const errorName = getSystemErrorName(error.errno);
        console.log(`System Error Name: ${errorName}`);
        console.log(`System Error Code: ${error.errno}`);
    } else {
        // Loop through and log the file names
        fileList.forEach((file, index) => {
            console.log(`File ${index + 1}: ${file}`);
        });
    }
});   

输出

 
System Error Name: ENOENT
System Error Code: -2

结论

总之，util.getSystemErrorName() 方法是改进 Node.js 中错误处理的强大工具，对于文件和目录管理等系统级任务特别有用。通过将错误代码转换为可读的错误名称，它使错误日志更容易阅读，并使调试更容易。该示例展示了如何将此技术集成到一个有用的文件系统函数中，该函数有助于识别和解决问题，例如丢失的目录或权限问题。对于希望构建能够成功处理多平台系统问题的可靠且可维护的 Node.js 应用程序的开发人员来说，此方法是一项至关重要的资源。

下一主题Nodejs-vm-runinnewcontext-method

Node.js util.getSystemErrorName() 方法