使用node时为require设置别名(alias)

Posted by Eleanor Mao on 2017-09-03

前言

由于本包包是个很懒惰的人,然后我们有些个项目设计的不是很好,所以导致写代码的时候有很多这样的代码:

1
require('../../../../../../foo.js');

写的时候数那个小点点感觉人都要死了😤
这种时候如果写node能像用了webpack(and so on)那样能够require别名就好了。 比如这样:

1
require('modules/foo.js');

于是我搜寻了几种方法。

来自总结的方法

以下内容来自于github上一名叫做branneman的同志的总结,我为他的内容进行了随性的翻译

原文可查看这里

1. Symlink

“偷”自focusaurus / express_code_structure # the-app-symlink-trick

  1. 在应用的node_modules文件夹下面创建一个symlink
  • Linux: ln -nsf node_modules app
  • Windows: mklink /D app node_modules (叉烧包注释:如果你在应用的目录下,应该使用,以bash为例cd node_modules && ln -nsf [模块路径],耍的时候请把app换成你要复制的模块的路径)

然后你就可以

1
var Article = require('app/article');

小贴士:由于git不能处理跨平台的symlinks,所以你不能再git repo里面用这样的文件。不过如果你是在克隆后、git-hook或者是由开发人员手动创建一个symlink,那就没啥问题

另外,你可以在npm里面里面增加一条postinstall钩子,这个方法由scharf提出。可以把命令加进package.json里面

1
2
3
"scripts": {
"postinstall" : "node -e \"var s='../src',d='node_modules/src',fs=require('fs');fs.exists(d,function(e){e||fs.symlinkSync(s,d,'dir')});\""
}

(叉烧包注释:postinstall会在npm run install前先自动执行)

2. 全局变量

在你的app里面增加

1
global.__base = __dirname + '/';

这样你就可以这样用了

1
var Article = require(__base + 'app/models/article');

3. 使用别人开发的库

(这里下面再做推荐)

4. 环境变量

设置环境变量NODE_PATH成一个指向你app想用的模块的路径(作者的情况下是.)。 (叉烧包注释:最好是使用绝对路径,这样比较稳妥)

然后就可以

1
var Article = require('app/models/article');

4.1 提前设置

在启动app前线确保已经设置好了环境变量

  • Linux: export NODE_PATH=.
  • Windows: set NODE_PATH=. 使用exportset是仅对当前shell有效的,如果你需要让他全局、永久的改变,需要修改你的配置文件

4.2 只在执行node时设置

这个方法不会影响你的环境,除非node运行。他需要你改变应用启用命令。

像这样启动你的app

  • Linux: NODE_PATH=. node app
  • Windows: cmd.exe /C "set NODE_PATH=.&& node app" (在win下面如果你在path和&&之间加空格的话就启动不了) (叉烧包注释:这里推荐一下cross-env插件,可以跨平台使用命令,这样的话就可以用这样使用命令啦~ cross-env NODE_PATH=. node app.js

5. 启用脚本

其实和4.2差不多
其实就是写成一个脚本来运行,不过这样比较方便加各种参数

例:

  • Linux: ./app (Windows PowerShell可)
  • Windows: app

5.1 Node.js

看这里 代码具体是这样

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
#!/usr/bin/env node
‘use strict’;
hquote
var spawn = require(‘child_process’).spawn;
var args = [
‘–harmony’,
‘app/bootstrap.js’
];
var opt = {
cwd: __dirname,
env: (function() {
process.env.NODE_PATH = ‘.’; // Enables require() calls relative to the cwd :)
//叉烧包注释: 如果需要多个路径可以这样(需要额外 require path 模块)
//process.env.NODE_PATH = [‘.’, ‘./lib’].join(path. delimiter)
return process.env;
}()),
stdio: [process.stdin, process.stdout, process.stderr]
};
var app = spawn(process.execPath, args, opt);
Raw

5.2 操作系统特定的启动脚本

  • Linux 可以创建一个app.sh
1
2
#!/bin/sh
NODE_PATH=. node app.js
  • Windows 可以创建一个app.bat
1
2
@echo off
cmd.exe /C "set NODE_PATH=.&& node app.js"

6. Hack

谢谢@joelabair和4.2差不多,但不需要在app之外指定NODEPATH。但是,由于这依赖于一个专用的Node.js核心方法。╮(╯╰)╭

你需要在require之前运行这个方法。

1
2
process.env.NODE_PATH = __dirname;
require('module').Module._initPaths();

7. 包裹

感谢@a-ignatov-parc 简单来说你可以在你的app最开始运行这样的代码。

1
2
3
global.rootRequire = function(name) {
return require(__dirname + '/' + name);
}

然后就可以这样

1
var Article = rootRequire('app/models/article');

叉烧包总结

基于我的原则一向来就是越快越好,打字越少越好,所以个人认为

  • symlink的方式由于各种限制而且你增加一点你的包就得新生产一个,感觉比较的不爽 => pass
  • 增加全局变量,但是还需要自己拼接一下,难受 => pass
  • 环境变量,我比较能接受写一份脚本的方法 0-0
  • Hack方法,这个我比较的喜欢, 使用时也和原生一样
  • 包裹方法在require时比较难受,我喜欢能直接require…so => pass

包子的方法

1. 修改启用命令

这个上面也提到过4和5中也提到过。
在启用时这样操作NODE_PATH=. node app.js
不过得考虑到不同操作系统下面path分割符的问题,所以个人推荐是采用5.1中的方法,写一份node脚本

2. HACK

我hack了_findPath()方法,这个就是想设成啥别名就啥别名w,只不过只能兼容到node6 具体可以看这里

其他人的方法

  • hack了require方法,这个和我想的hack差不多,但是这样兼容性比较好。code看这里。这个作者也封装成了一个插件,大家可以去支持一下sexy-require。这边的别名是配置在package.json下面的

  • 还有hack了export方法的,通过Object.defineProperty,在get方法时给模块的添加必要的属性

  • babel-plugin-resolver。这个本包倒是没有细去了解,所以使用的小伙伴可以自己看一下

插件推荐

各位有用过别的欢迎在评论里面告诉我哟~(@^_^@)~

使用起来和原生没有差别的

  • 先羞羞的安利一下自己的插件node-require-alias, node6.0环境以上的考虑一下
  • 还有是通过读package.json配置的sexy-require
  • module-alias这个读package.json和通过方法都可以设置别名

使用起来和原生有差别的

因为我个人比较嫌弃这种写法,这里就不做介绍了,只做推荐

最后的总结

我个人比较的作,喜欢自己写还是比较喜欢HACK!不过我觉得加环境变量也很快,也不用管兼容b( ̄▽ ̄)d。
另外对于HACK方法我还做了十分随性的原理解析,大家想看的可以戳hack原理解析这篇