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/】

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。