码迷,mamicode.com
首页 > Web开发 > 详细

require.js使用方法说明

时间:2014-08-06 18:36:41      阅读:399      评论:0      收藏:0      [点我收藏+]

标签:blog   http   color   java   使用   os   io   strong   

1  前端组件requireJS使用方法说明书

1.1 知识背景之javascript模块化

随着网站逐渐变成"互联网应用程序",嵌入网页的Javascript代码越来越庞大,越来越复杂。

网页越来越像桌面程序,需要一个团队分工协作、进度管理、单元测试等等......开发者不得不使用软件工程的方法,管理网页的业务逻辑。

Javascript模块化编程,已经成为一个迫切的需求。理想情况下,开发者只需要实现核心的业务逻辑,其他都可以加载别人已经写好的模块。

但是,Javascript不是一种模块化编程语言,它不支持""(class),更遑论"模块"(module)了。(正在制定中的ECMAScript标准第六版,将正式支持"类"和"模块",但还需要很长时间才能投入实用。)

Javascript社区做了很多努力,在现有的运行环境中,实现"模块"的效果。本文总结了当前"Javascript模块化编程"的最佳实践,说明如何投入实用。虽然这不是初级教程,但是只要稍稍了解Javascript的基本语法,就能看懂。

1.1.1原始写法

模块就是实现特定功能的一组方法。

只要把不同的函数(以及记录状态的变量)简单地放在一起,就算是一个模块。

function m1(){
    //...
  }

  function m2(){
    //...
  }

上面的函数m1()和m2(),组成一个模块。使用的时候,直接调用就行了。

这种做法的缺点很明显:"污染"了全局变量,无法保证不与其他模块发生变量名冲突,而且模块成员之间看不出直接关系。

1.1.2对象写法

为了解决上面的缺点,可以把模块写成一个对象,所有的模块成员都放到这个对象里面。

  var module1 = new Object({

    _count : 0,

    m1 : function (){
      //...
    },

    m2 : function (){
      //...
    }

  });

上面的函数m1()和m2(),都封装在module1对象里。使用的时候,就是调用这个对象的属性。

  module1.m1();

但是,这样的写法会暴露所有模块成员,内部状态可以被外部改写。比如,外部代码可以直接改变内部计数器的值。

  module1._count = 5;

1.1.3立即执行函数写法

使用"立即执行函数"(Immediately-Invoked Function Expression,IIFE),可以达到不暴露私有成员的目的。

  var module1 = (function(){

    var _count = 0;

    var m1 = function(){
      //...
    };

    var m2 = function(){
      //...
    };

    return {
      m1 : m1,
      m2 : m2
    };

})();

使用上面的写法,外部代码无法读取内部的_count变量。

  console.info(module1._count); //undefined

module1就是Javascript模块的基本写法。下面,再对这种写法进行加工。

1.1.4放大模式

如果一个模块很大,必须分成几个部分,或者一个模块需要继承另一个模块,这时就有必要采用"放大模式"(augmentation)。

var module1 = (function (mod){

    mod.m3 = function () {
      //...
    };

    return mod;

  })(module1);

上面的代码为module1模块添加了一个新方法m3(),然后返回新的module1模块。

1.1.5宽放大模式(Loose augmentation)

在浏览器环境中,模块的各个部分通常都是从网上获取的,有时无法知道哪个部分会先加载。如果采用上一节的写法,第一个执行的部分有可能加载一个不存在空对象,这时就要采用"宽放大模式"。

var module1 = ( function (mod){

  //...

  return mod;

})(window.module1 || {});

与"放大模式"相比,"宽放大模式"就是"立即执行函数"的参数可以是空对象。

1.1.6输入全局变量

独立性是模块的重要特点,模块内部最好不与程序的其他部分直接交互。

为了在模块内部调用全局变量,必须显式地将其他变量输入模块。

var module1 = (function ($, YAHOO) {

    //...

})(jQuery, YAHOO);

上面的module1模块需要使用jQuery库和YUI库,就把这两个库(其实是两个模块)当作参数输入module1。这样做除了保证模块的独立性,还使得模块之间的依赖关系变得明显。

1.1.7模块的规范

先想一想,为什么模块很重要?

因为有了模块,我们就可以更方便地使用别人的代码,想要什么功能,就加载什么模块。

但是,这样做有一个前提,那就是大家必须以同样的方式编写模块,否则你有你的写法,我有我的写法,岂不是乱了套!考虑到Javascript模块现在还没有官方规范,这一点就更重要了。

目前,通行的Javascript模块规范共有两种:CommonJSAMD。我主要介绍AMD,但是要先从CommonJS讲起。

1.1.8 CommonJS

2009年,美国程序员Ryan Dahl创造了node.js项目,将javascript语言用于服务器端编程。

这标志"Javascript模块化编程"正式诞生。因为老实说,在浏览器环境下,没有模块也不是特别大的问题,毕竟网页程序的复杂性有限;但是在服务器端,一定要有模块,与操作系统和其他应用程序互动,否则根本没法编程。

node.js的模块系统,就是参照CommonJS规范实现的。在CommonJS中,有一个全局性方法require(),用于加载模块。假定有一个数学模块math.js,就可以像下面这样加载。

var math = require(‘math‘);

然后,就可以调用模块提供的方法:

var math = require(‘math‘);

math.add(2,3); // 5

因为这个系列主要针对浏览器编程,不涉及node.js,所以对CommonJS就不多做介绍了。我们在这里只要知道,require()用于加载模块就行了。

1.1.9浏览器环境

有了服务器端模块以后,很自然地,大家就想要客户端模块。而且最好两者能够兼容,一个模块不用修改,在服务器和浏览器都可以运行。

但是,由于一个重大的局限,使得CommonJS规范不适用于浏览器环境。还是上一节的代码,如果在浏览器中运行,会有一个很大的问题,你能看出来吗?

var math = require(‘math‘);

math.add(2, 3);

第二行math.add(2, 3),在第一行require(‘math‘)之后运行,因此必须等math.js加载完成。也就是说,如果加载时间很长,整个应用就会停在那里等。

这对服务器端不是一个问题,因为所有的模块都存放在本地硬盘,可以同步加载完成,等待时间就是硬盘的读取时间。但是,对于浏览器,这却是一个大问题,因为模块都放在服务器端,等待时间取决于网速的快慢,可能要等很长时间,浏览器处于"假死"状态。

因此,浏览器端的模块,不能采用"同步加载"(synchronous),只能采用"异步加载"(asynchronous)。这就是AMD规范诞生的背景。

1.1.10 AMD

AMD是"Asynchronous Module Definition"的缩写,意思就是"异步模块定义"。它采用异步方式加载模块,模块的加载不影响它后面语句的运行。所有依赖这个模块的语句,都定义在一个回调函数中,等到加载完成之后,这个回调函数才会运行。

AMD也采用require()语句加载模块,但是不同于CommonJS,它要求两个参数:

require([module], callback);

第一个参数[module],是一个数组,里面的成员就是要加载的模块;第二个参数callback,则是加载成功之后的回调函数。如果将前面的代码改写成AMD形式,就是下面这样:

require([‘math‘], function (math) {

  math.add(2, 3);

});

math.add()与math模块加载不是同步的,浏览器不会发生假死。所以很显然,AMD比较适合浏览器环境。

目前,主要有两个Javascript库实现了AMD规范:require.jscurl.js。后文将对require.js进行详细的介绍。

1.2 利用require.js加载模块

1.2.1 为什么要使用 require.js?

最初,所有 Javascript 代码都写在一个文件里面,只要加载这一个文件就够了。可是后来,代码越来越多,一个文件显然不行了,必须拆分,依次加载。下面网页代码,你肯定不陌生。

<script src="1.js"></script>

<script src="2.js"></script>

<script src="3.js"></script>

<script src="4.js"></script>

<script src="5.js"></script>

<script src="6.js"></script>

该代码依次加载多个 js 文件。这样的写法有很大的缺陷:

  • 加载 js 文件时,浏览器会停止网页渲染,加载文件越多,网页失去响应的时间就越长。
  • 由于 js 文件之间是有依赖关系的,必须严格保证加载顺序。依赖性最大的模块一定要最后加载,当依赖关系很复杂的时候,代码的编写和维护会变得很困难。

require.js 就是为了解决这些问题而产生的:

  • 实现 js 文件的异步加载,避免网页失去响应。
  • 管理模块之间的依赖性,便于代码的编写和维护。

1.2.2 加载 require.js

先在官方网站下载最新版本的 require.js。下载地址:http://www.requirejs.org

下载后,假定把它放在js子目录下,用下面代码加载:

<script src="js/require.js"></script>

可加载这个文件本身也可能因为网络或是服务器问题,不能成功加载,而造成网页失去响应。解决方法有两个,一个是把它放在网页底部加载,另一个是写成下面这样:

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

async 属性表明文件需要异步加载,避免网页失去响应。IE 不支持这个属性,只支持defer,所以把defer也写上。

1.2.3 自定义主模块

加载 require.js 后,就要加载我们自己的代码了。假定我们自己的代码文件是 main.js,它是你的“主模块”,也放在 js 目录下面。那么,只需要写成下面这样就行了:

<script src="js/require.js" data-main="js/main"></script>

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

main.js 是“主模块”,意味着是整个网页js的入口代码,有点像 C 语言的 main() 函数,所有代码都从这儿开始运行。

如果我们的代码不依赖任何其他模块,那么可以直接写入 javascript 代码。

// main.js

alert("加载成功!");

要这么写就没必要使用 require.js。实际的情况是,主模块依赖于其他模块,这就需要使用 AMD 规范定义的的 require 函数了。

// main.js

require([‘moduleA‘, ‘moduleB‘, ‘moduleC‘], function (moduleA, moduleB, moduleC){

  // some code here

});

require 函数有两个参数,其中,

  • 第一个参数,是一个数组,表示所依赖的模块,本代码是 [‘moduleA‘, ‘moduleB‘, ‘moduleC‘],即主模块依赖三个模块。
  • 第二个参数,是一个回调函数,当指定的所有模块都成功加载后,才会被调用。加载的模块以参数形式传入该函数,从而在回调函数中使用这些模块。

这样,require 异步加载 moduleA,moduleB 和 moduleC,浏览器不会失去响应;指定了回调函数,只有当所有模块都加载成功才会运行,解决了 js 依赖性的问题。

假设,主模块依赖 jquery、underscore 和 backbone 三个模块,main.js 可以这样写:

require([‘jquery‘, ‘underscore‘, ‘backbone‘], function ($, _underscore, Backbone){

  // some code here

});

1.2.4 自定义加载

默认情况下,require.js 假设你的模块与 main.js 在同一目录,文件名分别为 jquery.js,underscore.js 和 backbone.js,然后自动加载。

使用 require.config 方法,我们可以自定义对模块加载的行为。require.config 写在主模块(main.js)的顶部。其参数是一个 paths 对象,指定各个模块的加载路径。如下所示:

require.config({

  paths: {

    "jquery": "jquery.min",

    "underscore": "underscore.min",

    "backbone": "backbone.min"

  }

});

上面代码表明你的三个模块文件与 main.js 在同一个 js 目录。如果这些模块在其他目录,如 js/lib 目录,则有两种写法。要么逐一指定,要么直接指定基目录baseUrl。当标明data-main属性但不特别配置baseUrl时,根目录baseUrl的值默认为data-main指定的文件所在的目录;当data-main和baseUrl都未指定时根目录的值默认为加载require.js的html文件所在的目录;否则将以配置的baseUrl作为根目录。

require.config({

  paths: {

    "jquery": "lib/jquery.min",

    "underscore": "lib/underscore.min",

    "backbone": "lib/backbone.min"

  }

});

或是,

require.config({

    baseUrl: "js/lib",

  paths: {

    "jquery": "jquery.min",

    "underscore": "underscore.min",

    "backbone": "backbone.min"

  }

});

如果某个模块在另一台主机上,也可以直接指定它的网址,比如:

require.config({

  paths: {

    "jquery": "https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min"

  }

});

require.js 要求,每个模块是一个单独的 js 文件。但这样,加载多个模块就会发出多个 HTTP 请求,影响网页的加载速度。因此,require.js 提供了一个优化工具,当模块部署完毕以后,该工具将多个模块合并在一个文件中,减少 HTTP 请求次数。

1.2.5 加载 AMD 规范的模块

require.js 加载的模块必须采用 AMD 规范。具体来说,模块必须采用 define 函数来定义。

  1. 定义简单键值对

如果模块不依赖于任何模块,同时只是传递一些简单的name/value对,那么只需传递一个原始的对象给define()。

// inside file coat.js

define({

   color : black,

   size : 32

});

  1. 定义函数

如果模块不依赖于任何模块,但是需要使用函数做一些设置工作,那么定义它自己,传递给define()。

// inside file coat.js

define(function(){

   //Do setup work here

  return {

     color : black,

     size : 32

}

});

  1. 定义带依赖的函数

如果模块有依赖,那么第一个参数应该是依赖名称的数组集合,第二个参数应该是一个定义的函数。一旦所有的依赖都已经加载没那么将调用这个函数来定义模块。这个函数应该返回一个定义模块的对象。这些依赖将作为参数传递给定义的参数,同时按照依赖顺序在参数中列出来。

//coad.js now has some dependencies,a cart and inventory

//module in the same directory as shirt.js

Define([./cart,.inventory],function(cart,inventory){

   //return an object to define the coat module

   return{

      color : blue,

      size : large,

      addToCart : function(){

          inventory.decrement(this);

          cart.add(this);

}

}

});

在上述案例中,coat模块已经创建。它依赖于cart和inventory两个模块。上述函数调用中指定了两个参数,cart和inventory,这些代表了’cart’和’inventory’模块,上述函数直到cart和inventory模块加载完成后才会被调用,它接收模块作为cart和inventory参数。

  1. 定义一个模块作为一个函数

模块没有必要一定返回对象。函数中的任何盒饭返回值都是允许的。下面是一个返回一个函数作为它的模块定义的模块实例。

//inside file title.js

define([my/cart,my/inventory],function(cart,inventory){

// return a fnction to define title

// it gets or sets the window title.

return function(title){

         return title ? (window.title = title) : inventory.storeName + ‘’ + cart.name;

}

});

 

1.2.6 加载非 AMD 规范的模块

理论上,require.js 加载的模块必须符合 AMD 规范,即用 define 函数定义的模块。但实际情况是,虽然已经有一部分流行的函数库(比如 jQuery)符合 AMD 规范,更多的库并不符合。那么,require.js 是否能够加载非规范的模块呢?当然可以。加载非规范模块前,要先用 require.config 方法,定义它们的一些特征。

例如,上面三个模块:jquery.js、underscore.js 和 backbone.js,其中,jQuery.js 符合规范,而 underscore 和 backbone 这两个库不符合。如果要加载它们的话,必须先定义它们的特征。

require.config({

  shim: {

    ‘underscore‘:{

      exports: ‘_‘

    },

    ‘backbone‘: {

      deps: [‘underscore‘, ‘jquery‘],

      exports: ‘Backbone‘

    }

  }

});

require.config 接受一个配置对象 shim,专门用来配置不兼容的模块。具体来说,每个模块要定义:

  • exports值(输出的变量名),表明这个模块外部调用时的名称。
  • deps数组,表明该模块的依赖性。

比如,jQuery 插件可以这样定义:

shim: {

  ‘jquery.scroll‘: {

    deps: [‘jquery‘],

    exports: ‘jQuery.fn.scroll‘

  }

}

本文旨在介绍requireJS的简单用法,如若要对其做更深入的理解可以参阅附件中的API文档。

RequiresJS_2.0_API中文.pdf

require.js使用方法说明,布布扣,bubuko.com

require.js使用方法说明

标签:blog   http   color   java   使用   os   io   strong   

原文地址:http://www.cnblogs.com/Xuen-zhang/p/3895161.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!