C# Entity Configurations Classlibrary

C# içerisinde veri tabanı işlemlerimize devam ederken veri tabanımızdaki tablolarımızı nasıl özelleştirebileceğimizden bahsedeceğiz.

Özelleştirmek derken ne demek istediğimi hemen açayım, Örneğin veri tabanında bir tablonuzun içindeki bir kolonun karakter uzunluğunu 15 karakter uzunluğu vermek istiyorsunuz

Veya bir kolonun optional yani zorunlu değil olarak işaretlemek istiyorsunuz.

Şimdi bu işlemleri yapabilmek için öncelikle proje oluşturmamız gerekiyor

Hemen boş bir klasör açalım ve aşağıdaki kodları sırasıyla çalıştıralım.

dotnet new webapi -n MyWebApi
dotnet add MyWebApi/MyWebApi.csproj package Microsoft.EntityFrameworkCore
dotnet add MyWebApi/MyWebApi.csproj package Microsoft.EntityFrameworkCore.Design
dotnet add MyWebApi/MyWebApi.csproj package Microsoft.EntityFrameworkCore.SqlServer

dotnet new webapi -n MyWebApi

dotnet add MyWebApi/MyWebApi.csproj package Microsoft.EntityFrameworkCore

dotnet add MyWebApi/MyWebApi.csproj package Microsoft.EntityFrameworkCore.Design

dotnet add MyWebApi/MyWebApi.csproj package Microsoft.EntityFrameworkCore.SqlServer

evet burada gerekli tüm projelerimizi oluşturduk ve paketlerimizi ekledik şimdi de Entities adlı bir klasör oluşturalım ve altında Blog adında bir class oluşturalım.

Buradaki Blog classını aşağıdaki gibi düzenledim .

using System.ComponentModel.DataAnnotations;

namespace MyWebapi.Entities;

public class Blog
{
    [Key]
    public int Id { get; set; }
    [MaxLength(50)]
    public string Title { get; set; }
    public string Content { get; set; }
    public string Author { get; set; }
}

using System.ComponentModel.DataAnnotations;

namespace MyWebapi.Entities;

public class Blog

{

[Key]

public int Id { get; set; }

[MaxLength(50)]

public string Title { get; set; }

public string Content { get; set; }

public string Author { get; set; }

}

Buradaki işaretli satırlardaki Attribute lere property Attribute deniyor, ve bunlar DataAnnotations namespace’i altından gelmekte.

7. Satıra belirtilen Key Attribute’ü Id kolonunun Key olduğunu belirtir, efcore normalde otomatik olarak Id bulunan kolonları ayarlamaya çalışır örneğin Key attribute’ünü belirtmesek de otomatik olarak Key olarak ayarlanacaktı zaten. Aynı şekilde BlogId diye belirtsek ID diye de belirtsek bunları key olarak atayacaktır.

9. Satırdaki MaxLength satırı ise Title kolonunun karakter sayısının en fazla 50 olacağını belirtir.

Şimdi migration oluşturabilmek ve veri tabanını güncelleyebilmek adına bir adet Persistence klasörü ekleyelim sonrasında ise bu klasör altında iki adet class oluşturacağız bu classlar sırasıyla MyApiDbContext ve MyApiDbContextFactory olacak

Aşağıda kodları bulabilirsiniz.

using Microsoft.EntityFrameworkCore;
using MyWebapi.Entities;

namespace MyWebApi.Persistence;
public class MyApiDbContext : DbContext
{
    public DbSet<Blog> Blogs { get; set; }

    public MyApiDbContext(DbContextOptions<MyApiDbContext> options) : base(options)
    {

    }
}

using Microsoft.EntityFrameworkCore;

using MyWebapi.Entities;

namespace MyWebApi.Persistence;

public class MyApiDbContext : DbContext

{

public DbSet<Blog> Blogs { get; set; }

public MyApiDbContext(DbContextOptions<MyApiDbContext> options) : base(options)

{

}

using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Design;

namespace MyWebApi.Persistence;

public class MyApiDbContextFactory : IDesignTimeDbContextFactory<MyApiDbContext>
{
    public MyApiDbContext CreateDbContext(string[] args)
    {
        var optionsBuilder = new DbContextOptionsBuilder<MyApiDbContext>();
        optionsBuilder.UseSqlServer("Server=localhost;Database=MyApiDb;User Id=sa;Password=P4$$W0Rd;");

        return new MyApiDbContext(optionsBuilder.Options);
    }
}

using Microsoft.EntityFrameworkCore;

using Microsoft.EntityFrameworkCore.Design;

namespace MyWebApi.Persistence;

public class MyApiDbContextFactory : IDesignTimeDbContextFactory<MyApiDbContext>

{

public MyApiDbContext CreateDbContext(string[] args)

{

var optionsBuilder = new DbContextOptionsBuilder<MyApiDbContext>();

optionsBuilder.UseSqlServer("Server=localhost;Database=MyApiDb;User Id=sa;Password=P4$$W0Rd;");

return new MyApiDbContext(optionsBuilder.Options);

}

buradaki iki sınıfı da ekledikten sonra veri tabanımızı aşağıdaki kodlar ile oluşturabiliriz.

dotnet ef migrations add v1.0 --project MyWebApi/MyWebApi.csproj
dotnet ef database update --project MyWebApi/MyWebApi.csproj

1 2	dotnet ef migrations add v1.0 --project MyWebApi/MyWebApi.csproj dotnet ef database update --project MyWebApi/MyWebApi.csproj

Kodlarımızı çalıştırdıktan sonra eğer veri tabanı bağlantımız başarılı ise veri tabanımız oluşturulacaktır.

Sonrasında Blog adlı tabloya gittiğimizde aşağıdaki gibi bir görsel göreceğiz.

Burada dikkat etmenizi istediğim şey Title adlı kolonun Type’ı nvarchar ve Length değeri de 50’dir bunu yukarıda belirttiğimiz data Annotation ile sağladık

Unique Keys üzerine geldiğimizde ise Id kolonunun başarılı bir şekilde PrimaryKey olarak atandığını görebiliriz.

Tabi bu şekilde tablodaki kolonlara özellik verme yeteneğimiz bir tane değil bir tane daha yöntemi var adı da Fluent Api

Şimdi de fluent api ile bir konfigurasyon oluşturacağız, ben tüm konfigürasyonları burada yazamam, eğer detaylı bilgi arıyorsanız buradan ulaşabilirsiniz.

Fluent api ile konfigurasyon yapabilmek için Entities klasörü altında bir adet daha tablo oluşturuyoruz adına da BlogCategory diyelim kodlarını aşağıya bırakıyorum.

namespace MyWebApi.Entities;

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

namespace MyWebApi.Entities;

public class BlogCategory

{

public int Id { get; set; }

public string Name { get; set; }

}

Gördüğünüz gibi burada herhangi bir data annotation geçmedim bunu yapacağımız yer farklı.

Klasörlerimizin daha düzenli olması adına Persistence klasörü altında Mappings adlı bir klasör oluşturalım.

Bunun altında da BlogCategoryConfiguration adında bir class oluşturalım.

using Microsoft.EntityFrameworkCore;
using MyWebApi.Entities;

namespace MyWebApi.Persistence.Mappings;

public class BlogCategoryConfiguration : IEntityTypeConfiguration<BlogCategory>
{
    public void Configure(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityTypeBuilder<BlogCategory> builder)
    {
        builder.ToTable("BlogCategories");
        builder.HasKey(x => x.Id);
        builder.Property(x => x.Id).ValueGeneratedOnAdd();
        builder.Property(x => x.Name).HasMaxLength(50).IsRequired();
    }
}

using Microsoft.EntityFrameworkCore;

using MyWebApi.Entities;

namespace MyWebApi.Persistence.Mappings;

public class BlogCategoryConfiguration : IEntityTypeConfiguration<BlogCategory>

{

public void Configure(Microsoft.EntityFrameworkCore.Metadata.Builders.EntityTypeBuilder<BlogCategory> builder)

{

builder.ToTable("BlogCategories");

builder.HasKey(x => x.Id);

builder.Property(x => x.Id).ValueGeneratedOnAdd();

builder.Property(x => x.Name).HasMaxLength(50).IsRequired();

}

Buradaki konfigürasyonları işaretlediğim satırlar ile gerçekleştiriyoruz

ToTable değeri veri tabanında oluşturulacak tablonun ismini belirtir

HasKey değeri ise [Key] data Annotation’u ile aynı şeyi yapmakta

Property fonksiyonu ile bir property seçebiliriz sonrasında ise seçtiğimiz propertylere özellik verebiliriz örneğin;

12. Satırda Id property’si için Veri tabanında eklenirken değer ata dedik böylelikle veri tabanı üzerine her değer eklendiğinde sayısı 1 artacak örneğin son eklenen satırın Id’değeri 1 ise bir sonraki 2 olacak

HasMaxLength ile Name isimli property’nin alabileceği karakter sayısını belirttik

IsRequired ile bu alanın null olamayacağını belirtiyoruz. (burada null dedim çünkü null ile boş değer farklı şeyler)

Şimdi buradaki oluşturduğumuz konfigürasyonun veri tabanımızın tanıması gerekmekte bunun için MyApiDbContext üzerinde biraz değişiklik yapmamız gerekmekte.

using Microsoft.EntityFrameworkCore;
using MyWebapi.Entities;
using MyWebApi.Entities;
using MyWebApi.Persistence.Mappings;

namespace MyWebApi.Persistence;
public class MyApiDbContext : DbContext
{
    public DbSet<Blog> Blogs { get; set; }
    public MyApiDbContext(DbContextOptions<MyApiDbContext> options) : base(options)
    {

    }
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.ApplyConfiguration<BlogCategory>(new BlogCategoryConfiguration());
    }
}

using Microsoft.EntityFrameworkCore;

using MyWebapi.Entities;

using MyWebApi.Entities;

using MyWebApi.Persistence.Mappings;

namespace MyWebApi.Persistence;

public class MyApiDbContext : DbContext

{

public DbSet<Blog> Blogs { get; set; }

public MyApiDbContext(DbContextOptions<MyApiDbContext> options) : base(options)

{

}

protected override void OnModelCreating(ModelBuilder modelBuilder)

{

modelBuilder.ApplyConfiguration<BlogCategory>(new BlogCategoryConfiguration());

}

Burada işaretlediğim satırları yeni ekledim ve gördüğünüz gibi DbSet property’si ile BlogCategory adlı değeri eklemedim , buna rağmen efcore otomatik olarak ilgili Tabloyu bulup veri tabanı için map işlemini yapacaktır. Hadi şimdi bir migration daha alalım ve veri tabanımızı güncelleyelim

dotnet ef migrations add v2.0 --project MyWebApi/MyWebApi.csproj
dotnet ef database update --project MyWebApi/MyWebApi.csproj

1 2	dotnet ef migrations add v2.0 --project MyWebApi/MyWebApi.csproj dotnet ef database update --project MyWebApi/MyWebApi.csproj

Görselde de gördüğünüz gibi BlogCategories adlı tablo oluştu sağ tarafta da görebileceğiniz üzere Name adlı kolonun karakter uzunluğu da 50 olarak ayarlanmış

Aynı şekilde Unique Keys adlı kısma baktığımızda ise Id Kolonunun Primary Key olarak ayarlandığını görebilirz.

Şimdi akıllarda bir soru işareti mevcut olmuş olabilir yani ben tüm veri tabanı tablolarım için gidip DbContext içerisinde ApplyConfiguration diyerek ilgili class’ı verip konfigurasyonları mı oluşturacağım?

Aslında buna gerek yok hadi bir adet daha tablo oluşturalım ve onu da yeni şekilde ekleyelim.

Entities altında BlogTag adlı bir class oluşturuyorum kodları aşağıdadır.

namespace MyWebApi.Entities;

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

namespace MyWebApi.Entities;

public class BlogTag

{

public int Id { get; set; }

public string Name { get; set; }

}

sonrasında ise bu oluşturduğumuz tablo için Configuration dosyasını üretmemiz gerekmekte

Persistence/Mappings altında gidip BlogTagConfiguration adlı bir class oluşturuyorum ve IEntitytypeConfiguration interface’inden türetiyorum. Kodları aşağıda.

using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.Metadata.Builders;
using MyWebApi.Entities;

namespace MyWebApi.Persistence.Mappings
{
    public class BlogTagConfiguration : IEntityTypeConfiguration<BlogTag>
    {
        public void Configure(EntityTypeBuilder<BlogTag> builder)
        {
            builder.ToTable("BlogTags");
            builder.HasKey(x => x.Id);
            builder.Property(x => x.Id).ValueGeneratedOnAdd();
            builder.Property(x => x.Name).HasMaxLength(50).IsRequired();
        }
    }
}

using Microsoft.EntityFrameworkCore;

using Microsoft.EntityFrameworkCore.Metadata.Builders;

using MyWebApi.Entities;

namespace MyWebApi.Persistence.Mappings

{

public class BlogTagConfiguration : IEntityTypeConfiguration<BlogTag>

{

public void Configure(EntityTypeBuilder<BlogTag> builder)

{

builder.ToTable("BlogTags");

builder.HasKey(x => x.Id);

builder.Property(x => x.Id).ValueGeneratedOnAdd();

builder.Property(x => x.Name).HasMaxLength(50).IsRequired();

}

sonrasında ise MyApiDbContext üzerinde değişiklik yapmamız gerekmekte hemen aşağıdaki şekilde güncelliyoruz.

using Microsoft.EntityFrameworkCore;
using MyWebapi.Entities;
using MyWebApi.Entities;
using MyWebApi.Persistence.Mappings;

namespace MyWebApi.Persistence;
public class MyApiDbContext : DbContext
{
    public DbSet<Blog> Blogs { get; set; }
    public MyApiDbContext(DbContextOptions<MyApiDbContext> options) : base(options)
    {

    }
    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.ApplyConfigurationsFromAssembly(typeof(MyApiDbContext).Assembly);
    }
}

using Microsoft.EntityFrameworkCore;

using MyWebapi.Entities;

using MyWebApi.Entities;

using MyWebApi.Persistence.Mappings;

namespace MyWebApi.Persistence;

public class MyApiDbContext : DbContext

{

public DbSet<Blog> Blogs { get; set; }

public MyApiDbContext(DbContextOptions<MyApiDbContext> options) : base(options)

{

}

protected override void OnModelCreating(ModelBuilder modelBuilder)

{

modelBuilder.ApplyConfigurationsFromAssembly(typeof(MyApiDbContext).Assembly);

}

Burada işaretli satırları günceledim, buradaki ApplyConfigurationFromAssembly adlı fonksiyon bizden bir adet Assembly istemektedir bu Assembly IEntityTypeConfiguration interface’inden türetilmiş veri tabanı tablolarımız için üretilen konfigürasyon dosyalarımızın bulunduğu assembly olmaktadır. Benim örneğim içerisinde tek bir proje mevcut ve Konfigürasyon dosyaları MyApiDbContext sınıfının assembly’si ile aynıdır.

Eğer proje farklı değil ise aynı proje içerisindeki herhangi bir class için typeof özelliğini kullanarak sınıfın bulunduğu assembly’i alabilirsiniz yukarıda da bunu yaptım.

Şimdi veri tabanını tekrar güncellediğimizde ise BlogTag ile ilgili ayarlarımızın da veri tabanımıza eklenmesi gerekmektedir. Aşağıdaki kodları çalıştırarak kontrol edelim.

dotnet ef migrations add v3.0 --project MyWebApi/MyWebApi.csproj
dotnet ef database update --project MyWebApi/MyWebApi.csproj

1 2	dotnet ef migrations add v3.0 --project MyWebApi/MyWebApi.csproj dotnet ef database update --project MyWebApi/MyWebApi.csproj

Veri tabanımıza göz atalım

Gördüğünüz gibi blogTags tablosu oluşturulmuş ve Fluent Api ile verdiğimiz ayarlar da uygulanmış vaziyette

Emin olmak adına unique keys adlı alandan primary key’i de kontrol edelim.

PrimaryKey değerimiz de Id kolonu için ayarlanmış vaziyette

Bu yazımda da tablolarımız için konfigürasyonları nasıl yapabiliriz ona baktık sonra görüşmek üzere sağlıcakla kalın.