萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> ASP.NET 程式設計

ASP.NET AJAX 自動完成 (AutoComplete) 整合 SQL Server 資料庫完整實作

使用 ASP.NET AJAX Control Toolkit 的 `AutoCompleteExtender` 搭配 Web Service (`.asmx` 或 WCF) 實現從 SQL Server 即時查詢資料並提供下拉建議功能。

架構圖解

[使用者輸入] -> [AutoCompleteExtender] -> [JavaScript] -> [Web Service (JSON)] -> [SQL Server] -> [回傳字串陣列] -> [顯示建議清單]

1. 建立 Web Service (ASMX - 簡單輕量)

// AutoCompleteService.asmx
[WebService(Namespace = "https://tempuri.org/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
[System.Web.Script.Services.ScriptService] // 關鍵:允許被腳本呼叫
public class AutoCompleteService : System.Web.Services.WebService
{
    [WebMethod]
    public string[] GetProducts(string prefixText, int count, string contextKey)
    {
        string connStr = ConfigurationManager.ConnectionStrings["Northwind"].ConnectionString;
        var results = new List();

        using (var conn = new SqlConnection(connStr))
        using (var cmd = new SqlCommand("SELECT ProductName FROM Products WHERE ProductName LIKE @prefix + '%'", conn))
        {
            cmd.Parameters.AddWithValue("@prefix", prefixText);
            conn.Open();
            using (var reader = cmd.ExecuteReader())
            {
                while (reader.Read() && results.Count < count)
                {
                    results.Add(reader.GetString(0));
                }
            }
        }
        return results.ToArray(); // 自動序列化為 JSON 字串陣列
    }
}

2. ASPX 頁面整合

<%@ Register Assembly="AjaxControlToolkit" Namespace="AjaxControlToolkit" TagPrefix="ajax" %>

<asp:ScriptManager ID="ScriptManager1" runat="server" />

<asp:TextBox ID="txtProduct" runat="server" Width="300px" />

<ajax:AutoCompleteExtender 
    ID="aceProduct" 
    runat="server" 
    TargetControlID="txtProduct"
    ServicePath="AutoCompleteService.asmx"
    ServiceMethod="GetProducts"
    MinimumPrefixLength="2"          <!-- 至少輸入 2 字元才查詢 -->
    CompletionInterval="300"         <!-- 延遲 300ms 發送請求 -->
    CompletionSetCount="10"          <!-- 最多顯示 10 筆 -->
    DelimiterCharacters=";, "        <!-- 支援多值輸入分隔符 -->
    ShowOnlyCurrentWordInCompletionListItem="true"
    EnableCaching="true"             <!-- 客戶端快取 -->
    CompletionListCssClass="autocomplete_list"
    CompletionListItemCssClass="autocomplete_item"
    CompletionListHighlightedItemCssClass="autocomplete_highlight">
</ajax:AutoCompleteExtender>

3. CSS 樣式美化

<style>
.autocomplete_list { border: 1px solid #ccc; background: white; overflow: auto; max-height: 200px; }
.autocomplete_item { padding: 5px 10px; cursor: pointer; }
.autocomplete_highlight { background: #3498db; color: white; }
</style>

進階:回傳 ID 與顯示文字分離 (雙欄位)

若需選取後取得 ID (如 `ProductID`),需修改 Web Method 回傳格式:

[WebMethod]
public AjaxControlToolkit.AutoCompleteItem[] GetProductsWithId(string prefixText, int count, string contextKey)
{
    var items = new List();
    // ... 查詢 DB 取得 ProductID, ProductName ...
    while (reader.Read())
    {
        items.Add(new AjaxControlToolkit.AutoCompleteItem(
            reader["ProductName"].ToString(),    // 顯示文字
            reader["ProductID"].ToString()       // 隱藏值
        ));
    }
    return items.ToArray();
}

前端取得選取值:

// 取得選取的隱藏值
var selectedValue = $find('aceProduct').get_selectedItemValue();

Web.config 關鍵設定

<system.web>
  <httpHandlers>
    <add verb="*" path="*_AppService.axd" type="System.Web.Script.Services.ScriptHandlerFactory, System.Web.Extensions, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" />
    <add verb="*" path="*.asmx" type="System.Web.Script.Services.ScriptHandlerFactory, System.Web.Extensions, Version=4.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" />
  </httpHandlers>
</system.web>
<system.webServer>
  <handlers>
    <add name="ScriptHandlerFactory" verb="*" path="*.asmx" type="System.Web.Script.Services.ScriptHandlerFactory" preCondition="integratedMode" />
    <add name="ScriptHandlerFactoryAppServices" verb="*" path="*_AppService.axd" type="System.Web.Script.Services.ScriptHandlerFactory" preCondition="integratedMode" />
  </handlers>
</system.webServer>

效能優化建議

  1. 資料庫索引: `ProductName` 欄位建立非叢集索引。
  2. 限制回傳筆數: `CompletionSetCount="10"` 避免傳輸過大 JSON。
  3. 客戶端快取: `EnableCaching="true"` 減少重複查詢。
  4. 最小字元長度: `MinimumPrefixLength="2"` 避免單字元觸發全表掃描。
  5. 延遲查詢: `CompletionInterval="300"` 等待使用者停止輸入。

現代替代方案

  • jQuery UI Autocomplete / Select2 / Typeahead.js + Web API / MVC Controller 回傳 JSON。
  • Blazor / React / Vue 元件化自動完成,支援虛擬滾動、分組、非同步搜尋。
  • ASP.NET Core 內建 Microsoft.AspNetCore.Mvc.TagHelpers 整合。

AutoCompleteExtender 雖屬舊世代技術,但在維護 Web Forms 專案時仍是快速實現自動完成的有效工具,核心在於 ScriptService 屬性與 JSON 字串陣列回傳格式。

copyright © 萬盛學電腦網 all rights reserved