JavaScript中模塊化工具require.js

時間 2019-11-11

標籤 javascript 模塊化工具 require.js require 欄目 JavaScript 简体版

原文原文鏈接

什麼是require.js?javascript

RequireJS是一個很是小巧的JavaScript模塊載入框架，是AMD規範最好的實現者之一。它還同時能夠和其餘的框架協同工做，使用RequireJS必將使您的前端代碼質量得以提高。html

使用require.js帶來的好處前端

一、防止JavaScript加載阻塞頁面渲染（由於它遵循AMD【異步模塊加載機制】規範）；java

二、使用程序調用的方式加載js，防止出現以下醜陋的場景：jquery

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

<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8" />
        <title></title>
    </head>
    <body>
        <p>AMD test</p>
        <script type="text/javascript" src="js/require.js" data-main = "./main.js"></script>
    </body>
</html>


//main.js(和html同個文件夾)
require(['./js/a.js'],function(a){
    var date = new Date();
    a.printDate(date);
})

//a.js
define(['./a-util.js'],function(aUtil){
    var a = {
        printDate:function(date){
            console.log(aUtil.aGetFormatDate(date));
        }
    }
    return a;
})

//a-util.js
define(['./util.js'],function(util){
    var aUtil = {
        aGetFormatDate:function(date){
            return util.getFormatDate(date,2);
        }
    }
    return aUtil;
})

//util.js
define(function(){
    var util = {
        getFormatDate:function(date,type){
            if(type === 1){
                return "2017-11-09";
            }else{
                return "2017年11月9日";
            }
        }
    }
    return util;
})

require.js中的基本API服務器

require會定義三個變量：框架

define 用來定義一個模塊；jquery插件

require 加載依賴模塊，並執行加載完後的回調函數。require API的第二個參數是callback，一個function，是用來處理加載完畢後的邏輯，如：異步

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

requirejs，其中require === requirejs，通常使用require更簡短。

require.js加載文件

以前的例子中加載模塊都是本地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是用來配置模塊加載位置，簡單點說就是給模塊起一個更短更好記的名字，好比將百度的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

使用require.js注意事項

一、在使用requirejs時，加載模塊時不用寫.js後綴的，固然也是不能寫後綴；

二、上面例子中的callback函數中發現有$參數，這個就是依賴的jquery模塊的輸出變量，若是你依賴多個模塊，能夠依次寫入多個參數來使用：

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

三、若是某個模塊不輸出變量值，則沒有，因此儘可能將輸出的模塊寫在前面，防止位置錯亂引起誤解。

require.js全局配置

上面的例子中重複出現了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將在加載完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，至關於默認配置了。

require.js第三方模塊

經過require加載的模塊通常都須要符合AMD規範即便用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);
})

2.插件形式的非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({...});
    })
})

相關標籤/搜索

每日一句

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