javascript模块化

我们为什么要模块化?
一般出来什么东西,说明当前的工具有其缺陷,或者是为了方便什么。
那么我们就来看看通过模块,我们可以做到什么?
我们可以只关注自己的核心逻辑,而不用考虑其中的辅助功能。比如我们想要实现计算两个文本框中数值的和,我们只需要关注业务逻辑,而不需要关注自己如何查找到该元素(查找到元素可以交给jquery来做,还解决了兼容性问题)。
通过模块,我们可以方便的使用别人的代码,需要什么模块就引入对应的依赖模块。

我们先来看看几种原生js的实现模块化得方法(下面说的每一个方法都是为了解决上一种方法出现的问题):

  • 原始的模块写法:

        function a1(){
    
        }
    
        function a2(){
    
        }
      缺点:污染全局变量,可能造成变量冲突,无法直观的显示二者的联系
    
  • 解决上一问题

var module = {
    a1: function(){
    
    },
    a2: function(){
    
    }
}
缺点:用户可以在外面修改module内的变量
  • 解决上一问题
var module = (function(){
    var m1 = function(){
    };
    var m2 = function(){
    };

    return {
        m1 : m1,
        m2 : m2
    };
});
通过立即执行函数,这样就解决了模块内部变量可能被修改的问题
缺点: 如果此模块需要依赖另一个模块才能生效
  • 解决上一问题
var module = (function(mod){
    mod.m1 = function(){
    };
    return mod;
})(another_module);

下面我们介绍现在应用广泛的javascript模块规范:CommonJS,AMD,以及国内的CMD。

  1. CommonJS
    我们先来说CommonJS,在其中有一个require()方法,用于加载模块
    比如:
    假设我们的一个模块(add_module)中有一个求两数之和的方法,在另一个地方我们就可以通过下面的方法使用这个求和方法。
var addModule = require(‘add_module’);
addModule.add(1,2);
  1. AMD
    既然已经有了CommonJS,为什么还会出现AMD呢?
因为CommonJS不适合浏览器环境,上面的代码假如在浏览器中执行,那么浏览器需要时间来加载add_module,如果网络条件不好,浏览器会出现“假死”状态。因此浏览器端不能采用“同步加载”,而应该使用“异步加载”。

AMD(异步模块定义),采用异步的方式加载模块,所有需要依赖其他模块的语句都被定义在回调函数中。
用AMD的语法改写上面CommonJS的写法:

require([‘add_module’],function(addModule){
    addModule.add(1,2);
});
  1. 基于AMD规范的javascript库:require.js
    require.js是为了实现下面的两个效果:
  • 实现js文件的异步加载,避免网页失去响应;
  • 管理模块之间的依赖性,便于代码的编写和维护。

3.1 使用require.js
从官网下载require.js,在html中引入

<script src="js/require.js" defer async="true" ></script>

async属性表明这个文件需要异步加载,避免网页失去响应。IE不支持这个属性,只支持defer,所以把defer也写上。
引入我们自己写的需要执行的js文件

<script src="js/require.js" data-main=“main” defer async="true" ></script>

data-main属性的作用是,指定网页程序的主模块。在上例中,就是js目录下面的main.js,这个文件会第一个被require.js加载。由于require.js默认的文件后缀名是js,所以可以把main.js简写成main。

  main.js文件:
require(['moduleA', 'moduleB'], function (moduleA, moduleB){
    // some code here
  });

require()函数接受两个参数。第一个参数是一个数组,表示所依赖的模块,上例就是['moduleA', 'moduleB'],即主模块依赖这2个模块;第二个参数是一个回调函数,当前面指定的模块都加载成功后,它将被调用。加载的模块会以参数形式传入该函数,从而在回调函数内部就可以使用这些模块。
require()异步加载moduleA,moduleB,浏览器不会失去响应;它指定的回调函数,只有前面的模块都加载成功后,才会运行,解决了依赖性的问题。

比如我们需要依赖jquery
require(['jquery'], function ($){
    // some code here
  });

  主模块的依赖模块是['jquery']。
默认情况下,require.js假定这个模块与main.js在同一个目录,文件名为jquery.js,然后自动加载。
使用require.config()方法,我们可以对模块的加载行为进行自定义。require.config()就写在主模块(main.js)的头部。
参数就是一个对象,这个对象的paths属性指定各个模块的加载路径。
如果我们的依赖文件和main.js不在同一文件夹下呢?
require.config({
    paths: {
      "jquery": "lib/jquery.min"
    }
  });
也可以通过配置baseUrl来改变基目录
require.config({
    baseUrl: "js/lib",
    paths: {
      "jquery": "jquery.min"
    }
  });
自定义的require.js加载的模块,采用AMD规范,即就是模块必须采用特定的define()函数来定义。
  • 如果一个模块不依赖其他模块,那么可以直接定义在define()函数之中。
define(function (){
    var add = function (x,y){
      return x+y;
    };
    return {
      add: add
    };
  });
  • 如果这个模块还依赖其他模块,那么define()函数的第一个参数,必须是一个数组,指明该模块的依赖性。
define(['myLib'], function(myLib){
    function foo(){
      myLib.doSomething();
    }
    return {
      foo : foo
    };
  });
加载非规范的模块

理论上,require.js加载的模块,必须是按照AMD规范、用define()函数定义的模块。但是实际上,虽然已经有一部分流行的函数库(比如jQuery)符合AMD规范,更多的库并不符合。那么,require.js是否能够加载非规范的模块呢?
回答是可以的。
这样的模块在用require()加载之前,要先用require.config()方法,定义它们的一些特征。
举例来说,underscore和backbone这两个库,都没有采用AMD规范编写。如果要加载它们的话,必须先定义它们的特征。

  require.config({
    shim: {
      'underscore':{
        exports: '_'
      },
      'backbone': {
        deps: ['underscore', 'jquery'],
        exports: 'Backbone'
      }
    }
  });

require.config()接受一个配置对象,这个对象除了有前面说过的paths属性之外,还有一个shim属性,专门用来配置不兼容的模块。具体来说,每个模块要定义(1)exports值(输出的变量名),表明这个模块外部调用时的名称;(2)deps数组,表明该模块的依赖性。

4.CMD
关于CMD的介绍,大家可以点击这里查看;
关于AMD和CMD的比较,大家可以点击这里看玉伯写的一篇评论;
SeaJS和RequireJS的区别,大家可以点击这里

本文内容是我自己在阮一峰博客的基础上整理的,原文大家可以查看:
http://www.ruanyifeng.com/blog/2012/10/javascript_module.html
http://www.ruanyifeng.com/blog/2012/10/asynchronous_module_definition.html
http://www.ruanyifeng.com/blog/2012/11/require_js.html

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,937评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,503评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,712评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,668评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,677评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,601评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,975评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,637评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,881评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,621评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,710评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,387评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,971评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,947评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,189评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,805评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,449评论 2 342

推荐阅读更多精彩内容