[ASP.NET AJAX]PageMethod:用javascript呼叫server端的method

[AJAX]PageMethod:用javascript呼叫server端的method

前言:

從有AJAX的UpdatePanel之後,就是普遍的將新進的開發人員無腦化,

講到UpdatePanel,在他們眼中就是「局部更新」、「非同步更新」、「畫面不會閃」、「比較快」、「啥都讓他Postback就好」、「不需要寫javascript」。

這幾點,以他們的角度來看,可以說都沒錯,但也可以說錯的離譜。

 

UpdatePanel的確是為了快速開發而存在,實作上的確可以省掉很多javascript的撰寫,畫面也的確不會閃爍,這跟局部更新也有關係。只是背後隱藏著太多的操作,沒去理解架構與運作流程,真的只會造成濫用、誤解。(雖然我不敢說我就懂AJAX架構)

 

UpdatePanel可以讓不熟javascript的開發人員,快速開發類似「回呼」(CallBack)的程式。

但付出的效率代價可是很大的,UpdatePanel應該是當畫面上觸發PostBack後攔截該PostBack事件

(但是這個時候整頁的資料、ViewState已經都傳回server端了,也就是流量effort跟整頁postback沒啥兩樣)

接著再去判斷觸發PostBack的物件,是否在UpdatePanel中,

若是,則代表此物件的PostBack只需局部更新相關的原始碼內容,

透過XMLHttpRequest

(也就是CallBack的核心),呼叫server端的method後,再回傳執行結果,至「需要更新的區塊裡」,也就是需要更新的UpdatePanel。

 

所以說,UpdatePanel真要說比較快,應該只有省Partial Render的部分(應該….應該…),AJAX的重點還是在如何使用client端的script,去執行server端的code。

除了UpdatePanel外,還可以透過javascript呼叫Web service(Web服務)或PageMethod(頁面方法),來執行server端的logic。

 

重點開始:

這邊就開始介紹一下PageMethod,整理一下在網路上看到的範例,其實還蠻容易上手的。

Step1:首先,PageMethod是建立在ASP.NET AJAX裡,也就是跟Scriptmanager息息相關。所以畫面上要有Scriptmanager,而且要設定一下EnablePageMethods屬性為True。


        <ASPExtensions:ScriptManager ID="ScriptManager1" runat="server" EnablePageMethods="true">
        </ASPExtensions:ScriptManager>

 

 

 

 

 

Step2:WebConfig要在<system.web>裡面,設定一下httpModules。

<httpModules>
      <add type="Microsoft.Web.UI.ScriptModule" name="ScriptModule"/>
</httpModules>

 

 

 

 

 

Step3:在aspx裡面,拉兩個textbox出來,用來當input與output的值。


        <asp:TextBox ID="TextBox1" runat="server" />
        <asp:TextBox ID="TextBox2" runat="server" Width="200px">

 

 

 

 

 

Step4:新增一個javascript檔,叫做TestJavaScript.js。放在同一層目錄底下。並在aspx的<body>之後,include該js。

<body>
    <script language="javascript" src="TestJavaScript.js" type="text/javascript"> </script>

 

 

 

 

 

Step5:撰寫javascript的function,CallMe()。其中,CallSuccess為XMLHttpRequest成功後要做的事,CallFailed為失敗要做的事,dest則是最後output的值要放在哪。而關鍵的一行就是Pagemethods.GetContactName()。

function CallMe(src,dest)
 {    
     var ctrl = document.getElementById(src);
     // call server side method
     PageMethods.GetContactName(ctrl.value,CallSuccess,CallFailed,dest);
 }
 
 // set the destination textbox value with the ContactName
 function CallSuccess(res, destCtrl)
 {    
     var dest = document.getElementById(destCtrl);
     dest.value = res;
 }
 
 // alert message on some failure
 function CallFailed(res, destCtrl)
 {
     alert(res.get_message());
 }

 

 

 

 

 

Step6:接著就要撰寫後置程式碼的Web Method了,也就是js裡呼叫的GetContactName()。這邊的例子input是TextBox1.text,output則是TextBox1.text+系統時間。可以修改成透過TextBox1.text,撈DB相關資料後,Return到TextBox2上。要特別注意的是,需宣告成public static,且需要System.Web.Services.WebMethod的修飾語。


    [System.Web.Services.WebMethod]
    public static string GetContactName(string TextBox1text)
    {
        return TextBox1text + System.DateTime.Now.ToString();
    }

 

 

 

 

 

Step7:接著在Page_Load()的時候,將javascript的function註冊到TextBox1的onblur事件上。


    protected void Page_Load(object sender, EventArgs e)
    {
        if (!Page.IsPostBack)
        {
            TextBox1.Attributes.Add("onblur", "CallMe('" + TextBox1.ClientID + "', '" + TextBox2.ClientID + "')");            
        }
    }

 

 

 

 

 

Step8:執行後,在TextBox1上輸入”Hello World !”,就會發現onblur之後,執行了server端的GetContactName(),而且畫面並未PostBack

 

執行結果


 

其實,PageMethod的方式跟Web Service大同小異,不過省了參考asmx,也省了些檔案,還蠻適合特殊需求時使用。

用Client端Script呼叫Server端的Method,這我也是第一次使用,有錯誤或需要加強的地方,還望大家多指教。

 

 

 

 

備註:

補上參考

http://www.dotnetcurry.com/(X(1)S(rt0xn145dv3fp355xczceu45))/ShowArticle.aspx?ID=109&AspxAutoDetectCookieSupport=1


或許您會對下列培訓課程感興趣:

  1. 2019/12/21(六)~2019/12/22(日):演化式設計:測試驅動開發與持續重構 第七梯次(台北)
  2. 2020/1/4(六)~2020/1/5(日):Clean Coder:DI 與 AOP 進階實戰 第三梯次(台北)
  3. 2020/02/08(六):【針對遺留代碼加入單元測試的藝術】 第八梯次(台北)
  4. 2020/02/09(日):【極速開發+】 第九梯次(台北)
  5. 2020/02/28(五)~2020/3/1(日) C#進階設計-從重構學會高易用性與高彈性API設計 第三梯次(台北)

想收到第一手公開培訓課程資訊,或想詢問企業內訓、顧問、教練、諮詢服務的,請洽 Facebook 粉絲專頁:91敏捷開發之路