Javascript模块化编程（三）：require.js的用法

相关文章推荐

粗眉毛的镜子 · 如何准确地使用Metals和VS代码调试器？ ...· 1 年前 ·

博学的煎饼 · MySql字符串拆分实现split功能（字段 ...· 2 年前 ·

愤怒的豆芽 · Web调用网络摄像头及各类错误处理 - ...· 2 年前 ·

狂野的鼠标垫 · java - how to get a ...· 2 年前 ·

有腹肌的猕猴桃 · c# datetime.now wrong ...· 2 年前 ·

这段代码依次加载多个js文件。

这样的写法有很大的缺点。首先，加载的时候，浏览器会停止网页渲染，加载文件越多，网页失去响应的时间就会越长；其次，由于js文件之间存在依赖关系，因此必须严格保证加载顺序（比如上例的1.js要在2.js的前面），依赖性最大的模块一定要放到最后加载，当依赖关系很复杂的时候，代码的编写和维护都会变得困难。

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

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文件。

Backbone并不依赖于jQuery啊，为什么还要写成deps: ['underscore', 'jquery']？

写成exports: 'Backbone'的话，应该怎么使用呢？

require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){
// some code here
require(['jquery', 'underscore', 'Backbone'], function ($, _, Backbone){
// some code here

"jquery": "jquery.min.js",
"underscore": "underscore.min.js",
"backbone": "backbone.min.js"

应该不用加 .js，不然例子不能通过。

看文档的时候看到的：
There may be times when you do want to reference a script directly and not conform to the "baseUrl + paths" rules for finding it. If a module ID has one of the following characterstics, the ID will not be passed through the "baseUrl + paths" configuration, and just be treated like a regular URL that is relative to the document:
*Ends in ".js".
*Starts with a "/".
*Contains an URL protocol, like "http:" or "https:".

表示不太明白，main文件里面把要用到的模块都写上？
那比如有一个页面A，只需要math模块，另外一个页面B，只需要add模块，都写到main文件里面的话，那A,B页面同时都载入了两个模块了吧。

A页面和B页面都可以写各自的main模块啊

我在dojo对js进行打包，生成的文件
require({cache:{"custom/MyModule":function () {
define(["dojo/_base/lang"], function (lang) {
......
......
这个require()里面好像是个map，请问我加载了模块怎么调用模块里面的方法呢

hola，请教个问题啊，使用require的时候，怎么写整个网站的统一入口比较合适啊？我现在是这样的情况，我没有用data-main来写入口，而是在每个页面里分别写自己的require（如下），但是最后发现貌似不用data-main这样的写法，grunt-requirejs不能把加载的模块打包到一起，但是由于每个页面所需的模块不一样，所以不知道怎么写统一的入口，请指教一下哈

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

<script>
require(['scripts/config'], function() {
require(['scripts/album/create']);
</script>

'jquery.colorize': ['jquery'],
'jquery.scroll': ['jquery'],
'backbone.layoutmanager': ['backbone']

Backbone并不依赖于jQuery啊，为什么还要写成deps: ['underscore', 'jquery']？

写成exports: 'Backbone'的话，应该怎么使用呢？

require(['jquery', 'underscore', 'backbone'], function ($, _, Backbone){
// some code here
require(['jquery', 'underscore', 'Backbone'], function ($, _, Backbone){
// some code here
我自己的测试结果是没有什么作用，本来其他的库就是在全局变量中添加一个，比如jQuery会添加window.$,如果require.js已经加载完成了jQurey，那么全局变量的$应该就是jQuery，直接使用$就是了直接都写在全局也没什么影响吧。只有在用的时候写了define(['d'],function(){})才会加载d。全局定义这个只是为了在用的时候少些一些路径。如果没定义jquery的paths，那么每个引用jquery的地方都得这么写： define(['lib/jquery.min'],function($){})

如果定义了paths:
require.config({
paths: {
jquery: 'lib/jquery.min'

那么每个引用jquery的地方就可以这么写了：
define(['jquery'],function($){})

试了一下出现了问题，解决不了：
require.js:168 Uncaught Error: Script error for "../jquery.validate", needed by: messages_zh
http://requirejs.org/docs/errors.html#scripterror

仅仅是配置以下路径吗？方便以后 define的时候只需要写模块名即可，是这样吗？
define定义所依赖的模块可以理解为一个局部的模块吗？只有用到时才会加载
而requirejs(['sys', 'utils', 'ajax'], function(sys, utils, ajax){}
才是页面的主模块，运行文件时即加载

有2个问题一直不太明白：
1：阮老师说，require.js的诞生主要解决2个问题，第一个就是实现js文件的异步加载，避免浏览器失去响应，但是不使用require.js也可以避免浏览器失去响应啊，比如把js文件放到最后，或者使用defer属性，为什么非得使用require呢？
2：阮老师说，require.js的诞生主要解决2个问题，第二个就是管理模块之间的依赖性，这个我倒是认同，不过，有一句话我不太明白，如下（以上原文）：

注意上面这句话：第二个参数是一个回调函数，当前面指定的模块都加载成功后，它将被调用。

当指定的模块都加载后，回调函数才会被调用，那就意味着只要有一个模块没有被加载完毕，回调函数就不会被调用，是这个意思吗？那还是会阻塞其他模块的执行啊，因为会等待模块加载完毕，请大神帮我分析一下，不是很明白

有个问题请大家指教：
我做一个小例子，index.html main.js(主模块) lib文件夹三个是兄弟关系在根目录，jquery-1.12.1.js、underscore.js、
backbone.js 在lib文件夹里。
require.config({
paths:{
'jquery':'lib/jquery-1.12.1'
shim:{
'lib/underscore':{
exports:'underscore'
'lib/backbone':{
exports:'backbone',
deps:['lib/underscore','lib/jquery']

shim属性的写法对吗？deps对应的数组内依赖的模块应该写成 'lib/underscore' 还是 ‘underscore’呢？