SeaJS入门教程系列之SeaJS介绍(一)


Posted in Javascript onMarch 03, 2014

前言
SeaJS是一个遵循CommonJS规范的JavaScript模块加载框架,可以实现JavaScript的模块化开发及加载机制。与jQuery等JavaScript框架不同,SeaJS不会扩展封装语言特性,而只是实现JavaScript的模块化及按模块加载。SeaJS的主要目的是令JavaScript开发模块化并可以轻松愉悦进行加载,将前端工程师从繁重的JavaScript文件及对象依赖处理中解放出来,可以专注于代码本身的逻辑。SeaJS可以与jQuery这类框架完美集成。使用SeaJS可以提高JavaScript代码的可读性和清晰度,解决目前JavaScript编程中普遍存在的依赖关系混乱和代码纠缠等问题,方便代码的编写和维护。
SeaJS的作者是淘宝前端工程师玉伯。
SeaJS本身遵循KISS(Keep It Simple, Stupid)理念进行开发,其本身仅有个位数的API,因此学习起来毫无压力。在学习SeaJS的过程中,处处能感受到KISS原则的精髓——仅做一件事,做好一件事。
本文首先通过一个例子直观对比传统JavaScript编程和使用SeaJS的模块化JavaScript编程,然后详细讨论SeaJS的使用方法,最后给出一些与SeaJS相关的资料。

传统模式 vs SeaJS模块化
假设我们现在正在开发一个Web应用TinyApp,我们决定在TinyApp中使用jQuery框架。TinyApp的首页会用到module1.js,module1.js依赖module2.js和module3.js,同时module3.js依赖module4.js。
传统开发
使用传统的开发方法,各个js文件代码如下:

//module1.js
var module1 = {
    run: function() {
        return $.merge(['module1'], $.merge(module2.run(), module3.run()));
    }
}//module2.js
var module2 = {
    run: function() {
        return ['module2'];
    }
}
//module3.js
var module3 = {
    run: function() {
        return $.merge(['module3'], module4.run());
    }
}
//module4.js
var module4 = {
    run: function() {
        return ['module4'];
    }
}

此时index.html需要引用module1.js及其所有下层依赖(注意顺序):
<!DOCTYPE HTML>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <title>TinyApp</title>
    <script src="./jquery-min.js"></script>
    <script src="./module4.js"></script>
    <script src="./module2.js"></script>
    <script src="./module3.js"></script>
    <script src="./module1.js"></script>
</head>
<body>
    <p class="content"></p>
    <script>
        $('.content').html(module1.run());
    </script>
</body>
</html>

随着项目的进行,js文件会越来越多,依赖关系也会越来越复杂,使得js代码和html里的script列表往往变得难以维护。
SeaJS模块化开发
下面看看如何使用SeaJS实现相同的功能。
首先是index.html:
<!DOCTYPE HTML>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <title>TinyApp</title>
</head>
<body>
    <p class="content"></p>
    <script src="./sea.js"></script>
    <script>
        seajs.use('./init', function(init) {
            init.initPage();
        });
    </script>
</body>
</html>

可以看到html页面不再需要引入所有依赖的js文件,而只是引入一个sea.js,sea.js会处理所有依赖,加载相应的js文件,加载策略可以选择在渲染页面时一次性加载所有js文件,也可以按需加载(用到时才加载响应js),具体加载策略使用方法下文讨论。
index.html加载了init模块,并使用此模块的initPage方法初始化页面数据,这里先不讨论代码细节。
下面看一下模块化后JavaScript的写法:
//jquery.js
define(function(require, exports, module) = {    //原jquery.js代码...
    module.exports = $.noConflict(true);
});
//init.js
define(function(require, exports, module) = {
    var $ = require('jquery');
    var m1 = require('module1');
    exports.initPage = function() {
        $('.content').html(m1.run());    
    }
});
//module1.js
define(function(require, exports, module) = {
    var $ = require('jquery');
    var m2 = require('module2');
    var m3 = require('module3');
    exports.run = function() {
        return $.merge(['module1'], $.merge(m2.run(), m3.run()));    
    }
});
//module2.js
define(function(require, exports, module) = {
    exports.run = function() {
        return ['module2'];
    }
});
//module3.js
define(function(require, exports, module) = {
    var $ = require('jquery');
    var m4 = require('module4');
    exports.run = function() {
        return $.merge(['module3'], m4.run());    
    }
});
//module4.js
define(function(require, exports, module) = {
    exports.run = function() {
        return ['module4'];
    }
});

乍看之下代码似乎变多变复杂了,这是因为这个例子太简单,如果是大型项目,SeaJS代码的优势就会显现出来。不过从这里我们还是能窥探到一些SeaJS的特性:
一是html页面不用再维护冗长的script标签列表,只要引入一个sea.js即可。
二是js代码以模块进行组织,各个模块通过require引入自己依赖的模块,代码清晰明了。
通过这个例子朋友们应该对SeaJS有了一个直观的印象,下面本文具体讨论SeaJS的使用。
Javascript 相关文章推荐
js压缩利器
Feb 20 Javascript
js 异步操作回调函数如何控制执行顺序
Dec 24 Javascript
多引号嵌套的变量命名的问题
May 09 Javascript
jQuery原生的动画效果
Jul 10 Javascript
js replace(a,b)之替换字符串中所有指定字符的方法
Aug 17 Javascript
原生JS:Date对象全面解析
Sep 06 Javascript
jQuery Ajax File Upload实例源码
Dec 12 Javascript
微信小程序 欢迎页面的制作(源码下载)
Jan 09 Javascript
详解在AngularJS的controller外部直接获取$scope
Jun 02 Javascript
vue实现仿淘宝结账页面实例代码
Nov 08 Javascript
通过一个简单的例子学会vuex与模块化
Nov 22 Javascript
解决vue移动端适配问题
Dec 12 Javascript
js的hasownproperty使用示例
Mar 02 #Javascript
javascript对象的使用和属性操作示例详解
Mar 02 #Javascript
使用js显示当前时间示例
Mar 02 #Javascript
jquery实现背景墙聚光灯效果示例分享
Mar 02 #Javascript
jquery制作弹窗提示窗口代码分享
Mar 02 #Javascript
jquery中ajax函数执行顺序问题之如何设置同步
Feb 28 #Javascript
JavaScript获取当前页面上的指定对象示例代码
Feb 28 #Javascript
You might like
YII Framework教程之异常处理详解
2016/03/14 PHP
PHP 二维数组和三维数组的过滤
2016/03/16 PHP
windows7配置Nginx+php+mysql的详细教程
2016/09/04 PHP
PHP并发查询MySQL的实例代码
2017/08/09 PHP
Javascript 判断客户端浏览器类型代码
2010/03/01 Javascript
Javascript 浮点运算精度问题分析与解决
2014/03/26 Javascript
javascript函数中参数传递问题示例探讨
2014/07/31 Javascript
jQuery添加/改变/移除CSS类及判断是否已经存在CSS
2014/08/20 Javascript
jQuery实现Twitter的自动文字补齐特效
2014/11/28 Javascript
JQuery实现防止退格键返回的方法
2015/02/12 Javascript
深入理解JavaScript单体内置对象
2016/06/06 Javascript
JavaScript ES6中CLASS的使用详解
2016/11/22 Javascript
JavaScript中定义对象原型的两种使用方法
2016/12/15 Javascript
AngularJS框架中的双向数据绑定机制详解【减少需要重复的开发代码量】
2017/01/19 Javascript
JavaScript设计模式之代理模式详解
2017/06/09 Javascript
JS实现留言板功能
2017/06/17 Javascript
浅谈webpack-dev-server的配置和使用
2018/05/17 Javascript
vue实现绑定事件的方法实例代码详解
2019/06/20 Javascript
JSONP 的原理、理解 与 实例分析
2020/05/16 Javascript
npm ci命令的基本使用方法
2020/09/20 Javascript
[15:28]DOTA2 HEROS教学视频教你分分钟做大人-剧毒术士
2014/06/13 DOTA
python去掉字符串中重复字符的方法
2014/02/27 Python
Python json模块使用实例
2015/04/11 Python
python在windows下创建隐藏窗口子进程的方法
2015/06/04 Python
python opencv实现图像边缘检测
2019/04/29 Python
python 对字典按照value进行排序的方法
2019/05/09 Python
HelloFresh澳大利亚:订购你的美味食品盒、健康餐食
2018/03/28 全球购物
5个HTML5的常用本地存储方式详解与介绍
2021/03/27 HTML / CSS
大学毕业生文采飞扬的自我鉴定
2013/12/03 职场文书
农民入党思想汇报
2014/01/03 职场文书
产品质量承诺书
2014/03/27 职场文书
学生请假条格式
2014/04/11 职场文书
党员领导干部承诺书
2014/05/28 职场文书
宣传标语大全
2014/07/01 职场文书
简易离婚协议书范本2014
2014/10/15 职场文书
vue的项目如何打包上线
2022/04/13 Vue.js