Front-end разработчик неизбежно сталкивается с Node.js каждый день. Node следует спецификации Commonjs, суть которой заключается в загрузке других зависимых модулей через require. Мы настолько привыкли использовать различные библиотеки, предоставляемые сообществом, что очень мало знаем о принципах, лежащих в основе ссылок на модули. В этой статье читается исходный код и анализируется принцип работы require в спецификации commonjs.
Откуда берется требование?
Как мы все знаем, в модулях/файлах node js некоторые «глобальные» переменные могут использоваться напрямую, напримерrequire, module, __dirname, __filename, exports.
На самом деле, эти переменные или методы не являются «глобальными», а вcommonjs
module.exports = function () {
console.log(__dirname);
}
проходить черезcompileПосле этого будетmodule,__dirname
(function (exports, require, module, __filename, __dirname) {
module.exports = function () {
console.log(__dirname);
}
})
Это также может быть хорошим ответом на вопрос, который часто смущает новичков: почему вы присваиваете значение экспорту, а результат, полученный после запроса, не определен?
// 直接给 exports 赋值是不会生效的
(function (exports, module) {
exports = function () {
}
})(m.exports, m)
return m.exports;
Прямое назначение изменяет только локальное изменение лицаexportsценность . наконецexportвнеmodule.exportsНе назначен.
Требуют поиска процесса
В документации это описано оченьЧисто, процесс поиска упрощенного модуля require выглядит следующим образом:
在 Y 路径下，require(X)
1. 如果X是内置模块（http, fs, path 等）, 直接返回内置模块，不再执行
2. 如果 X 以 '/' 开头，把 Y 设置为文件系统根目录
3. 如果 X 以 './'， '/'， '../' 开头
a. 按照文件的形式加载（Y + X），根据 extensions 依次尝试加载文件 [X, X.js, X.json, X.node]
如果存在就返回该文件，不再继续执行。
b. 按照文件夹的形式加载（Y + X），如果存在就返回该文件，不再继续执行，若找不到将抛出错误
a. 尝试解析路径下 package.json main 字段
b. 尝试加载路径下的 index 文件（index.js, index.json, index.node）
4. 搜索 NODE_MODULE，若存在就返回模块
a. 从路径 Y 开始，一层层往上找，尝试加载（路径 + 'node_modules/' + X）
b. 在 GLOBAL_FOLDERS node_modules 目录中查找 X
5. 抛出 "Not Found" Error
Например, в/Users/helkyle/projects/learning-module/foo.jsв require('bar') начнется с/Users/helkyle/projects/learning-module/Начните искать слой за слоемbarмодуль (не начинается с'./'， '/'， '../'начало).
'/Users/helkyle/projects/learning-module/node_modules',
'/Users/helkyle/projects/node_modules',
'/Users/helkyle/node_modules',
'/Users/node_modules',
'/node_modules'
Следует отметить, что при использованииnpm linkфункция, этоlinkвнутри модуляrequireБытьlinkМодули смотрят на их абсолютный путь в файловой системе вместоmain moduleПуть находится.
Например, предположим, что есть два модуля.
/usr/lib/foo
/usr/lib/bar
пройти черезlinkВ видеfooМодульlink barБудет производить мягкое даже/usr/lib/foo/node_modules/barнаправление/usr/lib/bar,В этой ситуацииbarrequire('quux')Путь поиска/usr/lib/bar/node_modules/вместо/usr/lib/foo/node_modules
Яма, на которую я наступил раньше
Механизм кэширования
На практике можно узнать, что на самом делеNode module requireПроцесс будет кэширован. это дваждыrequireтот самыйmoduleВы получите тот же результат.
// a.js
module.exports = {
foo: 1,
};
// b.js
const a1 = require('./a.js');
a1.foo = 2;
const a2 = require('./a.js');
console.log(a2.foo); // 2
console.log(a1 === a2); // true
воплощать в жизньnode b.js, видно, что во второй разrequire a.jsс первымrequireРезультирующий блок - это те же ссылки.
отИсточникТочка зрения,requireправдаmoduleИнкапсуляция общих методов.
function makeRequireFunction(mod, redirects) {
const Module = mod.constructor;
let require;
// 简化其他代码
require = function require(path) {
return mod.require(path);
};
function resolve(request, options) {
validateString(request, 'request');
return Module._resolveFilename(request, mod, false, options);
}
require.resolve = resolve;
function paths(request) {
validateString(request, 'request');
return Module._resolveLookupPaths(request, mod);
}
resolve.paths = paths;
require.main = process.mainModule;
require.extensions = Module._extensions;
require.cache = Module._cache;
return require;
}
Код отслеживания видит,require()Последний звонокModule._loadметод:
// 忽略代码，看看 load 的过程发生了什么？
Module._load = function(request, parent, isMain) {
// 调用 _resolveFilename 获得模块绝对路径
const filename = Module._resolveFilename(request, parent, isMain);
const cachedModule = Module._cache[filename];
if (cachedModule !== undefined) {
// 如果存在缓存，直接返回缓存的 exports 对象
return cachedModule.exports;
}
// 内建模块直接返回
const mod = loadNativeModule(filename, request, experimentalModules);
if (mod && mod.canBeRequiredByUsers) return mod.exports;
// 创建新的 module 对象
const module = new Module(filename, parent);
// main module 特殊处理
if (isMain) {
process.mainModule = module;
module.id = '.';
}
// 缓存 module
Module._cache[filename] = module;
// 返回 module exports 对象
return module.exports;
};
сюда,module cacheПринцип очень ясен, после первого модуля загрузки модуль будет абсолютным путемkeyкэшируется вModule._cacheсвойства, опять жеrequireКэшированные результаты возвращаются напрямую для повышения эффективности. распечатать на консолиrequire.cacheпосмотри.
// b.js
require('./a.js');
require('./a.js');
console.log(require.cache);
В тайнике дваkey, соответственноa.js, b.jsАбсолютный путь к файлу в системе.valueсоответствующий модульloadПослеmoduleобъект. так во второй разrequire('./a.js')Результатrequire.cache['/Users/helkyle/projects/learning-module/a.js'].exportsи в первый разrequireУказывая на то же самоеObject.
{
'/Users/helkyle/projects/learning-module/b.js':
Module {
id: '.',
exports: {},
parent: null,
filename: '/Users/helkyle/projects/learning-module/b.js',
loaded: false,
children: [ [Object] ],
paths:
[ '/Users/helkyle/projects/learning-module/node_modules',
'/Users/helkyle/projects/node_modules',
'/Users/helkyle/node_modules',
'/Users/node_modules',
'/node_modules' ] },
'/Users/helkyle/projects/learning-module/a.js':
Module {
id: '/Users/helkyle/projects/learning-module/a.js',
exports: { foo: 1 },
parent:
Module {
id: '.',
exports: {},
parent: null,
filename: '/Users/helkyle/projects/learning-module/b.js',
loaded: false,
children: [Array],
paths: [Array] },
filename: '/Users/helkyle/projects/learning-module/a.js',
loaded: true,
children: [],
paths: [
'/Users/helkyle/projects/learning-module/node_modules',
'/Users/helkyle/projects/node_modules',
'/Users/helkyle/node_modules',
'/Users/node_modules',
'/node_modules'
]
}
}
Приложение — Реализация эффекта фиктивного модуля Jest
jestЭто библиотека внешнего тестирования Facebook с открытым исходным кодом, которая предоставляет множество очень мощных и практичных функций.mock moduleявляется одной из очень привлекательных особенностей. Метод использования находится в каталоге того же уровня файлового модуля, который необходимо имитировать.__mock__Добавить в папку файл с таким же названием, запускать при выполнении тестового кодаjest.mock(modulePath),jestбудет автоматически загружатьсяmockВерсияmodule.
apisapi.
// /projects/foo/apis.js
module.export = {
getUsers: () => fetch('api/users')
};
Во время прогона теста я не хочу, чтобы он был на самом деле подключаться к запросу на бэкэнде. В это время в соответствии сjestДокументация, созданная на том же уровне, что и файл apismock file
// /projects/foo/__mock__/apis.js
module.exports = {
getUsers: () => [
{
id: "1",
name: "Helkyle"
},
{
id: "2",
name: "Chinuketsu"
}
]
}
В тестовом файле активно вызыватьjest.mock('./apis.js')Вот и все.
jest.mock('./apis.js');
const apis = require('./apis.js');
apis.getUsers()
.then((users) => {
console.log(users);
// [ { id: '1', name: 'Helkyle' }, { id: '2', name: 'Chinuketsu' } ]
})
К пониманиюrequireПосле основного принципа также реализуем аналогичную функцию, которая будет загружатьapi.jsОператор переписан для загрузки__mock__/api.js.
использовать require.cache
Благодаря наличию механизма кэширования предварительная запись в целевой кеш с повторным запросом приведет к ожидаемому нами результату.
// 提前 require mock apis 文件，产生缓存。
require('./__mock__/apis.js');
// 给即将 require 的文件路径写入缓存
const originalPath = require.resolve('./apis.js');
require.cache[originalPath] = require.cache[require.resolve('./__mock__/apis.js')];
// 得到的将是缓存版本
const apis = require('./apis.js');
apis.getUsers()
.then((users) => {
console.log(users);
// [ { id: '1', name: 'Helkyle' }, { id: '2', name: 'Chinuketsu' } ]
})
Модуль магических изменений._load
на основеrequire.cacheПуть, нужно продвинутьсяrequire mock module. 👆 Упоминается, потому что в итоге было пройденоModule._loadЧтобы загрузить модуль, перехватите его в этом месте, чтобы завершить запрос по требованию.mock.
const Module = require('module');
const originalLoad = Module._load;
Module._load = function (path, ...rest) {
if (path === './apis.js') {
path = './__mock__/apis.js';
}
return originalLoad.apply(Module, [path, ...rest]);
}
const apis = require('./apis.js');
apis.getUsers()
.then((users) => {
console.log(users);
})
Уведомление: Вышеупомянутое только для справки. По фактическим результатам операции,Jest реализовал свой собственный модуль загрузки механизма,а такжеcommonjs有出入。 например, вjestсерединаrequire moduleне пишетrequire.cache.
требовать при запуске программы
ПроверитьNodeДокументы, найденные вCommand LineГлавы также имеют--require, используйте этот параметр для предварительной загрузки определенных модулей перед выполнением бизнес-кода.
Например, напишитеsetupфайл, чтобыglobalУстанавливается на объектit, assertи другие методы.
// setup.js
global.it = async function test(title, callback) {
try {
await callback();
console.log(`✓ ${title}`);
} catch (error) {
console.error(`✕ ${title}`);
console.error(error);
}
}
global.assert = require('assert');
Добавить в код запуска--requireпараметр. представлятьglobal.assert, global.it, вы можете использовать его прямо в кодеassert, itНе включайте его в тестовый файл.
node --require './setup.js' foo.test.js
// foo.test.js
// 不需要 require('assert');
function sum (a, b) {
return a + b;
}
// 没有 --require 会报 it is not defined
it('add two numbers', () => {
assert(sum(2, 3) === 5);
})