معرفی SalarDbCodeGenerator

۱۳۹۱/۰۲/۱۶ ۹:۲۱ Salar Khalilzadeh https://plus.google.com/105397214522932500988 منتشر شده در تاریخ : ۱۳۹۱/۰۲/۱۶ دسته بندی : ، ، ، 7

مدتی بود که تصمیم داشتم پروژه رو که در ادامه مشاهده می کنید، اوپن سورس کنم. این برنامه در طول مدت تقریبا نزدیک به 4 سال به تدریج توسعه یافته و به شکل کنونی خود رسیده. تقریبا در بیشتر پروژه هایی که خودم شروع کردم از اون استفاده کردم و تا حد قابل قبولی آزمایش شده و قابل اعتماد هست.
SalarDbCodeGenerator یک تولید کننده کد است که از مدل اول دیتابیس (Database first) پیروی می کند. با استفاده از الگوهای از قبل تهیه شده پروژه را تولید کرده و آماده کامپایل و استفاده می شه. هر الگو معمولا شامل کلاسها مدلینگ جدوال، ویو ها و در نهایت کلاسهای پایه کار دیتابیس و یا کلاسهای پایه ORM مورد استفاده است.
از عمده مزیت استفاده از یک تولید کننده کد کاهش زمان مورد نیاز برای نوشتن کلاسهای مدل و توابع mapping است. تقریبا همه این کارها انجام شده و پروژه قابل استفاده تحویل می گیرید.
الگوهای مورد استفاده برنامه همگی قابلیت سفارشی سازی دارند و در حالت کلی برای نرم افزار زبان مورد استفاده شده هیچ اهمیتی ندارد و هر آنچه که در الگو معین شده خروجی را تعیین می کند. در نتیجه خروجی این تولید کننده در هر زبانی می تواند باشد.

پایگاه داده های مورد پشتیبانی
  • Micorsoft SQL Server (2000/2005/2008/2012)
    (پشتیبانی از توضیح برای فیلدها)
  • SQL Server Compact Edition 4
  • Oracle Database (8i/9i/10g/11g)
  • SQLite (v3 and above) 
خلاصه امکانات
  •  شناسایی کلید واژه های رزروشده (Keywords) زبان برنامه نویسی و عدم ایجاد تداخل کد تولیدی
  • پستیبانی از تغییر نامه جداول و ویوهای تولیدی جهت خوانا شدن در هنگام برنامه نویسی
  • افزودن توضیحات هر یک از فیلدهای جدول به مدلهای تولید شده جهت راحتی در هنگام کد نویسی (فقط SQLServer)
  • الگوی های سفارشی
  • استفاده شده از الگوهای کد به صورت XML که تغییر و ویرایش آنها را ساده می کند
  • تولید کد برای کلیدهای خارجی (Foreign keys) و اندیس ها (Index)

الگوهای همراه برنامه

Entity Framework Code First
  • EF4 CodeFirst
    (همراه با data annotations)
  • EF4 CodeFirst MVVM
  • (همراه با  data annotations و اعلان تغییر پراپرتی های mvvm)
  • EF4 CodeFirst Simple
    (کلاسهای ساده بدون ویژگی اضافه)
مدل دیتابیس را برای استفاده توسط Entity Framwork 4.2 CodeFirst تولید می کند. همچنین چندین متد و ویزگی اضافه که برای برنامه نویس مفید هستند همراه این مدل افزوده است.

data annotations و اعلان تغییر پراپرتی ها(INotifyPropertyChanged) به صورت دو الگوی جداگانه طراحی شده و در دسترس هستند. همچنین همه کلاسها به صورت partial بوده و قابلیت سفارش سازی دارند.
همراه با همه الگوهای پیش فرض معمولا کلاسهای Partial جداگانه ای تولید می شود تا برنامه نویس بتواند ویژگی ها و متد های سفارشی خودش را در آنها قرار دهد.

NHibernate Mapping By Code (در حال آماده سازی)
Mapping By Code از نسخه NHibernate 3.2 معرفی شد و بدون نیاز به داشتن فایلهای xml اضافه اجازه استفاده از مدلها را می دهد.
در زمانها فراقتم در حال آماده کردن این الگو هستم، که پس از آزمایش اطمینان از صحت عمل آن منتشر می کنم.

NHibernate ActiveRecord

  • NHibernate ActiveRecord
  • NHibernate ActiveRecord WCF
مدل های دیتابیس و کلاسهای مورد نیاز را تولید می کند که  توسط هر دو نسخه Castle ActiveRecord 2.2 یا 3 قابل استفاده است. Castle ActiveRecord از الگوی  ActiveRecord پیروی می کند و به صورت توکار از NHibernate برای اجرای کوئری ها استفاده میکند.
الگوی "NHibernate ActiveRecord WCF" اختصاصا برای کار با WCF بهینه سازی شده است، به این صورت که ID جدوال خارجی را نیز در خود نگه میدارد (این کار در حال عادی مرسوم نیست) جهت سهولت ارسال مدل ها در WCF. البته این Id ها باید به صورت دستی مقدار دهی شوند.

LinqToSql
نسخه متفاوتی از مدل Linq To Sql را تولید می کند. مدل تولید شده از روش برنامه های سه لایه تبعیت می کند. البته توجه شود که فقط دو لایه Bussinuess و DAL در این الگو تولید می شوند. طبق معمول جهت سفارشی سازی کلاسها  و متدهای اضافه مد تظر گرفته شده اند.

Entity Framework 4 POCO
  • EF4 POCO
  • EF4 POCO LINQ
مدل های دیتابیس و کلاسهای Entity Framework 4 را به صورت مدل POCO تولید می کند. POCO مخفف Plain Old Clr Object استفاده از روش سفارشی سازی شده برای Entity Framework نسخه 4 است.
الگوی "EF4 POCO LINQ" یک مدل اضافه روش برنامه نویسی سه لایه نیز تولید می کند، که هر دو روش در برنامه قابل استفاده هستند. جهت استفاده از این دو الگو باید حتما مراحل زیر را دنبال کنید.
ابتدا در پروژه باید حتما مدل ایجاد شود، نام مدل باید همنام دیتابیس به علاوه Entities باشد (مثلا TestDbEntities.edmx و TestDbEntities برای نام کلاس).
هنگام تهیه مدل حتما باید گزینه "Pluralize or singularize generated object names" حذف شود. و در نهایت ویرایشگر مدل (Model Designer) مقدار ویژگی "Code Generation Strategy" باید به "None" تغییر داده شود.
پس از طی این مراحل مدل تولیدی قابل استفاده خواهد بود.


3Tier
  • 3Tier CSharp
  • 3Tier VB.NET
مدل های دیتبایس را جهت استفاده در یک برنامه سه لایه کلاسیک تولید می کند. این الگوها از کلاسهای پایه ADO.Net جهت دسترسی به داده و انجام عملیات استفاده می کنند. همچنین همه عملیات پیش فرض این مدل ها توسط Stored Procedure تولید شده انجام می شود.
به همین دلایل سرعت عملیاتی این مدل بسیار بالا بوده و برای برنامه هایی که نیاز به سرعت زیادی دارند، بسیار مناسب می باشد.
الگوی "3Tier CSharp" علاوه بر موارد ذکر شده از یک مرحله caching اضافه هنگام خواندن اطلاعت بر روی ترتیب رکوردها نیر استفاده می کند. این باعث افزایش کارایی هنگام خواندن حجم عظیمی از داده می شود.
این دو الگو محدودیت های خودشان را نیز دارند، از جمله نیاز به نوشتن هر عملیات جدید به صورت دستی، عدم پشتیبانی از Linq و محدود بودن به SQL Server می توان اشاره کرد.

جهت اطلاعات بیشتر و مستندات الگوها می توانید به آدرس پروژه مراجعه کنید.
الگوها همگی به زبان XML تهیه شده اند و ویرایش آنها کار ساده ای است. در صورتی که درخواست کافی جهت تهیه مستندات برای قالب الگو دریافت کنم، این کار را خواهم کرد.

پنجره اصلی برنامه
پنجره تنظیمات برنامه

  • دانلود
این پروژه به صورت اوپن سورس و رایگان در آدرس salardbcodegenerator.codeplex.com قرار گرفته است.
همچنین کدهای برنامه به صورت آنلاین در این آدرس قابل مشاهده هستند.

پیشنهادات و ایرادات مشاهده شده از اینجا و یا صفحه نظرات پروژه مطرح کنید.

 

7 بازخورد برای “معرفی SalarDbCodeGenerator”

  1. بسیار عالی، مشخصه خیلی زحمت براش کشیدی، کار خیلی با ارزشی کردی

    پاسخحذف
  2. امیدوارم حالا که برنامه رو اوپن سورس کردید با مشارکت دوستان هر روز بهتر و کامل تر بشه

    پاسخحذف
  3. من هم به نوبه خودم از این حرکت پسندیده شما کمال تشکر را دارم

    پاسخحذف
  4. از این که حاصل زحمت خودتون رو به جامعه کاربران ایرانی وب ارائه کردید بسیار متشکرم. به امید روزی که همه به هم دیگه نفع برسونیم.

    پاسخحذف
  5. سلام ،
    از اینکه حاصل زحمت خودتون رو به اشتراک می گذارید متشکرم.

    پاسخحذف
  6. من هم همینطور. اگر کسی اصلاحی داشت می تونه از طریق codeplex اعلام کنه.

    پاسخحذف
  7. با تشکر از زحمات و لطف شما آقای خلیل زاده...

    پاسخحذف