{"id":16049,"date":"2020-05-27T15:35:50","date_gmt":"2020-05-27T15:35:50","guid":{"rendered":"https:\/\/www.gencayyildiz.com\/blog\/?p=16049"},"modified":"2020-05-27T15:35:50","modified_gmt":"2020-05-27T15:35:50","slug":"odata-action-function-yapilanmasi-ile-custom-metot-olusturma","status":"publish","type":"post","link":"https:\/\/www.gencayyildiz.com\/blog\/odata-action-function-yapilanmasi-ile-custom-metot-olusturma\/","title":{"rendered":"OData – Action\/Function Yap\u0131lanmas\u0131 \u0130le Custom Metot Olu\u015fturma"},"content":{"rendered":"

<\/div>\n

Merhaba,<\/p>\n

OData ile url \u00fczerinden yap\u0131lan sorgulamay\u0131 kar\u015f\u0131layacak actionlar\u0131 belirlerken belli kurallar \u00e7er\u00e7evesinde hareket etmekteyiz. Bu kurallar\u0131n neler oldu\u011funu OData Davran\u0131\u015f Modellemesi ve Attributelar\u0131<\/a> ve OData Custom Route Yap\u0131lanmas\u0131<\/a> ba\u015fl\u0131kl\u0131 makalelerde detayl\u0131ca incelemi\u015f bulunmaktay\u0131z. Bu i\u00e7eri\u011fimizde ise OData’n\u0131n bizlere sundu\u011fu kurallar\u0131 a\u015fmam\u0131z\u0131 ve custom metotlar olu\u015fturmam\u0131z\u0131 sa\u011flayacak olan Action\/Function yap\u0131lanmalar\u0131n\u0131 inceliyor olaca\u011f\u0131z.<\/p>\n

OData Action\/Function Nedir?<\/h3>\n

Custom metot olu\u015fturmam\u0131z\u0131 sa\u011flayan yap\u0131lard\u0131r. Ba\u015fl\u0131ktan da anla\u015f\u0131ld\u0131\u011f\u0131 \u00fczere Action ve Function olmak \u00fczere ikiye ayr\u0131lmaktad\u0131rlar. Aralar\u0131ndaki fark\u0131 anlayabilmek i\u00e7in Side Effect(Yan Etki)<\/a><\/em> kavram\u0131na hakim olunmas\u0131 i\u015fimizi kolayla\u015ft\u0131racakt\u0131r.<\/p>\n

K\u0131saca side effect; bir i\u015flem yap\u0131l\u0131rken kapsam\u0131 d\u0131\u015f\u0131ndaki bir de\u011fi\u015fkenin, de\u011ferin veya objenin de\u011fi\u015ftirilmesi durumudur. Salt olarak OData ile ilgili bir kavram olmaktan ziyade dolayl\u0131 yoldan OData’y\u0131 da ilgilendiren bir anlama sahiptir. \u0130\u015fte bu kavram\u0131n \u0131\u015f\u0131\u011f\u0131nda Action ve Function yap\u0131lanmas\u0131n\u0131 birbirlerinden ay\u0131rabilmekteyiz;<\/p>\n\n\n\n\n\n
Action<\/th>\n Function<\/th>\n<\/tr>\n<\/thead>\n
Yan etkisi olan(side effect) OData operasyonlar\u0131 i\u00e7in kullan\u0131l\u0131r.<\/p>\n
Genel olarak POST<\/span>, PUT<\/span> ve DELETE<\/span> operasyonlar\u0131 i\u015flevsel olarak yan etkiye sahip olduklar\u0131ndan dolay\u0131 Action olarak tan\u0131mlanmal\u0131d\u0131rlar.<\/p>\n
Ayr\u0131ca OData protokol\u00fc \u00fczerinden complex type veri al\u0131\u015f veri\u015finde bulunulacaksa kesinlikle Action tercih edilmelidir.<\/p>\n
Veri ak\u0131\u015f\u0131nda g\u00f6nderilen datalar\u0131 ‘ODataActionParameters<\/span>‘ t\u00fcr\u00fcnden parametreyle yakalamaktad\u0131r.<\/td>\n
Yan etkisi olmayan(no side effect) OData operasyonlar\u0131 i\u00e7in kullan\u0131l\u0131r. \u0130deal olarak yap\u0131lacak olan t\u00fcm GET<\/span> i\u015flemlerinde kullan\u0131lmas\u0131 tavsiye edilir.<\/p>\n
Veri ak\u0131\u015f\u0131nda g\u00f6nderilen datalar\u0131 ‘FromODataUri<\/span>‘ attribute’u ile i\u015faretlenmi\u015f parametreyle yakalamaktad\u0131r.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
\u015eimdi gelin s\u0131ras\u0131yla her iki yap\u0131lanmay\u0131 pratikte inceleyelim;<\/p>\n
Action Yap\u0131lanmas\u0131yla Custom Metot Olu\u015fturma<\/h3>\n
Action yap\u0131lanmas\u0131yla olu\u015fturulacak metotlar\u0131n temel ay\u0131rt edici \u00f6zellikleri POST, PUT veya DELETE i\u015flevlerine sahip olmas\u0131d\u0131r. Dolay\u0131s\u0131yla t\u00fcm bu i\u015flevleri kar\u015f\u0131layacak POST t\u00fcr\u00fcnden istekler olu\u015fturacaksan\u0131z action yap\u0131lanmas\u0131n\u0131 tercih edebilirsiniz. Action yap\u0131lanmas\u0131 olu\u015fturulacak custom metodun parametre al\u0131p almamas\u0131na g\u00f6re ikiye ayr\u0131lmaktad\u0131r;<\/p>\n
Parametre Almayan Metot<\/h4>\n
Action ile parametre almayan metot geli\u015ftirebilmek i\u00e7in \u00f6ncelikle ‘Startup.cs’ dosyas\u0131ndaki ‘Configure’ metodu i\u00e7erisinde a\u015fa\u011f\u0131daki tan\u0131mlaman\u0131n yap\u0131lmas\u0131 gerekmektedir.<\/p>\n
\r\n public void Configure(IApplicationBuilder app, IWebHostEnvironment env)\r\n {\r\n .\r\n .\r\n .\r\n var builder = new ODataConventionModelBuilder();\r\n builder.EntitySet<Personel>("Personel");\r\n builder.EntitySet<Kategori>("Kategori");\r\n builder.EntitySet<Satis>("Satis");\r\n\r\n builder.EntityType<Personel>().Action("ToplamSatis")\r\n .Returns<int>();\r\n\r\n app.UseEndpoints(endpoints =>\r\n {\r\n endpoints.MapODataRoute("odata", "odata", builder.GetEdmModel());\r\n endpoints.OrderBy().Expand().Select().MaxTop(50).Count();\r\n });\r\n .\r\n .\r\n .\r\n }\r\n<\/pre>\n
11.<\/em><\/strong> sat\u0131rdaki ‘EntityType’ fonksiyonuna g\u00f6z atarsan\u0131z e\u011fer ‘Personel’ entitysi ile ili\u015fkilendirilmi\u015f controller i\u00e7erisinde, ‘Action’ metodu ile ‘ToplamSatis’ isminde geriye int t\u00fcr\u00fcnden de\u011fer d\u00f6nd\u00fcrecek bir custom metot bildiriminde bulunulmu\u015ftur.<\/p>\n
\r\n public class PersonelController : ODataController\r\n {\r\n .\r\n .\r\n .\r\n [HttpPost]\r\n public IActionResult ToplamSatis([FromODataUri] int key)\r\n {\r\n var personel = _northwindContext.Personeller.Include(p => p.Satislar).FirstOrDefault(p => p.PersonelId == key);\r\n return Ok(personel.Satislar.Count());\r\n }\r\n }\r\n<\/pre>\n
Bildirimde bulunulan metot ilgili controllerda ‘HttpPost’ attribute’u ile i\u015faretlenerek tan\u0131mlanm\u0131\u015ft\u0131r. Burada tan\u0131mlanan ‘int key’ parametresi a\u015fa\u011f\u0131da kullan\u0131l\u0131rken de g\u00f6rece\u011finiz \u00fczere metodun de\u011fil entitynin parametresidir.<\/p>\n
Kullan\u0131m\u0131<\/strong>
\nTan\u0131mlanan bu custom metodu kullanabilmek i\u00e7in https:\/\/localhost:5001\/odata\/personel(1)<\/span>\/toplamsatis<\/strong><\/code> \u015feklinde bir url \u00fczerinden sorgulama yap\u0131lmas\u0131 gerekmektedir. Buradaki tan\u0131mlamada ‘EntityType<Personel>’ metodu ile bir bildirim oldu\u011fundan dolay\u0131 ‘ToplamSatis’ metoduna ‘Personel’ entitysinin controller\u0131 \u00fczerinden eri\u015filmek mecburiyetindedir. Dolay\u0131s\u0131yla url’de mavi ile vurgulanan k\u0131s\u0131m ilgili controller’\u0131 tarif etmektedir. Ayr\u0131ca ‘personel(1)<\/span>‘ ifadesindeki id de\u011feri yukar\u0131da tan\u0131mlama yaparken bahsedildi\u011fi \u00fczere olu\u015fturulan custom metodun parametresi de\u011fil entitynin parametresini ifade etmektedir. \n<\/a><\/p>\n
E\u011fer ki entityde parametre almaks\u0131z\u0131n t\u00fcm entity nesneleri \u00fczerinde i\u015flem yapmak istiyorsan\u0131z a\u015fa\u011f\u0131daki gibi bir bildirimde bulunman\u0131z gerekmektedir;<\/p>\n
\r\n .\r\n .\r\n .\r\n builder.EntityType<Personel>()\r\n .Collection\r\n .Action("ToplamSatis")\r\n .Returns<int>();\r\n .\r\n .\r\n .\r\n<\/pre>\nBurada dikkat ederseniz ”EntityType<Personel>’ metodundan sonra t\u00fcm koleksiyon verileri \u00fczerinde \u00e7al\u0131\u015faca\u011f\u0131z anlam\u0131na gelen ‘Collection’ propertysi \u00e7a\u011fr\u0131lmakta, ard\u0131ndan ‘Action’ metoduyla operatif ad\u0131mlara devam edilmektedir.<\/p>\n Hemen ard\u0131ndan bildirime uygun metodu ilgili controllerda tan\u0131mlayal\u0131m.<\/p>\n\r\n .\r\n .\r\n .\r\n [HttpPost]\r\n public IActionResult ToplamSatis()\r\n {\r\n var personel = _northwindContext.Personeller.Include(p => p.Satislar).ToList();\r\n return Ok(personel.Sum(x => x.Satislar.Count));\r\n }\r\n .\r\n .\r\n .\r\n<\/pre>\n\u0130\u015fte bu tarz bir metoda a\u015fa\u011f\u0131daki gibi istekte bulunulmas\u0131 yeterli olacakt\u0131r. \nhttps:\/\/localhost:5001\/odata\/personel<\/span>\/toplamsatis<\/strong><\/code> \nHaliyle bu url \u00fczerinden yap\u0131lan istekler \u00f6rne\u011fimize g\u00f6re herhangi bir personelin de\u011fil t\u00fcm personellerin toplam sat\u0131\u015f adedini bizlere getirecektir. \n<\/a><\/p>\n Parametre Alan Metot<\/h4>\nBenzer mant\u0131kla action yap\u0131lanmas\u0131yla olu\u015fturulan custom metoda a\u015fa\u011f\u0131daki gibi parametrelerde tan\u0131mlanabilmektedir.<\/p>\n\r\n .\r\n .\r\n .\r\n var builder = new ODataConventionModelBuilder();\r\n builder.EntitySet<Personel>("Personel");\r\n builder.EntitySet<Kategori>("Kategori");\r\n builder.EntitySet<Satis>("Satis");\r\n\r\n var toplamSatis = builder.EntityType<Personel>()\r\n .Action("ToplamSatis")\r\n .Returns<int>();\r\n toplamSatis.Parameter<int>("nakliyeUcreti");\r\n toplamSatis.Parameter<string>("satisTarihi");\r\n .\r\n .\r\n .\r\n<\/pre>\nYukar\u0131daki kod blo\u011funa g\u00f6z atarsan\u0131z e\u011fer ‘nakliyeUcreti’ ve ‘satisTarihi’ olmak \u00fczere iki adet parametre alan ve geriye int t\u00fcr\u00fcnden de\u011fer d\u00f6nd\u00fcren ‘ToplamSatis’ isimli metot bildiriminde bulunulmu\u015ftur. Bu bildirim neticesinde ‘Personel’ controller’a gelip a\u015fa\u011f\u0131daki gibi bir metot tan\u0131mland\u0131\u011f\u0131nda;<\/p>\n\r\n .\r\n .\r\n .\r\n [HttpPost]\r\n public IActionResult ToplamSatis([FromODataUri] int key, ODataActionParameters @params)\r\n {\r\n var satislar = _northwindContext.Satislar.Where(s => s.PersonelId == key && s.SatisTarihi.Value == DateTime.Parse(@params["satisTarihi"].ToString()) && s.NakliyeUcreti.Value >= int.Parse(@params["nakliyeUcreti"].ToString())).ToList();\r\n\r\n return Ok(satislar.Count());\r\n }\r\n .\r\n .\r\n .\r\n<\/pre>\nhttps:\/\/localhost:5001\/odata\/personel(1)<\/span>\/toplamsatis<\/strong><\/code> url’i \u00fczerinden istek yap\u0131labilecektir. Metot bildiriminde tan\u0131mlanan ilgili parametrelerin de\u011ferleri url’e yap\u0131lacak POST neticesinde body \u00fczerinden g\u00f6nderilecektir ve bu de\u011ferler ‘ODataActionParameters’ t\u00fcr\u00fcnden parametreyle yakalanacakt\u0131rlar.<\/p>\n\u015e\u00f6yle ki; \n<\/a> \n<\/a><\/p>\n Burada \u00f6nem arz eden bir hususa dikkatinizi \u00e7ekmek istiyorum. Yukar\u0131daki gibi tan\u0131mlad\u0131\u011f\u0131n\u0131z parametrelerde tarihsel veriler i\u00e7in DateTime vs. gibi struct t\u00fcrler belirtmek yerine ‘string’ kullanman\u0131z\u0131 tavsiye ederim. Aksi taktirde ‘ODataActionParameters’ parametresi de\u011ferleri yakalayamayacak ve null d\u00f6necektir.<\/p>\n Function Yap\u0131lanmas\u0131yla Custom Metot Olu\u015fturma<\/h3>\nFunction yap\u0131lanmas\u0131nda ise action’a nazaran sadece ‘GET’ isteklerini kar\u015f\u0131layacak metotlar\u0131n bildirilmesi tercih edilmelidir. T\u0131pk\u0131 action’da oldu\u011fu gibi parametre alan ve almayan olmak \u00fczere ikiye ayr\u0131lmaktad\u0131r.<\/p>\nParametre Almayan Metot<\/h4>\n\r\n .\r\n .\r\n .\r\n var builder = new ODataConventionModelBuilder();\r\n builder.EntitySet<Personel>("Personel");\r\n builder.EntitySet<Kategori>("Kategori");\r\n builder.EntitySet<Satis>("Satis");\r\n\r\n builder.EntityType<Personel>()\r\n .Function("ToplamSatis")\r\n .Returns<int>();\r\n .\r\n .\r\n .\r\n<\/pre>\nG\u00f6r\u00fcld\u00fc\u011f\u00fc \u00fczere function ile custom metot bildiriminde actiondan tek fark\u0131 metot isminin ‘Function’ isimli metot i\u00e7erisinde belirtilmesidir.<\/p>\n\r\n .\r\n .\r\n .\r\n [HttpGet]\r\n public IActionResult ToplamSatis([FromODataUri] int key)\r\n {\r\n var satislar = _northwindContext.Satislar.Where(s => s.PersonelId == key).ToList();\r\n return Ok(satislar.Count());\r\n }\r\n .\r\n .\r\n .\r\n<\/pre>\nAyriyetten tan\u0131mlamada da ilgili metodun GET t\u00fcr\u00fcnden oldu\u011fu bildirilmelidir. Bu i\u015flem neticesinde https:\/\/localhost:5001\/odata\/personel(1)<\/span>\/toplamsatis<\/strong><\/code> \u015feklinde yap\u0131lacak GET iste\u011fi ilgili metodu tetikleyecektir. Burada ‘int key’ parametresi actiondakiyle birebir ayn\u0131 mant\u0131ktad\u0131r ve yazd\u0131\u011f\u0131m\u0131z custom metodun de\u011fil entitynin parametresidir. E\u011fer ki entity’de parametre tan\u0131mlamak istemiyorsan\u0131z actiondaki gibi ‘Collection’ propertysini kullanabilirsiniz.<\/p>\n\r\n .\r\n .\r\n .\r\n builder.EntityType<Personel>()\r\n .Collection\r\n .Function("ToplamSatis")\r\n .Returns<int>();\r\n .\r\n .\r\n .\r\n<\/pre>\nParametre Alan Metot<\/h4>\nFunction ile tan\u0131mlanan custom metotlarda da parametreler actiondakiyle birebir ayn\u0131 tan\u0131mlanabilmektedirler.<\/p>\n\r\n .\r\n .\r\n .\r\n var builder = new ODataConventionModelBuilder();\r\n builder.EntitySet<Personel>("Personel");\r\n builder.EntitySet<Kategori>("Kategori");\r\n builder.EntitySet<Satis>("Satis");\r\n\r\n var toplamSatis = builder.EntityType<Personel>()\r\n .Function("ToplamSatis")\r\n .Returns<int>();\r\n toplamSatis.Parameter<int>("nakliyeUcreti");\r\n toplamSatis.Parameter<string>("satisTarihi");\r\n .\r\n .\r\n .\r\n<\/pre>\nLakin parametre de\u011ferlerini yakalayabilmek i\u00e7in a\u015fa\u011f\u0131daki gibi ‘FromODataUri’ attribute’u ile i\u015faretlenmi\u015f fiziksel parametrelerin ilgili metot imzas\u0131nda tan\u0131mlanmas\u0131 gerekmektedir.<\/p>\n\r\n .\r\n .\r\n .\r\n [HttpGet]\r\n public IActionResult ToplamSatis([FromODataUri] int key, [FromODataUri] int nakliyeUcreti, [FromODataUri] string satisTarihi)\r\n {\r\n var satislar = _northwindContext.Satislar.Where(s => s.PersonelId == key && s.SatisTarihi.Value == DateTime.Parse(satisTarihi) && s.NakliyeUcreti.Value >= nakliyeUcreti).ToList();\r\n return Ok(satislar.Count());\r\n }\r\n .\r\n .\r\n .\r\n<\/pre>\nBu \u015fekilde function yap\u0131lanmas\u0131 ile olu\u015fturulan metotlar\u0131 tetikleyebilmek i\u00e7in \nhttps:\/\/localhost:5001\/odata\/personel(1)<\/span>\/toplamsatis(nakliyeUcreti=10, satisTarihi='1997-01-01 00:00:00.000')<\/span><\/strong><\/code> \u015feklinde bir url kullan\u0131lmas\u0131 gerekmektedir.<\/p>\n<\/a><\/p>\n \u0130lgilenenlerin faydalanmas\u0131 dile\u011fiyle… \nSonraki yaz\u0131lar\u0131mda g\u00f6r\u00fc\u015fmek \u00fczere… \n\u0130yi \u00e7al\u0131\u015fmalar…<\/p>\n","protected":false},"excerpt":{"rendered":" Merhaba, OData ile url \u00fczerinden yap\u0131lan sorgulamay\u0131 kar\u015f\u0131layacak actionlar\u0131 belirlerken belli kurallar \u00e7er\u00e7evesinde hareket etmekteyiz. Bu kurallar\u0131n neler oldu\u011funu OData Davran\u0131\u015f Modellemesi ve Attributelar\u0131 ve OData Custom Route Yap\u0131lanmas\u0131 ba\u015fl\u0131kl\u0131 makalelerde detayl\u0131ca incelemi\u015f bulunmaktay\u0131z....<\/p>\n","protected":false},"author":1,"featured_media":15889,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[3516],"tags":[3549,3546,3548,3550,3553,3551,3554,3552,3540,3542,3547,3541],"class_list":["post-16049","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-odata","tag-c-side-effect","tag-c-side-effect-nedir","tag-c-yan-etki-nedir","tag-no-side-effect","tag-odata-action","tag-odata-action-vs-function","tag-odata-custom-metot","tag-odata-function","tag-side-effect","tag-side-effect-nedir","tag-side-effests","tag-yan-etki"],"amp_enabled":true,"_links":{"self":[{"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/posts\/16049","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/comments?post=16049"}],"version-history":[{"count":67,"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/posts\/16049\/revisions"}],"predecessor-version":[{"id":16140,"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/posts\/16049\/revisions\/16140"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/media\/15889"}],"wp:attachment":[{"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/media?parent=16049"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/categories?post=16049"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.gencayyildiz.com\/blog\/wp-json\/wp\/v2\/tags?post=16049"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}