DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> JavaScript入門知識 >> AJAX入門 >> AJAX詳解
用 Ajax 加原生 JavaScript 打造自動補全 TextBox
編輯:AJAX詳解     

一時興起,想自己動手做一個具備自動補全能力的文字框。目標拆成四項:能從資料庫讀取資料、能在使用者輸入時以 Ajax 向伺服器請求對應資料、能用 JavaScript 控制資料的呈現方式、能用 JavaScript 綁定相關事件。

手上現成的資源還不錯:SQL Server 2008 裡有一張收錄全台 500 多個縣市的表格 Macaco.CityCollection,欄位分別是自動編號的 AutoID、用途不明的 EndNumber,以及存放城市名稱的 City。就拿它當資料來源。

一、資料模型與資料存取

先在 Tools 類庫中建立兩個類別:一個對應資料表欄位的模型,一個封裝查詢邏輯。

public class CityModel
{
    public int ID { get; set; }
    public int EndNumber { get; set; }
    public string City { get; set; }
}
public class CityCollectionTools
{
    string strcon = "server=.;uid=DemoUser;pwd=DemoUser;DataBase=MacacoOnline;";

    public List<CityModel> GetCityDataByEndNumberAndCity(string sqlPar)
    {
        if (string.IsNullOrEmpty(sqlPar)) return null;

        // 模糊查詢取前 10 筆;實務上應加一個優先權欄位並依它排序
        string strcmd = "select top 10 ID, EndNumber, City from Macaco.CityCollection "
            + "where EndNumber like '%' + @SqlPar + '%' or City like '%' + @SqlPar + '%' "
            + "order by ID";

        using (SqlConnection conn = new SqlConnection(strcon))
        using (SqlCommand sqlcmd = new SqlCommand(strcmd, conn))
        {
            // 使用參數化查詢,避免 SQL  injection
            sqlcmd.Parameters.Add(new SqlParameter("@SqlPar", SqlDbType.VarChar, 20)).Value = sqlPar;

            conn.Open();
            using (SqlDataReader sdr = sqlcmd.ExecuteReader())
            {
                var cityList = new List<CityModel>();
                while (sdr.Read())
                {
                    cityList.Add(new CityModel
                    {
                        ID = sdr.GetInt32(0),
                        EndNumber = sdr.GetInt32(1),
                        City = sdr.GetString(2)
                    });
                }
                return cityList;
            }
        }
    }
}

二、回應 Ajax 請求的通用處理程式

在 MVC 專案裡新增一個一般事件處理程序 GetCityData.ashx,放在自建的 AjaxHelp 資料夾中。它負責接收參數、呼叫查詢方法,再把結果拼成 HTML 字串回傳。

public class GetCityData : IHttpHandler
{
    public void ProcessRequest(HttpContext context)
    {
        context.Response.Clear();

        CityCollectionTools ccTools = new CityCollectionTools();
        string strPar = context.Request.QueryString[0];

        List<CityModel> cityData = ccTools.GetCityDataByEndNumberAndCity(strPar);
        if (cityData == null)
        {
            context.Response.Write("");
            return;
        }

        StringBuilder sb = new StringBuilder();
        foreach (CityModel city in cityData)
        {
            sb.Append("<p>(" + city.EndNumber + ") " + city.City + "</p>");
        }

        context.Response.Write(sb.ToString());
    }

    public bool IsReusable { get { return false; } }
}

服務端到此就完成了:模糊查詢、簡單格式化、輸出回應。

三、前端頁面

reuse 既有的 Index 頁面(Views/Home/Index.aspx),不另外開新檔。

<%@ Page Language="C#" MasterPageFile="~/Views/Shared/Site.Master"
    Inherits="System.Web.Mvc.ViewPage" %>

<asp:Content ID="Content1" ContentPlaceHolderID="TitleContent" runat="server">
    主頁
</asp:Content>

<asp:Content ID="Content2" ContentPlaceHolderID="MainContent" runat="server">
    <%-- 等同於 <input id="txtCity" name="txtCity" /> --%>
    <%: Html.TextBox("txtCity") %><br />

    <%-- 這是資料的舞台,從伺服器取回的內容都呈現在這個 DIV 裡 --%>
    <div id="ShowDataDiv" class="showDataDivStyle" title="txtCity"></div>

    <%-- 動態在 head 中插入外部 JS 的連結 --%>
    <script type="text/javascript">
        var head = document.getElementsByTagName("head")[0];
        var script = document.createElement("script");
        script.src = "Scripts/MacacoJSTools.js";
        script.type = "text/javascript";
        head.appendChild(script);
    </script>
</asp:Content>

四、核心 JavaScript

放在 Scripts 資料夾下的 MacacoJsTools.js,包含建立、發送、回應 Ajax 請求,以及為 TextBox、P、Div 綁定事件的邏輯。

// 簡化 getElementById
function $(id) { return document.getElementById(id); }

var showDataDiv = $("ShowDataDiv");
// title 存的是 TextBox 的 id
var textBox = $(showDataDiv.title);

showDataDiv.style.display = "none";   // 初始隱藏

textBox.onkeyup = function () { SendRequest(this.value); };
textBox.onclick = function () { SendRequest(this.value); };
textBox.onblur = function () {
    // 延遲 150ms 隱藏,讓使用者有時間點選候補項目
    setTimeout(function () { showDataDiv.style.display = "none"; }, 150);
};

// 跨瀏覽器建立 XMLHttpRequest
function GetXMLHttpRequest() {
    if (window.XMLHttpRequest) {
        return new XMLHttpRequest();
    } else if (window.ActiveXObject) {
        try {
            return new ActiveXObject("Msxml2.XMLHTTP");
        } catch (e) {
            try {
                return new ActiveXObject("Microsoft.XMLHTTP");
            } catch (e) {
                alert("您的瀏覽器不支援 Ajax,無法完成查詢。");
                return false;
            }
        }
    }
    return false;
}

var httpRequest;

function SendRequest(strPar) {
    if (strPar.length === 0) {
        showDataDiv.style.display = "none";
        return;
    }

    httpRequest = GetXMLHttpRequest();
    if (!httpRequest) return;

    httpRequest.onreadystatechange = ResponseHttpRequest;
    httpRequest.open("GET", "/AjaxHelp/GetCityData.ashx?" + encodeURIComponent(strPar), true);
    httpRequest.send(null);
}

function ResponseHttpRequest() {
    if (httpRequest.readyState !== 4 || httpRequest.status !== 200) return;

    var reqText = httpRequest.responseText;
    if (reqText.length === 0) {
        showDataDiv.style.display = "none";
        return;
    }

    // 這裡用 innerHTML 而非 innerText,因為回傳內容含 HTML 標籤,需要瀏覽器解析並套用樣式
    showDataDiv.innerHTML = reqText;

    var pCol = showDataDiv.getElementsByTagName("p");
    for (var i = 0; i < pCol.length; i++) {
        // 點選項目後把內容填回 TextBox 並收合清單
        pCol[i].onclick = function () {
            textBox.value = this.innerHTML;
            showDataDiv.style.display = "none";
        };
        pCol[i].title = pCol[i].innerHTML;
    }

    showDataDiv.style.display = "block";
}

五、樣式

最後補上 CSS,放在 Content 資料夾中的 MacacoStyleSheet.css:

.showDataDivStyle {
    width: 202px;
    height: 210px;
    line-height: 15px;
    position: absolute;      /* 讓它脫離文件流,覆蓋在下方內容之上 */
    background-color: #ffeeee;
    font-size: 12px;
    border: 1px solid silver;
    margin-top: -1px;        /* 讓清單與 TextBox 更貼合 */
}

.showDataDivStyle p {
    cursor: pointer;
    width: 190px;
    border: 1px solid #ffeeee;
    border-left: none;
    border-right: none;
    margin: 0 auto;
}

.showDataDivStyle p:hover {
    border: 1px solid blue;
    border-left: none;
    border-right: none;
    background-color: Purple;
}

測試結果與可改進處

這份程式碼在 IE8、IE9、Safari、遨遊 3、Opera、Chrome 與 Firefox 4.0 Beta8 上都跑過,除 Firefox 反應慢約一秒之外其餘相容性良好。手邊沒有 Win7 以下的環境,IE6 可能會有樣式偏移,加上版本判斷即可處理。

回頭看,有幾個地方值得再打磨:onkeyup 每次按鍵都發一次請求,實務上應該加上 debounce 或最小字數門檻;清單定位用 absolute 搭配固定寬高,遇到視窗縮放容易跑位;查詢字串建議改用 encodeURIComponent 編碼,避免特殊字元造成參數錯誤。

專案原始碼可另循下載連結取得,Tools 專案的程式碼已移至 App_Code、資料庫檔移至 App_Data,可能需要附加到 MSSQL 才能執行。

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