文章內容

為你的網址提供跨域支持的JavaScript API

發布時間: 2012/8/28 15:29:17

天我們通過一個簡單的例子來講述如何創建支持跨域調用的 JavaScript API。我相信很多人都嘗試實現類似的方法，但可能會遇到很多困難，因為無法通過正常的 AJAX 請求來訪問遠程服務器并接收響應，這是因為瀏覽器的安全限制。下面我們將告訴你如何解決這個問題。

完整的示例代碼下載：source.zip

一. PHP

首先我們編寫一個簡單的服務端程序：

<?php  
// set possibility to send response to any domain  
header('Access-Control-Allow-Origin: *');  
if (version_compare(phpversion(), '5.3.0', '>=')  == 1)  
  error_reporting(E_ALL & ~E_NOTICE & ~E_DEPRECATED);  
else 
  error_reporting(E_ALL & ~E_NOTICE);   
// accept POST params  
$sAction = $_POST['action'];  
$iParam1 = (int)$_POST['param1'];  
$iParam2 = (int)$_POST['param2'];  
// perform calculation  
$iResult = 0;  
switch ($sAction) {  
    case 'sum':  
        $iResult = $iParam1 + $iParam2;  
        break;  
    case 'sub':  
        $iResult = $iParam1 - $iParam2;  
        break;  
    case 'mul':  
        $iResult = $iParam1 * $iParam2;  
        break;  
    case 'div':  
        $iResult = $iParam1 / $iParam2;  
        break;  
}  
// prepare results array  
$aResult = array(  
    'result' => $iResult 
);  
// generate result  
header('Content-type: application/json');  
echo json_encode($aResult);

值得你關注的是第一行 PHP 代碼中的自定義 HEAD ‘Access-Control-Allow-Origin’. 它允許發送回應到任意的服務器，甚至是不同域的。如果你要限制指定域名才能訪問，也是在這里設置。接下來是簡單的應用邏輯，接受參數并處理請求，這里我們實現的是最簡單的加減乘除操作，返回的結果用 JSON 格式。

二. JavaScript

api.js

function do_sum(param1, param2, cfunction) {  
    // send ajax response to server  
    $.ajax({  
        type: 'POST',  
        url: 'http://www.script-tutorials.com/demos/301/api.php',  
        crossDomain: true,  
        dataType: 'json',  
        data: 'action=sum¶m1=' + param1 + '¶m2=' + param2,  
        success: function(json) {  
            // and evoke client's function  
            cfunction(json);  
        }  
    });  
}  
function do_sub(param1, param2, cfunction) {  
 
    // send ajax response to server  
    $.ajax({  
        type: 'POST',  
        url: 'http://www.script-tutorials.com/demos/301/api.php',  
        crossDomain: true,  
        dataType: 'json',  
        data: 'action=sub¶m1=' + param1 + '¶m2=' + param2,  
        success: function(json) {  
            // and evoke client's function  
            cfunction(json);  
        }  
    });  
}  
function do_mul(param1, param2, cfunction) {  
 
    // send ajax response to server  
    $.ajax({  
        type: 'POST',  
        url: 'http://www.script-tutorials.com/demos/301/api.php',  
        crossDomain: true,  
        dataType: 'json',  
        data: 'action=mul¶m1=' + param1 + '¶m2=' + param2,  
        success: function(json) {  
            // and evoke client's function  
            cfunction(json);  
        }  
    });  
}  
function do_div(param1, param2, cfunction) {  
    // send ajax response to server  
    $.ajax({  
        type: 'POST',  
        url: 'http://www.script-tutorials.com/demos/301/api.php',  
        crossDomain: true,  
        dataType: 'json',  
        data: 'action=div¶m1=' + param1 + '¶m2=' + param2,  
        success: function(json) {  
            // and evoke client's function  
            cfunction(json);  
        }  
    });  
}

這是對服務器端方法的 JS 封裝，我準備了 4 個 JavaScript 方法，分別是 do_sum, do_sub, do_mul 和 do_div. 每個方法對應一個服務器的函數。一般來說，首先我們需要設置服務器 API 的 URL，這里是 http://www.script-tutorials.com/demos/301/api.php ，然后需要設置 crossDomain 為 true，最后設置數據格式為 json。請注意第三個參數是 cfunction，這是一個客戶端可定制的任意函數用來處理服務器端返回的數據。

三. 使用方法 (客戶端)

現在服務器端已經準備好了，接下來看看客戶端如何使用這個遠程接口。

<script src="http://code.jquery.com/jquery-1.7.1.min.js"></script>  
<script src="http://www.script-tutorials.com/demos/301/api.js"></script>  
<script type="text/javascript">  
$(document).ready(function() {   
    // execute method 1 (sum) by server  
    var param1 = 5;  
    var param2 = 10;  
    do_sum(param1, param2, function(data) {  
        $('#results').append(param1 + ' + ' + param2 + ' = ' + data.result + '  
');  
        // execute method 2 (sub) by server  
        param1 = 25;  
        param2 = 15;  
        do_sub(param1, param2, function(data) {  
            $('#results').append(param1 + ' - ' + param2 + ' = ' + data.result + '  
');  
            // execute method 3 (mul) by server  
            param1 = 8;  
            param2 = 5;  
            do_mul(param1, param2, function(data) {  
                $('#results').append(param1 + ' * ' + param2 + ' = ' + data.result + '  
');  
 
                // execute method 4 (sub) by server  
                param1 = 33;  
                param2 = 11;  
                do_sub(param1, param2, function(data) {  
                    $('#results').append(param1 + ' / ' + param2 + ' = ' + data.result + '  
');  
                });  
            });  
 
        });  
    });  
});  
</script>  
<div id="results"></div>

在這個例子中，我們使用的是服務器端的 JavaScript 函數，我們將上面的代碼簡化后的結果就是：

var param1 = 5;  
var param2 = 10;  
do_sum(param1, param2, function(data) {  
    $('#results').append(param1 + ' * ' + param2 + ' = ' + data.result + '  
');  
});