前端模块化：RequireJS

前言

前端模块化能解决什么问题？

模块的版本管理
提高可维护性 -- 通过模块化，可以让每个文件职责单一，非常有利于代码的维护
按需加载 -- 提高显示效率
更好的依赖处理 -- 传统的开发模式，如果B依赖A，那么必须在B文件前面先加载好A。如果使用了模块化，只需要在模块内部申明依赖即可。

AMD规范 & CMD规范

说到前端模块化，就不得不提AMD规范（中文版、英文版）和CMD规范（英文版）

它们的区别：

http://www.zhihu.com/question/20351507

http://www.cnblogs.com/tugenhua0707/p/3507957.html

AMD规范是 RequireJS 在推广过程中对模块定义的规范化产出，所以我在这里重点介绍下 AMD规范。

AMD规范全名异步模块定义（Asynchronous Module Definition）规范，让模块和依赖可以异步加载。

主要API：

define(id?, dependencies?, factory);

id,字符串，定义中模块的名字，可选参数（没有提供，则默认为模块加载器请求的指定脚本的名字），如果提供，那么模块名必须是顶级和绝对的（不允许相对名字）

dependencies，数组，模块的依赖，可选参数

factory，函数或对象，必选参数。

RequireJS

RequireJS是一个JS的文件和模块加载器。专门为浏览器优化，同时也支持其他JS环境。

使用RequireJS

要想使用requireJS，首先需要在页面引入脚本：

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

接下来，书写脚本：

<script>

    requirejs(['js/a'], function(a){

        alert(a.test);

    });

</script>

再来看看a.js:

define({

  test: 'aa'

});

html代码如下：

<!DOCTYPE html>

<html>

    <head>

        <title>RequireJS Demo</title>

        <meta name="viewport" content="width=device-width, initial-scale=1">

        <meta http-equiv="X-UA-Compatible" content="chrome=1">

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

    </head>

    <body>

        <script>

            requirejs(['assets/js/a'], function(a){

                alert(a.test);

            });

        </script>

    </body>

</html>

在浏览器中打开后，弹出aa。

在实践这个简单示例的时候，需要注意requireJS的baseUrl 设置：

细节之处

1、RequireJS 加载文件/模块都是相对于baseUrl的

2、baseUrl默认使用data-main属性指定的脚本目录

//baseUrl="assets/"

<script data-main="assets/main" src="assets/vendor/require/require.js"></script>

//baseUrl="assets/js/"

<script data-main="assets/js/main" src="assets/vendor/require/require.js"></script>

3、如果没有data-main属性，那么baseUrl等于该html所在的目录

4、baseUrl可以通过RequireJS config进行设置

5、优先级：config > data-main属性 -> html目录

6、RequireJS加载JS时，可以不写js后缀

7、加载文件/模块时，会自动包含前缀http或者https

8、可以在config中使用paths配置，指定相对目录

//这是我的项目目录结构

www/

  index.html

  assets/

    js/

      a.js

    vendor/

      require/

        require.js

    main.js

//配置文件

requirejs.config({

    baseUrl: 'assets',

    paths: {

        js: 'js'

    }

});

//可以直接使用js来映射目录，进行文件引用

requirejs(['js/a'], function(a){

  alert(a.test);

});

注意：一定要保证使用paths的时候，一定要放在config之后。通过在配置paths时，如果是直接子目录，不需要斜杠。

9、data-main指定的文件，是requirejs的入口点

定义模块

在requirejs中，我们可以采用多种方式定义模块，如下：

1、简单的键值对:

define({

  color: 'black',

  size: '18px'

});

2、定义函数：

define(function(){

  return {

    color: 'black',

    size: '18px'

  };

});

3、定义函数并使用依赖：

define(['a', 'b'], function(a, b){

  return {

    color: 'black',

    size: '18px',

    alert: function(){

      return a.num + b.num;

    }

  };

});

4、将函数定义为模块：

define(['a', 'b'], function(a, b){

  return function(title){

    return title ? title : a.title + b.title;

  };

});

5、通过简单的CommonJs包装器定义模块：

define(function(require, exports, module){

  var a = require('a'),

      b = require('b');

  return function(){};

});

6、定义包含名字的模块：

define('moduleA', ['a', 'b'], function(a, b){

  //do something...

});

配置项

requirejs.config({

  baseUrl: '', //基地址

  paths: { //路径映射

    'js': '../js'

  },

  bundles: { //

    primary: ['main', 'util'],

    secondary: ['text!secondary.html']

  },

  shim: { //从非模块的js中，导出模块

    jquery: {

      deps: [],

      exports: 'jQuery'

    }

  },

  map: { //方便版本控制

    'some/newmodule': {

      'foo': 'foo1.2'

    },

    'some/oldmodule': {

      'foo': 'foo1.0'

    }

  },

  config: { //配置module

    bar: {

      size: 'large'

    }

  },

  packages: [], //需要从CommonJS packages中加载的模块

  nodeIdCompat: true,

  waitSeconds: 15, // 加载脚本超时时间（秒）

  context: '', //设置上下文名称

  deps:[], //需要加载的依赖

  callback: function(){}, //当deps加载完时执行

  enforceDefine: false, // 是否当脚本没有define时抛出错误

  xhtml: false, //是否使用xhtml创建脚本元素

  urlArgs: 'test=' + (new Date()).getTime(), //配置url参数

  scriptType: 'text/javascript', //设置加载脚本的脚本类型

  skipDataMain: false //是否使用data-main属性

});

*:first-child {
margin-top: 0 !important;
}

body>*:last-child {
margin-bottom: 0 !important;
}

/* BLOCKS
=============================================================================*/

p, blockquote, ul, ol, dl, table, pre {
margin: 15px 0;
}

/* HEADERS
=============================================================================*/

h1, h2, h3, h4, h5, h6 {
margin: 20px 0 10px;
padding: 0;
font-weight: bold;
-webkit-font-smoothing: antialiased;
}

h1 tt, h1 code, h2 tt, h2 code, h3 tt, h3 code, h4 tt, h4 code, h5 tt, h5 code, h6 tt, h6 code {
font-size: inherit;
}

h1 {
font-size: 28px;
color: #000;
}

h2 {
font-size: 24px;
border-bottom: 1px solid #ccc;
color: #000;
}

h3 {
font-size: 18px;
}

h4 {
font-size: 16px;
}

h5 {
font-size: 14px;
}

h6 {
color: #777;
font-size: 14px;
}

body>h2:first-child, body>h1:first-child, body>h1:first-child+h2, body>h3:first-child, body>h4:first-child, body>h5:first-child, body>h6:first-child {
margin-top: 0;
padding-top: 0;
}

a:first-child h1, a:first-child h2, a:first-child h3, a:first-child h4, a:first-child h5, a:first-child h6 {
margin-top: 0;
padding-top: 0;
}

h1+p, h2+p, h3+p, h4+p, h5+p, h6+p {
margin-top: 10px;
}

/* LINKS
=============================================================================*/

a {
color: #4183C4;
text-decoration: none;
}

a:hover {
text-decoration: underline;
}

/* LISTS
=============================================================================*/

ul, ol {
padding-left: 30px;
}

ul li > :first-child,
ol li > :first-child,
ul li ul:first-of-type,
ol li ol:first-of-type,
ul li ol:first-of-type,
ol li ul:first-of-type {
margin-top: 0px;
}

ul ul, ul ol, ol ol, ol ul {
margin-bottom: 0;
}

dl {
padding: 0;
}

dl dt {
font-size: 14px;
font-weight: bold;
font-style: italic;
padding: 0;
margin: 15px 0 5px;
}

dl dt:first-child {
padding: 0;
}

dl dt>:first-child {
margin-top: 0px;
}

dl dt>:last-child {
margin-bottom: 0px;
}

dl dd {
margin: 0 0 15px;
padding: 0 15px;
}

dl dd>:first-child {
margin-top: 0px;
}

dl dd>:last-child {
margin-bottom: 0px;
}

/* CODE
=============================================================================*/

pre, code, tt {
font-size: 12px;
font-family: Consolas, "Liberation Mono", Courier, monospace;
}

code, tt {
margin: 0 0px;
padding: 0px 0px;
white-space: nowrap;
border: 1px solid #eaeaea;
background-color: #f8f8f8;
border-radius: 3px;
}

pre>code {
margin: 0;
padding: 0;
white-space: pre;
border: none;
background: transparent;
}

pre {
background-color: #f8f8f8;
border: 1px solid #ccc;
font-size: 13px;
line-height: 19px;
overflow: auto;
padding: 6px 10px;
border-radius: 3px;
}

pre code, pre tt {
background-color: transparent;
border: none;
}

kbd {
-moz-border-bottom-colors: none;
-moz-border-left-colors: none;
-moz-border-right-colors: none;
-moz-border-top-colors: none;
background-color: #DDDDDD;
background-image: linear-gradient(#F1F1F1, #DDDDDD);
background-repeat: repeat-x;
border-color: #DDDDDD #CCCCCC #CCCCCC #DDDDDD;
border-image: none;
border-radius: 2px 2px 2px 2px;
border-style: solid;
border-width: 1px;
font-family: "Helvetica Neue",Helvetica,Arial,sans-serif;
line-height: 10px;
padding: 1px 4px;
}

/* QUOTES
=============================================================================*/

blockquote {
border-left: 4px solid #DDD;
padding: 0 15px;
color: #777;
}

blockquote>:first-child {
margin-top: 0px;
}

blockquote>:last-child {
margin-bottom: 0px;
}

/* HORIZONTAL RULES
=============================================================================*/

hr {
clear: both;
margin: 15px 0;
height: 0px;
overflow: hidden;
border: none;
background: transparent;
border-bottom: 4px solid #ddd;
padding: 0;
}

/* IMAGES
=============================================================================*/

img {
max-width: 100%
}
-->