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

时间 2019-11-06

标签 JQuery require.js require ajax 方法栏目 JQuery 繁體版

原文原文链接

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的区别，依赖前置和依赖就近。