C# ve Asp.net MVC'de Çok katmanlı Soğan mimarisinde (Onion Architecture) Asp.Net Identity Kullanımı

Bir önceki makelemde (Buraya Tıklayınız)  Soğan mimarisini oluşturduk ve Ninject kullarak Katmanlar arasında bağımsızlığı sağladık. Bu makalede ise ASP.NET Identity 2.x kullanarak Güvenlik ve Üye yönetimini katmanlı mimaride nasıl sağlayabileceğimizi göstereceğim. bu makalede amaç ASP.NET Identity hakkında bilgi vermek veya nasıl kullanıldığını anlatmaktan ziyade, bir katmanlı mimaride katmanlar arası ilişkiyi bozmadan ASP.NET Identity'yi kullanıma sunulmasıdır.

Sorun Nedir?
Yeni bir web uygulaması oluşturulduğunda ve üye yönetimi olarak ASP.NET Identity kullanıldığında varsayılan olarak veri tabanı erişimini doğrudan PL katmanından ayarlamaktadır, ancak katmanlı mimaride PL katmanın veri tabanına veyahut DAL katmanına doğrudan erişmesi yasaklanmıştır. ASP.NET Identity'nin çalışabilmesi için IdentityDbContext'i geliştirmiş bir Context (Entity Framework) sınıfına ihtiyaç duyar.

Önemli Not: ASP.NET Identity varsayılan olarak EF kullanarak veri tabanına erişim sağlar, eğer EF kullanmak istenmiyorsa IUserStore interface'ini istediğiniz veri tabanı erişim yönetimi ile geliştirmeniz gerekmektedir. örneğin eğer BLL katmanı ve PL katmanı arasında Service Proxy katmanı varsa (katmanlar arası fiziksel ayrıştırma ihtiyaç olduğu zaman kullanılır), bu makaledeki yöntem ile identity kullanımını sağlayamazsınız, servis aracılığıyla BLL'e veri akışı sağlamak için PL katmanında IUserStore'u Servis aracılığıyla veriye ulaşmasını sağlayacak şekilde geliştirmeniz gerekmektedir.

Çok katmanlı Soğan mimarisine uygun olarak geliştirdiğimiz projeye github adresinden ulaşabilirsiniz.
kaynak kodlarına ulaşabilmek için buraya tıkalyınız.

ASP.NET Identity paketini Projeye Ekleme
ASP.NET Identity'yi mevcut bir projeye eklemenin en kolay yöntemi, yeni bir web uygulaması oluşturup ve o uygulama için Authentication seçeneklerinde Individual Authentication seçip daha sonra o projede Identity ile ilgili olan tüm paketleri mevcut projeye kurmak ve dosyaları mevcut projeye kopyalamaktır, bu makalede sadece ihtiyacımız olan NuGet paketlerini kuracağız, ve diğer dosyaları yeni oluşturulan bir web uygulamasından alacağız.

Projeye ASP.NET Indentity eklemek için Solution üzerinde sağ tıklayarak Manage NuGet Packages for Solution' a tıklayınız.

Açılan Ekranda, Browse tabında Identity terimini aratın, çıkan sonuçlarda Microsoft.AspNet.Identity.EntityFramework Paketini seçip kurunuz. bu paket diğer ihtiyaç olan paketleride kuracaktır.

ASP.NET Identity, OWIN tabanlı güvenlik sistemi olduğu için Owin paketinede ihtiyacımız vardır. OWIN'in amacı uygulamayı web sunucusundan bağımsız hale getirmektir. OWIN hakkında daha fazla bilgi almak için Buraya ve Buraya bakınız.
Owin için Microsoft.AspNet.Identity.Owin paketini kurunuz. bu paket Owin için gerekli diğer paketleri indirip kuracaktır.

OWIN ve Identity kullanıma açmak

OWIN'i kullanabilmemiz ve dolayısıyla Identity'yi kullanabilmek için Startup.cs sınıfını eklememiz gerekiyor, her OWIN uygulaması, uygulama Pipeline'nindak kullanılacak bileşenlerin (Component) tanıtmak amacıyla bir başlama sınıfına ihtiyacı vardır. bu sınıfın ismi startup.cs olmak zorunda değildir, ancak genelde bu isimde olması bu sınıfın amacını da tek bakışta belli ettiği için kullanılır. Startup.cs sınıfını PL katmanına ister örnek web uygulamasından ekleyiniz yada isterseniz kendiniz de yeni dosya ekleme ekranından yapabilirsiniz, bunun için PL katmanında yeni öğe ekleme ekranını açınız, ve arama çubuğuna startup yazınız, çıkan sonuçlarda OWIN Startup Class 'i seçiniz.

sınıf ilk eklendiği aşağıdaki gibidir.

Burada Configuration fonksiyonun içinde Identity'yi ayarlayabiliriz. bunun için öncelikle örnek web uygulamasından gerekli dosyaları projemize dahil edelim, daha sonra bu dosyaları düzenleyerek katmanlı mimariye uygun hale getirebiliriz.

dosyalar aşağıdaki gibidir:
1- App_Start klasörü içinde, Startup.auth.cs dosyası.
2- App_Start klasörü içinde, IdentityConfig.cs dosyası.
3- Controllers klasörü içinde, AccountController.cs ve ManageController.cs
4- Models klasörü içinde, AccountViewModels ve ManageViewModels
5- Views klasörü içinde, Account klasörü tamamı, Manage klasörü tamamı, ve Shared klasörü içinde, _LoginPartial.cshtml, Lockout.cshtml.


Identity ve Owin Config Sınıflarının Eklenmesi

Startup.Auth.cs ve IdentityConfig sınıflarını ekledikten sonra, Namespace'leri mevcut projeye uygun isimlendirme yapıyoruz. Namespace'ler düzenlendikten sonra, hem Startup.Auth.cs hemde IdentityConfig.cs sınıflarında bazı hatalar kalacaktır ki onları çözdüğümüzde aslında bu makalenin amacına ulaşmış olacağız.

birinci hata, Startup.Auth.cs sınıfında Owin context'inin daha sonra ihtiyaç durumunda kullanacağı ApplicationDbContext sınıfını bulamadığı için oluşan bir hatadır. Bu satırda aslında amaç daha sonra istenildiğinde Owin Context'inin Get metodunu kullanarak alabilinecek kaynakları ayarlamaktır, ki kullanıcı verisine ulaşabilmek için bir veritabanı bağlantı sınıfına ihtiyaç duyuluyor.

Bu noktada, Veri tabanı erişim sınıfını enjekte etmemiz gerekir, ancak PL katmanında doğrudan veri tabanı context sınıfına erişim mevcut değildir. bu hatayı çözmek için BLL katmanından context'i enjekte edebileceğimiz bir sınıf oluşturmamız gerekir, Factory Pattern kullanarak, DbContext'i create edip Owin'e enjekte etmemiz gerekir.

BLL katmanından aşağıdaki resimde olduğu gibi yeni bir sınıf oluştururuz. DbContextFactory isimli bu sınfın tek bir görevi var, ihtiyaç duyulduğunda bir DbContext sınıfı oluşturup geri dönmek.

bu sınıfın kodunu aşağıdaki gibi yazalım:

using MultiLayer.Infrasturcture;
 
namespace MultiLayer.Services
{
    public class DbContextFactory
    {
        public static MultilayerDbContext Create()
        {
            return new MultilayerDbContext();
        }
    }
}

 Şimdi Starup.auth.cs sınıfını aşağıdaki gibi düzeltelim:

DbContextFactory.Create eklediğimizde, bu kez visual studio, MultiLayerDbContext sınıfını tanımadığını ve MultiLayer.Infrastructure projesini referans olarak eklemeniz gerektiği hatası göstermektedir. Bu referansi eklersek, PL'den Doğrudan DAL katmanına referans eklemiş olacağız, ki doğru değildir. bu durumu çözmek için, öncelikle DbContext'imizin bir interface'i geliştirmesini sağlamalıyız ve bu interface'i de  tüm katmanlardan erişilebilinen Domain katmanında oluşturmalıyız. daha sonra, DbContextFactory sınıfımızda da değişiklik yaparak bu interface'in dönemesini sağlamalıyız. bu interface'in içeriğinde herhangi bir kod olmayacaktır. sadece referans eklemeden Run time'da DbContext'i enjekte edebilmemiz için gereklidir.

namespace MultiLayer.Domain
{
    public interface IDbContext : IDisposable
    {
    }
}

MultilayerDbContext ve DbContextFactory sınıfları düzenleme sonrası aşağıdaki gibir:

Yukarıdaki işlemler sonucunda, birinci hata giderilmiştir.
Startup.Auth.cs sınıfındaki ikinci hata ise, Identity ile alakalıdır, ve ApplicationUser sınıfı bulunamiyor hatasıdır. bu hatayı gidermek için öncelikle, ASP.NET Identity için bir kullanıcı sınıfı oluşturmamız lazım. Bu sınıf bir entity sınıfı olduğu için Domain katmanında oluşturmamız gerekiyor. ayrıca bu sınıf, IdentityUser sınıfından türemesi lazım. IdentityUser sınıfı ise, Microsoft.AspNet.Identity.EntityFramework paketinde yer aldığından bu paketi Domain katmanımıza NuGet'ten kurmamız gerekir. ApplicationUser sınıfı Domain katmanında Entities klasörü altında oluşturulur. bu sınıf ilk aşamada aşağıdaki gibidir.

using Microsoft.AspNet.Identity.EntityFramework;
 
namespace MultiLayer.Domain.Entities
{
    public class ApplicationUser : IdentityUser
    {
    }
}

Bu sınıfı ekledikten sonra ve gerekli using satırını Startup.Auth.cs sınıfına ekledikten sonra, yeni bir hata görünür, bu hatada ApplicationUser sınıfın GenerateUserIdentityAsync metodunun eksik olduğunu söyluyor. bu metodu ornek oluşturduğumuz web uygulamasında ApplicationUser sınıfına kopyalayıyoruz. ApplicationUser sınıfın son hali aşağıdaki gibidir.

Bu işlem sonucunda, Startup.Auth.cs sınıfı hatalardan arınmış olacaktır. sonraki aşamada, IdentityConfig.cs sınıfında, aşağıdaki hatayı gidermeliyiz.

bu sınıfın Create metodunda, ilk satırda, ApplicationUserManager sınıfı oluşturulmaya çalışılırken OWIN context'inden bir veri tabanı context'i istenmektedir. OWIN context'inin Get metuduna generic olarak gönderilen tip ise, ApplicationDbContext'dir ki PL katmanından erişilemez, bu noktada gene IDbContext interface'i yardımımıza koşacaktır. ApplicationDbContext yerine IDbContext yazıp ve context'ten dönen sonucu DbContext' e cast etmeliyiz, ancak burada DbContext'e cast edersek, Identity fonksiyonlarına ve sınıflarına erişemeyiz, bu sebepten dolayı, DbContext yerine IdentityDbContext<ApplicationUser> tipine cast ediyoruz. sonuç aşağıdaki gibidir.

Gerçi bu aşamada proje hatasız compile olacaktır, ancak biz henüz Identity Entity tiplerini Context'imize dahil etmemişiz ve bu durumda veri tabanımızda Identity ile ilgili olan sınıflar oluşmayacaktır. Bu işlem için MultiLayer.Infrastructure katmanımızdaki DbContext sınıfını, DbContext'ten miras almak yerine onun bir mirasçısı olan IdentityDbContext<ApplicationUser>'dan miras almalıyız. bu sınıf Microsoft.AspNet.Identity.EntityFramework paketinde olduğundan, bu paketi DAL katmanına da NuGet'ten kurmamız lazım. Aynı zamanda bu paketi BLL katmanına da kurmamız lazım, zira DbContextFactory sınıfı içinde artık bu paket ihtiyaç olmuştur. DbContext sınıfının son hali aşağıdaki gibidir.

Identity Entity'lerinin veri tabanında oluşması için Add-Migration komutuyla gerekli migration code'unu oluşturup daha sonra Update-Database komutuyla'da değişikliklerin veritabanına yansımasını sağlıyoruz.

Bu işlem sonucunda veritabanındaki tablolar aşağıdaki resimde gösterilmiştir.

Yukarıda kırmızı çerçeve içine alınan tablolar Identity'ye ait tablolardır.
Bu işlem'den sonra geriye kalan tek şey daha önce bahsettiğimiz ek dosyaları örnek olarak oluşturulan web uygulamasından projeye dahil edip ve namespace'leri düzenlemektir. geri kalan düzenlemeleri aşağıdaki video'dan görüntüleyebilirsiniz.