ایجاد Configuration Provider سفارشی
شناسه پست: 2838
بازدید: 707

در این مقاله، میخواهیم یک configuration provider سفارشی ایجاد کنیم که پیکربندی ما را از پایگاه داده میخواند. ما دیدیم که configuration provider های پیشفرض چطور کار میکنند و حالا قصد داریم configuration provider سفارشی خود را پیاده سازی کنیم.

برای configuration provider سفارشی، از Entity Framework Core به همراه پایگاه داده SQL Server استفاده میکنیم.

اگر میخواهید در طول مسیر این مقاله، ما را دنبال کنید، از نقطه شروع یعنی سورس `پروژه  Configuration Provider ها استفاده کنید. برای بررسی پروژه تکمیل شده این مقاله، از پروژه نهایی این مقاله یعنی پروژه تکمیل شده configuration provider سفارشی استفاده کنید.

در این مقاله، عناوین زیر را پوشش میدهیم:

ابتدا، با استفاده از رویکرد  solution ،database-first خود را برای پشتیبانی از EF Core ارتقا میدهیم.

راه اندازی EF Core

قبل از اینکه شروع کنیم، چند لحظه، تمام user secret ها و متغیرهای محیطی که در قسمت قبلی ست کرده بودیم را حذف کنیم. زمانی که حذف تمام آنها تمام شد، سپس کارمان را پیش خواهیم برد.

ما اول باید دو Nuget package را نصب کنیم:

ما چون میخواهیم از SQL Server instance استفاده کنیم، به این package نیاز داریم و:

این پکیج را به این دلیل که میخواهیم دیتابیس را از طریق CLI ایجاد و عملیات migration را انجام دهیم نیاز داریم.

ما یک کلاس نیاز داریم که شامل زوجهای key-value از پیکربندی باشد (پوشه Models):

و یک کلاس DbContext (پوشه Models):

ما فقط به یک DbSet از ConfigurationEntity که جدول ما را به دیتابیس مپ میکند نیاز داریم.

حالا ما فقط به set up کردن یک اتصال به سرورمان در متد ()ConfigureServices درون کلاس Startup نیاز داریم:

و البته، شما باید connection string را در فایل appsettings.json به دیتابیس خودتان تغییر دهید. اگر از SqlExpress استفاده میکنید، به احتمال زیاد connection string شما این چنین به نظر می رسد:

تمام کاری که میبایست انجام میدادید همین بود. حالا به سادگی میتوانیم یک migration اولیه را از طریق Package Manager Console انجام دهیم:

و سپس این migration را به دیتابیس اعمال میکنیم:

حالا دیتابیس ما ایجاد شده است و آماده است تا برای ذخیره داده های پیکربندی مورد استفاده قرار گیرد.

پیاده سازی یک EF Core Provider سفارشی

برای شروع کار، یک پوشه ConfigurationProviders در پوشه Models خود ایجاد میکنیم تا کلاسهای خود را به درستی گروه بندی کنیم.

سپس، باید در واقع یک configuration provider ایجاد کنیم که از کلاس ConfigurationProvider ارث بری میکند. ما کلاس provider خود را در پوشه ConfigurationProviders ایجاد میکنیم و نام آن را EFConfigurationProvider میگذاریم:

این کلاس ممکن است در ابتدا کمی ترسناک به نظر برسد، اما آنقدرها هم ترسناک نیست.

سازنده، یک آرگومان دارد که به Action<DbContextOptionsBuilder> optionsAction اشاره میکند. ما جلوتر از کلاس DbContextOptionsBuilder برای تعریف یک context برای دیتابیس خود استفاده میکنیم. ما قبلا این کار را زمانیکه connection string خود را تعریف کرده بودیم، انجام دادیم. ما context options builder را آورده ایم تا این option را در اختیار provider سفارشی خود قرار دهیم.

ما به منظور پرکردن ConfigurationEntity با داده ها از دیتابیس یا اگر دیتابیس خالی باشد، برای ایجاد تعدادی داده های پیشفرض، متد ()Load را override کردیم. این تمام چیزی است که باید باشد.

در مرحله بعد، باید configuration provider خود را به عنوان یک منبع ثبت کنیم. برای این منظور، ما باید اینترفیس IConfigurationSource را پیاده سازی کنیم. بنابراین کلاس EFConfigurationSource را در پوشه ConfigurationProviders ایجاد میکنیم:

ما فقط باید متد ()Build را پیاده سازی کنیم که در این مثال ما، این متد، configuration provider را با options ای که از طریق سازنده configuration source ارسال کردیم را initialize میکند.

این واقعا سردرگم کننده به نظر میرسد. بنابراین ببینیم که چطور باید configuration provider دیتابیس خود را به لیست configuration source ها اضافه کنیم. ما این را مشابه شیوه قبل انجام می دهیم:

همانطور که میبینید، ما configuration builder را اینجا به منظور گرفتن IConfiguration میسازیم. ما به آن نیاز داریم، زیرا connection string ما، در فایل appsettings.json ذخیره شده است. حالا میتوانیم یک configuration source را با آن connection string ایجاد کنیم و با استفاده از متد ()configBuilder.Add، آن را به configuration source های موجود اضافه کنیم.

حالا میتوانیم فایل appsettings.json را کمی تمیزتر کنیم:

ما قسمت “Pages” را حذف کردیم تا مطمئن شویم که اطلاعات این قسمت از دیتابیس خوانده میشود.

و ما باید متد ()AddDbContext را که قبلا در کلاس Startup استفاده میکردیم را حذف کنیم،زیرا دیگر به آن نیازی نداریم.

از آنجایی که دیگر به هیچ migration در این مثال نیاز نداریم، از طریق SQL Management Studio خود یا از طریق  SQL Server Object Explorer، یک دیتابیس به نام  “ExpertMarketCommerce” به صورت دستی ایجاد کنید.

تمام. حالا برنامه را اجرا کنید.

اجرای برنامه

حالا اگر برنامه را اجرا کنیم، یک breakpoint در کلاس Startup قرار دهید و آبجکت Configuration را بررسی کنید، ما configuration source خود را پیدا خواهیم کرد:

ef configuration provider در asp.net core

عالی.

حال اگر دیتابیس را بررسی کنیم، میبینیم که آن با داده های مورد نظر تکمیل شده است:

داده های پیکربندی در دیتابیس

اجرا را ادامه میدهیم و میبینیم که برنامه ما طبق انتظار هنوز کار میکند:

خواندن داده های پیکربندی از دیتابیس

برنامه هنوز به درستی مانند قبل کار میکند! شما میتوانید صفحه را چندبار refresh کنید تا مطمئن شوید که رنگ عنوان هنوز به درستی تغییر میکند.

Conclusion

در این مقاله کوتاه، نحوه پیاده سازی configuration provider سفارشی خود را که مقادیر را از دیتابیس میخواند را دیدیم. در قسمت بعدی، میخواهیم نحوه محافظت از مقادیر حساس پیکربندی را یاد بگیریم.

شما میتوانید دیگر قسمتهای این سری از آموزش سریالی را از صفحه ASP.NET Core Web API پیدا کنید.

نویسنده

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