The most elegant way to write ajax requests in jQuery

The core of Ajax is the JavaScript object XmlHttpRequest. This object was first introduced in Internet Explorer 5 and is a technology that supports asynchronous requests. In short, XmlHttpRequest allows you to use JavaScript to make requests to the server and handle the responses without blocking the user. In this article, we will share with you how to write ajax requests in the most elegant way.

First you need a configuration file

var api = {
    basePath: 'http://192.168.200.226:58080',
    pathList: [
        {
            name: 'agentHeartBeat',
            path:'/api/csta/agent/heartbeat/{{agentId}}',
            method:'post'
        },
        {
            name: 'setAgentState',
            path: '/api/csta/agent/state',
            method: 'post'
        },
        {
            name: 'getAgents',
            path: '/user/agent/{{query}}',
            method: 'get'
        }
    ]
}

Then you need a method to generate an interface from the configuration file

function WellApi(Config){
var headers = {};
var Api = function(){};

Api.pt = Api.prototype;

var util = {
    ajax: function(url, method, payload) {
        return $.ajax({
            url: url,
            type: method || "get",
            data: JSON.stringify(payload),
            headers: headers,
            dataType: "json",
            contentType: 'application/json; charset=UTF-8'
        });
    },

    /**
     * [render 模板渲染]
     * 主要用于将 /users/{{userId}} 和{userId: '89898'}转换成/users/89898，和mastache语法差不多，
     * 当然我们没必要为了这么小的一个功能来引入一个模板库
     * query字符串可以当做一个参数传递进来
     * 例如： /users/{{query}}和{query:'?name=jisika&sex=1'}
     * @Author   Wdd
     * @DateTime 2017-03-13T19:42:58+0800
     * @param    {[type]} tpl [description]
     * @param    {[type]} data [description]
     * @return   {[type]} [description]
     */
    render: function(tpl, data){
        var re = /{{([^}]+)?}}/g;
        var match = '';

        while(match = re.exec(tpl)){
            tpl = tpl.replace(match[0],data[match[1]]);
        }

        return tpl;
    }
};

/**
 * [setHeader 暴露设置头部信息的方法]
 * 有些方法需要特定的头部信息，例如登录之后才能获取sesssionId,然后访问所有的接口时，必须携带sessionId
 * 才可以访问
 * @Author   Wdd
 * @DateTime 2017-03-13T10:34:03+0800
 * @param    {[type]} headers [description]
 */
Api.pt.setHeader = function(headers){
    headers = headers;
};

/**
 * [fire 发送ajax请求，this会绑定到每个接口上]
 * @Author   Wdd
 * @DateTime 2017-03-13T19:42:13+0800
 * @param    {[type]} pathParm [description]
 * @param    {[type]} payload [description]
 * @return   {[type]} [description]
 */
function fire(pathParm, payload){
    var url = util.render(this.path, pathParm);
    return util.ajax(url, this.method, payload);
}


/**
 * [for 遍历所有接口]
 * @Author   Wdd
 * @DateTime 2017-03-13T19:49:33+0800
 * @param    {[type]} var i [description]
 * @return   {[type]} [description]
 */
for(var i=0; i <p> </p><h2 id="Try-it-out">Try it out</h2><pre class="brush:php;toolbar:false">nbsp;html>


    <meta>
    <title></title>
    <script></script>
    <script></script>
    <script></script>



<script>
    var saas = WellApi(api);

    saas.agentHeartBeat.fire({agentId: &#39;5001@1011.cc&#39;})
    .done(function(res){
        console.log(&#39;心跳成功&#39;);
    })
    .fail(function(res){
        console.log(&#39;心跳失败&#39;);
    });
</script>

Advantages and extensions

• [Advantages]: Callback method similar to promise

• [Advantages]: Adding an interface only requires adding a configuration file, which is very convenient

• [Extension]: I only wrote json for the current ajax contentType , you can expand other data types if you are interested

• [Disadvantages]: There is no verification of function parameters

The above content is how to use the most An elegant way to write ajax requests. Hope it helps everyone.

Related recommendations:

php handles ajax requests and ajax cross-domain

javascript implements ajax request steps and usage examples

How to implement the usage of ajax request in jquery

The above is the detailed content of The most elegant way to write ajax requests in jQuery. For more information, please follow other related articles on the PHP Chinese website!