【requirejs】JS模組化工具requirejs教程
初識requirejs
隨著網站功能逐漸豐富，網頁中的js也變得越來越複雜和臃腫，原有通過script標籤來匯入一個個的js檔案這種方式已經不能滿足現在網際網路開發模式，我們需要團隊協作、模組複用、單元測試等等一系列複雜的需求。
RequireJS是一個非常小巧的JavaScript模組載入框架，是AMD規範最好的實現者之一。最新版本的RequireJS壓縮後只有14K，堪稱非常輕量。它還同時可以和其他的框架協同工作，使用RequireJS必將使您的前端程式碼質量得以提升。
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.
大致意思：
在瀏覽器中可以作為js檔案的模組載入器，也可以用在Node和Rhino環境，balabala...。這段話描述了requirejs的基本功能"模組化載入"，什麼是模組化載入？我們要從之後的篇幅中一一解釋
先來看一段常見的場景，通過示例講解如何運用requirejs
正常編寫方式
index.html:
<!DOCTYPE html>
<html>
<head>
<script type="text/javascript" src="a.js"></script>
</head>
<body>
<span>body</span>
</body>
</html>
a.js:
function fun1(){
alert("it works");
}
fun1();
可能你更喜歡這樣寫
(function(){
function fun1(){
alert("it works");
}
fun1();
})()
第二種方法使用了塊作用域來申明function防止汙染全域性變數，本質還是一樣的，當執行上面兩種例子時不知道你是否注意到，alert執行的時候，html內容是一片空白的，即<span>body</span>並未被顯示，當點選確定後，才出現，這就是JS阻塞瀏覽器渲染
requirejs寫法
當然首先要到requirejs的網站去下載js -> requirejs.org
index.html:
<!DOCTYPE html>
<html>
<head>
<script type="text/javascript" src="require.js"></script>
<script type="text/javascript">
require(["a"]);
</script>
</head>
<body>
<span>body</span>
</body>
</html>
a.js:
define(function(){
function fun1(){
alert("it works");
}
fun1();
})
瀏覽器提示了"it works"，說明執行正確，但是有一點不一樣，這次瀏覽器並不是一片空白，body已經出現在頁面中，目前為止可以知道requirejs具有如下優點：
- 防止js載入阻塞頁面渲染
- 使用程式呼叫的方式載入js，防出現如下醜陋的場景
<script type="text/javascript" src="a.js"></script> <script type="text/javascript" src="b.js"></script> <script type="text/javascript" src="c.js"></script> <script type="text/javascript" src="d.js"></script> <script type="text/javascript" src="e.js"></script> <script type="text/javascript" src="f.js"></script> <script type="text/javascript" src="g.js"></script> <script type="text/javascript" src="h.js"></script> <script type="text/javascript" src="i.js"></script> <script type="text/javascript" src="j.js"></script>
require.js解決了兩個問題：
（1）實現js檔案的非同步載入，避免網頁失去響應；
（2）管理模組之間的依賴性，便於程式碼的編寫和維護。
基本知識
基本API
require會定義三個變數：define,require,requirejs，其中require === requirejs，一般使用require更簡短
- define 從名字就可以看出這個api是用來定義一個模組
- require 載入依賴模組，並執行載入完後的回撥函式
前一篇中的a.js：
define(function(){
function fun1(){
alert("it works");
}
fun1();
})
通過define函式定義了一個模組，然後再頁面中使用：
require(["js/a"]);
來載入該模組(注意require中的依賴是一個數組，即使只有一個依賴，你也必須使用陣列來定義)，require API的第二個引數是callback，一個function，是用來處理載入完畢後的邏輯，如：
require(["js/a"],function(){
alert("load finished");
})
require()非同步載入模組，瀏覽器不會失去響應；它指定的回撥函式，只有前面的模組都載入成功後，才會執行，解決了依賴性的問題。
載入檔案
之前的例子中載入模組都是本地js，但是大部分情況下網頁需要載入的JS可能來自本地伺服器、其他網站或CDN，這樣就不能通過這種方式來載入了，我們以載入一個jquery庫為例：
require.config({
paths : {
"jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery"]
}
})
require(["jquery","js/a"],function($){
$(function(){
alert("load finished");
})
})
這邊涉及了require.config，require.config是用來配置模組載入位置，簡單點說就是給模組起一個更短更好記的名字，比如將百度的jquery庫地址標記為jquery，這樣在require時只需要寫["jquery"]就可以載入該js，本地的js我們也可以這樣配置：
require.config({
paths : {
"jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery"],
"a" : "js/a"
}
})
require(["jquery","a"],function($){
$(function(){
alert("load finished");
})
})
通過paths的配置會使我們的模組名字更精煉，paths還有一個重要的功能，就是可以配置多個路徑，如果遠端cdn庫沒有載入成功，可以載入本地的庫，如：
require.config({
paths : {
"jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery", "js/jquery"],
"a" : "js/a"
}
})
require(["jquery","a"],function($){
$(function(){
alert("load finished");
})
})
這樣配置後，當百度的jquery沒有載入成功後，會載入本地js目錄下的jquery
- 在使用requirejs時，載入模組時不用寫
.js字尾的，當然也是不能寫字尾 - 上面例子中的callback函式中發現有
$引數，這個就是依賴的jquery模組的輸出變數，如果你依賴多個模組，可以依次寫入多個引數來使用：
require(["jquery","underscore"],function($, _){
$(function(){
_.each([1,2,3],alert);
})
})
如果某個模組不輸出變數值，則沒有，所以儘量將輸出的模組寫在前面，防止位置錯亂引發誤解
全域性配置
上面的例子中重複出現了require.config配置，如果每個頁面中都加入配置，必然顯得十分不雅，requirejs提供了一種叫"主資料"的功能，我們首先建立一個main.js：
require.config({
paths : {
"jquery" : ["http://libs.baidu.com/jquery/2.0.3/jquery", "js/jquery"],
"a" : "js/a"
}
})
然後再頁面中使用下面的方式來使用requirejs：
<script data-main="js/main" src="js/require.js"></script>
解釋一下，載入 requirejs 指令碼的 script 標籤加入了data-main屬性，這個屬性指定的 js 將在載入完 require.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，相當於預設配置了：
require.config({
baseUrl : "js"
})
第三方模組
通過require載入的模組一般都需要符合AMD規範即使用define來申明模組，具體來說，AMD規範就是模組必須採用特定的define()函式來定義。如果一個模組不依賴其他模組，那麼可以直接定義在define()函式之中。
但是部分時候需要載入非AMD規範的js，這時候就需要用到另一個功能：shim，shim解釋起來也比較難理解，shim直接翻譯為"墊"，其實也是有這層意思的，目前我主要用在兩個地方
1. 非AMD模組輸出，將非標準的AMD模組"墊"成可用的模組，例如：在老版本的jquery中，是沒有繼承AMD規範的，所以不能直接require["jquery"],這時候就需要shim，比如我要是用underscore類庫，但是他並沒有實現AMD規範，那我們可以這樣配置
require.config({
shim: {
"underscore" : {
exports : "_";
}
}
})
這樣配置後，我們就可以在其他模組中引用underscore模組：
require(["underscore"], function(_){
_.each([1,2,3], alert);
})
- 外掛形式的非AMD模組，我們經常會用到jquery外掛，而且這些外掛基本都不符合AMD規範，比如jquery.form外掛，這時候就需要將form外掛"墊"到jquery中：
require.config({
shim: {
"underscore" : {
exports : "_";
},
"jquery.form" : {
deps : ["jquery"]
}
}
})
也可以簡寫為：
require.config({
shim: {
"underscore" : {
exports : "_";
},
"jquery.form" : ["jquery"]
}
})
這樣配置之後我們就可以使用載入外掛後的jquery了
require.config(["jquery", "jquery.form"], function($){
$(function(){
$("#form").ajaxSubmit({...});
})
})
requireJS使用步驟
1、引入requireJS
nuget下載requirejs，在body中通過<script>引入
<script data-main="../scripts/main" src="../../Scripts/require.js"></script>
在require.js 載入完畢時，會自動去載入配置檔案 main.js。
2、基本引數配置
//main.js
require.config({
baseUrl:’’, //定義基準目錄
paths:{ //key/value，key=模組id（自己定義），value=js檔名(不需要.js)
}
})
3、定義模組
我們以後所編寫的程式碼或者是某段功能，都是要放在一個個定義好的模組中。
下面是requireJS定義模組的方法格式：
define([id,deps,] callback);
ID:模組的ID，預設的便是檔名，一般無需使用者自己手動指定。
deps:當前模組所有依賴的模組陣列，陣列的每個陣列元素便是模組名或者叫模組ID。
callback:模組的回撥方法，用於儲存模組具體的功能與程式碼，而這個回撥函式又接收一個或者多個引數，這些引數會與模組陣列的每個陣列元素一一對應，即每個引數儲存的是對應模組返回值。
返回結果可以是一個物件，也可以是一個函式。
方式：return
根據 define() 使用時引數數量的不同，可以定義以下幾種模組型別：
1、簡單鍵值對
當所要定義的模組沒有任何依賴也不具有任何的功能，只是單純的返回一組鍵值對形式的資料時，便可以直接將要返回的資料物件寫在 define方法中：
//define1.js //模組定義1，無依賴無功能函式 define({ 'color': 'red', 'size': '13px', 'width': '100px' }); 這種只為儲存資料的模組，我們稱之為“值對”模組 使用（載入模組） //app.js //配置 require.config({ baseUrl: 'Scripts/', paths: { "jquery": "jquery-3.3.1", "define1": "app/define1", "define2": "app/define2", "define3": "app/define3", } }) //載入模組1 require(['define1'], function (define1) { for (var prop in define1) { if (define1.hasOwnProperty(prop)) { console.log('key =' + prop + ' and value = ' + define1[prop]); } } })
2、非依賴的函式式定義
如果一個模組沒有任何的依賴，只是單純的執行一些操作，那麼便可以直接將函式寫在 define方法中
//define2.js //模組定義2，無依賴 但功能函式,返回一個物件 define(function () { return { 'color': 'red', 'size': '13px', } }) 使用（載入模組） require(['define1', 'define2'], function (define1, define2) { console.log("define1"); for (var prop in define1) { if (define1.hasOwnProperty(prop)) { console.log('key =' + prop + ' and value = ' + define1[prop]); } } console.log("define2"); for (var prop in define2) { if (define2.hasOwnProperty(prop)) { console.log('key =' + prop + ' and value = ' + define2[prop]); } } })
3、依賴的函式式定義
這種帶有依賴的函式式模組定義，也是我們平時常用到的，
//define3.js //模組定義3，依賴的函式式定義 但功能函式,返回一個物件 define(['jquery','define2'],function ($,define2) { obj= { 'color': 'red', 'size': '13px', } $(function () { console.log(obj.color); console.log(define2.size); }) // console.log(define2.size); //放這裡 會在一開始就輸出， }) 使用（載入模組） //app.js //配置 require.config({ baseUrl: 'Scripts/', paths: { "jquery": "jquery-3.3.1", "define1": "app/define1", "define2": "app/define2", "define3": "app/define3", } }) require(['define1', 'define2', 'define3'], function (define1, define2, define3) { console.log("define1"); for (var prop in define1) { if (define1.hasOwnProperty(prop)) { console.log('key =' + prop + ' and value = ' + define1[prop]); } } console.log("define2"); for (var prop in define2) { if (define2.hasOwnProperty(prop)) { console.log('key =' + prop + ' and value = ' + define2[prop]); } } console.log("define3"); })
4、載入模組
格式require(deps,[callback]);
deps:所要載入的模組陣列。
callback:模組載入後執行的回撥方法。
模組之前因為有依賴，故不用載入所有模組，載入一個的時候，會自動載入其所依賴的模組（這個定義模組裡面有 依賴關係）
callBcak定義和 定義模組時的回撥函式類似。。
更多參考：
阮一峰 require.js的用法
RequireJS中文網