萬盛學電腦網

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

ASP.NET Web Service (ASMX) 建立完整教學:從指令到部署

ASP.NET Web Service (.asmx) 雖屬舊技術 (現推薦 WCF/Web API),但維護舊系統仍需了解。本文詳述建立流程、指令屬性、屬性標記與實戰範例。

一、.asmx 檔案指令

<%@ WebService Language="C#" CodeBehind="~/App_Code/Service.cs" Class="Service" %>
屬性說明
Language程式語言 (C#/VB/JScript),可選,預設依副檔名推斷
Class實作 Web Service 的類別名稱 (必要)
CodeBehind原始碼檔案路徑 (VS2008 放在 App_Code)
Debug是否啟用偵錯編譯,預設 false (受 web.config 控制)

二、代碼隱藏檔結構

using System;
using System.Web.Services;
using System.Web.Services.Protocols;

[WebService(Namespace = "https://tempuri.org/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
// [System.Web.Script.Services.ScriptService] // 啟用 AJAX 呼叫時取消註解
public class Service : System.Web.Services.WebService {
    public Service() {
        // InitializeComponent();
    }

    [WebMethod]
    public string HelloWorld() {
        return "Hello World";
    }
}

三、核心屬性詳細說明

1. [WebService] 屬性

  • 可選,用於指定服務中繼資料
  • Namespace:XML 命名空間,**發布前必須修改**為永久唯一值 (如公司域名 https://www.mycompany.com/),開發階段可用 https://tempuri.org/
  • 其他屬性:Name、Description

2. [WebServiceBinding] 屬性

  • 對應 WSDL 中的 Binding (介面契約)
  • ConformsTo = WsiProfiles.BasicProfile1_1 宣告符合 WS-I Basic Profile 1.1 互通性標準
  • 可套用多個 WebServiceBinding 實作多重繫結

3. [WebMethod] 屬性

公開方法必須標記此屬性才能被遠端呼叫。支援屬性:

屬性功能預設值
BufferResponse啟用回應緩衝 (true=完整緩衝後送出)true
CacheDuration快取秒數 (0=停用),依參數組合快取0
Description說明文字,顯示於測試頁""
EnableSession啟用 Session 狀態false
MessageName方法別名,解決多載衝突 (Web Service 不支援多載)方法名

四、實戰範例:查詢聯絡人 Web Service

[WebMethod(Description = "輸入聯絡人姓名,回傳詳細資訊")]
public string Select(string stuName) {
    // 1. 連線 Access 資料庫
    string connStr = "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=" + 
                     Server.MapPath("~/App_Data/db18.mdb");
    using (OleDbConnection conn = new OleDbConnection(connStr)) {
        conn.Open();
        // 2. 參數化查詢 (防 SQL Injection)
        using (OleDbCommand cmd = new OleDbCommand(
            "SELECT * FROM 聯絡人 WHERE 姓名 = @Name", conn)) {
            cmd.Parameters.AddWithValue("@Name", stuName);
            using (OleDbDataReader dr = cmd.ExecuteReader()) {
                if (dr.Read()) {
                    return string.Format("姓名:{0},地址:{1},公司:{2},頭銜:{3}",
                        dr["姓名"], dr["地址"], dr["公司名稱"], dr["頭銜"]);
                }
                return string.IsNullOrEmpty(stuName) 
                    ? "<font color='blue'>請輸入姓名</font>" 
                    : "<font color='red'>查無此人!</font>";
            }
        }
    }
}

五、部署與測試

  1. 建立 ASP.NET Web Service 專案 (VS2008: 檔案 → 新增網站 → ASP.NET Web Service)
  2. 將 .asmx 放在網站根目錄,.cs 放在 App_Code
  3. 瀏覽 https://localhost/YourService.asmx → 出現測試頁
  4. 點擊方法名 → 輸入參數 → 「叫用」 → 查看 XML 回應
  5. 用戶端加入「Web 參考」或「服務參考」產生 Proxy 類別呼叫

六、遷移建議

  • 新專案請使用 ASP.NET Core Web API 或 WCF
  • ASMX 限制:僅支援 HTTP/ SOAP、序列化器固定 (XmlSerializer)、無 REST 支援
  • 遷移策略:保留商業邏輯,重寫端點層為 Controller/ServiceContract
copyright © 萬盛學電腦網 all rights reserved