【JQuery】require.js庫+$.ajax()方法

require.js總結自http://www.ruanyifeng.com/blog/2012/11/require_js.htmljavascript

爲啥使用 require.js模塊加載框架(對比 sea.js)

(1)實現js文件的異步加載,避免網頁失去響應;html

(2)管理模塊之間的依賴性,便於代碼的編寫和維護。java

使用方法:

(1)先去官網下載http://requirejs.org/docs/download.htmljquery

(2)下載後,假定把它放在js子目錄下面,就能夠加載了。git

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

有人可能會想到,加載這個文件,也可能形成網頁失去響應。解決辦法有兩個,一個是把它放在網頁底部加載,另外一個是寫成下面這樣:github

<script src="js/require.js" defer async="true" ></script>

async屬性代表這個文件須要異步加載,避免網頁失去響應。IE不支持這個屬性,只支持defer,因此把defer也寫上。ajax

加載require.js之後,下一步就要加載咱們本身的代碼了。假定咱們本身的代碼文件是main.js,也放在js目錄下面。那麼,只須要寫成下面這樣就好了:json

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

data-main屬性的做用是,指定網頁程序的主模塊。在上例中,就是js目錄下面的main.js,這個文件會第一個被require.js加載。因爲require.js默認的文件後綴名是js,因此能夠把main.js簡寫成main。api

(3)主模塊:main.js,通常主模塊依賴於其餘模塊,這時就要使用AMD規範定義的的require()函數。數組

// main.js
require(['moduleA', 'moduleB', 'moduleC'], function (moduleA, moduleB, moduleC){
    // some code here
});

require()函數接受兩個參數。第一個參數是一個數組,表示所依賴的模塊,上例就是['moduleA', 'moduleB', 'moduleC'],即主模塊依賴這三個模塊;第二個參數是一個回調函數,當前面指定的模塊都加載成功後,它將被調用。加載的模塊會以參數形式傳入該函數,從而在回調函數內部就可使用這些模塊。

require()異步加載moduleA,moduleB和moduleC,瀏覽器不會失去響應;它指定的回調函數,只有前面的模塊都加載成功後,纔會運行,解決了依賴性的問題。

(4)模塊加載

主模塊的依賴模塊是['jquery', 'underscore', 'backbone']。默認狀況下,require.js假定這三個模塊與main.js在同一個目錄,文件名分別爲jquery.js,underscore.js和backbone.js,而後自動加載。

使用require.config()方法,咱們能夠對模塊的加載行爲進行自定義。require.config()就寫在主模塊(main.js)的頭部。參數就是一個對象,這個對象的paths屬性指定各個模塊的加載路徑。

require.config({
    paths: {
        "jquery": "jquery.min",
     "underscore": "underscore.min",
     "backbone": "backbone.min"
    }
});

上面的代碼給出了三個模塊的文件名,路徑默認與main.js在同一個目錄(js子目錄)。若是這些模塊在其餘目錄,好比js/lib目錄,則有兩種寫法。一種是逐一指定路徑。

require.config({
    paths: {
      "jquery": "lib/jquery.min",
      "underscore": "lib/underscore.min",
      "backbone": "lib/backbone.min"
    }
});

另外一種則是直接改變基目錄(baseUrl)。

require.config({
    baseUrl: "js/lib",
    paths: {
        "jquery": "jquery.min",
     "underscore": "underscore.min",
     "backbone": "backbone.min"
    }
});

若是某個模塊在另外一臺主機上,也能夠直接指定它的網址,好比:

require.config({
    paths: {
        "jquery": "https://ajax.googleapis.com/ajax/libs/jquery/1.7.2/jquery.min"
    }
});

require.js要求,每一個模塊是一個單獨的js文件。這樣的話,若是加載多個模塊,就會發出屢次HTTP請求,會影響網頁的加載速度。所以,require.js提供了一個優化工具,當模塊部署完畢之後,能夠用這個工具將多個模塊合併在一個文件中,減小HTTP請求數。

(5)AMD 規範模塊

require.js加載的模塊,採用AMD規範。也就是說,模塊必須按照AMD的規定來寫。

具體來講,就是模塊必須採用特定的define()函數來定義。若是一個模塊不依賴其餘模塊,那麼能夠直接定義在define()函數之中。

假定如今有一個math.js文件,它定義了一個math模塊。那麼,math.js就要這樣寫:

// math.js
define(function (){
    var add = function (x,y){
      return x+y;
    };
    return {
      add: add
  };
});

加載方法以下:

// main.js
require(['math'], function (math){
    alert(math.add(1,1));
});

若是這個模塊還依賴其餘模塊,那麼define()函數的第一個參數,必須是一個數組,指明該模塊的依賴性。

define(['myLib'], function(myLib){
    function foo(){
      myLib.doSomething();
    }
    return {
      foo : foo
    };
  });

當require()函數加載上面這個模塊的時候,就會先加載myLib.js文件。

(6)加載非規範的模塊

理論上,require.js加載的模塊,必須是按照AMD規範、用define()函數定義的模塊。可是實際上,雖然已經有一部分流行的函數庫(好比jQuery)符合AMD規範,更多的庫並不符合。那麼,require.js是否可以加載非規範的模塊呢?

這樣的模塊在用require()加載以前,要先用require.config()方法,定義它們的一些特徵。

舉例來講,underscore和backbone這兩個庫,都沒有采用AMD規範編寫。若是要加載它們的話,必須先定義它們的特徵。

require.config({
    shim: {
      'underscore':{
        exports: '_'
      },
      'backbone': {
        deps: ['underscore', 'jquery'],
        exports: 'Backbone'
      }
    }
  });

require.config()接受一個配置對象,這個對象除了有前面說過的paths屬性以外,還有一個shim屬性,專門用來配置不兼容的模塊。具體來講,每一個模塊要定義(1)exports值(輸出的變量名),代表這個模塊外部調用時的名稱;(2)deps數組,代表該模塊的依賴性。

好比,jQuery的插件能夠這樣定義:

shim: {
    'jquery.scroll': {
      deps: ['jquery'],
      exports: 'jQuery.fn.scroll'
    }
  }

(7)require.js 插件

require.js插件

require.js還提供一系列插件,實現一些特定的功能。

domready插件,可讓回調函數在頁面DOM結構加載完成後再運行

require(['domready!'], function (doc){
    // called once the DOM is ready
});

text和image插件,則是容許require.js加載文本和圖片文件。

define(['text!review.txt','image!cat.jpg'],function(review,cat){
      console.log(review);
      document.body.appendChild(cat);
    }
  );

相似的插件還有json和mdown,用於加載json文件和markdown文件。

示例

define([], function(){})中第一個參數是依賴的名稱數組,第二個參數是函數,在模塊的全部依賴加載完畢後,該函數會被調用來定義該模塊。依賴關係會以參數的形式注入到該函數上,參數列表與依賴名稱列表一一對應。這是官方的解釋。

define(['bootbox'], function (bootbox) {
    var request = function (url, callback, params) {
        $.ajax({
            url: url,
            dataType: 'json',
            data: params,
            success: function (data) {
                if (data.ErrCode !== 0) {
                    bootbox.alert(data.ErrMsg);
                    return;
                }
                callback(data);
            }
        });
    };

    var listProducts = function (callback) {
        var url = '/blade/task?method=listProducts';
        return request(url, callback);
    };

    var getTaskConfigOutputData = function (taskId, callback) {
        var url = '/blade/task?method=getTaskConfigOutputData';
        return request(url, callback, {'task_id': taskId});
    };


    return {
        listProducts: listProducts,
        getTaskConfigOutputData: getTaskConfigOutputData,
    };
});

$.ajax 參數

1.url
要求爲String類型的參數,(默認爲當前頁地址)發送請求的地址。

2.type
要求爲String類型的參數,請求方式(post或get)默認爲get。注意其餘http請求方法,例如put和delete也可使用,但僅部分瀏覽器支持。

3.timeout
要求爲Number類型的參數,設置請求超時時間(毫秒)。此設置將覆蓋$.ajaxSetup()方法的全局設置。

4.async
要求爲Boolean類型的參數,默認設置爲true,全部請求均爲異步請求。若是須要發送同步請求,請將此選項設置爲false。注意,同步請求將鎖住瀏覽器,用戶其餘操做必須等待請求完成才能夠執行。

5.cache
要求爲Boolean類型的參數,默認爲true(當dataType爲script時,默認爲false),設置爲false將不會從瀏覽器緩存中加載請求信息。

6.data
要求爲Object或String類型的參數,發送到服務器的數據。若是已經不是字符串,將自動轉換爲字符串格式。get請求中將附加在url後。防止這種自動轉換,能夠查看  processData選項。對象必須爲key/value格式,例如{foo1:"bar1",foo2:"bar2"}轉換爲&foo1=bar1&foo2=bar2。若是是數組,JQuery將自動爲不一樣值對應同一個名稱。例如{foo:["bar1","bar2"]}轉換爲&foo=bar1&foo=bar2。

7.dataType
要求爲String類型的參數,預期服務器返回的數據類型。若是不指定,JQuery將自動根據http包mime信息返回responseXML或responseText,並做爲回調函數參數傳遞。可用的類型以下:
xml:返回XML文檔,可用JQuery處理。
html:返回純文本HTML信息;包含的script標籤會在插入DOM時執行。
script:返回純文本JavaScript代碼。不會自動緩存結果。除非設置了cache參數。注意在遠程請求時(不在同一個域下),全部post請求都將轉爲get請求。
json:返回JSON數據。
jsonp:JSONP格式。使用SONP形式調用函數時,例如myurl?callback=?,JQuery將自動替換後一個「?」爲正確的函數名,以執行回調函數。
text:返回純文本字符串。

8.beforeSend
要求爲Function類型的參數,發送請求前能夠修改XMLHttpRequest對象的函數,例如添加自定義HTTP頭。在beforeSend中若是返回false能夠取消本次ajax請求。XMLHttpRequest對象是唯一的參數。
            function(XMLHttpRequest){
               this;   //調用本次ajax請求時傳遞的options參數
            }
9.complete
要求爲Function類型的參數,請求完成後調用的回調函數(請求成功或失敗時均調用)。參數:XMLHttpRequest對象和一個描述成功請求類型的字符串。
          function(XMLHttpRequest, textStatus){
             this;    //調用本次ajax請求時傳遞的options參數
          }

10.success:要求爲Function類型的參數,請求成功後調用的回調函數,有兩個參數。
         (1)由服務器返回,並根據dataType參數進行處理後的數據。
         (2)描述狀態的字符串。
         function(data, textStatus){
            //data多是xmlDoc、jsonObj、html、text等等
            this;  //調用本次ajax請求時傳遞的options參數
         }

11.error:
要求爲Function類型的參數,請求失敗時被調用的函數。該函數有3個參數,即XMLHttpRequest對象、錯誤信息、捕獲的錯誤對象(可選)。ajax事件函數以下:
       function(XMLHttpRequest, textStatus, errorThrown){
          //一般狀況下textStatus和errorThrown只有其中一個包含信息
          this;   //調用本次ajax請求時傳遞的options參數
       }

12.contentType
要求爲String類型的參數,當發送信息至服務器時,內容編碼類型默認爲"application/x-www-form-urlencoded"。該默認值適合大多數應用場合。

13.dataFilter
要求爲Function類型的參數,給Ajax返回的原始數據進行預處理的函數。提供data和type兩個參數。data是Ajax返回的原始數據,type是調用jQuery.ajax時提供的dataType參數。函數返回的值將由jQuery進一步處理。
            function(data, type){
                //返回處理後的數據
                return data;
            }

14.dataFilter
要求爲Function類型的參數,給Ajax返回的原始數據進行預處理的函數。提供data和type兩個參數。data是Ajax返回的原始數據,type是調用jQuery.ajax時提供的dataType參數。函數返回的值將由jQuery進一步處理。
            function(data, type){
                //返回處理後的數據
                return data;
            }

15.global
要求爲Boolean類型的參數,默認爲true。表示是否觸發全局ajax事件。設置爲false將不會觸發全局ajax事件,ajaxStart或ajaxStop可用於控制各類ajax事件。

16.ifModified
要求爲Boolean類型的參數,默認爲false。僅在服務器數據改變時獲取新數據。服務器數據改變判斷的依據是Last-Modified頭信息。默認值是false,即忽略頭信息。

17.jsonp
要求爲String類型的參數,在一個jsonp請求中重寫回調函數的名字。該值用來替代在"callback=?"這種GET或POST請求中URL參數裏的"callback"部分,例如{jsonp:'onJsonPLoad'}會致使將"onJsonPLoad=?"傳給服務器。

18.username
要求爲String類型的參數,用於響應HTTP訪問認證請求的用戶名。

19.password
要求爲String類型的參數,用於響應HTTP訪問認證請求的密碼。

20.processData
要求爲Boolean類型的參數,默認爲true。默認狀況下,發送的數據將被轉換爲對象(從技術角度來說並不是字符串)以配合默認內容類型"application/x-www-form-urlencoded"。若是要發送DOM樹信息或者其餘不但願轉換的信息,請設置爲false。

21.scriptCharset
要求爲String類型的參數,只有當請求時dataType爲"jsonp"或者"script",而且type是GET時纔會用於強制修改字符集(charset)。一般在本地和遠程的內容編碼不一樣時使用。

 

AMD和CMD的區別,依賴前置和依賴就近。

相關文章
相關標籤/搜索