CommonJS模块独立导出的正确方法及模块引用问题解决

一、正确引用当前导出的模块 #

你现在的lib/index.js是以文件名作为键导出模块的，require('./lib')返回的是一个包含client和my-error属性的对象，直接用new Client()会报错，是因为Client既没有挂载到全局作用域，也没有从导出对象中解构出来。

正确的引用方式有两种：

1. 赋值后通过对象属性访问

const myLib = require('./lib');

try {
    const client = new myLib.client();
    // 后续逻辑
} catch (err) {
    // 错误处理
}

2. 使用解构赋值直接获取类（更直观，推荐）

const { client: Client } = require('./lib');

try {
    const client = new Client();
    // 后续逻辑
} catch (err) {
    // 错误处理
}

这里用client: Client是把导出的client属性重命名为Client，和类名保持一致，避免混淆。

二、更优的实现方案 #

你当前用fs.readdirSync自动遍历导出的方式虽然省事，但存在不少问题：导出键名和类名不一致、可能意外引入无关JS文件、代码可读性和可维护性差，对于npm包来说，明确的导出API更有利于用户使用。

推荐手动导出方案，完全控制导出的内容和名称：

修改lib/index.js为：

// 手动引入并导出模块
const Client = require('./client');
const MyError = require('./my-error');

module.exports = {
    Client,
    MyError
};

这样在test.js里就可以直接按类名解构引用：

const { Client, MyError } = require('./lib');

try {
    const client = new Client();
    // 后续逻辑
} catch (err) {
    if (err instanceof MyError) {
        // 处理自定义错误
    }
}

这种方案的优势：

• 导出的API清晰明确，用户一眼就能知道包提供了哪些类/方法
• 导出名称和类名保持一致，避免命名混淆
• 不会意外引入无关文件，安全性和稳定性更高
• 代码可读性强，后续维护时更容易追踪模块依赖关系

内容的提问来源于stack exchange，提问作者craig