DIV CSS 佈局教程網

用 JS 實作點擊事件統計(立即上報與延時上報)
編輯:關於JavaScript     

要統計使用者點了哪些連結,最直覺的做法是在 click 裡發一個 request。但頁面即將跳走,請求常常還沒送完就被中斷。以下這套方案用「立即上報」與「延時上報」兩種策略解決這個問題。

一、配置參數

透過外部的 _clickc 物件覆寫預設值:

selector(string,預設 '_click_rp'):觸發點擊的選擇器,支援 id 或 class
prefix(string,預設 '_rp_'):需要上報的屬性名前綴,例如 _rp_type 表示要上報 type 的值
cookie(string,預設 '_click_rp'):延遲上報時的 cookie 名稱
domain(string,預設 '.skye.com'):cookie 的網域
delay(boolean,預設 false):是否延遲上報
delay_attr(string,預設 '_delay'):標籤上指定是否延遲上報,優先級最高

二、外部參數

透過 _clickq 陣列追加全域參數。

三、標籤參數

用 _rp_ 前綴定義,上報時會把所有 _rp_ 開頭的屬性都送出去。格式有兩種:

純字串:直接寫值。<a class="_click_rp" _rp_a="aa" _rp_b="bb">a</a> 會上報 a=aa&b=bb。

回呼函式:以 javascript: 開頭,只寫函式體,回傳值即為參數值。

<a href="/qa_question/press.html" id="ques_search_btn" class="_click_rp"
   _rp_act="javascript:if($('#ques_search_btn').text()=='提問'){return 'act_qa_ques';}else{return 'act_search';}">
  <span>提問</span>
</a>

四、延時上報的三層優先級

由高到低:

1. 標籤的 _delay 是否為 true
2. 是否為特定標籤:a 標籤在本視窗開啟(target 為 _self 或空)、submit 按鈕
3. 配置參數中的 delay 設定

五、使用方式

引入 JS:

var _clickq = _clickq || [];
_clickq.push(['param1', 'value1']);

var _clickc = { selector: '_click_rps' };

(function () {
  var click = document.createElement("script");
  click.src = "//cache.skye.com/js/lib/stat/click.js";
  var s = document.getElementsByTagName("script")[0];
  s.parentNode.insertBefore(click, s);
})();

標記要統計的元素:

<a class="_click_rp" href="" _rp_a="aa" _rp_b="bb">a</a>

核心實作

(function () {
  // 預設參數
  var options = {
    selector: '_click_rp',
    prefix: '_rp_',
    cookie: '_click_rp',
    domain: '.skye.com',
    delay: false,
    delay_attr: '_delay'
  };

  var params = {};
  var _params = {};
  var clickObj = null;      // 當前點擊的物件

  // 取得元素:可傳物件、id 或 class
  var getObject = function (selector) {
    if (typeof (selector) == 'object') return selector;
    var obj = $('#' + selector);
    if (obj.length) return obj;
    obj = $('.' + selector);
    if (obj.length) return obj;
    return null;
  };

  // 組出 id 與 class 兩種選擇器
  var getSelector = function (selector) {
    return '#' + selector + ',.' + selector;
  };

  // cookie 操作
  var getCookie = function (c_name) {
    if (document.cookie.length > 0) {
      var c_start = document.cookie.indexOf(c_name + "=");
      if (c_start != -1) {
        c_start = c_start + c_name.length + 1;
        var c_end = document.cookie.indexOf(";", c_start);
        if (c_end == -1) c_end = document.cookie.length;
        return unescape(document.cookie.substring(c_start, c_end));
      }
    }
    return "";
  };

  var setCookie = function (c_name, value, expiredays, path, domain) {
    var exdate = new Date();
    exdate.setDate(exdate.getDate() + expiredays);
    var cookie = c_name + "=" + escape(value) +
      ((expiredays == null) ? "" : ";expires=" + exdate.toGMTString());
    if (path) cookie = cookie + ";path=" + path;
    if (domain) cookie = cookie + ";domain=" + domain;
    document.cookie = cookie;
  };

  // 從標籤屬性取得參數
  var getAttrParam = function () {
    if (clickObj) {
      var attrs = clickObj.get(0).attributes;
      $.each(attrs, function (i) {
        var name = attrs[i].name;
        if (name.indexOf(options.prefix) == 0) {
          name = name.replace(options.prefix, '');
          var value = attrs[i].value;
          if (value.indexOf('javascript:') == 0) {
            // 執行函式以取得參數值
            value = value.replace('javascript:', '');
            eval('var valFun = function() {' + value + '};');
            value = valFun();
          }
          params[name] = value;
        }
      });
    }
  };

  // 加入預設參數
  var getDefaultParam = function () {
    if (document) {
      params.url = document.URL || '';
      params.referrer = document.referrer || '';
    }
    var date = new Date();
    params.ltime = date.getTime() / 1000;   // 秒級時間戳
    params.t = date.getTime();              // 毫秒級時間戳
  };

  // 組出參數字串
  var getParamStr = function () {
    getAttrParam();
    getDefaultParam();

    // 合併外部配置參數
    for (var key in _params) {
      params[key] = _params[key];
    }

    var args = '';
    for (var i in params) {
      if (args != '') args += '&';
      args += i + '=' + encodeURIComponent(params[i]);
    }
    return args;
  };

  var clearParam = function () { params = {}; };

  // 判定是否走延時上報
  var getIsDelay = function () {
    if (clickObj) {
      // 最高優先:標籤明確指定
      if (clickObj.attr(options.delay_attr) == 'true') return true;

      // 特定標籤:a 標籤
      if (clickObj.is('a')) {
        if (clickObj.attr('href').indexOf('javascript:') == 0) return false;
        if (clickObj.attr('target') && clickObj.attr('target') != '_self') return false;
        return true;      // 會離開頁面,需延時上報
      }

      // 特定標籤:submit 按鈕
      if ((clickObj.is('input') || clickObj.is('button')) && clickObj.attr('type') == 'submit') {
        return true;
      }
    }
    return options.delay;
  };

  // 存入 cookie,下次再一起上報
  var setDelayCookie = function () {
    var args = getParamStr();
    var cookieStr = getCookie(options.cookie);
    cookieStr = (cookieStr == '') ? args : cookieStr + ',' + args;
    setCookie(options.cookie, cookieStr, 7, '/', options.domain);
    clearParam();
  };

  // 把 cookie 中累積的資料送出
  var rpCookie = function () {
    var cookieStr = getCookie(options.cookie);
    if (cookieStr) {
      var cookieArr = cookieStr.split(',');
      for (var key in cookieArr) {
        rpClick(cookieArr[key]);
      }
      setCookie(options.cookie, '', 7, '/', options.domain);
    }
  };

  // 實際送出(用 Image 物件發 GET 請求)
  var rpClick = function (args) {
    if (args == undefined) args = getParamStr();
    var img = new Image(1, 1);
    img.src = 'https://data.skye.com/stat/click?' + args;
    console.info(img.src);
    clearParam();
  };

  // 對外的上報函式
  var rpComm = function (obj) {
    clickObj = obj;
    if (getIsDelay()) {
      setDelayCookie();
    } else {
      rpClick();
    }
  };

  // 解析外部配置
  if (_clickc) {
    for (var i in _clickc) options[i] = _clickc[i];
  }
  // 解析外部參數
  if (_clickq) {
    for (var i in _clickq) _params[_clickq[i][0]] = _clickq[i][1];
  }

  // 提供外部呼叫
  $.rpComm = function (obj) { rpComm(obj); };
  $.fn.rpComm = function () { rpComm($(this)); };

  // 先把 cookie 中殘留的上報補送出去
  rpCookie();

  // 掛上事件委派
  var _time = new Date().valueOf();
  var selector = getSelector(options.selector);
  $('body').delegate(selector, 'click', function () {
    // 300ms 內的連續點擊視為重複,直接忽略
    if (new Date().valueOf() - _time < 300) return;
    _time = new Date().valueOf();
    rpComm($(this));
  });
})();

設計上值得學的地方

用 Image 物件發請求:img.src = url 這種方式不必等回應、不會阻塞頁面,是像素追蹤(tracking pixel)的經典做法。缺點是只能發 GET、無法自訂標頭。

事件委派取代逐項綁定:統計需求通常涵蓋全站連結,逐一綁定成本太高,掛在 body 上用選擇器過濾才現實。

300ms 防重複:使用者連點兩下不該被算成互不相干的兩次行為。

這段程式碼需要修正的地方

eval 有安全風險:把標籤屬性內容直接 eval 執行,若頁面有任何可注入的內容,就等於開了後門。改用 new Function('return ' + body)() 至少不污染作用域,更好的做法是把判斷邏輯集中在 JS 內以鍵值對照。

cookie 大小限制:cookie 只有 4KB 左右,且每筆上報都會附帶在請求標頭上。累積多筆時很快就會溢出,改用 localStorage 或 sessionStorage 更安全。

escape/unescape 已棄用:請改用 encodeURIComponent/decodeURIComponent。

delegate 已在新版 jQuery 移除:改用 $(document).on('click', selector, handler)。

sendBeacon 是更好的選擇:現代瀏覽器支援 navigator.sendBeacon(url, data),專為此情境設計——頁面卸載時仍會送出,也不必再靠 cookie 繞路:

document.addEventListener('click', function (e) {
  var el = e.target.closest('[_click_rp]');
  if (!el) return;
  var payload = { url: location.href, target: el.getAttribute('_rp_a') };
  navigator.sendBeacon('/stat/click', JSON.stringify(payload));
});

最後提醒,點擊統計屬於使用者行為資料,涉及個資保護規範。上報前應確認已取得同意,並避免收集可直接識別個人身分的資訊。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved