模块化之SeaJS(二)

  

Seajs

此文来自 予舍驿站

提供简单、极致的模块化开发体验

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

seajs.configObject

aliasObject

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

seajs.config({
    alias: { ‘jquery‘: ‘jquery/jquery/1.10.1/jquery‘ }
});
define(function(require, exports, module) {
    //引用jQuery模块
    var $ = require(‘jquery‘);
});

pathsObject

设置路径,方便跨目录调用。通过灵活的设置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
});

varsObject

变量配置。有些场景下,模块路径在运行时才能确定,这时可以使用 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
});

mapArray

该配置可对模块路径进行映射修改,可用于路径转换、在线调试等。

seajs.config({
    map: [
        [ ‘.js‘, ‘-debug.js‘ ]
    ]
});
define(function(require, exports, module) {
    var a = require(‘./a‘);
    //=> 加载的是 path/to/a-debug.js
});

preloadArray

使用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 已经加载并执行好
});

debugBoolean

值为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.useFunction

用来在页面中加载一个或多个模块。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.cacheOjbect

通过 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.resloveFunction

类似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.dataObject

通过 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>
时间: 2024-11-05 18:39:02

模块化之SeaJS(二)的相关文章

模块化之SeaJS

模块化(之SeaJS) 刚接触的童鞋可能会有很多疑惑,比喻:什么是模块?模块的目的是干嘛呀?接着就想,玛德怎么样实现模块化呢? 不要急,博主正是带着这三个问题来写这篇文章的. 一,什么是模块化? 在前端开发领域,一个模块,可以是JS 模块,也可以是 CSS 模块,或是 Template 等模块.在 Sea.js 里,我们专注于 JS 模块(其他类型的模块可以转换为 JS 模块):模块是一段 JavaScript 代码,具有统一的基本书写格式.模块之间通过基本交互规则,能彼此引用,协同工作(怎么书

用函数实现模块化程序设计(二)

用函数实现模块化程序设计(二)   一.函数的嵌套调用 C语言的函数定义是互相平行.独立的.即函数不能嵌套定义,但可以嵌套调用函数.即调用一个函数的过程中,又可以调用另一个函数 执行过程,如图: 例子:输入4个整数,找出其中最大的数.用函数的嵌套调用来处理. 解题思路: main中调用max1函数,找4个数中最大者 max1中再调用max2,找两个数中的大者 /* 输入4个整数,找出其中最大的数.用函数的嵌套调用来处理. */ #include "stdio.h" void main(

js模块化编程(二):AMD规范

转自 ruanyifeng 系列目录: Javascript模块化编程(一):模块的写法 Javascript模块化编程(二):AMD规范 Javascript模块化编程(三):Require.js的用法 今天介绍如何规范地使用模块. 接上文 七.模块的规范 先想一想,为什么模块很重要?因为有了模块,我们就可以更方便地使用别人的代码,想要什么功能,就加载什么模块.但是,这样做有一个前提,那就是大家必须以同样的方式编写模块,否则你有你的写法,我有我的写法,岂不是乱了套!考虑到Javascript模

模块化开发(二)--- seaJs入门学习

SeaJS是一个基于CMD模块定义规范实现一个模块系统加载器 [CMD规范](https://github.com/cmdjs/specification/blob/master/draft/module.md)9.seaJs启动函数的回调函数 官网:http://seajs.org/docs/ github:https://github.com/seajs/seajs 如何选择一个技术产品栈: - 看作者是否是大牛 - 看社区是否活跃 - 看是否经常更新 SeaJS的作者已经不更新该项目了,但

模块化之seaJs学习和使用

使用seaJs也有一阵子了,一直也想抽个时间写个这方面的博客,直到今天才写--也许写的不是很完善,但跟大伙分享也是一种乐趣,不对之处欢迎指出.[抱拳] 时间有限,我这里不过多介绍前端模块化,有兴趣可以去了解. 一.写在前面 seaJs出自前端工程师玉伯之手,一个文件就是一个模块,实现JavaScript的模块化及按模块加载.使用SeaJS可以提高JavaScript代码的可读性和清晰度,确保各个JS文件先后加载的顺序,解决目前JavaScript编程中普遍存在的依赖关系混乱和代码纠缠等问题,方便

JS模块化编程(二)

背景 我们常在页面引用js遇到下面情况 <script src="1.js"></script> <script src="2.js"></script> <script src="3.js"></script> <script src="4.js"></script> <script src="5.js"

模块化开发seaJS

1, 先下载seaJs, 然后在我们的项目中新建一个文件夹命名sea(名字可以随便取),把下载好的sea.js 文件拷贝到里面,最后在html文档中把用script标签引入即可使用. 2, 在模块化中,一个js文件就是一个模块,js文件夹下所有js文件都是模块.当然把普通的js文件转换成模块,要做一下变化.用define()方法, 把js文件定义成模块.define方法接受一个函数作为参数,函数有三个参数,如下. define(function(require,exports,module){

Javascript模块化编程(二):AMD规范

作者: 阮一峰 日期: 2012年10月30日 这个系列的第一部分介绍了Javascript模块的基本写法,今天介绍如何规范地使用模块. (接上文) 七.模块的规范 先想一想,为什么模块很重要? 因为有了模块,我们就可以更方便地使用别人的代码,想要什么功能,就加载什么模块. 但是,这样做有一个前提,那就是大家必须以同样的方式编写模块,否则你有你的写法,我有我的写法,岂不是乱了套!考虑到Javascript模块现在还没有官方规范,这一点就更重要了. 目前,通行的Javascript模块规范共有两种

JS模块化库seajs体验

seajs http://seajs.org/docs/en.html#intro https://github.com/seajs/seajs/releases Extremely simple experience of modular development Why use Sea.js ? Sea.js's pursuit of a simple, natural coding and organization,has the following key aspects: The def