标签归档:js

js模块化编程之彻底弄懂CommonJS和AMD/CMD!

答:因为有了模块,我们就可以更方便地使用别人的代码,想要什么功能,就加载什么模块。
但是,这样做有一个前提,那就是大家必须以同样的方式编写模块,否则你有你的写法,我有我的写法,岂不是乱了套!

于是下面三个模块规范出来了,这篇文章也出来了(拼出来的 {捂脸笑})。

 

JS中的模块规范(CommonJS,AMD,CMD),如果你听过js模块化这个东西,那么你就应该听过或CommonJS或AMD甚至是CMD这些规范咯,我也听过,但之前也真的是听听而已。 现在就看看吧,这些规范到底是啥东西,干嘛的。本文包括这三个规范的来源及对应的产物的原理。

 

一、CommonJS

1.一开始大家都认为JS是辣鸡,没什么用,官方定义的API只能构建基于浏览器的应用程序,逗我呢,这太狭隘了吧(用了个高端词,嘎嘎),CommonJS就按耐不住了,CommonJS API定义很多普通应用程序(主要指非浏览器的应用)使用的API,从而填补了这个空白。它的终极目标是提供一个类似Python,Ruby和Java标准库。这样的话,开发者可以使用CommonJS API编写应用程序,然后这些应用可以运行在不同的JavaScript解释器和不同的主机环境中。

在兼容CommonJS的系统中,你可以使用JavaScript开发以下程序:

 

(1).服务器端JavaScript应用程序
(2).命令行工具
(3).图形界面应用程序
(4).混合应用程序(如,Titanium或Adobe AIR)

2009年,美国程序员Ryan Dahl创造了node.js项目,将javascript语言用于服务器端编程。这标志"Javascript模块化编程"正式诞生。因为老实说,在浏览器环境下,没有模块也不是特别大的问题,毕竟网页程序的复杂性有限;但是在服务器端,一定要有模块,与操作系统和其他应用程序互动,否则根本没法编程。NodeJS是CommonJS规范的实现,webpack 也是以CommonJS的形式来书写。

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

var math = require('math');

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

  var math = require('math');

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

CommonJS定义的模块分为:{模块引用(require)} {模块定义(exports)} {模块标识(module)}

require()用来引入外部模块;exports对象用于导出当前模块的方法或变量,唯一的导出口;module对象就代表模块本身。

虽说Node遵循CommonJS的规范,但是相比也是做了一些取舍,填了一些新东西的。

不过,说了CommonJS也说了Node,那么我觉得也得先了解下NPM了。NPM作为Node的包管理器,不是为了帮助Node解决依赖包的安装问题嘛,那它肯定也要遵循CommonJS规范啦,它遵循包规范(还是理论)的。CommonJS WIKI讲了它的历史,还介绍了modules和packages等。

下面讲讲commonJS的原理以及简易实现:

1、原理

浏览器不兼容CommonJS的根本原因,在于缺少四个Node.js环境的变量。

 

  • module

  • exports

  • require

  • global

 

只要能够提供这四个变量,浏览器就能加载 CommonJS 模块。

 

下面是一个简单的示例。

 

var module = {
  exports: {}};(function(module, exports) {
  exports.multiply = function (n) { return n * 1000 };}(module, module.exports))var f = module.exports.multiply;f(5) // 5000

 

上面代码向一个立即执行函数提供 module 和 exports 两个外部变量,模块就放在这个立即执行函数里面。模块的输出值放在 module.exports 之中,这样就实现了模块的加载。

 

2、Browserify 的实现

知道了原理,就能做出工具了。Browserify 是目前最常用的 CommonJS 格式转换的工具。

请看一个例子,main.js 模块加载 foo.js 模块。

 

// foo.js
module.exports = function(x) {
  console.log(x);};// main.jsvar foo = require("./foo");foo("Hi");

 

使用下面的命令,就能将main.js转为浏览器可用的格式。

 

$ browserify main.js > compiled.js

 

Browserify到底做了什么?安装一下browser-unpack,就能看清楚了。

 

$ npm install browser-unpack -g

 

然后,将前面生成的compile.js解包。

 

$ browser-unpack < compiled.js[  {    "id":1,    "source":"module.exports = function(x) {\n  console.log(x);\n};",    "deps":{}  },  {    "id":2,    "source":"var foo = require(\"./foo\");\nfoo(\"Hi\");",    "deps":{"./foo":1},    "entry":true  }]

 

可以看到,browerify 将所有模块放入一个数组,id 属性是模块的编号,source 属性是模块的源码,deps 属性是模块的依赖。

 

因为 main.js 里面加载了 foo.js,所以 deps 属性就指定 ./foo 对应1号模块。执行的时候,浏览器遇到 require('./foo') 语句,就自动执行1号模块的 source 属性,并将执行后的 module.exports 属性值输出。

 

3、Tiny Browser Require

虽然 Browserify 很强大,但不能在浏览器里操作,有时就很不方便。

 

我根据 mocha 的内部实现,做了一个纯浏览器的 CommonJS 模块加载器 tiny-browser-require 。完全不需要命令行,直接放进浏览器即可,所有代码只有30多行。

 

 

它的逻辑非常简单,就是把模块读入数组,加载路径就是模块的id。

 

function require(p){  var path = require.resolve(p);  var mod = require.modules[path];  if (!mod) throw new Error('failed to require "' + p + '"');  if (!mod.exports) {
    mod.exports = {};
    mod.call(mod.exports, mod, mod.exports, require.relative(path));  }  return mod.exports;}

require.modules = {};

require.resolve = function (path){  var orig = path;  var reg = path + '.js';  var index = path + '/index.js';  return require.modules[reg] && reg    || require.modules[index] && index    || orig;};

require.register = function (path, fn){
  require.modules[path] = fn;};

require.relative = function (parent) {  return function(p){    if ('.' != p.charAt(0)) return require(p);    var path = parent.split('/');    var segs = p.split('/');
    path.pop();    for (var i = 0; i < segs.length; i++) {      var seg = segs[i];      if ('..' == seg) path.pop();      else if ('.' != seg) path.push(seg);    }    return require(path.join('/'));  };};

 

使用的时候,先将上面的代码放入页面。然后,将模块放在如下的立即执行函数里面,就可以调用了。

 

<script src="require.js" />

<script>
require.register("moduleId", function(module, exports, require){
  // Module code goes here
});
var result = require("moduleId");
</script>

 

还是以前面的 main.js 加载 foo.js 为例。

 

require.register("./foo.js", function(module, exports, require){
  module.exports = function(x) {
    console.log(x);  };});var foo = require("./foo.js");foo("Hi");

 

注意,这个库只模拟了 require 、module 、exports 三个变量,如果模块还用到了 global 或者其他 Node 专有变量(比如 process),就通过立即执行函数提供即可。

二、AMD

基于commonJS规范的nodeJS出来以后,服务端的模块概念已经形成很自然地,大家就想要客户端模块。而且最好两者能够兼容,一个模块不用修改,在服务器和浏览器都可以运行。但是,由于一个重大的局限,使得CommonJS规范不适用于浏览器环境。还是上面的代码,如果在浏览器中运行,会有一个很大的问题,你能看出来吗?

 

  var math = require('math');

  math.add(2, 3);

 

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

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

 

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

 

CommonJS是主要为了JS在后端的表现制定的,他是不适合前端的,AMD(异步模块定义)出现了,它就主要为前端JS的表现制定规范。

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

RequireJS就是实现了AMD规范的呢。

详细概括:下面以RequireJS为例说明AMD规范

一、为什么要用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文件之间存在依赖关系,因此必须严格保证加载顺序(比如上例的1.js要在2.js的前面),依赖性最大的模块一定要放到最后加载,当依赖关系很复杂的时候,代码的编写和维护都会变得困难。

 

require.js的诞生,就是为了解决这两个问题:

 

  

  (1)实现js文件的异步加载,避免网页失去响应;

  (2)管理模块之间的依赖性,便于代码的编写和维护。

 

二、require.js的加载

 

使用require.js的第一步,是先去官方网站下载最新版本。

 

下载后,假定把它放在js子目录下面,就可以加载了。

 

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

 

有人可能会想到,加载这个文件,也可能造成网页失去响应。解决办法有两个,一个是把它放在网页底部加载,另一个是写成下面这样:

 

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

 

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

 

加载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,我把它称为"主模块",意思是整个网页的入口代码。它有点像C语言的main()函数,所有代码都从这儿开始运行。

 

下面就来看,怎么写main.js。

 

如果我们的代码不依赖任何其他模块,那么可以直接写入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,浏览器不会失去响应;它指定的回调函数,只有前面的模块都加载成功后,才会运行,解决了依赖性的问题。

 

下面,我们看一个实际的例子。

 

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

 

  require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){

    // some code here

  });

 

require.js会先加载jQuery、underscore和backbone,然后再运行回调函数。主模块的代码就写在回调函数中。

 

四、模块的加载

 

上一节最后的示例中,主模块的依赖模块是['jquery', 'underscore', 'backbone']。默认情况下,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目录,则有两种写法。一种是逐一指定路径。

 

  require.config({

    paths: {

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

    }

  });

 

另一种则是直接改变基目录(baseUrl)。

 

  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请求数。

 

五、AMD模块的写法

 

require.js加载的模块,采用AMD规范。也就是说,模块必须按照AMD的规定来写。

 

具体来说,就是模块必须采用特定的define()函数来定义。如果一个模块不依赖其他模块,那么可以直接定义在define()函数之中。

 

假定现在有一个math.js文件,它定义了一个math模块。那么,math.js就要这样写:

 

  // math.js

  define(function (){

    var add = function (x,y){

      return x+y;

    };

    return {

      add: add
    };

  });

 

加载方法如下:

 

  // main.js

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

    alert(math.add(1,1));

  });

 

如果这个模块还依赖其他模块,那么define()函数的第一个参数,必须是一个数组,指明该模块的依赖性。

 

  define(['myLib'], function(myLib){

    function foo(){

      myLib.doSomething();

    }

    return {

      foo : foo

    };

  });

 

当require()函数加载上面这个模块的时候,就会先加载myLib.js文件。

 

六、加载非规范的模块

 

理论上,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数组,表明该模块的依赖性。

 

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

 

  shim: {

    'jquery.scroll': {

      deps: ['jquery'],

      exports: 'jQuery.fn.scroll'

    }

  }

 

七、require.js插件

 

require.js还提供一系列插件,实现一些特定的功能。

 

domready插件,可以让回调函数在页面DOM结构加载完成后再运行。

 

  require(['domready!'], function (doc){

    // called once the DOM is ready

  });

 

text和image插件,则是允许require.js加载文本和图片文件。

 

  define([

    'text!review.txt',

    'image!cat.jpg'

    ],

    function(review,cat){

      console.log(review);

      document.body.appendChild(cat);

    }

  );

 

类似的插件还有json和mdown,用于加载json文件和markdown文件。(完)

 

另一个人的概括(有点简单):

AMD就只有一个接口:define(id?,dependencies?,factory);

 

它要在声明模块的时候制定所有的依赖(dep),并且还要当做形参传到factory中,像这样:

 

1 define(['dep1','dep2'],function(dep1,dep2){...});

 

要是没什么依赖,就定义简单的模块,下面这样就可以啦:

 

复制代码
1 define(function(){
2     var exports = {};
3     exports.method = function(){...};
4     return exports;
5 });
复制代码

 

咦,这里有define,把东西包装起来啦,那Node实现中怎么没看到有define关键字呢,它也要把东西包装起来呀,其实吧,只是Node隐式包装了而已…..

这有AMD的WIKI中文版,讲了很多蛮详细的东西,用到的时候可以查看:AMD的WIKI中文版

三、CMD

大名远扬的玉伯写了seajs,就是遵循他提出的CMD规范,与AMD蛮相近的,不过用起来感觉更加方便些,最重要的是中文版,应有尽有:seajs官方doc

1 define(function(require,exports,module){...});

用过seajs吧,这个不陌生吧,对吧。

前面说AMD,说RequireJS实现了AMD,CMD看起来与AMD好像呀,那RequireJS与SeaJS像不像呢?

虽然CMD与AMD蛮像的,但区别还是挺明显的,官方非官方都有阐述和理解,我觉得吧,说的都挺好:

官方阐述SeaJS与RequireJS异同

SeaJS与RequireJS的最大异同(这个说的也挺好)

 

以上这些只是为了学习做的总结,有部分摘自大牛原话,本人只是为了学习方便做的笔记,如有侵权,联系必删,致敬大牛!

ajax返回的页面中绑定事件

当我们通过ajax返回的值,构造页面或者生成新的元素的时候,默认的事件监听是不起作用的。

比如

$('.next').click(function(){
    alert('点击next按钮');
});

当我们在页面上新生成的按钮

<button class="next">点击我啊</button>

我们点击并不会触发alert()事件,因为这个元素是后添加到dom树上的,我们想要监听这个事件,需要修改我们的代码。

$(document).on('click','.next',function(){
    alert('点击next按钮了');
})

有言评论自定义js

UYAN.addCmt2 = UYAN.addCmt;
UYAN.addCmt = function(e, a, b) {
    UYAN.addCmt2(e, a, b);
    $("#uyan_box_cnt div:eq(0) span").html("<label style='color:red;font-size:20px;'>登陆</label>");
    $("#uyan_box_cnt div:eq(1) h2").html("<label>点击图标登陆</label>");
 }
                               
UYAN.addCCmt2 = UYAN.addCCmt;
UYAN.addCCmt = function (e,a){
    UYAN.addCCmt2(e,a);
    $(".uyan_cmt_uname").attr('href','javascript:;');
    $("#uyan_cmt_list div div a").attr('href','javascript:;');  
}

我们通过js劫持有言函数,将原来的功能进行劫持

javascript 数组比较最大值易错点

下面是一个求数组最大值的例子,输出的结果会是什么呢?

var tmp = new Array('1','12','4','124','9','8','22228','456');

var max = tmp[0];

for(var i=1;i<tmp.length;i++){ 

  if(max<tmp[i]){

    max=tmp[i];
  }

}

console.log(max);

如果不仔细分析,会认为是22228,结果却是9。

这是因为数组中的元素加了引号,是字符串,我们需要将他进行转换成数值。

var tmp = new Array('1','12','4','124','9','8','22228','456');

var max = paresInt(tmp[0]);

for(var i=1;i<tmp.length;i++){ 

  if(max<paresInt(tmp[i])){

    max=paresInt(tmp[i]);
  }

}