require的按需加载

原文：http://www.cnblogs.com/chenxizhang/archive/2013/05/16/3081941.html

针对脚本的按需加载

我们可以想象一下，一个真正的网站项目中，会有各种各样的脚本文件，其中还包含很多基础的框架（例如jquery,knockoutjs 等），这些脚本文件可能都或多或少需要在页面中引用。问题在于，如果页面一多起来，或者复杂起来，我们可能不太能准确地知道某个页面是否真的需要某个脚本。（难道不是这样吗？），一个蹩脚的解决方案是，那么就在母版页中，一次性将所有可能用到的框架脚本都引用进来吧。你是这样做的吗？

如果你真的这样做，那么，可能可以一时地解决问题。但实际上存在一个问题，在某些页面上，可能只用到一个脚本库，但为了你的方便，以后都需要全部加载所有的脚本库了。

随着项目的进一步开发，脚本之间的依赖会进一步复杂，要维护这些脚本确实是一个大问题。

在当年雅虎的团队写下这条原则的时候，他们提到了一个他们自己开发的组件来实现按需加载脚本，这个组件叫做GET，是包含在YUI这套工具包中的。http://yuilibrary.com/yui/docs/get/  ，它的意思就是可以动态地，按需加载脚本和样式表。

我对YUI的研究并不太多，而实际上这几年，Javascript这方面的技术突飞猛进，涌现了更多的创新性的设计。例如我今天要讲的requirejs。

我通过一个简单的例子给大家来讲解吧

这里有一个简单的网站，首页叫Default.aspx。根据我们的设计，这个页面需要加载jquery，以及可能的其他一些库，然后执行自己的一些逻辑。所以，我们会有如下的脚本引用

    <!--传统的做法中，我们需要在页面中添加所有的脚本引用，有时候可能会加载一些不必要的脚本-->
    <script src="Scripts/jquery-2.0.0.min.js"></script>
    <script src="Scripts/knockout-2.2.1.js"></script>
    <script src="Scripts/default.js"></script>

这样做有什么问题吗？当然不是。只不过如我们之前所谈到的那样，这种预先加载所有脚本的方式，可能造成资源的浪费，而且这么多脚本引用在页面中，很容易引起混淆。为了更好地说明这一点，我给大家演示一个真实的场景：

1. 我们希望页面在加载的时候，只下载jquery这个库
2. 只有当用户点击了页面上面的那个按钮，我们才去下载knockout这个库

瞧！这就是所谓的按需加载。那么来看看我们将如何使用requirejs实现这个需求吧？

首先，你可以通过Nuget Package Manager 获取requirejs这个库。

然后，在页面中，你只需要像下面这样定义脚本引用。（以后，你的页面中也只需要有这样一个引用）

    <script src="Scripts/require.js" data-main="scripts/default"></script>

这里的data-main指的是主脚本。require.js会首先下载的一个脚本。你确实可以写成下面这样

    <script src="Scripts/require.js" data-main="scripts/default.js"></script>

但是，正如你所见，.js是可以省略掉的。

接下来在default.js中，应该如何写脚本呢？下面是一个简单的例子

/// <reference path="require.js" />
/// <reference path="jquery-2.0.0.js" />
/// <reference path="knockout-2.2.1.js" />


//对requirejs进行一些基本配置
requirejs.config({
    paths: {
        jquery: "jquery-2.0.0.min" //指定一个路径别名
        , knockout: "knockout-2.2.1"
    }
});


//声明下面的代码是需要jquery这个库的
require(['jquery'], function () {
    $(function () {
        alert("Hello,jquery!");
    });
});

 

我们看到，第一部分是对requirejs的基本配置，我们定义了两个别名。然后在第二部分，我们声明了下面的代码是需要jquery这个库的。

将页面运行起来之后，在浏览器中我们可以监控得到脚本下载的行为如下

如我们设想的那样，先加载了require.js，然后加载了default.js， 然后才是加载了jquery.js

有点意思，不是吗？虽然最后的结果也是加载了jquery，但这个加载方式与直接在页面中定义引用有着本质的区别，这是按需加载的。如果你对此还不太赞同，那么看了下面的例子，我相信你一定会同意的。

我们需要在default.js这个文件中，为页面上的那个按钮订阅点击事件，而且我们希望，只有当用户真的点击过了按钮，才会下载另外一个脚本（knockout），看看如何实现这个需求吧？

/// <reference path="require.js" />
/// <reference path="jquery-2.0.0.js" />
/// <reference path="knockout-2.2.1.js" />


//对requirejs进行一些基本配置
requirejs.config({
    paths: {
        jquery: "jquery-2.0.0.min" //指定一个路径别名
        , knockout: "knockout-2.2.1"
    }
});



//声明下面的代码是需要jquery这个库的
require(['jquery'], function ($) {
    $(function () {
        //只有用户点击了某个按钮，才动态加载knockoutjs
        $("#test").click(
            function () {
                require(['knockout'], function (ko) {
                    alert(ko.version);
                });
            }
        );
    });
});

同样的，我们可以通过浏览器监控工具了解脚本下载的流程：

页面加载的时候，仍然只有三个脚本下载了

但是，如果点击了按钮，则会有第四个脚本下载

同时，从下面的对话框来看，也可以断定确实是执行了相应的脚本的。因为我们当前使用的knockout脚本的版本确实是2.2.1。

这的确是一个很不错的机制。如果大家有兴趣，还可以继续深入研究，现在jquery为了更好地满足动态加载和按需加载的需要，甚至都提供了模块化的版本。请参考 http://projects.jga.me/jquery-builder/

 

针对样式表文件的按需加载

我相信按需加载脚本文件这样的设计，足够引起你的兴趣了。很自然地，你可能会有这样一个问题，能不能实现对样式表的按需加载呢？

听起来不错，而且应该也不难，但目前没有现成的实现。当然YUI中的GET是可以用的。

requirejs的官方有一个解释，有兴趣可以参考一下  http://requirejs.org/docs/faq-advanced.html#css

他们也提供了一个建议的脚本来按需加载样式表

function loadCss(url) {
    var link = document.createElement("link");
    link.type = "text/css";
    link.rel = "stylesheet";
    link.href = url;
    document.getElementsByTagName("head")[0].appendChild(link);
}

你可以将这个脚本访问任何的地方，进行调用。例如我是下面这样做的

/// <reference path="require.js" />
/// <reference path="jquery-2.0.0.js" />
/// <reference path="knockout-2.2.1.js" />


//对requirejs进行一些基本配置
requirejs.config({
    paths: {
        jquery: "jquery-2.0.0.min" //指定一个路径别名
        , knockout: "knockout-2.2.1"
    }
});



//声明下面的代码是需要jquery这个库的
require(['jquery'], function ($) {
    $(function () {
        //只有用户点击了某个按钮，才动态加载knockoutjs
        $("#test").click(
            function () {
                loadCss('default.css');

                require(['knockout'], function (ko) {
                    alert(ko.version);
                });
            }
        );
    });
});



function loadCss(url) {
    var link = document.createElement("link");
    link.type = "text/css";
    link.rel = "stylesheet";
    link.href = url;
    document.getElementsByTagName("head")[0].appendChild(link);
}

 

针对图片的按需加载

本文的最后一部分我们来谈谈图片的按需加载的问题。如果你的页面包含了大量的图片，掌握这个原则将非常有助于提高网页的加载速度。

大家可以设想一下图片搜索引擎的结果页面，例如 https://www.google.com/search?newwindow=1&site=&tbm=isch&source=hp&biw=1468&bih=773&q=microsoft&oq=microsoft&gs_l=img.3...1779.4076.0.4399.9.7.0.0.0.0.0.0..0.0...0.0...1ac.1j4.12.img.aajYF7y8xW8

我在images.google.com中搜索microsoft，毫无疑问，这会返回成千上万张图片。

那么，这些图片是不是要一次性全部加载进来呢？显然不可能，你可能会说，应该做分页会不会好一些？分页通常是一个好技术，但在搜索引擎的页面中，分页不是一个很好的选择（作为用户并不见得愿意去点击页面导航按钮），目前主流的是图片搜索引擎的做法都是不采用分页，而是随着用户的滚动条滑动来按需获取图片。

这是一个相当重要的设计，但稍微思考一下，应该不是很简单的一个工作。幸运的是，雅虎的团队提供了一个很好的组件(ImageLoader)可以直接使用：http://yuilibrary.com/yui/docs/imageloader/ 

关于这个组件的用法，有几个在线的演示页面：

• Basic Features of the ImageLoader Utility
• Loading Images Below the Fold
• Using ImageLoader with CSS Class Names

如果你习惯用jquery,那么可以参考一下下面这个说明

http://www.appelsiini.net/projects/lazyload