前端知识整理（一）：RequireJs

1.  概念

CommonJs 和 AMD 都是 javascript 模块化规范，node.js的模块系统，就是参照CommonJS规范实现的。在CommonJs中有一个全局方法require（）用来加载模块，假如有一个模块a.js

var a = require('a.js');

由于浏览器端的模块只能采用异步加载，CommonJs不适用于浏览器环境，AMD采用异步方式加载模块，模块的加载不影响它后面语句的运行。所有依赖这个模块的语句，都定义在一个回调函数中，等到加载完成之后，这个回调函数才会运行。

AMD也采用require()语句加载模块，但是不同于CommonJS，它要求两个参数：

require([module], callback);

第一个参数是需要加载的模块，第二个参数是加载成功之后的callback，我们可以将前面的写法替换成AMD规范，可以写成如下形式

require(['a.js'],function(a){
    
})

require.js实现了AMD规范。

2.  require.js 用法

require.js 的出现解决了两个问题：

        （1）实现js文件的异步加载，避免网页失去响应；

        （2）管理模块之间的依赖性，便于代码的编写和维护。

要使用require.js需要先将其引入，

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

为了避免网页失去响应我们可以将其写到最下面，也可以用下面的写法

<script src="js/require.js" defer async="true" ></script>
//async属性表明这个文件需要异步加载，避免网页失去响应。IE不支持这个属性，只支持defer，所以把defer也写上。

接下来需要加载自己的代码，我们需要一个主模块，也就是整个网页的入口文件，假设主模块为main.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应该怎么写呢，如果不依赖其他模块可以直接写入js代码，但是常见的是主模块依赖于其他模块，我们需要使用AMD规范定义的require（）；

// main.js
　　require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC){
　　　　// some code here
　　});

第一个参数是一个数组，表示所依赖的模块，上例就是['moduleA', 'moduleB', 'moduleC']，即主模块依赖这三个模块；第二个参数是一个回调函数，当前面指定的模块都加载成功后，它将被调用。加载的模块会以参数形式传入该函数，从而在回调函数内部就可以使用这些模块。

require()异步加载moduleA，moduleB和moduleC，浏览器不会失去响应；它指定的回调函数，只有前面的模块都加载成功后，才会运行，解决了依赖性的问题。

下面，我们看一个实际的例子，假定主模块依赖jquery、underscore和backbone这三个模块，main.js就可以这样写：

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

3.  模块的加载

上面例子默认['jquery', 'underscore', 'backbone']这三个模块和main.js同一个目录，自动加载。使用require.config()方法，我们可以对模块的加载行为进行自定义。require.config()就写在主模块（main.js）的头部。参数就是一个对象，这个对象的paths属性指定各个模块的加载路径。

如果这些模块在其他目录，比如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"
　　　　}
　　});

4.  模块的写法

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

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

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

// a.js
define(function (){
　　　　var add = function (x,y){
　　　　　　return x+y;
　　　　};
　　　　return {
　　　　　　add: add
　　　　};
　　});

而相对应的加载方法（这里是我们的main.js）就要这样写

// main.js
　　require(['a'], function (math){
　　　　alert(math.add(1,1));
　　});

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

// a.js
define(['b'], function(b){
　　　　function foo(){
　　　　　　myLib.doSomething();
　　　　}
　　　　return {
　　　　　　foo : foo
　　　　};
　　});

当 require() 函数加载上面 a 模块的时候，就会先加载 b.js 文件

5.加载非规范的模块

require.js既能加载符合AMD规范的模块（如jq）也能够加载非规范模块。

这样的模块在用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'
　　　　}
　　}

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

 

文章参考自：http://www.ruanyifeng.com/blog/2012/11/require_js.html 自己整理方便自己学习使用

转载于:https://my.oschina.net/u/3340589/blog/1549111