ASP.NET AJAX İle WebMethod Kullanımı

Herkese merhaba. Crema’da yazılım geliştirme uzmanı olarak çalışıyorum. Bu blogda ASP.Net ve Web teknolojileri ile ilgili hile ve ipuçlarını sizinle paylaşacağım. Bu ipuçlarını sosyal hayatınızda denemeyin veya uygulamayın @D

İlk konumuz Asp.net ajax web methodlarla ilgili olacak.

Page Method nedir?

Asp.net server-client bazlı çalışma mantığına sahip olduğu için bir sayfanın çağrılması o sayfa ile ilgili olan bütün eventlerin ve nesnelerin yeniden oluşturulması anlamına gelmektedir. Update panel ile sayfamızda asenkron callback işlemi başlatsak bile, update panel içerisindeki tüm veriler server tarafına aktarılır ve sayfanın life-cycle’ı yeniden oluşturulmuş olur. Bu durum (Partial Postback in Update Panel), tüm sayfanın ve controllerinin viewstate ile taşınmasından daha iyi bir durumdur. Bunun yanında geliştirme açısından çok hızlı çözümler üretmemizi sağlar. Eğer uygulamızın çok hızlı çalışmasını istiyorsak, sayfanın sunucu tarafında yeniden üretilmesi ve life-cycle içerinde bazı olayların her defasında tekrarlanmasını istemiyorsak bu noktada ortaya Page Method’ lar çıkıyor.

Neden Page Method’lar Daha Hızlıdır?
Page method’lar static methodlar olduğu için sayfada tetiklendiğinde taşıyıcısı olan page class’ının eventlerini tetiklemez ve page yeniden oluşturulmaz. Aşağıdaki c# örneğinde GetMessage methoduna ulaşmak için Sample.GetMessage() dememiz yeterli olacaktır. Sample nesnesinin bir örneği oluşturulmaz veya içerisinde bazı eventler olmuş olsa bunlar tetiklenmez. PageMethod’ların da page classı içerisinde static olması bundan farklı bir durum değildir. Hatta daha önemlisi update panel içerisinde taşınan ViewState datasına ihtiyacı yoktur. Bu da ona ciddi bir performans katmaktadır.

Düz metinPanoya kopyalaYazdır

1. Public  class Sample  
2. {  
3.     Public static string GetMessage()  
4.     {  
5.     return DateTime.Now;  
6.     }  
7. }  

Bloglarda çokça incelenen bir konu üzerinde durmak istiyorum. Bu konunun çözümü ile ilgili küçük bir örnekle Page Method’lar konusundan daha detaylı ve ince noktalara değinmiş olacağız.

User Controls,Master Page ve Page üçlemesinde PageMethod

Düz metinPanoya kopyalaYazdır

1. using System;  
2. using System.Collections.Generic;  
3. using System.Linq;  
4. using System.Web;  
5. using System.Web.UI;  
6. using System.Web.UI.WebControls;  
7. using System.Web.Services;  
8.   
9. namespace AjaxPageMethode.UserControl  
10. {  
11.     public partial class ctrl_Alert : System.Web.UI.UserControl  
12.     {  
13.         protected void Page_Load(object sender, EventArgs e)  
14.         {  
15.   
16.         }  
17.         [WebMethod]  
18.         public static string GetMessage()  
19.         {  
20.             return "Test Methode" + DateTime.Now;  
21.         }  
22.     }  
23. }  

Düz metinPanoya kopyalaYazdır

1. <%@ Control Language="C#" AutoEventWireup="true" CodeBehind="ctrl_Alert.ascx.cs" Inherits="AjaxPageMethode.UserControl.ctrl_Alert" %>  
2. <script type="text/javascript">  
3. //<![CDATA[ 
4.  
5.     function GetMessageFromPageMethode() { 
6.         PageMethods.GetMessage(OnSucces, OnError); 
7.     } 
8.     function OnSucces(result) { 
9.         alert(result); 
10.     } 
11.     function OnError() { 
12.         var stackTrace = error.get_stackTrace(); 
13.         alert(stackTrace); 
14.     } 
15.  //]]>  
16. </script>  
17. <asp:button id="btnShowMessage" runat="server" onclientclick="javascript:GetMessageFromPageMethode();" text="Show Message">  
18. </asp:button>  

Yukarıda örnekte ctr_Alert.ascx usercontrolu içerisinde static web method ve html tarafında bir javascript ile static metod sonucu dönen string’i alert olarak vermeye çalışacağız. Senaryo basit gibi gözüksede  sayfayı çalıştırdığımızda resimdeki çıktıyı aldığımızda şaşırmamalıyız. Malesef usercontrol içerisinde pagemethodları kullanamıyoruz. Çünkü usercontrol yukarıda da görüldüğü gibipublic partial class ctrl_Alert : System.Web.UI.UserControl 
usercontrol tipinden inherit edilmiştir. Bunun çözmek için usercontroller içerisindedeki pagemethodları kullanacağımız sayfalara taşımalıyız.

Örneğin usercontrolü eklediğim default.aspx ‘e

Düz metinPanoya kopyalaYazdır

1. public partial class _Default : System.Web.UI.Page  
2.     {  
3.         protected void Page_Load(object sender, EventArgs e)  
4.         {  
5.   
6.         }  
7.         [WebMethod]  
8.         public static string GetMessage()  
9.         {  
10.             return "Test Methode" + DateTime.Now;  
11.         }  
12.   
13.     }  

Web metoudunu eklediğimizde ise basit olan senaryonun ilk problemini çözmüş olacağız. Bu bizim açımızdan pek tatmin edici bir çözüm olmayabilir. Çünkü yazdığımız Composite ve Custom controllerin PageMetholarının kendi içerinde olması kodun düzenlenmesi ve ilerideki güncellemeler göz önüne alındığında dezavantajları vardır.

Not: En azından, page methodları kullanan scriptleri user control içerisinde tutabilirsiniz. Sadece PageMethodu o user controlü çağırdığınız sayfaya eklemeniz yeterli olacaktır.

Tabii sayfaya script manager ekleminiz ve EnablePageMethode propertysini True yapmanız gibi ufak detayları bildiğinizi varsayarak bunlar üzerinde durmayacağım.
Aynı senaryoyu masterpage üzerinde denediğimizde, aşağıdaki gibi bir yapıya sahip olacak.

Düz metinPanoya kopyalaYazdır

1. <%@ Master Language="C#" AutoEventWireup="true" CodeBehind="TestMaster.master.cs" Inherits="AjaxPageMethode.TestMaster" %>  
2.     <asp:contentplaceholder id="head" runat="server">  
3.     </asp:contentplaceholder>  
4.     <script type="text/javascript">  
5.     //<![CDATA[ 
6.         function GetMessageFromPageMethode() { 
7.             PageMethods.GetMessage(OnSucces, OnError); 
8.         } 
9.         function OnSucces(result) { 
10.             alert(result); 
11.         } 
12.         function OnError() { 
13.             var stackTrace = error.get_stackTrace(); 
14.             alert(stackTrace); 
15.         } 
16.     //]]>  
17. </script>  
18.   
19.   
20. <form id="form1" runat="server">  
21.         <asp:scriptmanager id="ScriptManager1" enablepagemethods="true" runat="server">  
22.         </asp:scriptmanager>  
23. <div>  
24.         <asp:contentplaceholder id="ContentPlaceHolder1" runat="server">  
25.         </asp:contentplaceholder>  
26.   
27.   
28.         <asp:button id="btnShowMessage" runat="server" onclientclick="javascript:GetMessageFromPageMethode();" text="Show Message">  
29.     </asp:button></div>  
30. </form>  

Düz metinPanoya kopyalaYazdır

1. using System;  
2. using System.Collections.Generic;  
3. using System.Linq;  
4. using System.Web;  
5. using System.Web.UI;  
6. using System.Web.UI.WebControls;  
7. using System.Web.Services;  
8.   
9. namespace AjaxPageMethode  
10. {  
11.     public partial class TestMaster : System.Web.UI.MasterPage  
12.     {  
13.         protected void Page_Load(object sender, EventArgs e)  
14.         {  
15.   
16.         }  
17.         [WebMethod]  
18.         public static string GetMessage()  
19.         {  
20.             return "Test Methode" + DateTime.Now;  
21.         }  
22.     }  
23. }  

Bu senaryoda da master page’imizi test.aspx adlı bir sayfanın master page’i olacak şekilde düzenlediğimizde yine aynı nedenle (Master page’in System.Web.UI.MasterPage ‘ten inherit edilmiş olması) pageMethodmuzun çalışmadığını göreceğiz.

Yine birinci çözümdeki gibi PageMethodumuzu master page’ten alıp hangi sayfanın master’ı olarak belirleyeceksek tüm sayfalarda bu methodu oluşturmalıyız. Yukarıdaki ilk örnekteki gibi scriptlerin master page içerisinde kalması daha iyi olacaktır.

Page Methodların bu denli handikapları ortaya çıkınca aklımıza birçok avantajı ve kullanım kolaylıkları bulunan web serviceleri gelmektedir; hatta kendi c# model tiplerimizi javascript’e result set halinde aktarabileceğimiz web serviceler. Gelecek yazımızda web servislerinin avantajları ve hiç eksik olmasın dezavantajları üzerinde durup Linq To sql model tiplerimizi serileştirerek javascript fonksiyonları ile elde edip, bu verileri web sayfalarımızda göstereceğiz.

Makalenin kaynak kodları

Teşekkürler.

Kaynak: http://www.clubcrema.com/index.php/2009/06/asp-net-ajax-ile-webmethod-kullanimi/