聊聊 Sea.js 里 require 的书写规范——这些并非高深理论,而是编写模块时需要遵循的几条实用约定。下面直接分享核心要点。

require 书写约定
在使用 Sea.js 编写模块时,请牢记几条简单规则,它们的主要目的是帮助 Sea.js 的静态分析工具准确识别模块间的依赖关系。当然,这些规则仅在编码和调试阶段生效——经过构建工具处理后,最终代码完全无需遵守这些限制,构建工具会自动处理依赖关系。
1. 正确拼写
模块工厂函数(factory)的第一个参数 必须 命名为 require,不可使用其他自定义名称。
// 错误用法
define(function(req) {
// ...
});
// 正确用法
define(function(require) {
// ...
});
2. 不要修改
请勿对 require 进行重命名,也不要在任何作用域中重新赋值。它本质上等同于语法关键字,一旦改动,静态分析将无法正常工作。
// 错误 - 重命名 "require"!
var req = require, mod = req("./mod");
// 错误 - 重定义 "require"!
require = function() {};
// 错误 - 将 "require" 作为函数参数重新定义!
function F(require) {}
// 错误 - 在内嵌作用域中重新定义 "require"!
function F() {
var require = function() {};
}
3. 使用直接量
require 的参数必须是一个字符串直接量,不能使用变量、表达式或函数调用的结果。
// 错误用法!
require(myModule);
// 错误用法!
require("my-" + "module");
// 错误用法!
require("MY-MODULE".toLowerCase());
// 正确用法!
require("my-module");
总而言之,编写模块时请将 require 视为语言关键字,避免任何花哨的操作。
关于动态依赖
有时需要根据条件动态加载模块,可能会写出类似下面的代码:
if (todayIsWeekend)
require("play");
else
require("work");
但请注意,从静态分析的角度来看,这个模块同时依赖 play 和 work 两个模块,加载器会一并下载两个文件。在这种情况下,推荐使用 require.async 进行条件加载,实现按需下载,避免不必要的资源消耗。
以上就是 Sea.js 中 require 的几个基本约定,简单但非常实用。在实际开发中遵循这些规范,基本不会遇到依赖分析方面的问题。
