Seajs 简易文档 提供简单、极致的模块化开发体验


Posted in Javascript onApril 13, 2016

非官方文档,整理来自己官方文档的文字与实例,方便速查。

为什么使用 Sea.js ?

Sea.js 追求简单、自然的代码书写和组织方式,具有以下核心特性:

简单友好的模块定义规范:Sea.js 遵循 CMD 规范,可以像 Node.js 一般书写模块代码。
自然直观的代码组织方式:依赖的自动加载、配置的简洁清晰,可以让我们更多地享受编码的乐趣。
Sea.js 还提供常用插件,非常有助于开发调试和性能优化,并具有丰富的可扩展接口。

兼容性

Sea.js 具备完善的测试用例,兼容所有主流浏览器:

Chrome 3+        
Firefox 2+       
Safari 3.2+      
Opera 10+        
IE 5.5+          

Sea.js 可运行在 Mobile 端,包括 Hybrid 模式的 App 上。理论上,Sea.js 可以运行在任何浏览器引擎上。

seajs.configObject

alias Object

别名配置,配置之后可在模块中使用require调用 require('jquery');

 

seajs.config({
  alias: { 'jquery': 'jquery/jquery/1.10.1/jquery' }
});

 

define(function(require, exports, module) {
  //引用jQuery模块
  var $ = require('jquery');
});

 paths Object

设置路径,方便跨目录调用。通过灵活的设置path可以在不影响base的情况下指定到某个目录。 

seajs.config({
  //设置路径
  paths: {
    'gallery': 'https://a.alipayobjects.com/gallery'
  },

  // 设置别名,方便调用
  alias: {
    'underscore': 'gallery/underscore'
  }
});
define(function(require, exports, module) {
  var _ = require('underscore');
   //=> 加载的是 https://a.alipayobjects.com/gallery/underscore.js
});

vars Object

变量配置。有些场景下,模块路径在运行时才能确定,这时可以使用 vars 变量来配置。

vars 配置的是模块标识中的变量值,在模块标识中用 {key} 来表示变量。

seajs.config({
  // 变量配置
  vars: {
    'locale': 'zh-cn'
  }
});
define(function(require, exports, module) {
 var lang = require('./i18n/{locale}.js');
   //=> 加载的是 path/to/i18n/zh-cn.js
});

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配置项,可以在普通模块加载前,提前加载并初始化好指定模块。

preload中的空字符串会被忽略掉。

// 在老浏览器中,提前加载好 ES5 和 json 模块
seajs.config({
  preload: [
    Function.prototype.bind ? '' : 'es5-safe',
    this.JSON ? '' : 'json'
  ]
});

注意: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 等信息的输出。

baseString

Sea.js 在解析顶级标识时,会相对 base 路径来解析。

注意:一般请不要配置 base 路径,把 sea.js 放在合适的路径往往更简单一致。
charsetString | 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.use Function
用来在页面中加载一个或多个模块。seajs.use(id, callback?)

// 加载一个模块
seajs.use('./a');

// 加载一个模块,在加载完成时,执行回调
seajs.use('./a', function(a) {
 a.doSomething();
});

// 加载多个模块,在加载完成时,执行回调
seajs.use(['./a', './b'], function(a, b) {
 a.doSomething();
 b.doSomething();
});

注意:seajs.use 与 DOM ready 事件没有任何关系。如果某些操作要确保在 DOM ready 后执行,需要使用 jquery 等类库来保证。比如

seajs.use(['jquery', './main'], function($, main) {
  $(document).ready(function() {
    main.init();
  });
});

注意:use方法第一个参数一定要有,但是可以是null,也可以是一个变量

var bootstrap = ['bootstrap.css', 'bootstrap-responsive.css', 'bootstrap.js'];

seajs.use(bootstrap, function() {
  //do something
});

seajs.cache Ojbect
通过 seajs.cache,可以查阅当前模块系统中的所有模块信息。

比如,打开 seajs.org,然后在 WebKit Developer Tools 的 Console 面板中输入 seajs.cache,可以看到:

Object
 > http://seajs.org/docs/assets/main.js: x
 > https://a.alipayobjects.com/jquery/jquery/1.10.1/jquery.js: x
 > __proto__: Object

这些就是文档首页用到的模块。展开某一项可以看到模块的具体信息,含义可参考:CMD 模块定义规范 中的 module 小节。

seajs.reslove Function
类似require.resolve,会利用模块系统的内部机制对传入的字符串参数进行路径解析。

seajs.resolve('jquery');
// => http://path/to/jquery.js

seajs.resolve('./a', 'http://example.com/to/b.js');
// => http://example.com/to/a.js

seajs.resolve 方法不光可以用来调试路径解析是否正确,还可以用在插件开发环境中。

seajs.data Object
通过 seajs.data,可以查看 seajs 所有配置以及一些内部变量的值,可用于插件开发。当加载遇到问题时,也可用于调试。

常见问题
关于模块标识

Seajs模块标识主要以小驼峰字符串、.或..

// 在 http://example.com/js/a.js 的 factory 中:
require.resolve('./b');
 // => http://example.com/js/b.js

// 在 http://example.com/js/a.js 的 factory 中:
require.resolve('../c');
 // => http://example.com/c.js

分为 相对 与 顶级 标识。以.或..开头,则为相对标识 。以小驼峰字符串开关,则为顶级标识。

// 假设 base 路径是:http://example.com/assets/

// 在模块代码里:
require.resolve('gallery/jquery/1.9.1/jquery');
 // => http://example.com/assets/gallery/jquery/1.9.1/jquery.js

关于路径

Seajs除了相对与顶级标识之外,还可以使用普通路径来加载模块。

就到当前页面的脚本分析(可以右键查看源码)

//sea.js的路径,即 base 路径,相对于当前页面
<script src="http://yslove.net/actjs/assets/sea-modules/seajs/2.1.1/sj.js"></script>

<script type="text/javascript">
//配置Seajs
seajs.config({
  alias: {
    //顶级标识,基于 base 路径
    'actjs': 'actjs/core/0.0.7/core.js',
      // => http://
    'position': 'actjs/util/0.0.2/position.js'
  }
});

seajs.config({
  alias: {
    //普通路径,相对于当前页面
    'affix': '../../actjs/assets/widget/src/widget-affix.js',

    //相对标识,相对于当前页面
    'init': './src/init.js'
  }
});
</script>

开始的时候会觉得Seajs的路径有点不习惯,由其是Base路径。切记Base路径就是sea.js的那个文件的上级路径,然后所有顶级标识,相对标识都是相对于这个Base来调整。 

Javascript 相关文章推荐
js模拟点击事件实现代码
Nov 06 Javascript
js如何设置在iframe框架中指定div不显示
Dec 04 Javascript
jquery插件jquery.beforeafter.js实现左右拖拽分隔条对比图片的方法
Aug 07 Javascript
JS设置下拉列表框当前所选值的方法
Dec 22 Javascript
javascript事件冒泡简单示例
Jun 20 Javascript
多功能jQuery树插件zTree实现权限列表简单实例
Jul 12 Javascript
React为 Vue 引入容器组件和展示组件的教程详解
May 03 Javascript
vue axios整合使用全攻略
May 24 Javascript
Jquery遍历筛选数组的几种方法和遍历解析json对象,Map()方法详解以及数组中查询某值是否存在
Jan 18 jQuery
ES6模板字符串和标签模板的应用实例分析
Jun 25 Javascript
详解基于原生JS验证表单组件xy-form
Aug 20 Javascript
Vue和Flask通信的实现
May 19 Vue.js
原生js编写autoComplete插件
Apr 13 #Javascript
JS中的eval 为什么加括号
Apr 13 #Javascript
jQuery操作属性和样式详解
Apr 13 #Javascript
jquery跟随屏幕滚动效果的实现代码
Apr 13 #Javascript
两种方法解决javascript url post 特殊字符转义 + &amp; #
Apr 13 #Javascript
Angular.js与Bootstrap相结合实现手风琴菜单代码
Apr 13 #Javascript
JQuery 两种方法解决刚创建的元素遍历不到的问题
Apr 13 #Javascript
You might like
全国FM电台频率大全 - 29 青海省
2020/03/11 无线电
Discuz! 5.0.0论坛程序中加入一段js代码,让会员点击下载附件前自动弹出提示窗口
2007/04/18 PHP
提交表单后 PHP获取提交内容的实现方法
2016/05/25 PHP
PHP判断JSON对象是否存在的方法(推荐)
2016/07/06 PHP
php 使用 __call实现重载功能示例
2019/11/18 PHP
Array对象方法参考
2006/10/03 Javascript
图片上传即时显示缩略图的js代码
2009/05/27 Javascript
jQuery 锚点跳转滚动条平滑滚动一句话代码
2010/04/30 Javascript
NodeJS框架Express的模板视图机制分析
2011/07/19 NodeJs
jQuery动态添加 input type=file的实现代码
2012/06/14 Javascript
纯CSS3代码实现滑动开关效果
2015/08/19 Javascript
浅析nodejs实现Websocket的数据接收与发送
2015/11/19 NodeJs
JavaScript中数组去除重复的三种方法
2016/04/22 Javascript
JQuery异步加载PartialView的方法
2016/06/07 Javascript
最好用的Bootstrap fileinput.js文件上传组件
2016/12/12 Javascript
jquery与ajax获取特殊字符实例详解
2017/01/08 Javascript
JS 实现计算器详解及实例代码(一)
2017/01/08 Javascript
浅谈关于.vue文件中style的scoped属性
2017/08/19 Javascript
js module大战
2019/04/19 Javascript
NodeJS实现一个聊天室功能
2019/11/25 NodeJs
[59:36]2018DOTA2亚洲邀请赛 4.3 突围赛 Secret vs VG 第二场
2018/04/04 DOTA
简介Python中用于处理字符串的center()方法
2015/05/18 Python
Python WXPY实现微信监控报警功能的代码
2017/10/20 Python
python实现校园网自动登录的示例讲解
2018/04/22 Python
python smtplib模块实现发送邮件带附件sendmail
2018/05/22 Python
Python matplotlib通过plt.scatter画空心圆标记出特定的点方法
2018/12/13 Python
python实现简单日期工具类
2019/04/24 Python
python实现windows倒计时锁屏功能
2019/07/30 Python
Python爬取12306车次信息代码详解
2020/08/12 Python
解决pycharm不能自动保存在远程linux中的问题
2021/02/06 Python
英国知名的皮手套品牌:Dents
2016/11/13 全球购物
大学生创业感言
2014/01/25 职场文书
面试后感谢信
2014/02/01 职场文书
幼儿园元旦活动感言
2014/03/02 职场文书
八达岭长城导游词
2015/01/30 职场文书
党校培训学习心得体会
2016/01/06 职场文书