使用seajs进行模块化前端开发

之前有一篇文章介绍了requireJS进行模块化开发,今天来说高大上的国产SeaJS的吧,是的SeaJS遵循的是CMD规范。作者是淘宝前端工程师,名字叫玉伯。此解决方案的宗旨是使前端工程师从繁重的js文件及对象依赖处理中解救出来,从而可以专注代码的逻辑本身。

要使用SeaJs,只要下载sea.js文件,然后直接包含在html文件中就可以了,那么如何定义能被seajs加载的模块呢?请看下面的这段源码:

fn.define = function(id, deps, factory) {
    //code of function…
}

define函数可以接受三个参数,但是你也可以只传一个参数,即factory。这也是官方推荐的做法。各参数的解释如下:

id:即模块id,如http://example/a,代表一个模块的绝对路径,a就是此模块文件名如a.js。

deps:表示需要此模块要用到的其他模块。

factory:表示工厂函数,这是模块的主体,也是最重要的部分。

下面来详细解释一下工厂函数:

define(function(require, exports, module) {
    //code of the module...
});

这里只传了factory一个参数,factory其实是一个匿名函数,里面的几个参数表示如下:

require:此模块需要依赖的其他模块。

exports:模块对外提供接口。

module:模块元数据。

下面来介绍一下定义模块的几种方式:

.基于exports的模式:

define(function(require, exports, module) {
    var a = require('a'); //引入a模块
    var b = require('b'); //引入b模块

    var data1 = 1; //私有数据

    var func1 = function() { //私有方法
        return a.run(data1);
    }

    exports.data2 = 2; //公共数据

    exports.func2 = function() { //公共方法
        return 'hello';
    }
});

这是比较常用的方式,还可以直接返回一个对象:如下:

define(function(require) {
    var a = require('a'); //引入a模块
    var b = require('b'); //引入b模块

    var data1 = 1; //私有数据

    var func1 = function() { //私有方法
        return a.run(data1);
    }

    return {
        data2: 2,
        func2: function() {
            return 'hello';
        }
    };
});

如果模块中只有一个对象,可以简化这样:

define({
    data: 1,
    func: function() {
        return 'hello';
    }
});

最后一种方法适合纯json数据的模块开发。

写好了模块,那么怎么来使用它们呢?

模块的载入和引用:

require("http://example/js/a");

表示载入http://example/js/a.js这个文件。

也可以用相对地址:

require("./c");

表示载入http://example/js/c.js这个文件。

require("./module1-style.css");

表示载入css文件。

seajs.use主要用于载入入口模块,就像c里面的main函数一样样,如下:

//单一模式
seajs.use('./a');

//回调模式
seajs.use('./a', function(a) {
  a.run();
});

//多模块模式
seajs.use(['./a', './b'], function(a, b) {
  a.run();
  b.run();
});

一般用于页面中载入入口文件。

也可以使用<script>标签中加入data-main属性来代替seajs.use如下:

<!DOCTYPE HTML>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <title>TinyApp</title>
</head>
<body>
    <p class="content"></p>
    <script src="./sea.js" data-main="./init"></script>
</body>
</html>

require.async:

require.async('/path/to/module/file', function(m) {
    //code of callback...
});

这种方法会异步加载模块,即需要使用摸个模块的时候再加载。

SeaJS的全局配置:

seajs.config({
    base: 'path/to/jslib/',
    alias: {
      'app': 'path/to/app/'
    },
    charset: 'utf-8',
    timeout: 20000,
    debug: false
});

base:表示基址路径,设置了它可以简化require的加载路径。

alias:别名,可以对较长的路径进行缩写。

剩下的没那么重要了,略过。

那么SeaJs如何与其他js框架配合使用呢?这也是大家最关心的问题了吧。

就拿jquery来吧,我们需要对jquery的源码进行封装,你也可以直接用npm来直接下载已经封装好的jquery,但是我试了下,好像淘宝的服务器抽风了,下下来的是损坏的文件。自己动手.....

define(function() {

//{{{jQuery原有代码开始
/*!
 * jQuery JavaScript Library v1.6.1
 * http://jquery.com/
 *
 * Copyright 2011, John Resig
 * Dual licensed under the MIT or GPL Version 2 licenses.
 * http://jquery.org/license
 *
 * Includes Sizzle.js
 * http://sizzlejs.com/
 * Copyright 2011, The Dojo Foundation
 * Released under the MIT, BSD, and GPL Licenses.
 *
 * Date: Thu May 12 15:04:36 2011 -0400
 */
//...
//}}}jQuery原有代码结束

return $.noConflict();
});

下面来介绍一个完整的例子吧:

  • index.html——主页面。
  • sea.js——SeaJS脚本。
  • init.js——init模块,入口模块,依赖data、jquery、style三个模块。由主页面载入。
  • data.js——data模块,纯json数据模块,由init载入。
  • jquery.js——jquery模块,对 jQuery库的模块化封装,由init载入。
  • style.css——CSS样式表,作为style模块由init载入。
  • sea.js和jquery.js的代码属于库代码,就不赘述,这里只给出自己编写的文件的代码。

html:

<!DOCTYPE HTML>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <title></title>
</head>
<body>
<div id="content">
    <p class="author"></p>
    <p class="blog"><a href="#">Blog</a></p>
</div>

<script src="./sea.js" data-main="./init"></script>
</body>
</html>

js;

//init.js
define(function(require, exports, module) {
    var $ = require('./jquery');
    var data = require('./data');
    var css = require('./style.css');

    $('.author').html(data.author);
    $('.blog').attr('href', data.blog);
});

//data.js
define({
    author: 'ZhangYang',
    blog: 'http://blog.codinglabs.org'
});

css:

.author{color:red;font-size:10pt;}
.blog{font-size:10pt;}

好的,今天就到这吧!

前端技术交流群:139761568

时间: 2024-10-27 11:41:42

使用seajs进行模块化前端开发的相关文章

SeaJS实现模块化JavaScript开发

SeaJS的作者是淘宝前端工程师玉伯.SeaJS是一个遵循CommonJS规范的JavaScript模块加载框架,可以实现JavaScript的模块化开发及加载机制.SeaJS本身遵循KISS(Keep It Simple, Stupid)理念进行开发,其本身仅有个位数的API. 简单例子: html文件 <script type="text/javascript" src="__PLG__/sea.js"></script> <scr

前端设计工作经验分享:前端开发设计

文章描述:前端的横向发展. 今天的交流会上,提到了"横向发展"这个词,意指推荐大家学习与前端打交道的相关技术,如:php 其实"前端"这个词,是2005年才逐渐在国内兴起的.那之前,国内的网站,通常是TABLE+ASP搞定一切.做这份工作的人,通称"程序员". 开发设计-"> 那是个孤军奋战就能赢得天下的年代.一个网站丢过来,一个人就全拿了:"写需求==>出设计稿==>做模板==>写程序==>运营

使用decj简化Web前端开发(一)

声明式Javascript动态加载和浏览器事件绑定 引言 Web前端开发中,开发人员经常需要处理一些常规问题,如: 在页面中引用多个相互存在依赖关系的Javascript文件 在页面中引用CSS文件 浏览器事件绑定 表单的数据填充.数据打包提交.数据校验和格式化 页面初始化逻辑 采用传统的命令式编程范式来处理这些问题时,开发人员不得不反复地通过编写代码调用相关API来完成这些常规任务.事实上,开发人员的主要精力应该集中在业务逻辑实现上,而非在这些常规任务上过多消耗时间.声明式编程范式可以帮助开发

前端开发工程师如何在2013年里提升自己

这篇文章其实文字部分不多,强烈推荐大家直接阅读原文,我这里主要是把文章里介绍的PPT简述一下,方便大家寻找. 大部分人非常在意个人在技术上的提升.但是保持对新技术的了解是一项不小的挑战, 毕竟我们需要的信息在数量上过于庞大.2012年里,伴随着前端发展的是大量的革命性突破和对前端的重新定义. 我们在实践的路上飞速前进,具体的进步体现在使用抽象化,优秀的代码质量,维护性上的提升以及更好的性能.如果你实在忙到没有时间来跟上最新的技术,不用担心. 随着假日的来临,我们就有了一些空闲的时间可以自己支配,

在 windows(cygwin) 或 mac 下安装git、node、ruby等前端开发环境

我记得每一年技术部年会都会由老大说出一个技术主题,之前有服务化.模块化.工具化.数据化等等等等,今年的主题是全栈.遥想当年,在供职过的两家公司什么抗机器.装机架:什么安装系统.加固.搭建Web或任务应用的前后端环境.打包发布.网络配置:什么JavaScript.CSS.VB..NET.PHP.JAVA等等语言:什么Mootools.JQuery.Ext.Lucene.Solr.Hibernate.Spring:什么Oracle.Mysql.SQLServer.MongoDB.PL/SQL --

如何打造一个令人愉悦的前端开发环境(一)

文章来源 最近几年,前端发展越来越迅速,各种萌新加入了前端这个大家庭,大有赶IOS.超Android的趋势呀!同时,萌新们提出了各种前端工作问题,除了最基础的html.css.js三板斧之外,最让人头疼的应该是关于环境的配置问题,所以以环境作为切入点,开始一系列的前端开发环境配置文章. 主要会涉及到打包.构建.编程工具.debug等等前端环境,以及前后端分离.Nodejs中间层使用伸展面. 工欲善其事必先利其器 以编程工具而言WebStorm.sublime.Atom.VS Code.Brack

html5- 新手求助,前端开发最好用框架吗?

问题描述 新手求助,前端开发最好用框架吗? 前端开发,最好要框架吗?有什么框架呢?比如做学校的失物招领系统 解决方案 前段开发如果是新手,我建议别着急学框架,先把javascript.jquery的基础学好.然后系统学习一种框架,然后所有框架就基本都会了.学框架,主 要学习框架的搭建思想.我推荐你系统学习bootstrap响应式框架.很强大的前端框架. 解决方案二: 没用最好的,框架只是看你的用途来挑选最合适的框架 解决方案三: 人个觉得使用框架能提升前端开发的效率,降低开发成本和周期.因为网站

前端开发工程师如何在新的一年里提升自己

大部分人非常在意个人在技术上的提升.但是保持对新技术的了解是一项不小的挑战, 毕竟我们需要的信息在数量上过于庞大.2012年里,伴随着前端发展的是大量的革命性突破和对前端的重新定义. 我们在实践的路上飞速前进,具体的进步体现在使用抽象化,优秀的代码质量,维护性上的提升以及更好的性能.如果你实在忙到没有时间来跟上最新的技术,不用担心. 随着假日的来临,我们就有了一些空闲的时间可以自己支配,我想,如果我把我收集的前端相关的精品讨论列表分享出来,那一定会对大家有一些帮助.你不需要把所有的都阅读一遍,但

使用npm+gulp+browserify网页前端开发

本文的目的在于使用npm进行js类库依赖管理,同时精简html中繁杂的<script>导入. 目前类库加载器(如requirejs/seajs等)可以解决script加载的问题.但对依赖处理不好,还需要开发者一个一个去下载js库,根据个人喜好把js堆砌在项目中. nodejs中的npm等工具可以很好的处理依赖,但它是为nodejs服务的,它的模块打包格式是CMD,而requirejs是AMD.seajs官方倒是推荐了spm,据说该项目已经终止维护了. 在一定程度上,nodejs的bower插件