jsonp的原理與實現

zhangguixu發表於2016-12-01
JSON

1. 概述

jsonp是一種跨域通訊的手段，它的原理其實很簡單：

  1. 首先是利用script標籤的src屬性來實現跨域。

  2. 通過將前端方法作為引數傳遞到伺服器端，然後由伺服器端注入引數之後再返回，實現伺服器端向客戶端通訊。

  3. 由於使用script標籤的src屬性，因此只支援get方法

2. 實現流程

  1. 設定一個script標籤

    <script src="http://jsonp.js?callback=xxx"></script>

  2. callback定義了一個函式名，而遠端服務端通過呼叫指定的函式並傳入引數來實現傳遞引數，將fn(response)傳遞迴客戶端

    $callback = !empty($_GET['callback']) ? $_GET['callback'] : 'callback';
echo $callback.'(.json_encode($data).)';

  3. 客戶端接收到返回的js指令碼，開始解析和執行fn(response)

3. jsonp簡單實現

一個簡單的jsonp實現，其實就是拼接url，然後將動態新增一個script元素到頭部。

function jsonp(req){
    var script = document.createElement('script');
    var url = req.url + '?callback=' + req.callback.name;
    script.src = url;
    document.getElementsByTagName('head')[0].appendChild(script); 
}

前端js示例

function hello(res){
    alert('hello ' + res.data);
}
jsonp({
    url : '',
    callback : hello 
});

伺服器端程式碼

var http = require('http');
var urllib = require('url');

var port = 8080;
var data = {'data':'world'};

http.createServer(function(req,res){
    var params = urllib.parse(req.url,true);
    if(params.query.callback){
        console.log(params.query.callback);
        //jsonp
        var str = params.query.callback + '(' + JSON.stringify(data) + ')';
        res.end(str);
    } else {
        res.end();
    }
    
}).listen(port,function(){
    console.log('jsonp server is on');
});

然而，這個實現雖然簡單，但有一些不足的地方：

  1. 我們傳遞的回撥必須是一個全域性方法，我們都知道要儘量減少全域性的方法。

  2. 需要加入一些引數校驗，確保介面可以正常執行。

4. 可靠的jsonp實現

(function (global) {
    var id = 0,
        container = document.getElementsByTagName("head")[0];

    function jsonp(options) {
        if(!options || !options.url) return;

        var scriptNode = document.createElement("script"),
            data = options.data || {},
            url = options.url,
            callback = options.callback,
            fnName = "jsonp" + id++;

        // 新增回撥函式
        data["callback"] = fnName;

        // 拼接url
        var params = [];
        for (var key in data) {
            params.push(encodeURIComponent(key) + "=" + encodeURIComponent(data[key]));
        }
        url = url.indexOf("?") > 0 ? (url + "&") : (url + "?");
        url += params.join("&");
        scriptNode.src = url;

        // 傳遞的是一個匿名的回撥函式，要執行的話，暴露為一個全域性方法
        global[fnName] = function (ret) {
            callback && callback(ret);
            container.removeChild(scriptNode);
            delete global[fnName];
        }

        // 出錯處理
        scriptNode.onerror = function () {
            callback && callback({error:"error"});
            container.removeChild(scriptNode);
            global[fnName] && delete global[fnName];
        }

        scriptNode.type = "text/javascript";
        container.appendChild(scriptNode)
    }

    global.jsonp = jsonp;

})(this);

使用示例

jsonp({
    url : "www.example.com",
    data : {id : 1},
    callback : function (ret) {
        console.log(ret);
    }
});

5. 來源

個人部落格

相關文章