egg.js 路径别名配置 module-alias

最新推荐文章于 2025-07-29 22:00:53 发布

原创最新推荐文章于 2025-07-29 22:00:53 发布 · 1.8k 阅读

0 ·

CC 4.0 BY-SA版权

egg 专栏收录该内容

23 篇文章

订阅专栏

本文详细介绍如何在Node.js项目中使用module-alias模块进行路径别名的配置，包括安装依赖、配置package.json及app.js文件，以及在控制器中进行测试的过程。

安装依赖 moudle-alias

npm install module-alias --save

配置package.json文件

注：这里@root就是别名，后面引号内的内容就是原路径

"_moduleAliases": {
  "@root": ".",
  "@app": "app"
},

配置文件引入 require(‘module-alias/register’);

注：因为需要将该代码放置在所有使用路径别名代码的前面，因此在这里将此引用放置在app.js中，当然，也可以在所需的地方进行单独引用（不推荐）

'use strict';

class AppBootHook {
  constructor(app) {
    this.app = app;
  }

  configWillLoad() {
    // 此时 config 文件已经被读取并合并，但是还并未生效
    // 这是应用层修改配置的最后时机
    // 注意：此函数只支持同步调用
    require('module-alias/register');
    // 例如：参数中的密码是加密的，在此处进行解密

  }
}

module.exports = AppBootHook;

测试

/** app/controller/core/base.js */
'use strict';

const { Controller } = require('egg');

class BaseController extends Controller {

  success(data) {
    this.ctx.body = {
      sta: '999',
      msg: '操作成功',
      data,
    };
  }

}

module.exports = BaseController;

/** app/controller/moudleAliasCeshi.js */
'use strict';

const BaseController = require('@app/controller/core/base');

class MoudleAliasCeshiController extends BaseController {

  async ceshi() {
    this.success('dfsgvds');
  }

}

module.exports = MoudleAliasCeshiController;

/** app/router.js */
'use strict';

/**
 * @param {Egg.Application} app - egg application
 */
module.exports = app => {
  const { router, controller } = app;

  router.get('/moudleAliasCeshi', controller.moudleAliasCeshi.ceshi);

};