using System;
namespace Console1.Models
{
public enum UserType
{
Admin,
Ordinary
}
public class User
{
public int Id { get; set; }
public string Name { get; set; }
public int Age { get; set; }
public UserType Type { get; set; }
}
} UserType نیز کاملا مشخص است؛ هر User نقش Admin یا Ordinary را میتواند داشته باشد.
نوبت به نوشتن اینترفیس IUser میرسد. در همین پوشه‌ای که قرار داریم، آن را پیاده سازی مینماییم:
namespace Console1.Models
{
public interface IUser
{
int UserId { get; set; }
User User { get; set; }
}
} هر entity که با User ارتباط دارد، باید اینترفیس فوق را پیاده سازی نماید. حال یک کلاس دیگر را به نام Post در همین پوشه درست کرده و بدین صورت پیاده سازی مینماییم.
using System.ComponentModel.DataAnnotations.Schema;
namespace Console1.Models
{
public class Post : IUser
{
public int Id { get; set; }
public string Context { get; set; }
public int UserId { get; set; }
[ForeignKey(nameof(UserId))]
public User User { get; set; }
}
} واضح است که relation از نوع one to many برقرار است و هر User میتواند n تا Post داشته باشد.
خوب تا اینجا کافیست و میخواهیم مدل‌های خود را با استفاده از EF به Context معرفی کنیم. میتوانیم در همین پوشه کلاسی را به نام Context ساخته و بصورت زیر بنویسیم
using System.Data.Entity;
namespace Console1.Models
{
public class Context : DbContext
{
public Context() : base("Context")
{
}
public DbSet<User> Users { get; set; }
public DbSet<Post> Posts { get; set; }
}
} در اینجا مشخص کرده‌ایم که دو Dbset از نوع User و Post را داریم. بدین معنا که EF دو table را برای ما تولید خواهد کرد. همچنین نام کلید رشته‌ی اتصالی به دیتابیس خود را نیز، Context معرفی کرده‌ایم.
خوب تا اینجا قسمت اول پروژه‌ی خود را تکمیل کرده‌ایم. الان میتوانیم با استفاده از Migration دیتابیس خود را ساخته و همچنین رکوردهایی را بدان اضافه کنیم. در Package Manager Console خود دستور زیر را وارد نمایید:
به صورت خودکار پوشه‌ای به نام Migrations ساخته شده و درون آن Configuration.cs قرار میگیرد که آن را بدین صورت تغییر میدهیم:
namespace Console1.Migrations
{
using Models;
using System.Data.Entity.Migrations;
internal sealed class Configuration : DbMigrationsConfiguration<Console1.Models.Context>
{
public Configuration()
{
AutomaticMigrationsEnabled = true;
}
protected override void Seed(Console1.Models.Context context)
{
context.Users.AddOrUpdate(x => x.Id,
new User { Id = 1, Name = "aaa", Age = 30, Type = UserType.Admin },
new User { Id = 2, Name = "bbb", Age = 20, Type = UserType.Ordinary },
new User { Id = 3, Name = "ccc", Age = 25, Type = UserType.Ordinary }
);
context.Posts.AddOrUpdate(x => x.Id,
new Post { Context = "ccc 1", UserId = 3 },
new Post { Context = "bbb 1", UserId = 2 },
new Post { Context = "bbb 2", UserId = 2 },
new Post { Context = "aaa 1", UserId = 1 },
new Post { Context = "bbb 3", UserId = 2 },
new Post { Context = "ccc 2", UserId = 3 },
new Post { Context = "ccc 3", UserId = 3 }
);
context.SaveChanges();
}
}
} در متد seed، رکورد‌های اولیه را به شکل فوق وارد کرده ایم (رکورد‌ها فقط به منظور تست میباشند*). در کنسول دستور Update-database را ارسال کرده، دیتابیس تولید خواهد شد.
قطعا مراحل بالا کاملا بدیهی بوده و نوشتن آنها بدین دلیل بوده که در Repository که الان میخواهیم شروع به نوشتنش کنیم به مدل‌های فوق نیاز داریم تا بصورت کاملا عملی با مراحل کار آشنا شویم.
حال میخواهیم به پیاده سازی بخش اصلی این مقاله یعنی repository که از Row Level Security پشتیبانی میکند بپردازیم. در ریشه‌ی پروژه‌ی خود پوشه‌ای را به نام Repository ساخته و درون آن کلاسی را به نام GenericRepository میسازیم. پروژه‌ی شما هم اکنون باید ساختاری شبیه به این را داشته باشد.
GenericRepository.cs را اینگونه پیاده سازی مینماییم
using Console1.Models;
using System;
using System.Linq;
using System.Linq.Dynamic;
using System.Linq.Expressions;
namespace Console1.Repository
{
public interface IGenericRepository<T>
{
IQueryable<T> CustomizeGet(Expression<Func<T, bool>> predicate);
void Add(T entity);
IQueryable<T> GetAll();
}
public class GenericRepository<TEntity, DbContext> : IGenericRepository<TEntity>
where TEntity : class, new() where DbContext : Models.Context, new()
{
private DbContext _entities = new DbContext();
public IQueryable<TEntity> CustomizeGet(Expression<Func<TEntity, bool>> predicate)
{
IQueryable<TEntity> query = _entities.Set<TEntity>().Where(predicate);
return query;
}
public void Add(TEntity entity)
{
int userId = Program.UserId; // یوزد آی دی بصورت فیک ساخته شده
// اگر از آیدنتیتی استفاده میکنید میتوان آی دی و هر چیز دیگری که کلیم شده را در اختیار گرفت
if (typeof(IUser).IsAssignableFrom(typeof(TEntity)))
{
((IUser)entity).UserId = userId;
}
_entities.Set<TEntity>().Add(entity);
}
public IQueryable<TEntity> GetAll()
{
IQueryable<TEntity> result = _entities.Set<TEntity>();
int userId = Program.UserId; // یوزد آی دی بصورت فیک ساخته شده
// اگر از آیدنتیتی استفاده میکنید میتوان آی دی و هر چیز دیگری که کلیم شده را در اختیار گرفت
if (typeof(IUser).IsAssignableFrom(typeof(TEntity)))
{
User me = _entities.Users.Single(c => c.Id == userId);
if (me.Type == UserType.Admin)
{
return result;
}
else if (me.Type == UserType.Ordinary)
{
string query = $"{nameof(IUser.UserId).ToString()}={userId}";
return result.Where(query);
}
}
return result;
}
public void Commit()
{
_entities.SaveChanges();
}
}
} توضیح کدهای فوق
1) یک اینترفیس Generic را به نام IGenericRepository داریم که کلاس GenericRepository قرار است آن را پیاده سازی نماید.
2) این اینترفیس شامل متدهای CustomizeGet است که فقط یک predicate را گرفته و خیلی مربوط به این مقاله نیست (صرفا جهت اطلاع). اما متد Add و GetAll بصورت مستقیم قرار است هدف row level security را برای ما انجام دهند.
3) کلاس GenericRepository دو Type عمومی را به نام TEntity و DbContext گرفته و اینترفیس IGenericRepository را پیاده سازی مینماید. همچنین صریحا اعلام کرده‌ایم TEntity از نوع کلاس و DbContext از نوع Context ایی است که قبلا نوشته‌ایم.
4) پیاده سازی متد CustomizeGet را مشاهده مینمایید که کوئری مربوطه را ساخته و بر میگرداند.
5) پیاده سازی متد Add بدین صورت است که به عنوان پارامتر، TEntity را گرفته (مدلی که قرار است save شود). بعد مشاهد میکنید که من به صورت hard code به UserId مقدار داده‌ام. قطعا میدانید که برای این کار به فرض اینکه از Asp.net Identity استفاده میکنید، میتوانید Claim آن Id کاربر Authenticate شده را بازگردانید.
با استفاده از IsAssignableFrom مشخص کرده‌ایم که آیا TEntity یک Typeی از IUser را داشته است یا خیر؟ در صورت true بودن شرط، UserId را به TEntity اضافه کرده و بطور مثال در Serviceهای خود نیازی به اضافه کردن متوالی این فیلد نخواهید داشت و در مرحله‌ی بعد نیز آن را به entity_ اضافه مینماییم.
مشاهده مینمایید که این متد به قدری انعطاف پذیری دارد که حتی مدل‌های مختلف به صورت کاملا یکپارچه میتوانند از آن استفاده نمایند.
6) به جالبترین متد که GetAll میباشد میرسیم. ابتدا کوئری را از آن Entity ساخته و در مرحله‌ی بعد مشخص مینماییم که آیا TEntity یک Typeی از IUser میباشد یا خیر؟ در صورت برقرار بودن شرط، User مورد نظر را یافته در صورتیکه Typeی از نوع Admin داشت، همه‌ی مجموعه را برخواهیم گرداند (Admin میتواند همه‌ی پست‌ها را مشاهده نماید) و در صورتیکه از نوع Ordinary باشد، با استفاده از dynamic linq، کوئری مورد نظر را ساخته و شرط را ایجاد می‌کنیم که UserId برابر userId مورد نظر باشد. در این صورت بطور مثال همه‌ی پست‌هایی که فقط مربوط به user خودش میباشد، برگشت داده میشود.
نکته: برای دانلود dynamic linq کافیست از طریق nuget آن را جست و جو نمایید: System.Linq.Dynamic
و اگر هم از نوع IUser نبود، result را بر میگردانیم. بطور مثال فرض کنید مدلی داریم که قرار نیست security روی آن اعمال شود. پس کوئری ساخته شده قابلیت برگرداندن همه‌ی رکورد‌ها را دارا میباشد.
7) متد Commit هم که پرواضح است عملیات save را اعمال میکند.
قبلا در قسمت Seed رکوردهایی را ساخته بودیم. حال میخواهیم کل این فرآیند را اجرا نماییم. Program.cs را از ریشه‌ی پروژه‌ی خود باز کرده و اینگونه تغییر میدهیم:
using System;
using Console1.Models;
using Console1.Repository;
using System.Collections.Generic;
using System.Linq;
namespace Console1
{
public class Program
{
public static int UserId = 1; //fake userId
static void Main()
{
GenericRepository<Post, Context> repo = new GenericRepository<Post, Context>();
List<Post> posts = repo.GetAll().ToList();
foreach (Post item in posts)
Console.WriteLine(item.Context);
Console.ReadKey();
}
}
} همانطور که ملاحظه میکنید، UserId به صورت fake ساخته شده است. آن چیزی که هم اکنون در دیتابیس رفته، بدین صورت است که UserId = 1 برابر Admin و بقیه Ordinary میباشند. در متد Main برنامه، یک instance از GenericRepository را گرفته و بعد با استفاده از متد GetAll و لیست کردن آن، همه‌ی رکورد‌های مورد نظر را برگردانده و سپس چاپ مینماییم. در صورتی که UserId برابر 1 باشد، توقع داریم که همه‌ی رکورد‌ها بازگردانده شود:
حال کافیست مقدار userId را بطور مثال تغییر داده و برابر 2 بگذاریم. برنامه را اجرا کرده و مشاهد می‌کنیم که با تغییر یافتن userId، عملیات مورد نظر متفاوت می‌گردد و به صورت زیر خواهد شد:
میبینید که تنها با تغییر userId رفتار عوض شده و فقط Postهای مربوط به آن User خاص برگشت داده میشود.
از همین روش میتوان برای طراحی Repositoryهای بسیار پیچیده‌تر نیز استفاده کرد و مقدار زیادی از validationها را به طور مستقیم بدان واگذار نمود!
دانلود کدها در Github
