RequireJS -Javascript模块化(一、简介)

1、认识RequireJS

RequireJs官网(http://requirejs.org/)的描述:

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.

RequireJS是一个用来加载模块的js文件,它是在浏览器端的一个优化设计,同时它能够在其他js环境下使用,比如Rhino和Node,使用类似于RequireJS的js模块加载器能够提升您的代码执行速度和质量

2、使用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.js

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

window.dr = dr;

}(window);
控制台输出
dr.version: v1.0

(2)引用requirejs的方式

一个简单的例子:

目录结构:

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

1、看下index.html。

  在<head>标签中引入了require的js文件,并指明属性 data-main="js/main.js",这个属性相当于指明了RequireJs的入口,与java中的mian方法相似(这个属性的值可以直接写成"js/main",require会自动去找js下的main.js文件)。

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

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

    baseUrl如果不指定的话,那默认为main.js的文件夹路径,即"js",我们的代码中写不写baseUrl属性都无所谓,因为我们与main的文件夹路径是一致的;

    path:我们要引用的js文件和路径,如果要引用多个js文件,追加即可,但是这里我们引用的js文件中必须符合AMD规范(异步模块加载机制)才可以,简单的说就是必须有define()方法。

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

3、看下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的值。

简单的总结下:

1、在我们需要引用的js文件中定义define()方法,返回某个对象。

2、编写main.js方法(当然名字写成什么都可以,只要在index引用RequireJs文件的时候指明属性data-main的值为对应的main.js即可)。编写配置文件(指定baseUrl,paths里面存放我们要引用的js文件,这里js文件都是作为module的方式被require异步加载)

3、在index.html中引入requirejs文件,指明require入口,在页面中使用即可。

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

目录结构:

(配图有误,后面测试的时候将jquery文件夹修改为了jq)

按照步骤来:

1、在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实现。

2、编写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)
    }
})

3、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完成的回调函数。

 
时间: 2024-11-03 09:15:56

RequireJS -Javascript模块化(一、简介)的相关文章

RequireJS -Javascript模块化(二、模块依赖)

上一篇文章中简单介绍了RequireJs的写法和使用,这节试着写下依赖关系 需求描述:我们经常写自己的js,在元素选择器这方面,我们可能会用jquery的$("#id")id选择器去代替document.getElementById("id")这个原生的js选择器,那么我们的js文件就需要依赖于jquery,通常我们需要在index.html的<head>标签中先引入jquery,然后引入我们的js文件以达到这样的效果,那么如果放在RequireJs中我

使用requireJS实现模块化编程

RequireJS是一个工具库,主要用于客户端的模块管理.他可以让客户端的代码分成一个个模块,实现异步或动态加载,从而提高代码的性能和可维护性.他的模块管理遵守AMD规范(Asynchronous Module Definition). RequireJS的基本思想就是:通过define方法,将代码定义为模块:通过require方法,实现代码的模块加载. 第一步,将requirejs.js文件使用script标签嵌入到网页,然后即可以使用requireJS进行模块化编程. <script dat

该如何理解AMD ,CMD,CommonJS规范--javascript模块化加载学习总结

是一篇关于javascript模块化AMD,CMD,CommonJS的学习总结,作为记录也给同样对三种方式有疑问的童鞋们,有不对或者偏差之处,望各位大神指出,不胜感激. 本篇默认读者大概知道require,seajs的用法(AMD,CMD用法),所以没有加入使用语法. 1.为何而生: 这三个规范都是为javascript模块化加载而生的,都是在用到或者预计要用到某些模块时候加载该模块,使得大量的系统巨大的庞杂的代码得以很好的组织和管理.模块化使得我们在使用和管理代码的时候不那么混乱,而且也方便了

实现一个JavaScript模块化加载器

对任何程序,都存在一个规模的问题,起初我们使用函数来组织不同的模块,但是随着应用规模的不断变大,简单的重构函数并不能顺利的解决问题.尤其对JavaScript程序而言,模块化有助于解决我们在前端开发中面临的越来越复杂的需求. 为什么需要模块化 对开发者而言,有很多理由去将程序拆分为小的代码块.这种模块拆分的过程有助于开发者更清晰的阅读和编写代码,并且能够让编程的过程更多的集中在模块的功能实现上,和算法一样,分而治之的思想有助于提高编程生产率. 在本文中,我们将集中讨论JavaScript的模块化

JavaScript模块化 --- Commonjs、AMD、CMD、es6 modules

随着前端js代码复杂度的提高,JavaScript模块化这个概念便被提出来,前端社区也不断地实现前端模块化,直到es6对其进行了规范,下面就介绍JavaScript模块化. 这篇文章还是希望能给大家一个比较好的思路,即JavaScript模块化是如何一步一步地发展起来的,并且也会主要对这些模块化方式做一个简单的比较. 第一阶段:无模块化 JavaScript最初的作用仅仅是验证表单,后来会添加一些动画,但是这些js代码很多在一个文件中就可以完成了,所以,我们只需要在html文件中添加一个scri

Javascript 模块化开发上线解决方案

最近又换部门了,好频繁地说...于是把这段时间搞的小工具们简单整理了一下,作了一个小的总结.这次用一个简单业务demo来向大家介绍一下Javascript模块化开发的方式和自动化合并压缩的一些自己的处理. 模块化开发已经有一些标准(AMD/CMD)而且现在也算比较普及了,其为开发人员提供了很大的方便.模块化开发可以按结构整理代码,将一些功能分小颗粒来实现,这样的代码维护起来会方便很多,也更灵活,更容易在一定程度上去满足各种需求的变更. 比如这是demo中的代码结构: 先说page目录,这里的每一

JavaScript模块化-require.js,r.js和打包发布

在JavaScript模块化和闭包和JavaScript-Module-Pattern-In-Depth这两篇文章中,提到了模块化的基本思想,但是在实际项目中模块化和项目人员的分工,组建化开发,打包发布,性能优化,工程化管理都有密切的关系,这么重要的事情,在JavaScript大行其道的今天,不可能没有成熟的解决方案,所以从我的实践经验出发,从模块化讲到工程化,分享一下自己的经验. 这篇文章主要是讲require.js和r.js在项目中的使用,不会涉及到工程化问题,对此熟悉的看官可以略过此文.对

使用requireJs进行模块化开发

requireJs使用 requireJs 使用require.js的第一步,是先去官方网站下载最新版本. 下载后,假定把它放在js子目录下面,就可以加载了. <script src="js/require.js"></script> 有人可能会想到,加载这个文件,也可能造成网页失去响应.解决办法有两个,一个是把它放在网页底部加载,另一个是写成下面这样: <script src="js/require.js" defer async=&

javascript高级程序设计--简介

工作一年多了,这一年的收获真是丰富.结识了许多同事朋友,技术网友,学了许多新的技术知识:当然还要感谢我的朋友们,感谢我的第一家公司. 大学主要学的.net,刚毕业那会对javascript的了解几乎就是空白,后来有机会接触了百度地图,开始了javascript学习之路.现在在项目中也能熟练的使用javascript,jquery等技术,可总感觉缺点什么,有些东西你知道是什么,也能写出来,但就是不知道他是什么,他的原理是什么样的.所以才有了现在的想法,系统的学习一遍javascript.---文笔