DIV CSS 佈局教程網

手把手做一個留言板:前端 jQuery 封裝 + 後端 PHP 讀寫 MySQL
編輯:關於JavaScript     

先上成果,這是我個人網站的留言頁,大家可以看看效果:

前端為了省麻煩直接用 jQuery 寫,後端則用 PHP 簡單讀寫 MySQL。

資料庫設計與整體思路

資料庫只建一張表:comments,結構如下:

設計上把所有評論(文章評論、留言板)都塞在同一張表,用 belong 欄位區分不同評論區。同一區裡頭,parent 為 0 代表這是一則主評論,parent 有值時代表它是某則評論的回覆。思路不複雜,但很夠用。

以下不談 CSS,那部分大家依需求自行客製。

先定功能邊界

我的網站沒做訊息通知與即時通訊,所以評論回覆不會主動提醒任何人,只在留言區內產生效果。因此只要實作三件事:

一、顯示評論列表

二、能提交評論

三、能進行回覆

封裝成評論類別

把評論功能包成一個類別,只要實例化就能開出一個新的評論區。所以實例化時需要傳入的參數大概是:評論區 id、抓評論的 PHP 網址、送評論的 PHP 網址。呼叫起來像這樣:

 var oCmt = new Comment({
    parent: $('#box'),        // 要把評論區放到頁面哪個元素裡
    id: 0,
    getCmtUrl: './php/getcomment.php',
    setCmtUrl: './php/comment.php'
 })

當然,也可以改成在 Comment 上定義一個靜態方法,寫法大同小異,只是初始化的位置不同:

 Comment.allocate({
    parent: $('#box'),
    id: 0,
    getCmtUrl: './php/getcomment.php',
    setCmtUrl: './php/comment.php'
 })

建構函式

 function Comment(options){
    this.belong = options.id;
    this.getCmtUrl = options.getCmtUrl;
    this.setCmtUrl = options.setCmtUrl;
    this.lists = [];      // 評論列表
    this.keys = {};       // 評論 id 與 index 對應表
    this.offset = 5;      // 每頁筆數
}

var fn = Comment.prototype;

Comment.allocate = function(options){
    var oCmt = new Comment(options);
    if (oCmt.belong == undefined || !oCmt.getCmtUrl || !oCmt.setCmtUrl) {
        return null;
    };
    oCmt.init(options);
    return oCmt;
};

裡面的變數與方法後面慢慢解釋。如果不打算另外定義 allocate,也可以把檢查與初始化直接寫進建構函式:

 function Comment(options){
    this.belong = options.id;
    this.getCmtUrl = options.getCmtUrl;
    this.setCmtUrl = options.setCmtUrl;
    this.lists = [];
    this.keys = {};
    this.offset = 5;

    if (this.belong == undefined || !this.getCmtUrl || !this.setCmtUrl) {
        return null;
    };
    this.init(options)
}

var fn = Comment.prototype;

變數先放著不管,我的習慣是先寫功能函式,等需要什麼屬性再回頭補。重點是建構函式最後執行了 this.init(options),看名字就知道是初始化函式。

init 函式

 fn.init = function (options) {
    this.initNode(options);      // 初始化節點
    this.parent.html(this.body); // 把內容放進容器
    this.initEvent();            // 初始化事件
    this.getList();              // 抓取列表
 };

以下 fn 皆指 Comment.prototype,不再重複說明。初始化共四件事,逐一拆解。

initNode 函式:初始化並快取 DOM

 fn.initNode = function(options){
    // 初始化容器
    if (!!options.parent) {
        this.parent = options.parent[0].nodeType == 1 ? options.parent : $('#' + options.parent);
    };
    if (!this.parent) {
        this.parent = $('div');
        $('body').append(this.parent);
    }

    // 初始化內容
    this.body = (function(){
        var strHTML = '<div class="m-comment">' +
            '<div class="cmt-form">' +
            '<textarea class="cmt-text" placeholder="歡迎建議,提問題,共同學習!"></textarea>' +
            '<button class="u-button u-login-btn">提交評論</button>' +
            '</div>' +
            '<div class="cmt-content">' +
            '<div class="u-loading1"></div>' +
            '<div class="no-cmt">暫時沒有評論</div>' +
            '<ul class="cmt-list"></ul>' +
            '<div class="f-clear">' +
            '<div class="pager-box"></div>' +
            '</div>' +
            '</div>' +
            '</div>';
        return $(strHTML);
    })();

    // 初始化其他節點
    this.text     = this.body.find('.cmt-text').eq(0);
    this.cmtBtn   = this.body.find('.u-button').eq(0);
    this.noCmt    = this.body.find('.no-cmt').eq(0);
    this.cmtList  = this.body.find('.cmt-list').eq(0);
    this.loading  = this.body.find('.u-loading1').eq(0);
    this.pagerBox = this.body.find('.pager-box').eq(0);
 };

各變數的用途對照如下:

this.parent:容器節點

this.body:評論區的 HTML

this.text:評論輸入的 textarea

this.cmtBtn:提交按鈕

this.noCmt:沒有評論時的提示文字

this.cmtList:列表容器

this.loading:載入中的 GIF

this.pagerBox:分頁器容器

這段沒什麼難點,全是常見的 jQuery 操作。接著 this.parent.html(this.body) 把內容塞進容器,此時評論區已經顯示在頁面上了,只是還沒載入列表、也還不能留言。先看載入列表。

getList 函式:抓取評論列表

先初始化列表——清空、顯示載入動畫、隱藏「暫時沒有評論」,準備好就發 Ajax 請求。思路是請 PHP 把該區的留言一次全抓回來,前端再自行整理:

 fn.resetList = function(){
    this.loading.css('display', 'block');
    this.noCmt.css('display', 'none');
    this.cmtList.html('');
 };

 fn.getList = function(){
    var self = this;
    this.resetList();
    $.ajax({
        url: self.getCmtUrl,
        type: 'get',
        dataType: 'json',
        data: { id: self.belong },
        success: function(data){
            if(!data){ alert('獲取評論列表失敗'); return !1; };
            self.initList(data);          // 整理評論列表
            self.loading.css('display', 'none');

            if(self.lists.length == 0){
                self.noCmt.css('display', 'block');   // 暫時沒有評論
            }else{
                var total = Math.ceil(self.lists.length / self.offset);
                self.pager = new Pager({
                    index: 1,
                    total: total,
                    parent: self.pagerBox[0],
                    onchange: self.doChangePage.bind(self),
                    label: { prev: '<', next: '>' }
                });
            }
        },
        error: function(){ alert('獲取評論列表失敗'); }
    });
 };

用 GET 把 id 傳過去,希望拿回一個列表陣列。PHP 部分不細講,SQL 大致如下:

 $id = $_GET['id'];
$query = "select * from comments where belong=$id order by time";
...
$str = '[';
foreach ($result as $key => $value) {
    $id = $value['id'];
    $username = $value['username'];
    $time = $value['time'];
    $content = $value['content'];
    $parent = $value['parent'];
    $str .= <<<end
{
    "id" : "{$id}",
    "parent" : "{$parent}",
    "username" : "{$username}",
    "time" : "{$time}",
    "content" : "{$content}",
    "response" : []
}
end;
}
$str = substr($str, 0, -1);
$str .= ']';
echo $str;

輸出的 JSON 字串會被 jQuery 的 dataType: 'json' 自動轉成物件,結構如下:

載入成功後我們拿到一堆資料,但此刻所有評論與回覆都還在同一層,必須整理過才能顯示。

initList 函式:把扁平資料整理成樹狀

 fn.initList = function (data) {
    this.lists = [];    // 評論列表
    this.keys = {};     // 評論 id 與 index 對應表
    var index = 0;

    for(var i = 0, len = data.length; i < len; i++){
        var t = data[i], id = t['id'];
        if(t['parent'] == 0){
            this.keys[id] = index++;
            this.lists.push(t);
        }else{
            var parentId = t['parent'],
                parentIndex = this.keys[parentId];
            this.lists[parentIndex]['response'].push(t);
        }
    };
 };

思路很直接:this.lists 只放主評論(parent 為 0),遍歷時遇到 parent 為 0 就 push 進去;否則說明這是回覆,就找到對應的主評論,塞進它的 response 陣列。

但有個坑:id 是持續遞增的,中間若有評論被刪除,id 與 index 就不會對齊,所以才需要 this.keys 這張對照表。一遍下來所有資料都整理進 this.lists 了,剩下就是把資料轉成 HTML 塞回頁面。

 // 顯示評論列表
if(self.lists.length == 0){
    self.noCmt.css('display', 'block');       // 暫時沒有評論
}else{
    var total = Math.ceil(self.lists.length / self.offset);
    self.pager = new Pager({
        index: 1,
        total: total,
        parent: self.pagerBox[0],
        onchange: self.doChangePage.bind(self),
        label: { prev: '<', next: '>' }
    });
}

這是剛才 success 回呼的後半段:資料為空就顯示「暫時沒有評論」,否則建立分頁器。分頁器我直接沿用先前封裝好的版本,簡單說它會先執行一次 onchange,預設頁碼為 1 並存在參數的 index 上。

 fn.doChangePage = function (obj) {
    this.showList(obj.index);
 };

showList 函式:渲染 HTML

 fn.showList = (function(){
    /* 生成一條評論字串 */
    function oneLi(_obj){
        var str1 = '';

        // 處理回覆
        for(var i = 0, len = _obj.response.length; i < len; i++){
            var t = _obj.response[i];
            t.content = t.content.replace(/\<\;/g, '<');
            t.content = t.content.replace(/\>\;/g, '>');
            str1 += '<li class="f-clear"><table><tbody><tr><td>' +
                '<span class="username">' + t.username + ':</span></td><td>' +
                '<span class="child-content">' + t.content + '</span></td></tr></tbody></table>' +
                '</li>'
        }

        // 處理評論:站長固定頭像,其他人隨機
        var headImg = '';
        if(_obj.username == "kang"){
            headImg = 'kang_head.jpg';
        }else{
            var index = Math.floor(Math.random() * 6) + 1;
            headImg = 'head' + index + '.jpg'
        }

        _obj.content = _obj.content.replace(/\<\;/g, '<');
        _obj.content = _obj.content.replace(/\>\;/g, '>');

        var str2 = '<li class="f-clear">' +
            '<div class="head g-col-1">' +
            '<img src="./img/head/' + headImg + '" width="100%"/>' +
            '</div>' +
            '<div class="content g-col-19">' +
            '<div class="f-clear">' +
            '<span class="username f-float-left">' + _obj.username + '</span>' +
            '<span class="time f-float-left">' + _obj.time + '</span>' +
            '</div>' +
            '<span class="parent-content">' + _obj.content + '</span>' +
            '<ul class="child-comment">' + str1 + '</ul>' +
            '</div>' +
            '<div class="respone-box g-col-2 f-float-right">' +
            '<a href="javascript:void(0);" class="f-show response" data-id="' + _obj.id + '">[回復]</a>' +
            '</div>' +
            '</li>';

        return str2;
    };

    return function (page) {
        var len = this.lists.length,
            end = len - (page - 1) * this.offset,
            start = end - this.offset < 0 ? 0 : end - this.offset,
            current = this.lists.slice(start, end);

        var cmtList = '';
        for(var i = current.length - 1; i >= 0; i--){
            var t = current[i], index = this.keys[t['id']];
            current[i]['index'] = index;
            cmtList += oneLi(t);
        }
        this.cmtList.html(cmtList);
    };
})();

參數 page 就是頁碼,依頁碼切片 this.lists 後遍歷拼 HTML,最後 this.cmtList.html(cmtList) 就完成渲染。模板用字串拼接,這部分看個人喜好。效果圖見本文最開頭。

initEvent 函式:綁定事件

剩下最後一個功能:評論與回覆。

 fn.initEvent = function () {
    // 提交按鈕點擊
    this.cmtBtn.on('click', this.addCmt.bind(this, this.cmtBtn, this.text, 0));

    // 點擊回復、取消回復、回復中的提交按鈕
    this.cmtList.on('click', this.doClickResponse.bind(this));
 };

如上圖,點擊回復時希望能出現一個輸入區,可提交也可取消。由於這些元素都是後續動態產生的,所以把事件都掛在評論列表這個父元素上做事件代理,這也是為什麼要用 on 綁在 cmtList 上而不是直接綁在按鈕上。

addCmt 函式:送出評論

 fn.addCmt = function (_btn, _text, _parent) {
    // 防止連續點擊
    if(_btn.attr('data-disabled') == 'true') { return !1; }

    // 處理空白內容
    var value = _text.val().replace(/^\s+|\s+$/g, '');
    value = value.replace(/[\r\n]/g, '<br >');
    if(!value){ alert('內容不能為空'); return !1; }

    // 暫時禁止點擊
    _btn.attr('data-disabled', 'true');
    _btn.html('評論提交中...');

    var self = this, email, username;
    username = $.cookie('user');
    if (!username) { username = '游客'; }
    email = $.cookie('email');
    if (!email) { email = 'default@163.com'; }

    var now = new Date();

    $.ajax({
        type: 'get',
        dataType: 'json',
        url: this.setCmtUrl,
        data: {
            belong: self.belong,
            parent: _parent,
            email: email,
            username: username,
            content: value
        },
        success: function(_data){
            // 解除禁止
            _btn.attr('data-disabled', '');
            _btn.html('提交評論');

            if (!_data) { alert('評論失敗,請重新評論'); return !1; }

            if (_data['result'] == 1) {
                alert('評論成功');
                var id = _data['id'],
                    time = now.getFullYear() + '-' + (now.getMonth() + 1) + '-' + now.getDate() +
                           ' ' + now.getHours() + ':' + now.getMinutes() + ':' + now.getSeconds();

                if (_parent == 0) {
                    var index = self.lists.length;
                    if (!self.pager) {
                        self.noCmt.css('display', 'none');
                        var total = Math.ceil(self.lists.length / self.offset);
                        self.pager = new Pager({
                            index: 1,
                            total: total,
                            parent: self.pagerBox[0],
                            onchange: self.doChangePage.bind(self),
                            label: { prev: '<', next: '>' }
                        });
                    }
                    self.keys[id] = index;
                    self.lists.push({
                        "id": id,
                        "username": username,
                        "time": time,
                        "content": value,
                        "response": []
                    });
                    self.showList(1);
                    self.pager._$setIndex(1);
                } else {
                    var index = self.keys[_parent],
                        page = self.pager.__index;
                    self.lists[index]['response'].push({
                        "id": id,
                        "username": username,
                        "time": time,
                        "content": value
                    });
                    self.showList(page);
                }
                self.text.val('');
            } else {
                alert('評論失敗,請重新評論');
            }
        },
        error: function () {
            alert('評論失敗,請重新評論');
            _btn.attr('data-disabled', '');
            _btn.html('提交評論');
        }
    });
 }

參數有三個:_btn、_text、_parent。之所以要這樣傳,是為了讓「新增評論」與「新增回覆」共用同一支函式,不必分開寫兩份。流程是:防連點 → 檢查 cookie 有沒有 username / email,沒有就用訪客身分 → 清理內容(去首尾空白、把換行轉成 <br>)→ 發請求。成功後把新資料塞進 this.lists,再呼叫 this.showList(1) 刷新畫面。

PHP 端同樣不細講,SQL 大致如下:

 $parent = $_GET['parent'];
$belong = $_GET['belong'];
$content = htmlentities($_GET['content']);
$username = $_GET['username'];
$email = $_GET['email'];
$query = "insert into comments (parent,belong,content,time,username,email) value ($parent,$belong,'$content',NOW(),'$username','$email')";

doClickResponse 函式:處理回覆區的互動

 fn.doClickResponse = function(_event){
    var target = $(_event.target);
    var id = target.attr('data-id');

    if (target.hasClass('response') && target.attr('data-disabled') != 'true') {
        // 點擊回復:動態插入輸入區
        var oDiv = document.createElement('div');
        oDiv.className = 'cmt-form';
        oDiv.innerHTML = '<textarea class="cmt-text" placeholder="歡迎建議,提問題,共同學習!"></textarea>' +
            '<button class="u-button resBtn" data-id="' + id + '">提交評論</button>' +
            '<a href="javascript:void(0);" class="cancel">[取消回復]</a>';
        target.parent().parent().append(oDiv);
        oDiv = null;
        target.attr('data-disabled', 'true');   // 阻止重複生成
    } else if (target.hasClass('cancel')) {
        // 點擊取消回復:移除剛才插入的節點
        var ppNode = target.parent().parent(),
            oRes = ppNode.find('.response').eq(0);
        target.parent().remove();
        oRes.attr('data-disabled', '');         // 讓回復按鈕可以重新點擊
    } else if (target.hasClass('resBtn')) {
        // 點擊提交
        var oText = target.parent().find('.cmt-text').eq(0),
            parent = target.attr('data-id');
        this.addCmt(target, oText, parent);
    } else {
        return !1;
    }
 };

靠 target.hasClass() 判斷點到哪個元素,分別處理三種情況。值得注意的是 parent 的值在生成 HTML 時就存進提交按鈕的 data-id 上了,所以提交時直接讀得出來。

另外提醒一個實務上的資安重點:這份程式碼的 SQL 是直接字串拼接的,正式上線前務必改用 Prepared Statement 或至少做好參數轉義,否則会有 SQL Injection 風險;輸出到頁面的內容也建議經過適當的轉義處理,避免 XSS。留言板屬於公開輸入點,這部分不能省。

至此全部功能都實作完成了,希望對大家的學習有所啟發。

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