RequireJS -Javascript模块化（1、简介）

时间 2019-11-10

标签 requirejs javascript 模块化简介栏目 JavaScript 繁體版

原文原文链接

一、认识RequireJSjavascript

RequireJs官网（http://requirejs.org/）的描述：html

RequireJS is a JavaScript file and module loader. It is optimized for in-browser use, but it can be used in other JavaScript environments, like Rhino and Node. Using a modular script loader like RequireJS will improve the speed and quality of your code.java

RequireJS是一个用来加载模块的js文件，它是在浏览器端的一个优化设计，同时它可以在其余js环境下使用，好比Rhino和Node，使用相似于RequireJS的js模块加载器可以提高您的代码执行速度和质量jquery

二、使用RequireJS数组

（1）平时咱们引用js的方式浏览器

index.html异步

<!DOCTYPE html>
<html>

<head>
<meta charset="utf-8" />
<script type="text/javascript" src="js/my/dr.js"></script>
<title></title>
</head>

<body>
<p>this is index.html</p>
<script>
console.log("dr.version: "+dr.version);
</script>
</body>

</html>

js/my/dr.jsasync

! function(window) {
　　var dr = {};
　　dr.version = "v1.0";
　　window.dr = dr;

}(window);

控制台输出

dr.version: v1.0

（2）引用requirejs的方式ide

一个简单的例子：函数

目录结构：

index.html

<!DOCTYPE html>
<html>

    <head>
        <meta charset="utf-8" />
        <script type="text/javascript" src="js/require.js" data-main="js/main"></script>
        <title></title>
    </head>

    <body>
        <p>this is index.html</p>
    </body>

</html>

js/my/dr.js

! function(window) {
　　 var dr = {};
    dr.version = "v1.0";

    window.dr = dr;

    define(function() { return dr; });

}(window);

js/main.js

require.config({
    baseUrl: "js",
    paths: {
        dr: "my/dr"
    }
})

require(["dr"], function(dr) {
    if (dr) {
        console.log("dr.js is ready!");
　　　　 console.log("dr.version: " + dr.version);
    }
})

测试，控制台输出：

dr.js is ready!
dr.version: v1.0

一、看下index.html。

　　在<head>标签中引入了require的js文件，并指明属性 data-main="js/main.js"，这个属性至关于指明了RequireJs的入口，与java中的mian方法类似（这个属性的值能够直接写成"js/main"，require会自动去找js下的main.js文件）。

二、看下RequireJs的“入口”main.js。

　　require.config()：配置require的基本信息。

　　　　baseUrl若是不指定的话，那默认为main.js的文件夹路径，即"js"，咱们的代码中写不写baseUrl属性都无所谓，由于咱们与main的文件夹路径是一致的；

　　　　path：咱们要引用的js文件和路径，若是要引用多个js文件，追加便可，可是这里咱们引用的js文件中必须符合AMD规范（异步模块加载机制）才能够，简单的说就是必须有define()方法。

　　require()：两个参数，第一个是数组，里面存放咱们要引用的js文件的名称，与上面config方法中的paths中的名称对应，第二个是引用完成后的回调函数，在这个函数中有个参数，这个参数值就是js文件中define()方法的返回值。

三、看下dr.js

! function(window) {
    var dr = {};
    dr.version = "v1.0";

    window.dr = dr;

    define(function() { return dr; });

}(window);

这个跟以前（1）平时咱们引用js的方式相比，多了一个define函数（斜体部分），这个函数返回了dr对象。这样才符合AMD规范，咱们在main.js的require()的回调函数中才能获得dr.version的值。

简单的总结下：

一、在咱们须要引用的js文件中定义define()方法，返回某个对象。

二、编写main.js方法（固然名字写成什么均可以，只要在index引用RequireJs文件的时候指明属性data-main的值为对应的main.js便可）。编写配置文件（指定baseUrl，paths里面存放咱们要引用的js文件，这里js文件都是做为module的方式被require异步加载）

三、在index.html中引入requirejs文件，指明require入口，在页面中使用便可。

下面是我加载两个模块的例子（dr.js和jquery.js），很简单，各位一眼就能看懂的。

目录结构：

（配图有误，后面测试的时候将jquery文件夹修改成了jq）

按照步骤来：

一、在dr.js和jquery.js中编写define()方法。dr.js咱们刚刚已经写过了，这里不改动；jquery呢？看下jquery源码：

// Expose jQuery as an AMD module, but only for AMD loaders that
// understand the issues with loading multiple versions of jQuery
// in a page that all might call define(). The loader will indicate
// they have special allowances for multiple jQuery versions by
// specifying define.amd.jQuery = true. Register as a named module,
// since jQuery can be concatenated with other files that may use define,
// but not use a proper concatenation script that understands anonymous
// AMD modules. A named AMD is safest and most robust way to register.
// Lowercase jquery is used because AMD module names are derived from
// file names, and jQuery is normally delivered in a lowercase file name.
// Do this after creating the global so that if an AMD module wants to call
// noConflict to hide this version of jQuery, it will work.
if ( typeof define === "function" && define.amd && define.amd.jQuery ) {
    define( "jquery", [], function () { return jQuery; } );
}

已经看到jquery已经写好了，将jQuery作一个异步加载的module实现。

二、编写main.js，在paths中添加jquery的配置，名称为“jquery”，路径是“jq/jquery”，表明着引入"js/jq/"下的jquery.js文件，注意：这里的路径不能写后缀".js"；在require中添加jquery的模块。

require.config({
    baseUrl: "js",
    paths: {
        jquery: "jq/jquery",
        dr: "my/dr"
    }
})

require(["jquery", "dr"], function($, dr) {
    if ($) {
        console.info("jquery is ready!");
        console.log("jquery version: "+$().jquery);
    }
    if (dr) {
        console.info("dr.js is ready!");
        console.log("dr.version: " + dr.version)
    }
})

三、index.html，增长一个按钮，用于测试jquery和dr是否正确引入

<!DOCTYPE html>
<html>

    <head>
        <meta charset="utf-8" />
        <script type="text/javascript" src="js/require.js" data-main="js/main.js" async="async" defer="defer"></script>
        <title></title>
    </head>

    <body>
        <p>this is index.html</p>
        <button onclick="getVersion();">获取版本</button>
        <script>
            function getVersion() {
                console.log("index-->jquery version: " + $().jquery);
                console.log("index-->dr version: " + dr.version);
            }
        </script>
    </body>

</html>

测试：

jquery is ready!
jquery version: 1.9.1
dr.js is ready!
dr.version: v1.0

//点击button按钮时候控制台输出
index-->jquery version: 1.9.1
index-->dr version: v1.0

这里存在一个问题，很大的问题：若是咱们把getVersion()的function包装去掉，直接在script中写

console.log("index-->jquery version: " + $().jquery);

或者

console.log("index-->dr version: " + dr.version);

会发生什么呢？

Uncaught ReferenceError: $ is not defined

jquery is ready!
jquery version: 1.9.1
dr.js is ready!
dr.version: v1.0

或者

Uncaught ReferenceError: dr is not defined

jquery is ready!
jquery version: 1.9.1
dr.js is ready!
dr.version: v1.0

问题的根源在于，在requirejs异步加载jquery和dr的时候，index.html的文档流已经读完了，因此发生了错误，以后又异步获取到了require加载jquery和dr完成的回调函数。