Guide
Guide

module (模块)

稳定性: 稳定

Auto.js 有一个简单的模块加载系统。 在 Auto.js 中，文件和模块是一一对应的（每个文件被视为一个独立的模块）。

例子，假设有一个名为 foo.js 的文件：

1var circle = require("./circle.js");
2console.log("半径为 4 的圆的面积是 %d", circle.area(4));

在第一行中，foo.js 加载了同一目录下的 circle.js 模块。

circle.js 文件的内容为：

1const PI = Math.PI;
2
3exports.area = function (r) {
4    return PI * r * r;
5};
6
7exports.circumference = (r) => 2 * PI * r;

circle.js 模块导出了 area() 和 circumference() 两个函数。 通过在特殊的 exports 对象上指定额外的属性，函数和对象可以被添加到模块的根部。

模块内的本地变量是私有的。 在这个例子中，变量 PI 是 circle.js 私有的，不会影响到加载他的脚本的变量环境。

module.exports 属性可以被赋予一个新的值（例如函数或对象）。

如下，bar.js 会用到 square 模块，square 导出一个构造函数：

1const square = require("./square.js");
2const mySquare = square(2);
3console.log("正方形的面积是 %d", mySquare.area());

square 模块定义在 square.js 中：

1// 赋值给 `exports` 不会修改模块，必须使用 `module.exports`
2module.exports = function (width) {
3    return {
4        area: () => width ** 2,
5    };
6};

require函数

require函数用于加载模块，返回模块中module.exports的值。

该函数有一个参数用于查找模块位置，可以是相对路径(以'./'或'../'开头)，也可以是绝对路径(以'/'开头)， 还可以是以'http://'或'https://'开头的 uri 地址，用于加载网络模块，出于安全和加载速度考虑，此方式不建议使用。

当没有以这些开头时，将会视为内置模块，从内置模块目录依次查找，由于历史原因，在脚本主文件中仍然会先尝试解析成相对路径解析，若解析成功则会忽略内置模块直接加载，强烈不建议使用此方式加载相对路径的模块，该方式在模块中不可用并且被弃用，在未来版本可能会被移除。

和 nodejs 类似，当传入的是一个目录，则会尝试加载该目录下的 index.js 文件，若存在 package.json 文件则会先解析该文件中的 main 字段，若 main 字段指向一个有效的模块将直接加载该模块。

模块变量

这些变量只存在于模块中，并非全局变量

  • module 储存当前模块一些信息的对象，其中最重要的是module.exports表示该模块导出的对象

  • exports 相当于预先运行了var exports = module.exports

  • __dirname 当前模块的目录名

  • __filename 当前模块的文件名。 这是当前模块文件的已解析符号链接的绝对路径。

ON THIS PAGE