requirejs基础教程

时间 2019-11-15

原文原文链接

1、初识requirejs

随着网站功能逐渐丰富，网页中的js也变得愈来愈复杂和臃肿，原有经过script标签来导入一个个的js文件这种方式已经不能知足如今互联网开发模式，咱们须要团队协做、模块复用、单元测试等等一系列复杂的需求。javascript

RequireJS是一个很是小巧的JavaScript模块载入框架，是AMD规范最好的实现者之一。最新版本的RequireJS压缩后只有14K，堪称很是轻量。它还同时能够和其余的框架协同工做，使用RequireJS必将使您的前端代码质量得以提高。html

requirejs能带来什么好处

官方对requirejs的描述：前端

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.java

大体意思：jquery

在浏览器中能够做为js文件的模块加载器，也能够用在Node和Rhino环境，balabala...。这段话描述了requirejs的基本功能"模块化加载"，什么是模块化加载？咱们要从以后的篇幅中一一解释ajax

先来看一段常见的场景，经过示例讲解如何运用requirejsapi

正常编写方式

index.html:数组

1 <!DOCTYPE html>
2 <html>
3     <head>
4         <script type="text/javascript" src="a.js"></script>
5     </head>
6     <body>
7       <span>body</span>
8     </body>
9 </html>

a.js:浏览器

1 function fun1(){
2   alert("it works");
3 }
4 
5 fun1();

可能你更喜欢这样写服务器

1 (function(){
2     function fun1(){
3       alert("it works");
4     }
5 
6     fun1();
7 })()

第二种方法使用了块做用域来申明function防止污染全局变量，本质仍是同样的，当运行上面两种例子时不知道你是否注意到，alert执行的时候，html内容是一片空白的，即<span>body</span>并未被显示，当点击肯定后，才出现，这就是JS阻塞浏览器渲染致使的结果。

requirejs写法

固然首先要到requirejs的网站去下载js -> requirejs.org
index.html:

 1 <!DOCTYPE html>
 2 <html>
 3     <head>
 4         <script type="text/javascript" src="require.js"></script>
 5         <script type="text/javascript">
 6             require(["a"]);
 7         </script>
 8     </head>
 9     <body>
10       <span>body</span>
11     </body>
12 </html>

a.js:

1 define(function(){
2     function fun1(){
3       alert("it works");
4     }
5 
6     fun1();
7 })

浏览器提示了"it works"，说明运行正确，可是有一点不同，此次浏览器并非一片空白，body已经出如今页面中，目前为止能够知道requirejs具备以下优势：

防止js加载阻塞页面渲染
使用程序调用的方式加载js，防止出现以下丑陋的场景

 1 <script type="text/javascript" src="a.js"></script>
 2 <script type="text/javascript" src="b.js"></script>
 3 <script type="text/javascript" src="c.js"></script>
 4 <script type="text/javascript" src="d.js"></script>
 5 <script type="text/javascript" src="e.js"></script>
 6 <script type="text/javascript" src="f.js"></script>
 7 <script type="text/javascript" src="g.js"></script>
 8 <script type="text/javascript" src="h.js"></script>
 9 <script type="text/javascript" src="i.js"></script>
10 <script type="text/javascript" src="j.js"></script>

2、基本知识

基本API

require会定义三个变量：define,require,requirejs，其中require === requirejs，通常使用require更简短

define 从名字就能够看出这个api是用来定义一个模块
require 加载依赖模块，并执行加载完后的回调函数

前一篇中的a.js：

1 define(function(){
2     function fun1(){
3       alert("it works");
4     }
5 
6     fun1();
7 })

经过define函数定义了一个模块，而后在页面中使用：

1 require(["js/a"]);

来加载该模块(注意require中的依赖是一个数组，即便只有一个依赖，你也必须使用数组来定义)，require API的第二个参数是callback，一个function，是用来处理加载完毕后的逻辑，如：

1 require(["js/a"],function(){
2     alert("load finished");
3 })

加载文件

以前的例子中加载模块都是本地js，可是大部分状况下网页须要加载的JS可能来自本地服务器、其余网站或CDN，这样就不能经过这种方式来加载了，咱们以加载一个jquery库为例：

 1 require.config({
 2     // paths属性： 指定各个模块的加载路径
 3     paths : {    
 4         "jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery"]   
 5     }
 6 })
 7 require(["jquery","js/a"],function($){
 8     $(function(){
 9         alert("load finished");  
10     })
11 })

这边涉及了require.config，require.config是用来配置模块加载位置，简单点说就是给模块起一个更短更好记的名字，好比将百度的jquery库地址标记为jquery，这样在require时只须要写["jquery"]就能够加载该js，本地的js咱们也能够这样配置：

 1 require.config({
 2     paths : {
 3         "jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery"],
 4         "a" : "js/a"   
 5     }
 6 })
 7 require(["jquery","a"],function($){
 8     $(function(){
 9         alert("load finished");  
10     })
11 })

经过paths的配置会使咱们的模块名字更精炼，paths还有一个重要的功能，就是能够配置多个路径，若是远程cdn库没有加载成功，能够加载本地的库，如：

 1 require.config({
 2     paths : {
 3         "jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery", "js/jquery"],
 4         "a" : "js/a"   
 5     }
 6 })
 7 require(["jquery","a"],function($){
 8     $(function(){
 9         alert("load finished");  
10     })
11 })

这样配置后，当百度的jquery没有加载成功后，会加载本地js目录下的jquery

在使用requirejs时，加载模块时不用写.js后缀的，固然也是不能写后缀
上面例子中的callback函数中发现有$参数，这个就是依赖的jquery模块的输出变量，若是你依赖多个模块，能够依次写入多个参数来使用：

1 require(["jquery","underscore"],function($, _){
2     $(function(){
3         _.each([1,2,3],alert);
4     })
5 })

若是某个模块不输出变量值，则没有，因此尽可能将输出的模块写在前面，防止位置错乱引起误解

全局配置

上面的例子中重复出现了require.config配置，若是每一个页面中都加入配置，必然显得十分不雅，requirejs提供了一种叫"主数据"的功能，咱们首先建立一个main.js：

1 require.config({
2     paths : {
3         "jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery", "js/jquery"],
4         "a" : "js/a"   
5     }
6 })

而后在页面中使用下面的方式来使用requirejs：

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

解释一下，加载requirejs脚本的script标签加入了data-main属性，这个属性指定的js将在加载完reuqire.js后处理，咱们把require.config的配置加入到data-main后，就可使每个页面都使用这个配置，而后页面中就能够直接使用require来加载全部的短模块名

data-main还有一个重要的功能，当script标签指定data-main属性时，require会默认的将data-main指定的js为根路径，是什么意思呢？如上面的data-main="js/main"设定后，咱们在使用require(['jquery'])后(不配置jquery的paths)，require会自动加载js/jquery.js这个文件，而不是jquery.js，至关于默认配置了：

1 require.config({
2     baseUrl : "js"
3 })

第三方模块

经过require加载的模块通常都须要符合AMD规范即便用define来申明模块，可是部分时候须要加载非AMD规范的js，这时候就须要用到另外一个功能：shim。shim解释起来也比较难理解，shim直接翻译为"垫"，其实也是有这层意思的，目前我主要用在两个地方：

1. 非AMD模块输出，将非标准的AMD模块"垫"成可用的模块，例如：在老版本的jquery中，是没有继承AMD规范的，因此不能直接require["jquery"],这时候就须要shim，好比我要是用underscore类库，可是他并无实现AMD规范，那咱们能够这样配置：

 1 require.config({
 2     /* 
 3     shim属性：
 4          exports值：输出的变量名。代表这个模块外部调用时的名称
 5          deps数组：代表该模块的依赖性
 6     */
 7     shim: {
 8         "underscore" : {
 9             exports : "_";
10         }
11     }
12 })

这样配置后，咱们就能够在其余模块中引用underscore模块：

1 require(["underscore"], function(_){
2     _.each([1,2,3], alert);
3 })

2.插件形式的非AMD模块，咱们常常会用到jquery插件，并且这些插件基本都不符合AMD规范，好比jquery.form插件，这时候就须要将form插件"垫"到jquery中：

 1 require.config({
 2     shim: {
 3         "underscore" : {
 4             exports : "_";
 5         },
 6         "jquery.form" : {
 7             deps : ["jquery"]
 8         }
 9     }
10 })

也能够简写为：

1 require.config({
2     shim: {
3         "underscore" : {
4             exports : "_";
5         },
6         "jquery.form" : ["jquery"]
7     }
8 })

这样配置以后咱们就可使用加载插件后的jquery了

1 require.config(["jquery", "jquery.form"], function($){
2     $(function(){
3         $("#form").ajaxSubmit({...});
4     })
5 })

参考资料1：【http://www.ruanyifeng.com/blog/2012/11/require_js.html】

参考资料2：【http://requirejs.org/】