微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

详解JavaScript模块化开发

什么是模块化开发?

前端开发中,起初只要在script标签中嵌入几十上百行代码就能实现一些基本的交互效果,后来js得到重视,应用也广泛起来了,jQuery,Ajax,Node.Js,MVC,MVVM等的助力也使得前端开发得到重视,也使得前端项目越来越复杂,然而,JavaScript却没有为组织代码提供任何明显帮助,甚至没有类的概念,更不用说模块(module)了,那么什么是模块呢?

一个模块就是实现特定功能文件,有了模块,我们就可以更方便地使用别人的代码,想要什么功能,就加载什么模块。模块开发需要遵循一定的规范,否则就都乱套了。

根据AMD规范,我们可以使用define定义模块,使用require调用模块。

目前,通行的js模块规范主要有两种:Commonjs和AMD。

AMD规范

AMD 即Asynchronous Module DeFinition,中文名是“异步模块定义”的意思。它是一个在浏览器端模块化开发的规范,服务器端的规范是Commonjs

模块将被异步加载,模块加载不影响后面语句的运行。所有依赖某些模块的语句均放置在回调函数中。

AMD 是 RequireJS 在推广过程中对模块定义的规范化的产出。

define() 函数

AMD规范只定义了一个函数 define,它是全局变量函数的描述为:

rush:js;"> define(id?,dependencies?,factory);

参数说明:

id:指定义中模块的名字,可选;如果没有提供该参数,模块的名字应该认为模块加载器请求的指定脚本的名字。如果提供了该参数,模块名必须是“顶级”的和绝对的(不允许相对名字)。

依赖dependencies:是一个当前模块依赖的,已被模块定义的模块标识的数组字面量。 依赖参数是可选的,如果忽略此参数,它应该认为["require","exports","module"]。然而,如果工厂方法的长度属性小于3,加载器会选择以函数的长度属性指定的参数个数调用工厂方法

工厂方法factory,模块初始化要执行的函数或对象。如果为函数,它应该只被执行一次。如果是对象,此对象应该为模块的输出值。

模块名的格式

模块名用来唯一标识定义中模块,它们同样在依赖性数组中使用:

模块名是用正斜杠分割的有意义单词的字符串 单词须为驼峰形式,或者".",".." 模块名不允许文件扩展名的形式,如“.js” 模块名可以为 "相对的" 或 "顶级的"。如果首字符为“.”或“..”则为相对的模块名 顶级的模块名从根命名空间的概念模块解析 相对的模块名从 "require" 书写和调用的模块解析

使用 require 和 exports

创建一个名为"alpha"的模块,使用了require,exports,和名为"beta"的模块:

rush:js;"> define("alpha",["require","beta"],function (require,exports,beta) { exports.verb = function() { return beta.verb(); //Or: return require("beta").verb(); } });

require API 介绍:

AMD规范中文版:

目前,实现AMD的库有RequireJS 、curl 、Dojo 、Nodules 等。

Commonjs规范

Commonjs是服务器端模块的规范,Node.js采用了这个规范。Node.JS首先采用了js模块化的概念。

根据Commonjs规范,一个单独的文件就是一个模块。每一个模块都是一个单独的作用域,也就是说,在该模块内部定义的变量,无法被其他模块读取,除非定义为global对象的属性

输出模块变量的最好方法是使用module.exports对象。

rush:js;"> var i = 1; var max = 30;

module.exports = function () {
for (i -= 1; i++ < max; ) {
console.log(i);
}
max *= 1.1;
};

上面代码通过module.exports对象,定义了一个函数,该函数就是模块外部与内部通信的桥梁。

加载模块使用require方法,该方法读取一个文件并执行,最后返回文件内部的module.exports对象。

Commonjs 规范:

RequireJS和SeaJS

RequireJS由James Burke创建,他也是AMD规范的创始人。

define方法用于定义模块,RequireJS要求每个模块放在一个单独的文件里。

RequireJS 和 Sea.js 都是模块加载器,倡导模块化开发理念,核心价值是让 JavaScript 的模块化开发变得简单自然。

SeaJS与RequireJS最大的区别:

SeaJS对模块的态度是懒执行,而RequireJS对模块的态度是预执行

不明白?看这篇图文并茂的文章吧:

RequireJS API:

RequireJS的用法:

为什么要用requireJS

试想一下,如果一个网页有很多的js文件,那么浏览器在下载该页面的时候会先加载js文件,从而停止了网页的渲染,如果文件越多,浏览器可能失去响应。其次,要保证js文件的依赖性,依赖性最大的模块(文件)要放在最后加载,当依赖关系很复杂的时候,代码的编写和维护都会变得困难。

RequireJS就是为了解决这两个问题而诞生的:

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

RequireJS文件下载:

AMD和CMD

CMD(Common Module Definition) 通用模块定义。该规范明确了模块的基本书写格式和基本交互规则。该规范是在国内发展出来的。AMD是依赖关系前置,CMD是按需加载。

在 CMD 规范中,一个模块就是一个文件。代码的书写格式如下:

factory 为函数时,表示是模块的构造方法。执行该构造方法,可以得到模块向外提供的接口。factory 方法在执行时,默认会传入三个参数:require、exports 和 module:

require是可以把其他模块导入进来的一个参数,而export是可以把模块内的一些属性和方法导出的。

CMD规范地址:

AMD 是 RequireJS 在推广过程中对模块定义的规范化产出。 CMD 是 SeaJS 在推广过程中对模块定义的规范化产出。

对于依赖的模块,AMD 是提前执行,CMD 是延迟执行。

AMD:提前执行(异步加载:依赖先执行)+延迟执行 CMD:延迟执行(运行到需加载,根据顺序执行) CMD 推崇依赖就近,AMD 推崇依赖前置。看如下代码

rush:js;"> // CMD define(function(require,module) { var a = require('./a') a.doSomething() // 此处略去 100 行 var b = require('./b') // 依赖可以就近书写 b.doSomething() // ... })

// AMD 认推荐的是
define(['./a','./b'],function(a,b) { // 依赖必须一开始就写好
a.doSomething()
// 此处略去 100 行
b.doSomething()
...
})

另外一个区别是:

AMD:API根据使用范围有区别,但使用同一个api接口 CMD:每个API的职责单一 AMD的优点是:异步并行加载,在AMD的规范下,同时异步加载是不会产生错误的。 CMD的机制则不同,这种加载方式会产生错误,如果能规范化模块内容形式,也可以

jquery1.7以上版本会自动模块化,支持AMD模式:主要是使用define函数,sea.js虽然是Commonjs规范,但却使用了define来

定义模块

所以jQuery已经自动模块化了

rush:js;"> seajs.config({ 'base':'/','alias':{ 'jquery':'jquery.js'//定义jQuery文件 } });

define函数和AMD的define类似:

rush:js;"> define(function(require,module{ //先要载入jQuery的模块 var $ = require('jquery'); //然后将jQuery对象传给插件模块 require('./cookie')($); //开始使用 $.cookie方法 });

sea.js如何使用?

引入sea.js的库

如何变成模块?

define

3.如何调用模块?

-exports -sea.js.use 4.如何依赖模块?

-require

rush:js;">

sea.js 开发实例

rush:js;"> 鼠标拖拽的模块化开发实践

A同事

rush:js;"> //A同事写的main.js:

define(function (require,module) {
var oInput = document.getElementById('input1');
var oDiv1 = document.getElementById('div1');
var oDiv2 = document.getElementById('div2');
var oDiv3 = document.getElementById('div3');

require('./drag.js').drag(oDiv3);
oInput.onclick = function () {
oDiv1.style.display = 'block';
require('./scale.js').scale(oDiv1,oDiv2);

require.async('./scale.js',function (ex) {
  ex.scale(oDiv1,oDiv2);
})

}
});

B同事

rush:js;"> //B同事写的drag.js:

define(function(require,module){

function drag(obj){
var disX = 0;
var disY = 0;
obj.onmousedown = function(ev){
var ev = ev || window.event;
disX = ev.clientX - obj.offsetLeft;
disY = ev.clientY - obj.offsetTop;

  document.onmousemove = function(ev){
    var ev = ev || window.event;


     var L = require('./range.js').range(ev.clientX - <a href="https://www.jb51.cc/tag/dis/" target="_blank" class="keywords">dis</a>X,document.documentElement.clientWidth - obj.offsetWidth,0 );
     var T = require('./range.js').range(ev.clientY - <a href="https://www.jb51.cc/tag/dis/" target="_blank" class="keywords">dis</a>Y,document.documentElement.clientHeight - obj.offsetHeight,0 );


    obj.style.left = L + 'px';
    obj.style.top = T + 'px';
  };
  document.<a href="https://www.jb51.cc/tag/onmouseup/" target="_blank" class="keywords">onmouseup</a> = function(){
    document.onmousemove = null;
    document.<a href="https://www.jb51.cc/tag/onmouseup/" target="_blank" class="keywords">onmouseup</a> = null;
  };
  return false;
};

}

exports.drag = drag;//对外提供接口

});

C同事

rush:js;"> //C同事写的scale.js:

define(function(require,module){

function scale(obj1,obj2){
var disX = 0;
var disY = 0;
var disW = 0;
var disH = 0;

obj2.onmousedown = function(ev){
  var ev = ev || window.event;
  <a href="https://www.jb51.cc/tag/dis/" target="_blank" class="keywords">dis</a>X = ev.clientX;
  <a href="https://www.jb51.cc/tag/dis/" target="_blank" class="keywords">dis</a>Y = ev.clientY;
  <a href="https://www.jb51.cc/tag/dis/" target="_blank" class="keywords">dis</a>W = obj1.offsetWidth;
  <a href="https://www.jb51.cc/tag/dis/" target="_blank" class="keywords">dis</a>H = obj1.offsetHeight;

  document.onmousemove = function(ev){
    var ev = ev || window.event;

    var W = require('./range.js').range(ev.clientX - <a href="https://www.jb51.cc/tag/dis/" target="_blank" class="keywords">dis</a>X + <a href="https://www.jb51.cc/tag/dis/" target="_blank" class="keywords">dis</a>W,500,100);
    var H = require('./range.js').range(ev.clientY - <a href="https://www.jb51.cc/tag/dis/" target="_blank" class="keywords">dis</a>Y + <a href="https://www.jb51.cc/tag/dis/" target="_blank" class="keywords">dis</a>H,100);

    obj1.style.width = W + 'px';
    obj1.style.height = H + 'px';
  };
  document.<a href="https://www.jb51.cc/tag/onmouseup/" target="_blank" class="keywords">onmouseup</a> = function(){
    document.onmousemove = null;
    document.<a href="https://www.jb51.cc/tag/onmouseup/" target="_blank" class="keywords">onmouseup</a> = null;
  };
  return false;
};

}

exports.scale = scale;

});

D同事

define(function(require,module){

function range(iNum,iMax,iMin){

  if( iNum > iMax ){
    return iMax;
  }
  else if( iNum < iMin ){
    return iMin;
  }
  else{
    return iNum;
  }

}

exports.range = range;

});

requirejs开发实例

require.config是用来定义别名的,在paths属性下配置别名。然后通过requirejs(参数一,参数二);参数一是数组,传入我们需要引用的模块名,第二个参数是个回调函数,回调函数传入一个变量,代替刚才所引入的模块。

main.js文件

rush:js;"> //别名配置 requirejs.config({ paths: { jquery: 'jquery.min' //可以省略.js } }); //引入模块,用变量$表示jquery模块 requirejs(['jquery'],function ($) { $('body').css('background-color','red'); });

引入模块也可以只写require()。requirejs通过define()定义模块,定义的参数上同。在此模块内的方法和变量外部是无法访问的,只有通过return返回才行.

define 模块

rush:js;"> define(['jquery'],function ($) {//引入jQuery模块 return { add: function(x,y){ return x + y; } }; });

将该模块命名为math.js保存。

main.js引入模块方法

rush:js;"> require(['jquery','math'],function ($,math) { console.log(math.add(10,100));//110 });

没有依赖

如果定义的模块不依赖其他模块,则可以:

rush:js;"> define(function () {

return {
name: "trigkit4",age: "21"
}
});

AMD推荐的风格通过返回一个对象做为模块对象,Commonjs的风格通过对module.exports或exports的属性赋值来达到暴露模块对象的目的。

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐