如何在Serverless Framework的NodeJS中实现模块别名（无需Webpack/Babel）

前提说明 #

你的代码位于src目录下，目标是把require("../../services")这类相对路径替换成require("@services")、require("@models")的形式，以下是几种原生Node.js支持的实现方案：

方案1：使用Node.js原生Subpath Imports（推荐） #

这是Node.js 12.20.0+、14.13.0+、16.0.0+支持的原生特性，无需额外工具，配置简单。

步骤： #

1. 在项目根目录的package.json中添加imports字段，映射别名到实际路径：

{
  "name": "your-serverless-project",
  "imports": {
    "@services/*": "./src/services/*",
    "@models/*": "./src/models/*"
  }
}

2. 确保Serverless配置的Lambda运行时版本符合要求（比如选择nodejs18.x或更高版本）。
3. 直接在代码中使用别名：

// src/handlers/userHandler.js
const userService = require('@services/userService');
const userModel = require('@models/userModel');

方案2：自定义全局require解析（兼容旧Node.js版本） #

如果你的Lambda运行时版本较低，不支持Subpath Imports，可以通过自定义require函数来实现别名解析：

步骤： #

1. 在src/utils目录下创建aliasResolver.js文件：

const path = require('path');
const originalRequire = require;

// 自定义require逻辑
function aliasRequire(modulePath) {
  // 替换@别名到实际相对路径
  if (modulePath.startsWith('@services/')) {
    const targetPath = modulePath.replace('@services/', '../services/');
    return originalRequire(path.resolve(__dirname, targetPath));
  } else if (modulePath.startsWith('@models/')) {
    const targetPath = modulePath.replace('@models/', '../models/');
    return originalRequire(path.resolve(__dirname, targetPath));
  }
  // 非别名路径用原生require处理
  return originalRequire(modulePath);
}

// 替换全局require
global.require = aliasRequire;

2. 在每个handler文件的最顶部引入这个解析器：

// src/handlers/userHandler.js
require('../utils/aliasResolver');
const userService = require('@services/userService');

注意事项 #

• 使用Subpath Imports时，要保证Serverless打包时包含根目录的package.json，默认情况下Serverless会打包项目根目录下的所有必要文件，无需额外配置。
• 如果你的项目结构有调整，比如src的位置变化，要同步修改package.json或自定义解析器中的路径映射。

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