分析sajax

Thu, 19 Apr 2007 05:14:51 +0000

现在学习ajax的人太多了。网上，书店都已经大量摆放ajax相关的书籍。我不喜欢看太多文字的东西。所以不可能去看买一本的书来慢慢看。看那么多字不如看明白代码。那才是最重要的。而且ajax本来就是把老技术重新整合而成的技术。So，只要在原来的技术基础上，重新理解一下新概念就可以了。(如果对ajax基本概念及动作流程不了解的，请先google搜一下"什么是ajax")

选择sajax来看也只是偶然。昨天在网上看到一篇blog说sajax是比较好的ajax框架。所以我就去下载一份来看了。

我选择了其中更新服务器时间的那个例子来讲一下吧.
example_date.php

require("Sajax.php");

// Leonardo Lorieri
// My first SAJAX implementention, few lines of inspiration
// A good way to understand SAJAX programming
//
// Work Flow:
// 1- starting by the
// 2- loading the server's date from the php function,
//      calling the javascript function to show it.
// 3- scheduling another load to the next second
//
// Disclaimer: Hey! I dont speak english
// Under (put your choice here) license

function show_now() {
  //return server date
  return date("l dS of F Y h:i:s A");
}

//starting SAJAX stuff
$sajax_request_type = "GET";
sajax_init();
sajax_export("show_now");
sajax_handle_client_request();
?>

        Show Server's Date


Server date:

(loading...)

Sajax.php

if (!isset($SAJAX_INCLUDED)) {

  /*
   * GLOBALS AND DEFAULTS
   *
   */
  $GLOBALS['sajax_version'] = '0.12';
  $GLOBALS['sajax_debug_mode'] = 0;
  $GLOBALS['sajax_export_list'] = array();
  $GLOBALS['sajax_request_type'] = 'GET';
  $GLOBALS['sajax_remote_uri'] = '';
  $GLOBALS['sajax_failure_redirect'] = '';

  /*
   * CODE
   *
   */

  //
  // Initialize the Sajax library.
  //
  function sajax_init() {
  }

  //
  // Helper function to return the script's own URI.
  //
  function sajax_get_my_uri() {
    return $_SERVER["REQUEST_URI"];
  }
  $sajax_remote_uri = sajax_get_my_uri();

  //
  // Helper function to return an eval()-usable representation
  // of an object in JavaScript.
  //
  function sajax_get_js_repr($value) {
    $type = gettype($value);

    if ($type == "boolean") {
      return ($value) ? "Boolean(true)" : "Boolean(false)";
    }
    elseif ($type == "integer") {
      return "parseInt($value)";
    }
    elseif ($type == "double") {
      return "parseFloat($value)";
    }
    elseif ($type == "array" || $type == "object" ) {
      //
      // XXX Arrays with non-numeric indices are not
      // permitted according to ECMAScript, yet everyone
      // uses them.. We'll use an object.
      //
      $s = "{ ";
      if ($type == "object") {
        $value = get_object_vars($value);
      }
      foreach ($value as $k=>$v) {
        $esc_key = sajax_esc($k);
        if (is_numeric($k))
          $s .= "$k: " . sajax_get_js_repr($v) . ", ";
        else
          $s .= "\"$esc_key\": " . sajax_get_js_repr($v) . ", ";
      }
      if (count($value))
        $s = substr($s, 0, -2);
      return $s . " }";
    }
    else {
      $esc_val = sajax_esc($value);
      $s = "'$esc_val'";
      return $s;
    }
  }

  function sajax_handle_client_request() {
    global $sajax_export_list;

    $mode = "";

    if (! empty($_GET["rs"]))
      $mode = "get";

    if (!empty($_POST["rs"]))
      $mode = "post";

    if (empty($mode))
      return;

    $target = "";

    if ($mode == "get") {
      // Bust cache in the head
      header ("Expires: Mon, 26 Jul 1997 05:00:00 GMT");    // Date in the past
      header ("Last-Modified: " . gmdate("D, d M Y H:i:s") . " GMT");
      // always modified
      header ("Cache-Control: no-cache, must-revalidate");  // HTTP/1.1
      header ("Pragma: no-cache");                          // HTTP/1.0
      $func_name = $_GET["rs"];
      if (! empty($_GET["rsargs"]))
        $args = $_GET["rsargs"];
      else
        $args = array();
    }
    else {
      $func_name = $_POST["rs"];
      if (! empty($_POST["rsargs"]))
        $args = $_POST["rsargs"];
      else
        $args = array();
    }

    if (! in_array($func_name, $sajax_export_list))
      echo "-:$func_name not callable";
    else {
      echo "+:";
      $result = call_user_func_array($func_name, $args);
      echo "var res = " . trim(sajax_get_js_repr($result)) . "; res;";
    }
    exit;
  }

  function sajax_get_common_js() {
    global $sajax_debug_mode;
    global $sajax_request_type;
    global $sajax_remote_uri;
    global $sajax_failure_redirect;

    $t = strtoupper($sajax_request_type);
    if ($t != "" && $t != "GET" && $t != "POST")
      return "// Invalid type: $t.. \n\n";

    ob_start();
    ?>

    // remote scripting library
    // (c) copyright 2005 modernmethod, inc
    var sajax_debug_mode = ;
    var sajax_request_type = "";
    var sajax_target_id = "";
    var sajax_failure_redirect = "";

    function sajax_debug(text) {
      if (sajax_debug_mode)
        alert(text);
    }

     function sajax_init_object() {
       sajax_debug("sajax_init_object() called..")

       var A;

       var msxmlhttp = new Array(
        'Msxml2.XMLHTTP.5.0',
        'Msxml2.XMLHTTP.4.0',
        'Msxml2.XMLHTTP.3.0',
        'Msxml2.XMLHTTP',
        'Microsoft.XMLHTTP');
      for (var i = 0; i < msxmlhttp.length; i++) {
        try {
          A = new ActiveXObject(msxmlhttp[i]);
        } catch (e) {
          A = null;
        }
      }

      if(!A && typeof XMLHttpRequest != "undefined")
        A = new XMLHttpRequest();
      if (!A)
        sajax_debug("Could not create connection object.");
      return A;
    }

    var sajax_requests = new Array();

    function sajax_cancel() {
      for (var i = 0; i < sajax_requests.length; i++)
        sajax_requests[i].abort();
    }

    function sajax_do_call(func_name, args) {
      var i, x, n;
      var uri;
      var post_data;
      var target_id;

      sajax_debug("in sajax_do_call().." + sajax_request_type + "/" + sajax_target_id);
      target_id = sajax_target_id;
      if (typeof(sajax_request_type) == "undefined" || sajax_request_type == "")
        sajax_request_type = "GET";

      uri = "";
      if (sajax_request_type == "GET") {

        if (uri.indexOf("?") == -1)
          uri += "?rs=" + escape(func_name);
        else
          uri += "&rs=" + escape(func_name);
        uri += "&rst=" + escape(sajax_target_id);
        uri += "&rsrnd=" + new Date().getTime();

        for (i = 0; i < args.length-1; i++)
          uri += "&rsargs[]=" + escape(args[i]);

        post_data = null;
      }
      else if (sajax_request_type == "POST") {
        post_data = "rs=" + escape(func_name);
        post_data += "&rst=" + escape(sajax_target_id);
        post_data += "&rsrnd=" + new Date().getTime();

        for (i = 0; i < args.length-1; i++)
          post_data = post_data + "&rsargs[]=" + escape(args[i]);
      }
      else {
        alert("Illegal request type: " + sajax_request_type);
      }

      x = sajax_init_object();
      if (x == null) {
        if (sajax_failure_redirect != "") {
          location.href = sajax_failure_redirect;
          return false;
        } else {
          sajax_debug("NULL sajax object for user agent:\n" + navigator.userAgent);
          return false;
        }
      } else {
        x.open(sajax_request_type, uri, true);
        // window.open(uri);

        sajax_requests[sajax_requests.length] = x;

        if (sajax_request_type == "POST") {
          x.setRequestHeader("Method", "POST " + uri + " HTTP/1.1");
          x.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
        }

        x.onreadystatechange = function() {
          if (x.readyState != 4)
            return;

          sajax_debug("received " + x.responseText);

          var status;
          var data;
          var txt = x.responseText.replace(/^\s*|\s*$/g,"");
          status = txt.charAt(0);
          data = txt.substring(2);

          if (status == "") {
            // let's just assume this is a pre-response bailout and let it slide for now
          } else if (status == "-")
            alert("Error: " + data);
          else {
            if (target_id != "")
              document.getElementById(target_id).innerHTML = eval(data);
            else {
              try {
                var callback;
                var extra_data = false;
                if (typeof args[args.length-1] == "object") {
                  callback = args[args.length-1].callback;
                  extra_data = args[args.length-1].extra_data;
                } else {
                  callback = args[args.length-1];
                }
                callback(eval(data), extra_data);
              } catch (e) {
                sajax_debug("Caught error " + e + ": Could not eval " + data );
              }
            }
          }
        }
      }

      sajax_debug(func_name + " uri = " + uri + "/post = " + post_data);
      x.send(post_data);
      sajax_debug(func_name + " waiting..");
      delete x;
      return true;
    }

        $html = ob_get_contents();
    ob_end_clean();
    return $html;
  }

  function sajax_show_common_js() {
    echo sajax_get_common_js();
  }

  // javascript escape a value
  function sajax_esc($val)
  {
    $val = str_replace("\\", "\\\\", $val);
    $val = str_replace("\r", "\\r", $val);
    $val = str_replace("\n", "\\n", $val);
    $val = str_replace("'", "\\'", $val);
    return str_replace('"', '\\"', $val);
  }

  function sajax_get_one_stub($func_name) {
    ob_start();
    ?>

    // wrapper for

    function x_() {
      sajax_do_call("",
        x_.arguments);
    }

        $html = ob_get_contents();
    ob_end_clean();
    return $html;
  }

  function sajax_show_one_stub($func_name) {
    echo sajax_get_one_stub($func_name);
  }

  function sajax_export() {
    global $sajax_export_list;

    $n = func_num_args();
    for ($i = 0; $i < $n; $i++) {
      $sajax_export_list[] = func_get_arg($i);
    }
  }

  $sajax_js_has_been_shown = 0;
  function sajax_get_javascript()
  {
    global $sajax_js_has_been_shown;
    global $sajax_export_list;

    $html = "";
    if (! $sajax_js_has_been_shown) {
      $html .= sajax_get_common_js();
      $sajax_js_has_been_shown = 1;
    }
    foreach ($sajax_export_list as $func) {
      $html .= sajax_get_one_stub($func);
    }
    return $html;
  }

  function sajax_show_javascript()
  {
    echo sajax_get_javascript();
  }


  $SAJAX_INCLUDED = 1;
}
?>

先看example_date.php中的sajax_init()与sajax_export("show_now")，这两个函数在Sajax.php中定义的。sajax_init是一个配置函数定义，是由开始者因为程序的需要而添加的。而sajax_export这个函数有点意思

  function sajax_export() {
    global $sajax_export_list;

    $n = func_num_args();
    for ($i = 0; $i < $n; $i++) {
      $sajax_export_list[] = func_get_arg($i);
    }
  }

看到没有，在function sajax_export()中是没有定义参数的。但通过func_num_args与func_get_arg来读取参数。这个方法我还是第一次见。兴奋一下。这个函数的作用就是让取得用于浏览器与服务器交互传递操作的函数名.但个人认为有点多此一举。为什么不直接定义成一个数组。
sajax_init()与sajax_export("show_now")，可以说是定义部分。对程序进行定义

sajax_handle_client_request()对于ajax的请求进行操作。这里有一个地方要注意的。因为在传递中使用了rs与rsargs这个变量名，所以程序中一定不能使用这两个变量名来传递数据。程序运行这个函数会先看一个有没有定义rs（rs传递的是执行的函数名）,如果没有就return来停止下面的代码.如果已经定义了,就用rs来定义的函数名来进行执行。并把返回值转换成js可以直接调用的字符串。传送到浏览器并停止程序。所以，在执行sajax_handle_client_request前，不可能有任何数据传送到浏览器，不然会产生错误.

sajax_show_javascript()只是把 sajax_get_javascript()的字符串输出。所以我们来看一下sajax_get_javascript有什么内容
  function sajax_get_javascript()
  {
    global $sajax_js_has_been_shown;//是否已经展示了基本的js程序
    global $sajax_export_list;//可调用的php函数名数组

    $html = "";
    if (! $sajax_js_has_been_shown) {
      $html .= sajax_get_common_js();//生成基本的js程序
      $sajax_js_has_been_shown = 1;
    }
    foreach ($sajax_export_list as $func) {
      $html .= sajax_get_one_stub($func);//生成执行操作的函数，函数名为 x_{php函数名}
    }
    return $html;
  }

现在再来看一下sajax整体流程
先定义服务器端的sajax相关数据

通过sajax_show_javascript()输出所有用到的js代码
在浏览器端可以看到这样的源代码.

Show Server's Date

Server date:

(loading...)

在加载body时运行了get_date()的js函数,x_show_now()是用于执行提交的命令sajax_do_call()。其中func_name就是服务器端执行操作的函数。args就是指在浏览器端在完成提交与返回操作后，在浏览器上需要进行的更新动作的对象或函数名。（如果是对像的话，必须存在callback方法与extra_data变量）

这是我对sajax分析所理解到的。如果各位觉得不同，请指教

[评论] 分析sajax

Fri, 20 Apr 2007 14:48:41 +0000

ajax好烦人啊

[评论] 分析sajax

Sat, 03 Nov 2007 15:45:53 +0000

支持一下，欢迎大家加我QQ：25698632做个朋友

[评论] 分析sajax

Sat, 03 Nov 2007 15:46:15 +0000

楼主，好东西大家谢谢了

[评论] 分析sajax

Sat, 03 Nov 2007 15:46:49 +0000

真不错，我顶~~~

阿Tim日志

分析sajax

[评论] 分析sajax

[评论] 分析sajax

[评论] 分析sajax

[评论] 分析sajax