如何利用Require.Js管理多页面站点文件(译)

英文版地址

最近使用 Require.Js 的时候我发现它确实是一个改善代码管理的一个好方法。我以前发表Backbone类的文章时曾提到过 Require，但此前，我从未在传统的多页面网站内使用到 Require。在多页面网站里面配置 Require 的过程相当繁琐，所以我想将教程整理出来帮助那些可能会遇到困惑的朋友们。

概述

注意，本文假设你已经熟悉 Require.Js 和基本的配置使用方法，如果不是，建议你先看看官网的手册。

创建一个单页应用 (single-page App) 时，许多人喜欢在发布之前把所有的js文件全部打包编译为一个文件，可以减少断断续续的 http 请求，操作体验简洁明快更像 app，同样的，这种做法增加了首次加载时页面的量级。

部署多页面站点的时候，编译合并所有文件并非一个好方案，因为你不能保证用户会访问到每一个页面，而且加载中的文件会有很多用不到的js，这拖慢了页面渲染速度，用户体验变差。比如说，用户只是访问了Contact页面，那么有必要把About页面要用到的js给加载一遍吗？

完美的情景是每一个页面都有自己的 main 文件用来存放特定页面的方法，外加一个独立文件(最好是缓存起来)用来存放公共 Javascript 库。

例如，你有一个About页面和一个 Contact 页面，于是你新建一个 mian-about.js 和一个 main-contact.js，而且假设 mian-about 和 main-contact 都需要 jQuery 和 underscore。这时，不建议把 jQuery 和 underscore 编译到每一个 main 文件里面，那样会造成不必要的重复和臃肿，我们只用新建一个包含 jQuery 和 underscore 的 common.js 并且保证它在 mian-*.js 文件之前加载就可以了。下表可以加深理解：

common.js

----------------

js/vendor/jquery.js

js/vendor/underscore.js

About

----------------

js/common.js

js/app/main-about.js

Contact

----------------

js/common.js

js/app/main-contact.js

将那些公用的 js 文件编译合并到 common.js 后减少了每个页面的 http 请求，而且，第一个页面加载完毕，common.js 就可以从浏览器缓存里直接读取了。下面我们再来看一个例子。

例子

RequireJS 的作者 James Burke，做了很多有效组织代码，利用 RequireJS Optimizer 压缩优化代码的努力，有些例子是我经常提到的：example-multipage-shim.，example-multipage。但我更喜欢用 shim 版本（它支持非 AMD 方式定义的模块载入）的 RequireJS，因为一个项目里面似乎总有几个非 AMD 的脚本文件。

如果你在用RequireJs创建一个单页站点，那么你可能会这样定义你的script标签：

<!--This sets the baseUrl to the "scripts" directory, and
    loads a script that will have a module ID of 'main'-->
<script data-main="scripts/main.js" src="scripts/require.js"></script>

data-main 属性可以很方便的用来设置 RequireJs 的 baseUrl property，通常，你也可以在 main.js 里面加上一些配置，比如，你要加载一个第三方的js库，你要创建一个路径以便引用。因为模板里的每一个单页的 mian-* 文件都不同，所以，我们可以把配置信息放在 common.js 里：

 //The build will inline common dependencies into this file.

 requirejs.config({
   baseUrl: './js',
   paths: {
     'jquery': 'vendor/jquery',
     'bootstrap': 'vendor/bootstrap'
   },
   shim: {
     'bootstrap': ['jquery']
   }
 });

除了 common.js，我还在 app/models 下创建了BasicModel文件以表明common.js是公用的，并把BasicModel放进common.js里。

编译

编译之前需要有一个 option.js 来指定哪些文件需要编译，哪些不需要：

 module.exports = {
   appDir: 'www',
   baseUrl: 'js/',
   mainConfigFile: 'www/js/common.js',
   dir: 'www-release',
   modules: [
     {
       name: 'common',
       include: [
         'app/models/basicModel',
         'jquery',
         'bootstrap'
       ]
     },
     {
       name: 'app/main-about',
       exclude: ['common']
     },
     {
       name: 'app/main-contact',
       exclude: ['common']
     }
   ]
 };

上面的代码中，首先把所有的文件用 include 方法包含进来，然后把不需要的文件用 exclude 方法排除出去。RequireJs 会根据 exclude 的参数配置理出嵌套依赖关系并把文件排除掉。因为 bootstrap 已经编译合并进 common.js 了，所以不需要单独为 main-about 或 main-contact 再 exclude 掉 bootstrap。

在执行这些操作之前，你需要执行一个 npm 安装。首先你要确保安装了 grunt 工具，安装完成后执行 grunt 命令压缩打包。如果打包顺利完成，会在www-release/build.txt 里看到如下被打包的文件清单：

css/bootstrap-responsive.css
----------------
css/bootstrap-responsive.css

css/bootstrap.css
----------------
css/bootstrap.css

css/style.css
----------------
css/style.css

js/common.js
----------------
js/common.js
js/app/models/basicModel.js
js/vendor/bootstrap.js

js/app/main-about.js
----------------
js/app/models/aboutModel.js
js/app/main-about.js

js/app/main-contact.js
----------------
js/app/models/contactModel.js
js/app/main-contact.js

www-release/common.js 里面试一大块压缩后的代码，代码里就包含了 BasicModel, Bootstrap, jQuery, and 初始配置代码。要配置 about.html ，只需要按下面的顺序加载文件即可：

 <script src="./js/vendor/require.js"></script>
 <script type="text/javascript">
 // Load common code that includes config,
 // then load the app logic for this page.
 require(['./js/common'], function (common) {
   // ./js/common.js sets the baseUrl to be ./js/
   // You can ask for 'app/main-about' here instead
   // of './js/app/main-about'
   require(['app/main-about']);
 });
 </script>

通过层层引入 RequireJs --> common.js --> main-about.js 实现了明晰简便的代码管理方式。

谢谢。

前端技术文章翻译QQ群：338353879