Category Archives: WCF

Bir önceki WCF Data service ile ilgili yazımızda herhangi bir veri kaynağına bağlı olmayan veri kolleksiyonlarına servisler aracılığıyla erişimi incelemiştik. Bu yazıda ise bir veri kaynağına bağlı olan EDMX modeldeki veri kümelerine WCF data servisleri aracılığıyla erişmeyi inceleyeceğiz.

İlk olarak WcfDatabaseDataservice adında yeni bir Web projesi eklenir. Projeye StoreModel adında yeni bir ADO.Net Entity Data Model eklenir.

Model üzerindeki veri kümelerine erişmek için projeye StoreService adında bir WCF data service eklenir.

   public class StoreService : DataService<StoreEntities>
   {
       public static void InitializeService(DataServiceConfiguration config)
       {
          config.SetEntitySetAccessRule("*", EntitySetRights.AllRead);
          config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V2;
       }
   }

Servis tipinin  DataService<StoreEntities> generic tipinden türetildiği görülmektedir. Yani StoreEntities içindeki veri kümelerine erişilecek.

SolutionExplorer penceresindeki StoreService.svc dosyasına sağ tıklayıp “View in Browser” seçeneği ile servise web browser üzerinden erişebiliriz.

Servis aracılığıyla Collection düğümlerindeki veri kümelerine, kendine ait URI’ler yardımıyla erişilebilir. Örneğin kategorilere erişmek için http://localhost:10182/StoreService.svc/Categories kullanılabilir.

Model üzerindeki stored procedure kullanılmadan önce Function Import işleminden geçirilmelidir. Bunun için Model Browser penceresinden ilgili stored procedure ki örneğimizdeki store procedure adı GetProductSP’dir. Bu procedure sağ tıklayıp Add Function Import tıklanır ve açılan pencerede Get Column Information butonu tıklanarak kolon bilgileri listelenir. Ardından Create New Complex Type butonu ile GetProductBySP_Result kompleks tipi oluşturulur.

WCF data servisi üzerinden GetProductSP function import’una direk erişilemez. Ancak StoreService sınıfına bir metod ekleyerek, metod üzerinden erişim sağlayabiliriz. Servis sınıfına eklenen metodlar servis operasyonları(Service Operations) olarak adlandırılır. Servis operasyonları parametre alabilir. Fakat servis oprasyonlarının geri döndürdüğü değerler Ienumerable, Iqueryable veya void tipinde olmalıdır.

Servis operasyonları WebGet veya WebInvoke attribute ile imzalanmalıdır. WebGet attribute, HTTP GET ile çalışır, WebInvoke ise HTTP POST ile çalışır. Aşağıdaki örnek, WebGet attribute ile imzalanmış bir servis operasyonunun URI yardımıyla nasıl çalıştırıldığını göstermektedir.

public class StoreService : DataService<StoreEntities>
{
        public static void InitializeService(DataServiceConfiguration config)
        {
           config.SetEntitySetAccessRule("*", EntitySetRights.AllRead);
           config.SetServiceOperationAccessRule("*", ServiceOperationRights.All);
           config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V2;
        }

        [WebGet]
        public IQueryable<GetProductBySP_Result> ProductsBySp()
        {
           using (StoreEntities context = new StoreEntities())
           {
              return context.GetProductBySP().ToList().AsQueryable();
           }
        }
    }

Servis ayarlamalarının yapıldığı DataServiceConfiguration sınıfının servis operasyonlarının yetkilerini belirlediği bir metod vardır. Bu metod setServiceOperationAccessRule metodudur.

Metodu browser üzerinden http://localhost:10182/StoreService.svc/ProductBySp şeklinde çağırılır.

Sonuç olarak servis aracılığı ile modeldeki bir “stored procedure” erişimini incelemiş olduk.

Umarım faydalı bir yazı olmuştur.

WCF data servisleri mimarisini bir önceki yazımızdada kısaca özetlemiştik. Bu yazımızda ise bir WCF data servisinin nasıl oluşturulduğunu ve kendi özel sınıfımıza ait bir kolleksiyona bu servis üzerinden erişildiğini inceleyeceğiz.

Visual studio ortamından WcfCustomDataService adında yeni bir web projesi başlatarak bu proje üzerinde incelemelerimizi yapabiliriz.

Projemize Product ve Category adında iki yeni sınıf ekliyoruz.

    [DataServiceKey("Id")]
    public class Product
    {

        public int Id { get; set; }
        public string Name { get; set; }

    }

    [DataServiceKey("Id")]
    public class Category
    {
        public int Id { get; set; }
        public string Name { get; set; }

    }

Sınıflarımıza baktığımızda DataServiceKey ile servis anahtar property değerinin belirlendiğini görüyoruz. Bu attribute ile belirlenen anahtar özellik sayesinde OData, istenen elemana ulaşabilmektedir. DataServiceKey attribute System.Data.Services.Client.dll içindeki System.Data.Services.Common alanında bulunmaktadır. Eğer bu dll projenize dahil değilse eklemeniz gerekecektir.

Servisimiz ile ulaşabileceğimiz kolleksiyonları bulunduracağımız Store adında bir sınıf ekleyerek içerisine kolleksiyonlarımızı bu sınıf içerisine yerleştirebiliriz. Store içerisine ProductSet ve CategorySet adında iki adet generic IQueryable kolleksiyon ekliyoruz. Generic tip IQueryable olmalıdır.

    public class Store
    {
        public IQueryable<Product> ProductSet
        {
          get
          {
             return new List<Product>
             {
               new Product{ Id=1, Name="Game Console" },
               new Product{ Id=2, Name="IBM Computer"},
               new Product{ Id=3, Name="Baby Toy"}

             }.AsQueryable();
          }
        }

       public IQueryable<Category> CategorySet
       {
         get
         {
            return new List<Category>
            {
               new Category{ Id=1, Name="Game" },
               new Category{ Id=2, Name="Computer"},
               new Category{ Id=3, Name="Toys"}

            }.AsQueryable();
         }
       }
   }

Şimdi projemizde kullanacak olduğumuz servisi eklemeye geldi. WCF data servis ekleme işlemi için projemize sağ tıklayıp Add -> New Item şeçeneği yardımıyla  StoreService.svc adında bir “WCF Data Service” ekliyoruz. Servisimiz eklendiğinde kod kısmını aşağıdaki şekilde düzenliyoruz.

   public class StoreService : DataService<Store>
   {
       public static void InitializeService(DataServiceConfiguration config)
       {
          config.SetEntitySetAccessRule("*", EntitySetRights.AllRead);
          config.DataServiceBehavior.MaxProtocolVersion = DataServiceProtocolVersion.V2;
       }
   }

StoreService sınıfı DataService<Store> generic tipinden türetilmiştir. Burada Store tipi bizim daha önceden tanımladığımız kolleksiyonları tutmaktadır.

InitializeService metodu DataServiceConfiguration tipinde servis ayarlarını belirleyen bir parametre almaktadır.

DataServiceConfiguration  tipinin SetEntityAccessRule metodu iki parametre alamktadır. Birinci parametre string türündedir ve entity adını belirler, ikincisi ise EntitySetRights numaralandırıcı tütündedir ve entity erişim kurallarını belirler.

Örnek:

            config.SetEntitySetAccessRule("ProductSet", EntitySetRights.AllRead);
            config.SetEntitySetAccessRule("CategorySet", EntitySetRights.None);

Yukarıda örnekte belirlenen kuralda, ProductSet için tüm okuma yetkileri verilmiş, CategorySet için tüm erişimler kısıtlanmıştır. Bu durumda servis çağrıldığında sadece ProductSet verilerine erişilebilmektedir.

Biz bu örnekteki ayarları kullanmadan  varsayılan ayarlar ile devam ediyoruz.

Servisi hazırladıktan sonra StoreService.svc’ye sağ tıklayıp “View in Browser” seçeneğini tıklayarak servise browser üzerinden ulaşabilmekteyiz. Browser, servisi XML formatında bize sunmaktadır.

ProductSet ve CategorySet kolleksiyonlarına özel URI konumlandırıcılar belirlenmiştir. Adres sonuna ProductSet ekleyerek koleksiyon içeriğine de ulaşmak mümkündür.

Bu noktada servisin sunduğu entity tiplerine ait şema bilgisini elde etmekte mümkündür. Bunun için ise URI sonuna /$metadata ekleyerek gerekli metadata bilgisi alınabilmektedir.

Bu yazıda kendi tiplerimize ait kolleksiyonlara ve metadata bilgilerine, WCF Data Servisleri yardımıyla nasıl erişilebileceğini incelemiş olduk. İlerki yazılarda WCF data servislerini daha yakından incelemeye çalışacağız.

WCF data servisleri Open Data Protokolünü(OData) kullanarak, WEB veya intranet ortamına Atom ve JSON formatında veri sunabilen servislerdir. OData protokolü URI’ler aracılığıyla adreslenemiş veri kaynaklarına erişmeye olanak sağlar. Bu sayede veri erişimi ve güncelleme işlemleri, standart HTTP işlemleri olan GET, POST, PUT ve DELETE ile yapılabilmektedir.

WCF Data Service Mimarisi

Aşağıdaki şekilde WCF Data Service mimarisi gösterilmektedir.

Şekilde kullanıcı, open data protokolü ve sunucu şeklinde üç ayrı seviye belirlenmiştir.

Kullanıcı tarafı uygulama bağımsızlığına dayanmaktadır. Yani OData protokolü üzerinden gelen verilere herhangi bir platformdan ulaşmak mümkündür.

Sunucu tarafı ise herhangi bir veri kaynağından elde ettiği veriyi OData protokolü üzerinden kullanıcı tarafına sunmaktadır.

WCF data servis mimarisini kısa cümlelerle özetlemeye çalıştık. Bir sonraki yazıda ise WCF data servislerini kullanarak kendi özel kolleksiyonlarımıza nasıl erişebileceğimizi inceleyeceğiz. Hemen ardından gelecek yazıda ise gerçek veritabanına erişebilen EDMX modele ait verilere WCF data servisleri yardımıyla erişmeye çalışacağız.