seajs.config配置可以对 Sea.js 进行配置,让模块编写、开发调试更方便。
seajs.config seajs.config(options)用来进行配置的方法。
seajs.config({ // 别名配置 alias: { 'es5-safe': 'gallery/es5-safe/0.9.3/es5-safe', 'json': 'gallery/json/1.0.2/json', 'jquery': 'jquery/jquery/1.10.1/jquery' }, // 路径配置 paths: { 'gallery': 'https://a.alipayobjects.com/gallery' }, // 变量配置 vars: { 'locale': 'zh-cn' }, // 映射配置 map: [ ['http://example.com/js/app/', 'http://localhost/js/app/'] ], // 预加载项 preload: [ Function.prototype.bind ? '' : 'es5-safe', this.JSON ? '' : 'json' ], // 调试模式 debug: true, // Sea.js 的基础路径 base: 'http://example.com/path/to/base/', // 文件编码 charset: 'utf-8' });
支持以下配置选项:
alias Object
当模块标识很长时,可以使用 alias
来简化。
seajs.config({ alias: { 'jquery': 'jquery/jquery/1.10.1/jquery', 'app/biz': 'http://path/to/app/biz.js', } }); define(function(require, exports, module) { var $ = require('jquery'); //=> 加载的是 http://path/to/base/jquery/jquery/1.10.1/jquery.js var biz = require('app/biz'); //=> 加载的是 http://path/to/app/biz.js });
使用 alias
,可以让文件的真实路径与调用标识分开,有利于统一维护。
paths Object
当目录比较深,或需要跨目录调用模块时,可以使用 paths
来简化书写。
seajs.config({ paths: { 'gallery': 'https://a.alipayobjects.com/gallery', 'app': 'path/to/app', } }); define(function(require, exports, module) { var underscore = require('gallery/underscore'); //=> 加载的是 https://a.alipayobjects.com/gallery/underscore.js var biz = require('app/biz'); //=> 加载的是 path/to/app/biz.js });
paths
配置可以结合 alias
配置一起使用,让模块引用非常方便。
vars Object
有些场景下,模块路径在运行时才能确定,这时可以使用 vars
变量来配置。
seajs.config({ vars: { 'locale': 'zh-cn' } }); define(function(require, exports, module) { var lang = require('./i18n/{locale}.js'); //=> 加载的是 path/to/i18n/zh-cn.js });
vars
配置的是模块标识中的变量值,在模块标识中用 {key}
来表示变量。
map Array
该配置可对模块路径进行映射修改,可用于路径转换、在线调试等。
seajs.config({ map: [ [ '.js', '-debug.js' ] ] }); define(function(require, exports, module) { var a = require('./a'); //=> 加载的是 path/to/a-debug.js });
preload Array
使用 preload
配置项,可以在普通模块加载前,提前加载并初始化好指定模块。
// 在老浏览器中,提前加载好 ES5 和 json 模块 seajs.config({ preload: [ Function.prototype.bind ? '' : 'es5-safe', this.JSON ? '' : 'json' ] });
preload
中的空字符串会被忽略掉。
注意:preload
中的配置,需要等到 use
时才加载。比如:
seajs.config({ preload: 'a' }); // 在加载 b 之前,会确保模块 a 已经加载并执行好 seajs.use('./b');
preload 配置不能放在模块文件里面:
seajs.config({ preload: 'a' }); define(function(require, exports) { // 此处执行时,不能保证模块 a 已经加载并执行好 });
debug Boolean
值为 true
时,加载器不会删除动态插入的 script 标签。插件也可以根据 debug 配置,来决策 log 等信息的输出。
base String
Sea.js 在解析顶级标识时,会相对 base
路径来解析。详情请参阅 模块标识
注意:一般请不要配置 base
路径,把 sea.js
放在合适的路径往往更简单一致。
charset String | Function
获取模块文件时,<script>
或 <link>
标签的 charset
属性。 默认是 utf-8
charset
还可以是一个函数:
seajs.config({ charset: function(url) { // xxx 目录下的文件用 gbk 编码加载 if (url.indexOf('http://example.com/js/xxx') === 0) { return 'gbk'; } // 其他文件用 utf-8 编码 return 'utf-8'; } });
提示:多次配置自动合并
seajs.config
可以多次运行,每次运行时,会对配置项进行合并操作:
seajs.config({ alias: { 'jquery': 'path/to/jquery.js', 'a': 'path/to/a.js' }, preload: ['seajs-text'] });
seajs.config({ alias: { 'underscore': 'path/to/underscore.js', 'a': 'path/to/biz/a.js' }, preload: ['seajs-combo'] });
上面两处 config
运行的结果是:
alias = { 'jquery': 'path/to/jquery.js', 'underscore': 'path/to/underscore.js', 'a': 'path/to/biz/a.js' }; preload = ['seajs-text', 'seajs-combo'];
即:config
会自动合并不存在的项,对存在的项则进行覆盖。
插件的配置
插件可以给 Sea.js 添加配置项,请查看具体插件了解相关配置。
配置文件
配置可以直接写在 html 页面上,也可以独立出来成为一个文件。
config.js
seajs.config({ ... });
独立成一个文件时,一般通过 script 标签在页面中同步引入。
常用的配置项是 alias
、paths
、base
,其他配置项有需要时,来查查文档就会用了。
相关推荐
你还可以利用 Sea.js 插件扩展其功能,比如支持 AMD 模块格式或进行代码压缩。 ```javascript // 在 main.js 中 seajs.config({ alias: { 'jquery': 'path/to/jquery.min.js' // 定义别名 }, preload: ['jquery...
- **`seajs.config`**:配置 Sea.js 的行为,如设置模块路径、别名、映射等,以便更高效地加载模块。 - **`seajs.data`**:存储 Sea.js 运行时的数据,如模块缓存、配置信息等。 3. **示例解析**: - **示例1:...
Sea.js 支持 `./` 和 `../` 开头的相对路径,也支持从 `seajs-config` 配置中定义的模块路径。 5. **模块定义**:使用 `define` 函数定义模块,它可以接收三个参数:模块 ID(可选)、依赖(数组)和回调函数。回调...
1. **配置优化**:通过配置文件(sea-config.js)可以设置基础路径、别名、预加载模块等,简化模块引用路径。 2. **模块化设计**:合理划分模块,遵循单一职责原则,避免大而全的模块。 3. **模块缓存**:Sea.js 会...
- `js/config.js`:配置 Sea.js,设置基础路径、别名等。 - `js/modules` 目录:包含多个模块文件,如 `module1.js`、`module2.js`,它们通过 `define` 定义并互相引用。 - `js/main.js`:主模块,加载其他模块并...
`seajs.config` 用于配置 Sea.js 的加载行为,主要包括以下几个方面: - **alias(别名配置)**:可以为模块创建别名,方便后续模块中通过 `require` 调用。例如: ```javascript seajs.config({ alias: { '...
5. **Sea.js API**:提供`seajs.use`、`seajs.config`、`seajs.module`等API,方便开发者操作模块和配置环境。 二、Seajs的使用场景 1. **大型Web应用**:对于需要大量JavaScript代码的Web应用,Seajs可以帮助组织...
综上所述,Sea.js 通过提供强大的配置选项和遵循 CMD 规范,极大地提高了前端开发的效率和可维护性。无论是对于大型项目还是小型项目,都能够有效地管理依赖关系和优化资源加载,从而实现更好的性能表现。
sea.js也提供了类似的`config`方法来处理非CMD模块,类似于require.js的`shim`。 总的来说,AMD和CMD在模块化开发中各有优势。AMD更适用于大型项目,尤其是需要动态加载和按需加载的场景,而CMD则更适合小规模的、...
- **seajs-css.js**:这是一个加载CSS资源的插件,它可以让Seajs自动加载CSS文件,与JavaScript模块一起管理。 - **seajs-debug.js**:提供调试功能,通过设置环境变量`seajs.debug = true`,可以在浏览器中开启...
可以使用`seajs.config()`方法进行配置: ```javascript seajs.config({ base: "./js/" // 设置基础路径 }); ``` 3. **加载模块**:Seajs使用`seajs.use()`方法加载模块,同时可以指定回调函数处理加载后的模块...
SeaJS的核心理念是模块化,它借鉴了CommonJS标准,使得JavaScript代码可以像Node.js中那样进行模块化编写。CommonJS是一个为服务器端JavaScript设计的一套API,但SeaJS将其应用到了浏览器环境,使得前端开发也能享受...
Seajs,也称为Sea.js,是一款基于CommonJS模块定义规范的JavaScript模块加载框架。它由淘宝前端工程师玉伯主导开发,旨在为JavaScript项目提供更加模块化、依赖清晰的代码组织方式,从而提高开发效率和项目维护性。 ...
当在页面中引入Sea.js后,配置好模块路径,然后通过`seajs.use`指定入口模块,Sea.js会在加载完成后自动执行。 Sea.js遵循CMD(Common Module Definition)规范,与Node.js的模块系统类似,允许通过`require`引入...
用于预加载的 Sea.js 插件 安装 使用 spm 安装: $ spm install seajs/seajs-preload 用法 < script src =" path/to/sea.js " > </ script > < script src =" path/to/seajs-preload.js " > &...
Seajs 提供了 `seajs.config` 方法来配置模块加载的行为,例如设置基础URL、映射、别名等。例如,设置基础URL: ```javascript seajs.config({ base: './' }); ``` 这样,所有模块的相对路径都将相对于此base...
6. **自定义配置**:Sea.js允许通过`seajs.config`进行配置,比如改变模块路径、设置别名、配置映射等,以便于项目的构建和部署。 7. **事件监听**:Sea.js提供了一些事件监听机制,如`seajs.use`的回调函数,可以...
1. **配置sea.js**:设置基础路径、模块别名、预加载模块等,通常在HTML文件中通过`<script>`标签引入seajs.config()方法。 2. **定义模块**:使用define()定义模块,指定模块ID、依赖及模块内容。 3. **加载模块**...