عنوان:

‫روش افزودن بسته‌های محلی NuGet به پروژه‌های .NET


نویسنده: وحید نصیری
تاریخ: ۱۴۰۴/۰۱/۲۶ ۰۷:۴۸
آدرس: www.dntips.ir
مقدمه
مدیریت وابستگی‌ها (Dependencies) یکی از مهم‌ترین جنبه‌های توسعه پروژه‌های مقیاس‌پذیر و کارآمد است. ابزار NuGet به‌عنوان مدیر بسته (Package Manager) پیش‌فرض .NET، امکان استفاده از کتابخانه‌ها و ابزارهای شخص ثالث یا سفارشی را فراهم می‌کند. گاهی اوقات، توسعه‌دهندگان نیاز دارند تا بسته‌های NuGet را به‌صورت محلی (Local) در پروژه‌های خود استفاده کنند، چه برای تست بسته‌های توسعه‌یافته توسط خودشان و چه برای استفاده از بسته‌هایی که هنوز در مخازن عمومی مانند nuget.org منتشر نشده‌اند. این مقاله به بررسی روش‌های افزودن بسته‌های محلی NuGet (فایل‌های .nupkg) به پروژه‌های .NET می‌پردازد.

بسته NuGet چیست؟
بسته NuGet یک فایل فشرده با پسوند .nupkg است که شامل کدهای کامپایل‌شده (معمولاً DLLها)، فایل‌های مرتبط و یک فایل متادیتا به نام .nuspec است که اطلاعات بسته مانند نسخه، شناسه و وابستگی‌ها را مشخص می‌کند. این بسته‌ها می‌توانند در مخازن عمومی مانند nuget.org یا به‌صورت محلی ذخیره شوند. استفاده از بسته‌های محلی به‌ویژه در سناریوهایی مفید است که توسعه‌دهنده در حال آزمایش یک کتابخانه جدید است یا به دلایلی نمی‌خواهد بسته را در یک مخزن عمومی منتشر کند.

چرا از بسته‌های محلی استفاده کنیم؟
دلایل متعددی برای استفاده از بسته‌های محلی وجود دارد:
  • تست و توسعه: توسعه‌دهندگان می‌توانند قبل از انتشار عمومی بسته، آن را در محیط محلی آزمایش کنند.
  • محدودیت‌های دسترسی: در برخی سازمان‌ها، دسترسی به مخازن عمومی محدود است و استفاده از مخازن محلی ترجیح داده می‌شود.
  • شخصی‌سازی: بسته‌های محلی امکان استفاده از کدهای سفارشی را بدون نیاز به انتشار فراهم می‌کنند.
  • سرعت: دسترسی به بسته‌های محلی معمولاً سریع‌تر از دانلود از مخازن آنلاین است.

روش‌های افزودن بسته‌های محلی به پروژه .NET
برای افزودن یک بسته محلی NuGet به پروژه .NET، چندین روش وجود دارد که در ادامه به‌صورت گام‌به‌گام توضیح داده می‌شوند. این روش‌ها با استفاده از Visual Studio، رابط خط فرمان (CLI) و تنظیمات پروژه قابل اجرا هستند.

1. استفاده از Visual Studio و منبع بسته محلی
یکی از رایج‌ترین روش‌ها برای افزودن بسته محلی، استفاده از رابط کاربری Visual Studio است. مراحل زیر این فرآیند را توضیح می‌دهند:
- ایجاد یک پوشه برای بسته‌های محلی: ابتدا یک پوشه در سیستم خود (مثلاً C:\LocalNuGet) ایجاد کنید و فایل .nupkg موردنظر را در آن قرار دهید.
- افزودن منبع بسته به Visual Studio:
  • در Visual Studio، به منوی Tools > Options > NuGet Package Manager > Package Sources بروید.
  • روی دکمه سبز "+" کلیک کنید و یک نام (مثلاً "LocalNuGet") و مسیر پوشه (مثلاً C:\LocalNuGet) را وارد کنید.
  • روی "Update" و سپس "OK" کلیک کنید.
- نصب بسته در پروژه:
  • در Solution Explorer، روی پروژه راست‌کلیک کرده و گزینه Manage NuGet Packages را انتخاب کنید.
  • در بخش Package Source، منبع جدید (LocalNuGet) را انتخاب کنید.
  • بسته موردنظر را از لیست انتخاب کرده و روی Install کلیک کنید.
این روش به‌ویژه برای توسعه‌دهندگانی که ترجیح می‌دهند از رابط گرافیکی استفاده کنند، مناسب است.

2. استفاده از Package Manager Console
روش دیگر، استفاده از کنسول مدیریت بسته‌ها (Package Manager Console) در Visual Studio است. این روش برای کسانی که با دستورات PowerShell راحت هستند، کارآمد است. مراحل به شرح زیر است:
  1. باز کردن کنسول: در Visual Studio، به منوی Tools > NuGet Package Manager > Package Manager Console بروید.
  2. اجرای دستور نصب: از دستور زیر برای نصب بسته استفاده کنید:
Install-Package SomePackage -Source "C:\PathToThePackageDir\"
در این دستور، SomePackage نام بسته و C:\PathToThePackageDir\ مسیر پوشه حاوی فایل .nupkg است.

نکته: اگر بسته نسخه پیش‌انتشار (Prerelease) باشد، باید پرچم -IncludePrerelease را اضافه کنید:
Install-Package SomePackage -Source "C:\PathToThePackageDir\" -IncludePrerelease
این روش انعطاف‌پذیری بالایی دارد و برای اتوماسیون یا اسکریپت‌نویسی مناسب است.

3. استفاده از .NET CLI
برای توسعه‌دهندگانی که خارج از Visual Studio یا در محیط‌های غیرویندوزی کار می‌کنند، ابزار .NET CLI گزینه‌ای قدرتمند است. مراحل به این صورت است:
- ایجاد منبع بسته محلی: منبع بسته را با دستور زیر به فایل تنظیمات NuGet اضافه کنید:
dotnet nuget add source "C:\LocalNuGet" --name LocalNuGet
- نصب بسته: بسته را با دستور زیر به پروژه اضافه کنید:
dotnet add package SomePackage --source LocalNuGet
این روش به‌ویژه در محیط‌های CI/CD یا پروژه‌های چندپلتفرمی مفید است، زیرا وابستگی به Visual Studio ندارد.

4. استفاده مستقیم از فایل .nupkg
در برخی موارد، می‌توان فایل .nupkg را مستقیماً به پروژه اضافه کرد. این روش کمتر رایج است اما در سناریوهای خاص کاربرد دارد:
- فایل .nupkg را در یک پوشه مشخص کپی کنید.
- در فایل پروژه (.csproj)، یک مرجع بسته (PackageReference) به‌صورت زیر اضافه کنید:
<ItemGroup>
    <PackageReference Include="SomePackage" Version="1.0.0" />
</ItemGroup>
- منبع محلی را در فایل NuGet.Config پروژه یا سیستم تعریف کنید:
<configuration>
    <packageSources>
        <add key="LocalNuGet" value="C:\LocalNuGet" />
    </packageSources>
</configuration>
این روش برای پروژه‌هایی که نیاز به تنظیمات پیشرفته دارند، مناسب است.

نکات مهم در کار با بسته‌های محلی
  • مدیریت نسخه‌ها: هنگام استفاده از بسته‌های محلی، اطمینان حاصل کنید که نسخه بسته با نیازهای پروژه سازگار است. در صورت استفاده از بسته‌های پیش‌انتشار، پرچم‌های مناسب را در دستورات اعمال کنید.
  • پاک‌سازی کش: اگر بسته به‌درستی نمایش داده نشد، کش NuGet را با دستور زیر پاک کنید:
dotnet nuget locals all --clear
  • سازگاری فریم‌ورک: مطمئن شوید که بسته با نسخه فریم‌ورک .NET پروژه شما سازگار است (مثلاً .NET 6 یا .NET 8).
  • امنیت: فایل‌های .nupkg را فقط از منابع معتبر دریافت کنید، زیرا ممکن است حاوی کدهای مخرب باشند.

مثال عملی
فرض کنید یک بسته محلی به نام MyLibrary.1.0.0.nupkg دارید که در مسیر C:\LocalNuGet ذخیره شده است. برای افزودن آن به پروژه با Visual Studio:
- منبع بسته را در Visual Studio اضافه کنید (همان‌طور که در بخش اول توضیح داده شد).
- در Package Manager Console، دستور زیر را اجرا کنید:
Install-Package MyLibrary -Source "C:\LocalNuGet"
- یا با .NET CLI:
dotnet add package MyLibrary --source "C:\LocalNuGet"
پس از نصب، می‌توانید از کلاس‌های موجود در بسته استفاده کنید، به‌عنوان مثال:
using MyLibrary;
var greeter = new Greeter();
Console.WriteLine(greeter.SayHello("Developer"));
این مثال نشان می‌دهد که چگونه یک بسته محلی به پروژه اضافه شده و در کد استفاده می‌شود.

نتیجه‌گیری
افزودن بسته‌های محلی NuGet به پروژه‌های .NET فرآیندی انعطاف‌پذیر و قدرتمند است که توسعه‌دهندگان را قادر می‌سازد تا کتابخانه‌های سفارشی یا آزمایشی را به‌راحتی در پروژه‌های خود ادغام کنند. با استفاده از ابزارهایی مانند Visual Studio، Package Manager Console یا .NET CLI، می‌توان این بسته‌ها را به روش‌های مختلفی مدیریت کرد. هر روش مزایا و کاربردهای خاص خود را دارد، و انتخاب روش مناسب به نیازهای پروژه و ترجیحات توسعه‌دهنده بستگی دارد. با رعایت نکات امنیتی و مدیریت صحیح نسخه‌ها، توسعه‌دهندگان می‌توانند از این قابلیت برای بهبود کارایی و تسریع فرآیند توسعه استفاده کنند.


مشاهده مطلب اصلی