یادگیری Castle ActiveRecord با مثال – قسمت سوم

قسمت اول | قسمت دوم

در ادامه می خواهیم اعمال CRUD را برای هر یک از کلاس های برنامه پیاده سازی کنیم. اگر از هر یک از کلاس های دامین برنامه یک نمونه بسازید متوجه خواهید شد که به علت مشتق شدن تمامی این کلاس ها از کلاس ActiveRecordBase تمامی اعمال مورد نظر ما توسط CAR پیاده سازی شده اند! یعنی شما نیازی نیست برای انجام اعمال CRUD متدهایی جدیدی به کلاس های دامین برنامه اضافه کنید. در واقع Castle ActiveRecord یک لایه دسترسی به داده های کامل برای شما مهیا می کند. کافیست شما قوانین تجاری برنامه خود را با override کردن متدهای کلاس ActiveRecordBase اعمال کنید.

برای درک بهتر فرض کنید می خواهیم یک کتاب جدید ایجاد و به دیتابیس اضافه کنیم. کد زیر را برای این کار می نویسیم :

using (new SessionScope())
 {
 Book book = new Book()
 {
 BuyPrice = 1000,
 SalePrice = 1200,
 Title = "Castle ActiveRecord"
 };
 book.Categories = new List<Category>();
 Category category = new Category() { Title = "ORM" };
 category.Save();
 book.Categories.Add(category);
 Author author = new Author() { Title = "Iman Nemati" };
 author.Save();
 book.Author = author;
 Publisher publisher = new Publisher() { Title = "Farasun" };
 publisher.Save();
 book.Publisher = publisher;
 book.Save();
 }

خوشبختانه این کد آنقدر واضح است که نیازی به توضیح اضافه ندارد. یکی از مزایای مهم استفاده از یک ORM همین واضح بودن کدهاست. متد Save ابتدا شیء را برای داشتن یک ID معتبر بررسی می کند و سپس بر اساس آن عمل Insert یا Update را انجام خواهد داد. در اینجا از SessionScope برای Insert کردن آبجکت های مختلف استفاده کردیم. با این کار Castle ActiveRecord یک ISession را برای ذخیره کردن تمام آبجکت های ما در دبتابیس بکار می گیرد. برای ذخیره کردن یک آبجکت به تنهایی نیاز به استفاده از SessionScope ندارید.

حالا فرض کنید می خواهیم شیء کتابی که در بالا به دیتابیس اضافه کردیم را به روز رسانی کنیم. مثلاً عنوان کتاب را عوض کنیم. برای این کار ابتدا باید اطلاعات کتاب مورد نظرمان را در یک آبجکت Load کنیم، اطلاعات آن را تغییر دهیم و برای ذخیره به دیتابیس بفرستیم. کلاس ActiveRecordBase متدهایی مناسبی را برای خواندن و به روز رسانی اطلاعات در اختیارمان قرار می دهد. با متد Find می توانیم اطلاعات یک آبجکت را بوسیله ID یکتای آن از دیتابیس بخوانیم و پس از اعمال تغییرات با استفاده از متد Save تغییرات را به دیتابیس بفرستیم.

Book book = Book.Find(SelectedBookId);
 book.Title = "Learn Castle ActiveRecord with Example";
 book.Save();

همانطور که می بینید انجام اعمال CRUD با استفاده از CAR به سادگی انجام پذیر هستند. به همین ترتیب برای Delete و Update نیز متدهای مناسب وجود دارد. فقط باید توجه داشته باشید که برای انجام Delete و Update آبجکت شما باید دارای یک ID معتبر باشد، اما برای Insert احتیاجی به ID معتبر نیست.

بازیابی رکوردها (Retrive)

همانطور که در اولین قسمت این سری آموزشی گفته شد، در الگوی ActiveRecord متدهای استاتیک بر روی کل رکوردهای دیتابیس و متدهای داینامیک (آن هایی که حتماً باید اول نمونه سازی شوند و سپس مورد استفاده قرار گیرند) بر روی یک رکورد خاص عمل می کنند. کلاس ActiveRecordBase شامل یکسری متد استاتیک است که بیشتر به منظور یافتن رکوردها بر اساس یک شرط پیاده سازی شده اند. برای دستیابی به رکوردها در دیتابیس می توانید از متدهای استاتیک زیر کمک بگیرید :

  • Find : آبجکتی شامل اطلاعات رکوردی از دیتابیس با ID مشخص شده را برمی گرداند.
  • FindAll : آرایه ای از آبجکت ها شامل اطلاعات تمام رکوردهای موجود در دیتابیس برای این کلاس را بر می گرداند.
  • FindAllByProperty : آرایه ای از آبجکت ها شامل اطلاعات تمام رکوردهایی که با شرط Property = Value برابر باشند را برمی گرداند.
  • TryFind : مانند Find است با این تفاوت که اگر رکوردی که با ID پاس داده شده وجود نداشته باشد هیچ خطایی رخ نخواهد داد.

بحثی در مورد بقیه متدهای این کلاس نخواهیم کرد چون می خواهیم برای دستیابی به رکوردها از کوئری های LINQ استفاده کنیم. برای این کار در پروژه Model برنامه مثال به فایل Castle.ActiveRecord.Linq ارجاع دهید. با استفاده از این کتابخانه می توانید از قابلیت های معمولی Linq برای اجرای کوئری روی کلاس های مدل خود برخوردار شوید. متدهای زیر را به کلاس Book خود اضافه کنید : (یادتان نرود اول فضای نام Castle.ActiveRecord.Linq را using کنید)

public static Book GetByID(long id)
 {
 return (from x in ActiveRecordLinq.AsQueryable<Book>()
 where x.ID == id
 select x).First();
 }

 public static List<Book> GetByAuthor(long authorID)
 {
 return (from x in ActiveRecordLinq.AsQueryable<Book>()
 where x.Author.ID == authorID
 select x).ToList();
 }

 public static List<Book> SearchWithTitle(string title)
 {
 return (from x in ActiveRecordLinq.AsQueryable<Book>()
 where x.Title.Contains(title)
 select x).ToList();
 }

 public static List<Book> GetBooksByPriceBetween
(decimal lowPrice, decimal highPrice)
 {
 return (from x in ActiveRecordLinq.AsQueryable<Book>()
 where x.SalePrice >= lowPrice &&
 x.SalePrice <= highPrice
 select x).ToList();
 }

همانطور که مشاهده می کنید با استفاده از سینتاکس آشنای Linq هر نتیجه ای که بخواهید می توانید از اطلاعات موجود در دیتابیس بدست آورید. حالا باید خودتان بتوانید متدهای مورد نیاز برای دسترسی به رکوردها را برای بقیه کلاس های پروژه بنویسید. پس دست به کار شوید!

farasun.wordpress.com

این مطلب ادامه دارد…

برای اینکه مطالب بعدی را از دست ندهید، مشترک فید فراسان شوید!

یادگیری Castle ActiveRecord با مثال – قسمت اول

Castle ActiveRecord پیاده سازی الگوی ActiveRecord برای پلت فرم دات نت است که در آن هر نمونه از یک کلاس به عنوان یک رکورد در دیتابیس در نظر گرفته می شود که با ساخته شدن یک نمونه از کلاس، یک رکورد در دیتابیس درج می شود و با به روز شدن اطلاعات آن کلاس، رکورد مورد نظر در دیتابیس به روز می شود. متدهای استاتیک درون کلاس ها بر روی کل یا مجموعه ای از رکوردهای دیتابیس عمل می کنند.
Castle ActiveRecord پیاده سازی الگوی ActiveRecord برای پلت فرم دات نت مایکروسافت است که بر روی NHibernate ساخته شده و به عنوان یک لایه دسترسی به داده ها عمل می کند و پیچیدگی های NHibernate را از دید برنامه نویس مخفی نگه می دارد. انجام عمل Mapping در CAR به صورت اضافه کردن خاصیت به کلاس ها انجام می گیرد و شما را از نوشتن فایل های XML برای انجام نگاشت کلاس ها رها می سازد. با استفاده از Castle ActiveRecord دیگر نیازی به یادگیری نحوه نگاشت فایل های XML در NHibernate ندارید و در چند دقیقه می توانید یک لایه دسترسی به داده های کامل و بی نقص را پیاده سازی کنید. اکثر پیچیدگی های NHibernate بوسیله CAR هندل می شوند. در حال حاضر CAR زیر مجموعه ای از قابلیت های نگاشت NHibernate را که توسط اکثر برنامه نویسان و بیشتر سناریوها مورد استفاده قرار می گیرد را پوشش می دهد.

در این مطلب و مطالب آینده، با بررسی یک مثال نحوه استفاده از Castle ActiveRecord به عنوان یک لایه برای دسترسی به داده ها که بر روی NHibernate ساخته شده است را یاد خواهید گرفت. پیش نیاز یادگیری این مطلب آشنایی با مفهوم ORM است. بهتر است قبل از خواندن این نوشته، مطالب زیر را خوانده باشید :

بررسی مدل برنامه مثال

می خواهیم برنامه ای تحت ویندوز برای کتاب فروشی ها بنویسیم که اطلاعات کتاب ها، مشتریان و فروش یک کتاب فروشی کوچک را مدیریت کند. در این برنامه هر کتاب می تواند یک نویسنده و یک ناشر داشته باشد و در دسته بندی های مختلفی قرار بگیرد. کاربر می تواند اطلاعات فروش کتاب ها را به ازای هر مشتری وارد کند. برای درک بهتر مدل برنامه نگاهی به کلاس دیاگرام زیر بیندازید :

MyBookStore Domain Modelبرای شروع، آخرین نسخه کتابخانهCastle ActiveRecord را از اینجا دانلود کنید. ویژوال استادیو را باز کنید و یک سولوشن خالی ایجاد کنید. یک پروژه از نوع Class Library با نام MyBookStore.Model به سولوشن خود اضافه کنید و کتابخانه Castle.ActiveRecord را به ارجاعات این پروژه اضافه نمایید. یک کلاس به نام Category به این پروژه اضافه کنید، فضای نام Castle.ActiveRecord را using کنید و کدهای زیر را در بدنه آن بنویسید (کپی کنید!) :

[ActiveRecord(Table="Categories", Lazy=true)]
    public class Category: ActiveRecordBase<Category>
    {
        [PrimaryKey(Generator=PrimaryKeyType.Native)]
        public virtual long ID { get; set; }

        [Property(NotNull=true, Length=100)]
        public virtual string Title { get; set; }
    }

اصلاً نگران نباشید اگر منظور Attributeهای اضافه شده به کلاس بالا را متوجه نمی شوید. یکی از مزایای CAR نسبت به استفاده مستقیم از NHibernate همین نحوه نگاشت کلاس ها بر اساس Attributeهاست. در این روش دیگر نیازی به نوشتن فایل های XML برای انجام عمل Mapping ندارید و کدهای نوشته شده در کلاس شما از خوانایی بسیار بالایی برخوردار خواهند بود.

حالا کلاس دیگری به نام Customer به پروژه خود اضافه کنید و کدهای زیر را در آن بنویسید (قبلش فضای نام Castle.ActiveRecord را using کنید ) :


[ActiveRecord(Table="Customers", Lazy=true)]
 public class Customer: ActiveRecordBase<Customer>
 {
 [PrimaryKey(PrimaryKeyType.Native)]
 public virtual long ID { get; set; }

 [Property(NotNull=true, Length=250)]
 public virtual string Title { get; set; }

 [Property(Length=50)]
 public virtual string ContactNumber { get; set; }

 [Property(Length=250)]
 public virtual string Email { get; set; }

 [HasMany(typeof(Order), Inverse=true, Lazy=true)]
 public virtual IList<Order> Orders { get; set; }
 }

اگر به کدهای کلاس های بالا دقت کرده باشید نکته هایی را متوجه خواهید شد :

  • با اضافه کردن صفت ActiveRecord مشخص می کنیم که این کلاس قرار است به یک Table در دیتابیس Map شود.
  • با مقدار دهی Table می توانید نام جدولی که قرار است در دیتابیس ساخته شود را تعیین کنید. اگر مقدار دهی نشود به صورت پیش فرض نام کلاس را برای نام Table انتخاب می کند.
  • در هر کلاس یک پراپرتی به نام ID وجود دارد که با صفت PrimaryKey معرفی شده اند. با این کار یک فیلد به نام ID به عنوان کلید اصلی در Table ایجاد می شود و نوع آن Identity خواهد بود (البته در SQL Server)
  • اعضایی که با صفت Property مشخص شده اند، فیلدهای Table را مشخص می کنند. هر کدام از این اعضا به صورت پیش فرض Nullable هستند که می توانید با مقدار دهی NotNull برای هر کدام این پیش فرض را تغییر دهید.
  • برای اعضای String می توانید Length مشخص کنید.

برای ادامه کلاس های زیر را به پروژه تان اضافه کنید. یادتان نرود در هر کدام فضای نام Castle.ActiveRecord را using کنید!

کلاس Author برای نگهداری اطلاعات یک نویسنده :

Author.cs

[ActiveRecord(Table="Authors", Lazy=true)]
 public class Author: ActiveRecordBase<Author>
 {
 [PrimaryKey(Generator=PrimaryKeyType.Native)]
 public virtual long ID { get; set; }

 [Property(NotNull=true, Length=100)]
 public virtual string Title { get; set; }

کلاس Publisher برای نگهداری اطلاعات ناشر یک کتاب : Publisher.cs

[ActiveRecord(Table="Publishers", Lazy=true)]
public class Publisher: ActiveRecordBase<Publisher>
{
[PrimaryKey(Generator=PrimaryKeyType.Native)]
public virtual long ID { get; set; }</p>
<p dir="ltr">[Property(NotNull=true, Length=100)]
public virtual string Title { get; set; }</p>
<p dir="ltr">[Property(Length=400)]
public virtual string Description { get; set; }
}

کلاس Book برای نگهداری اطلاعات یک کتاب : Book.cs

[ActiveRecord(Table="Books", Lazy=true)]
public class Book: ActiveRecordBase&lt;Book&gt;
{
[PrimaryKey(Generator=PrimaryKeyType.Native)]
public virtual long ID { get; set; }</p>
[Property(NotNull=true, Length=250)]
public virtual string Title { get; set; }

[Property(NotNull=true)]
public virtual decimal BuyPrice { get; set; }

[Property(NotNull=true)]
public virtual decimal SalePrice { get; set; }

[BelongsTo(Column="AuthorID", NotNull=true)]
public virtual Author Author { get; set; }

[BelongsTo(Column="PublisherID", NotNull=true)]
public virtual Publisher Publisher { get; set; }

[HasAndBelongsToMany(typeof(Category), Table="BookCategories" ,
 ColumnKey="BookID", ColumnRef="CategoryID")]
public virtual IList Category Categories { get; set; }
}

کلاس های Author و Publisher نکته جدیدی ندارند اما اگر به تعریف کلاس Book توجه کنید Attributeهای جدیدی می بینید. با توجه به مدل برنامه (که تصویر آن در ابتدای مطلب آمده) موجودیت Book با موجودیت های دیگر ارتباط دارد که باید در تعریف این کلاس این ارتباط ها را معرفی کنیم. پراپرتی های Author و Publisher با صفت BelongsTo به همراه NotNull=true مشخص شده اند. این یعنی هر Book باید متعلق به یک Author و یک Publisher مشخص باشد. پراپرتی Categories لیستی از نوع کلاس Category است که در ابتدای مطلب تعریف آن را دیدید. این پراپرتی با صفت HasAndBelongsToMany مشخص شده است که منظور رابطه چند به چند میان کتاب ها و دسته بندی هاست. در این رابطه ColumnKey فیلدی است که آی دی Book و ColumnRef فیلدی است که آی دی یک Category را برای ایجاد رابطه چند به چند ذخیره می کند. در طرف دیگر رابطه (یعنی در کلاس Category) جای ColumnKey و ColumnRef باید عوض شود اما نام Table باید یکی باشد.

تا اینجا رابطه های میان کتاب ها با دیگر موجودیت ها را برای کلاس Book تعریف کردیم. برای اینکه کلاس های دیگر نیز رابطه خودشان با کلاس Book را بدانند باید برای آن ها نوع رابطه را مشخص کنیم. برای این منظور کلاس های فوق را به صورت زیر تغییر دهید:

کلاس Author :

[ActiveRecord(Table="Authors", Lazy=true)]
 public class Author: ActiveRecordBase<Author>
 {
 [PrimaryKey(Generator=PrimaryKeyType.Native)]
 public virtual long ID { get; set; }

 [Property(NotNull=true, Length=100)]
 public virtual string Title { get; set; }

 [HasMany(typeof(Book), Inverse=true, Lazy=true)]
 public virtual IList<Book> Books { get; set; }
 }

کلاس Publisher :

[ActiveRecord(Table="Publishers", Lazy=true)]
 public class Publisher: ActiveRecordBase<Publisher>
 {
 [PrimaryKey(Generator=PrimaryKeyType.Native)]
 public virtual long ID { get; set; }

 [Property(NotNull=true, Length=100)]
 public virtual string Title { get; set; }

 [Property(Length=400)]
 public virtual string Description { get; set; }

 [HasMany(typeof(Book), Inverse=true, Lazy=true)]
 public virtual IList<Book> Books { get; set; }
 }

کلاس Category :

[ActiveRecord(Table="Categories", Lazy=true)]
 public class Category: ActiveRecordBase<Category>
 {
 [PrimaryKey(Generator=PrimaryKeyType.Native)]
 public virtual long ID { get; set; }

 [Property(NotNull=true, Length=100)]
 public virtual string Title { get; set; }

 [HasAndBelongsToMany(typeof(Book), Table="BookCategories", ColumnKey="CategoryID", ColumnRef="BookID")]
 public virtual IList<Book> Books { get; set; }
 }

همانطور که مشاهده می کنید نیازی نیست تمام تعریف کلاس های بالا را تغییر دهید، فقط کافیست پراپرتی های جدید را به همان کلاس های قبلی اضافه کنید. در کلاس های Author و Publisher یک پراپرتی به نام Books از نوع لیستی از کلاس Book با صفت HasMany تعریف شده است. HasMany مشخص کننده یک رابطه یک به چند از این موجودیت ها به موجودیت «کتاب» است. Inverse=true مشخص می کند که طرف دیگر رابطه یعنی Book مسئول ذخیره کردن اطلاعات است و Lazy=true ویژگی Lazy Loading را برای این مجموعه فعال می کند.

پراپرتی جدید کلاس Category مشخص کننده رابطه چند به چند این موجودیت با موجودیت Book است. اگر به تعریف کلاس Book نگاهی دوباره بیندازید مشاهده می کنید که این رابطه برای کلاس Book تعریف شده است. در Castle ActiveRecord همیشه باید رابطه ها را برای هر دو طرف یک رابطه تعریف کنید. برای یک رابطه چند به چند باید از صفت HasAndBelongsToMany استفاده کنید و ColumnKey، ColumnRef و Table را طوری مقدار دهی کنید که در انتها یک رابطه چند به چند به درستی بین دو موجودیت بوسیله یک Table واسط ایجاد شود. ColumnKey همیشه کلید خارجی موجودیت جاری است و ColumnRef کلید خارجی طرف دیگر رابطه را مشخص می کند. نام Table برای هر دو طرف رابطه باید یکی باشد تا CAR بتواند رابطه چند به چند را برای شما ایجاد کند.

farasun.wordpress.com

این مطلب ادامه دارد…

برای اینکه مطالب بعدی را از دست ندهید، مشترک فید فراسان شوید!