DIV CSS 佈局教程網

Baidu Musicbox 的 Ajax 程式碼解析:請求封裝、XML 解析與歌詞同步
編輯:AJAX基礎知識     

這份前端腳本是一個音樂盒的完整大腦,可以拆成五個部分來讀:請求封裝、XML 解析、清單渲染、播放器切換、歌詞同步。它示範了在没有框架的年代,如何把非同步溝通整理成可重複呼叫的模組。

一、請求封裝:AJAXCALL 與 RequestHTTP

對外只暴露一個 AJAXCALL(url, handleResponse, param)。第三個參數是個用逗號分隔的「選項字串」,例如 "isXML=true",內部拆解後決定要不要走 responseXML、要不要快取、用 GET 還是 POST、以及要帶的附掛參數。

var names;
var Cs, St;        // 目前與上一句歌詞的秒數
var rorw = "";     // 目前使用哪個播放器:wmp / rmp
var lrcT;          // 歌詞輪詢的計時器

function AJAXCALL(url, handleResponse, param) {
    var isXML = false;    // false: html true: xml
    var isCache = false;  // false: no-cache true: cache
    var method = "GET";   // GET or POST
    var attach = "";

    if (param) {
        param = param.replace(/\s+/g, "");
        var tmp = param.split(",");
        for (var i = 0; i < tmp.length; i++) {
            var pa = tmp[i].substr(0, 3);          // 取前三碼當識別
            var ct = tmp[i].split("=")[1];
            switch (pa) {
                case "isX": isXML  = (ct == "true"); break;   // isXML=
                case "isC": isCache = (ct == "true"); break;  // isCache=
                case "met": method = ct; break;               // method=
                case "att": attach = ct; break;               // attach=
            }
        }
    }

    // 不快取就掛上時戳,讓每次網址都不同
    if (!isCache) {
        var t = new Date().getTime();
        url += (url.indexOf("?") > 0 ? "&" : "?") + "t=" + t;
    }

    // POST 時把查詢字串移到 body
    var postdata = null;
    if (method == "POST") {
        var purl = url.split("?");
        url = purl[0];
        postdata = purl[1];
    }

    RequestHTTP(url, handleResponse, method, isXML, postdata, attach);
}

底層的 RequestHTTP 負責建立物件與收發,並把結果交給回呼。這裡有兩個設計值得注意:

function RequestHTTP(burl, rdRandleResponse, bmethod, bXML, Formdata, attach) {
    var http_request = false;

    function doHttpRequest() {
        if (window.XMLHttpRequest) {
            http_request = new XMLHttpRequest();
            if (http_request.overrideMimeType) {
                http_request.overrideMimeType('text/xml');
            }
        } else if (window.ActiveXObject) {
            try {
                http_request = new ActiveXObject("Msxml2.XMLHTTP");
            } catch (e) {
                try {
                    http_request = new ActiveXObject("Microsoft.XMLHTTP");
                } catch (e) {}
            }
        }

        if (!http_request) {
            alert('Giving up :( Cannot create an XMLHTTP instance');
            return false;
        }

        http_request.onreadystatechange = handleStateChange;
        http_request.open(bmethod, burl, true);

        if (Formdata) {
            http_request.setRequestHeader("Content-Length", Formdata.length);
            http_request.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
            http_request.send(Formdata);
        } else {
            http_request.setRequestHeader("Content-Type", "text/html");
            http_request.send(null);
        }
    }

    function handleStateChange() {
        if (http_request.readyState == 4 && http_request.status == 200) {
            var response_content = bXML ? http_request.responseXML
                                        : http_request.responseText;
            // 回呼可以是函式,也可以只是函式名稱的字串
            if (typeof rdRandleResponse == "function") {
                rdRandleResponse(response_content, attach);
            } else {
                eval(rdRandleResponse + "(response_content,attach)");
            }
        }
    }

    doHttpRequest();
}

第一個設計是回呼可用函式或函式名稱字串,讓呼叫端能寫成 AJAXCALL(url, "musiclist", "isXML=true") 這種簡潔形式。第二個是attach 附加參數,用來把額外資訊(例如音樂格式)一路傳到回呼裡,不必靠全域變數。

要提醒的是:eval(函式名稱 + "(...)") 這種寫法有注入風險,字串若來自外部輸入就等於任意執行程式碼。現代做法是直接傳函式物件,根本不需要 eval。

二、XML 解析的小工具

function getTagValue(doc, tag) {
    return doc.getElementsByTagName(tag)[0].firstChild.nodeValue;
}

function getElementsByClass(node, tag) {
    return node.getElementsByTagName(tag);
}

function $(obj) {
    return document.getElementById(obj);
}

伺服器端回傳的是自訂 XML,每筆資料包在一個 <item> 裡,內部有 songname、singer、type、link、time、lrc 等節點。用 getElementsByTagName 逐節點取值,就是這個年代的標準解析手法。

三、清單渲染

// 搜尋結果:最多列出 22 筆可試聽的來源
function musiclist(doc) {
    var items = getElementsByClass(doc, "item");
    var tmp = "<ul>";
    for (var i = 0; i < 22 && i < items.length; i++) {
        var d = i + 1;
        var type = getTagValue(items[i], 'type');
        tmp += '<li> <img src="img/list.gif" /> '
             + '<a title="試聽點 ' + d + ' (' + type + ')" '
             + 'href="javascript:play(\'' + getTagValue(items[i], 'type') + '\',\''
             + getTagValue(items[i], 'link').replace(/\s/g, ' ') + '\')">'
             + names.replace(/\s/g, ' ') + ' (' + type + ')</a></li>';
    }
    tmp += "</ul>";
    $("list").innerHTML = tmp;
    $("msg").style.display = "none";
    play(getTagValue(items[0], "type"), getTagValue(items[0], "link"));  // 自動播第一首
}

// 新歌榜與全部歌曲榜:結構相同,輸出目標不同
function toplist(doc) { /* 寫入 $("toplist") */ }
function s3(doc)      { /* 寫入 $("topalllist") */ }

榜单的處理有一個共同細節:若 singer 節點為空,就不附加歌手名,避免畫面出現「(空白)」這種殘缺括號。

四、依格式切換播放器

function play(obj, url) {
    initLrc();
    $("guanxin").style.display = "none";
    $("msg").style.display = "block";
    // 先把真實播放位址抓回來
    AJAXCALL("inc/songurl.asp?type=url2&keyword=" + url + "&attach=" + obj,
             "gotoplay", "isXML=true");
    // 同時抓歌詞
    AJAXCALL("inc/lyrics.asp?song=" + names, "getlrc", "isXML=true");
}

function gotoplay(docs) {
    var type = getTagValue(docs, "type");
    var link = getTagValue(docs, "link");

    if (type == "rm" || type == "ra" || type == "ram" || type == "rmvb" ||
        type == "mpga" || type == "mp4" || type == "3gp") {
        $("players").innerHTML = realplayer(link);   // RealPlayer
    } else {
        $("players").innerHTML = mdplayer(link);     // Windows Media Player
    }

    var link3 = cuturl(link);
    $("msg").style.display = "none";
    $("wmaurl").innerHTML = "歌曲出處: <a href=" + link.replace(/\s/g, " ")
                          + " target='_blank' title='點右鍵另存:" + names + "'>"
                          + link3 + "</a>";
    setTimeout(guanxin, 1000);
    playobj();
}

function mdplayer(str) {
    return '<object classid="clsid:6bf52a52-394a-11d3-b153-00c04f79faa6" '
         + 'id="MPlayer" width="100%" height="64">'
         + '<param name="url" value="' + str + '">'
         + '<param name="enablecontextmenu" value="0">'
         + '</object>';
}

function realplayer(str) {
    return '<object classid="clsid:cfcdaa03-8be4-11cf-b84b-0020afbbccfa" '
         + 'id="RPlayer" width="100%" height="60">'
         + '<param name="src" value="' + str + '">'
         + '<param name="controls" value="controlpanel,statusbar">'
         + '<param name="autostart" value="true">'
         + '</object>';
}

playobj 會輪流檢查頁面上有沒有 MPlayer 或 RPlayer,記下用了哪一個到 rorw,因為後續抓播放進度要用各自的 API。若兩者都還沒就位(object 尚未完成載入),就再遞迴呼叫自己,直到成功——這是一個樸素但有效的等待手法。

五、歌詞同步

function getlrc(doc) {
    tl = "";
    var items = getElementsByClass(doc, "item");
    var tmp = "<div id=LrcDiv class=LrcDiv>";
    for (var i = 0; i < items.length; i++) {
        // 每一行給一個以時間為 id 的 div,點擊可跳轉播放位置
        tmp += '<div class=div id=T_' + getTagValue(items[i], 'time')
             + ' onclick=To(\'' + getTagValue(items[i], 'time') + '\')">'
             + getTagValue(items[i], 'lrc') + '</div>';
        tl += getTagValue(items[i], 'time') + "|";   // 另外攤平成時間索引字串
    }
    tmp += "</div>";
    $("lrc").innerHTML = tmp;
}

// 點歌詞跳轉播放位置(t 為秒)
function To(t) {
    if (rorw == "") { return; }
    if (rorw == "rmp" && RPlayer.GetPlayState() == 3) { RPlayer.SetPosition(t * 1000); }
    if (rorw == "wmp" && MPlayer.playState == 3)      { MPlayer.controls.CurrentPosition = t; }
}

// 每 10 毫秒比對一次進度,命中就換行並捲動
function lrcrun() {
    var rtl = "|" + tl;
    if (rtl.indexOf("|" + Cs + "|") != -1) {
        GetEBID("LrcDiv").scrollTop = GetEBID("LrcDiv").offsetTop
            - parseInt(GetEBID("LrcDiv").offsetHeight / 2)
            + GetEBID("T_" + Cs).offsetTop + 10;
        GetEBID("T_" + St).className = "";     // 上一句取消高亮
        GetEBID("T_" + Cs).className = "b";    // 目前句加粗
        St = Cs;
    }
}

function ldL() {
    if (rorw == "rmp" && RPlayer.GetPlayState() == 3) {
        Cs = Math.floor(RPlayer.GetPosition() / 1000);
        lrcrun();
    }
    if (rorw == "wmp" && MPlayer.playState == 3) {
        Cs = Math.floor(MPlayer.controls.CurrentPosition);
        lrcrun();
    }
    lrcT = setTimeout("ldL()", 10);
}

同步的做法很直白:把歌詞的秒數用 | 串成一個索引字串,每 10 毫秒取一次播放器進度 Cs,用 indexOf("|Cs|") 確認這一秒有沒有對應歌詞;有的話就把該行設為粗體並捲到容器中央,同時把上一行還原。St 記住上一句的位置,避免每次重設同一行。

以今天的標準看,10 毫秒輪詢實在太密集;用 requestAnimationFrame 搭配畫面更新頻率會省很多資源,而 setTimeout("字串", ...) 這種寫法也應該改成直接傳函式。

六、記錄最近聽過的歌(Cookie)

function setcookie(name, value) {
    var exp = new Date();
    exp.setTime(exp.getTime() + 30 * 24 * 60 * 60 * 1000);   // 30 天
    document.cookie = name + "=" + escape(value) + ";expires=" + exp.toGMTString();
}

function getcookie(name) {
    var arr = document.cookie.match(new RegExp("(^| )" + name + "=([^;]*)(;|$)"));
    if (arr != null) { return unescape(arr[2]); }
    return null;
}

function addbox(name) {
    var a1 = name + "|*|";              // 用 |*| 當分隔符,避免歌名中的字元干擾
    var box = getcookie("box").replace(a1, "");   // 已存在則先移除,等於移到最前
    setcookie("box", a1 + box);
    listbox();
}

function delbox(name) {
    setcookie("box", getcookie("box").replace(name + "|*|", ""));
    listbox();
}

function listbox() {
    var tmp = "";
    var s3 = getcookie("box").split("|*|" );
    var s4 = s3.length - 1;
    if (s4 > 8) { $("boxlist").style.height = "139px"; }   // 超過 8 筆就出現捲軸
    for (var i = 0; i < s4; i++) {
        tmp += '<div id="box">'
             + '<div id="del" style="float: right;">'
             + '<span onclick="javascript:delbox(\'' + s3[i] + '\')">刪除</span></div>'
             + '<div id="boxtitle"><a href="javascript:getname(\'' + s3[i] + '\')">'
             + s3[i] + '</a></div></div>';
    }
    $("boxlist").innerHTML = tmp;
}

URL 顯示的截短處理

function cuturl(song_url) {
    var MAX_DISP_LEN = 40;
    if (getStrActualLen(song_url) <= MAX_DISP_LEN) { return song_url; }

    var disp = song_url;
    var pos1 = song_url.indexOf("://");
    if (pos1 > 0) {
        disp = song_url.substring(pos1 + 3);
        var pos2 = disp.indexOf("/");
        if (pos2 > 0) { disp = song_url.substring(0, pos1 + pos2 + 4); }  // 只留網域
        var len2 = MAX_DISP_LEN - 3 - getStrActualLen(disp);
        if (len2 > 0) { disp = disp + '...' + song_url.substring(song_url.length - len2); }
        return disp;
    }
}

// 中日韓字元算兩個字寬
function getStrActualLen(sChars) {
    return sChars.replace(/[^\x00-\xff]/g, "xx").length;
}

這個函式解決的是一個很實際的問題:音樂來源網址往往長達上百字元,直接顯示會撐破版面。做法是保留網域與結尾,中間用省略號帶過,並把全形字元以兩倍寬度計算,讓截斷位置在視覺上剛好。

讀完這份程式碼,值得帶走的三件事

  1. 把請求封裝成單一入口。用一個選項字串控制 XML/快取/方法/附加參數,呼叫端就非常乾淨。今天的 fetch 包裝(例如 axios 的 config 物件)是同一個想法的成熟版本。
  2. 用 attach 傳遞上下文。非同步回呼最怕「回來時不知道自己在處理誰」。把識別資訊隨請求一起送、再隨回呼一起帶回來,是避免全域變數的正確做法。
  3. 輪詢與 DOM 操作都要節制。10 毫秒的計時器、每次重建整份 innerHTML,在當年機器上勉強堪用,放到今天就是電量與效能的殺手。

今天要如何改寫

  • 播放器換成 HTML5 <audio>。直接用 timeupdate 事件取代 10 毫秒輪詢,跨平台且不必依賴 ActiveX/插件,也不需要判斷 rm 與 wma 兩套 API。
  • 資料格式換成 JSON。不必再寫 getTagValue 逐節點取值,response.json() 一行搞定。
  • 不要用 eval 呼叫回呼。直接傳函式物件。
  • innerHTML 組字串要格外小心。歌名、歌手名都是外部資料,直接拼進 HTML 與 javascript: 連結裡,等於製造 XSS。改用 textContent 建立節點,或用 addEventListener 綁事件、資料放 dataset。
  • Cookie 改用 localStorage。API 更簡單、容量更大,也不會隨每次請求送到伺服器。

整體而言,這是一份結構清楚、職責分工明確的老派前端程式:通訊、解析、渲染、狀態、記錄各成一塊。這個分層意識,比任何一段具體程式碼都更值得沿用到今天。

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