ایجاد یک سرویس ساده با ServiceStack

ساخت APIهای سریع و مقیاس‌پذیر یک چالش همیشگی است. توسعه‌دهندگان دات نت ابزارهای مختلفی در اختیار دارند. یکی از قدرتمندترین آن‌ها، فریمورک ServiceStack است. این فریمورک یک جایگزین عالی برای ASP.NET Core Web API محسوب می‌شود. در این مقاله، به صورت کامل به ایجاد یک سرویس ساده با استفاده از ServiceStack می‌پردازیم. ما شما را از مفاهیم اولیه تا پیاده‌سازی یک سرویس کاربردی همراهی می‌کنیم. 🚀

ServiceStack چیست؟ یک نگاه کلی

ServiceStack یک فریمورک مدرن و پرسرعت در اکوسیستم دات نت است. این ابزار برای ساخت وب سرویس‌ها و APIهای تحت وب طراحی شده است. برخلاف برخی فریمورک‌های پیچیده، ServiceStack بر سادگی و کارایی تمرکز دارد. فلسفه اصلی آن بر پایه اشیاء انتقال داده (DTO) استوار است. این یعنی شما ابتدا درخواست‌ها و پاسخ‌های خود را تعریف می‌کنید. سپس منطق سرویس را پیاده‌سازی می‌نمایید. این رویکرد کد شما را بسیار تمیز و قابل نگهداری می‌کند.

چرا باید از ServiceStack استفاده کنیم؟

شاید بپرسید با وجود ASP.NET Core Web API، چرا به سراغ ServiceStack برویم؟ پاسخ در مزیت‌های کلیدی آن نهفته است. این فریمورک به شما کمک می‌کند سریع‌تر و بهتر کد بزنید. در ادامه به مهم‌ترین مزایای آن اشاره می‌کنیم.

(High-Performance): 🚀 ServiceStack به شدت برای سرعت بهینه‌سازی شده است. این فریمورک یکی از سریع‌ترین گزینه‌ها برای ساخت API در دات نت است.
🧩 سادگی و بهره‌وری بالا: با پیروی از الگوی «قرارداد محور» (DTO-First)، پیچیدگی کد کاهش می‌یابد. بنابراین، توسعه و نگهداری پروژه‌ها آسان‌تر می‌شود.
🌍 پلتفرم مستقل: سرویس‌های ساخته شده با ServiceStack به راحتی روی ویندوز، لینوکس و مک اجرا می‌شوند. این ویژگی برای محیط‌های مبتنی بر کانتینر (مانند Docker) عالی است.
🛠️ امکانات داخلی غنی: این فریمورک دارای ابزارهای داخلی قدرتمندی است. ابزارهایی مانند کشینگ، احراز هویت، اعتبارسنجی و لاگینگ به صورت آماده وجود دارند.
🔄 پشتیبانی از فرمت‌های مختلف: یک سرویس ServiceStack می‌تواند به صورت خودکار از فرمت‌های JSON, XML, SOAP, gRPC و… پشتیبانی کند.

کاربردهای کلیدی ServiceStack

به لطف انعطاف‌پذیری و کارایی بالا، ServiceStack در سناریوهای مختلفی کاربرد دارد. این فریمورک تنها برای ساخت یک API ساده نیست. بلکه می‌تواند ستون فقرات سیستم‌های بزرگ باشد.

🏢 سیستم‌های سازمانی (Enterprise): برای ساخت بک‌اند برنامه‌های بزرگ و پیچیده ایده‌آل است.
🔬 معماری میکروسرویس: سادگی و استقلال سرویس‌ها آن را به گزینه‌ای عالی برای میکروسرویس‌ها تبدیل کرده است.
⚡ وب‌سایت‌های پربازدید: توانایی مدیریت درخواست‌های بالا، آن را برای وب‌سایت‌های پرترافیک مناسب می‌سازد.
📱 بک‌اند اپلیکیشن‌های موبایل: توسعه‌دهندگان موبایل می‌توانند به راحتی با APIهای ساخته شده توسط آن ارتباط برقرار کنند.

آموزش گام به گام: ایجاد یک سرویس ساده با ServiceStack

حالا زمان آن رسیده که وارد عمل شویم. ما یک سرویس ساده برای مدیریت یادداشت‌ها (Notes) خواهیم ساخت. این سرویس می‌تواند لیستی از یادداشت‌ها یا یک یادداشت خاص را بر اساس شناسه برگرداند.

پیش‌نیازها

برای شروع، به ابزارهای زیر نیاز دارید.

نصب .NET 8 SDK یا نسخه‌های جدیدتر.
یک ویرایشگر کد مانند Visual Studio 2022 یا VS Code.

گام اول: ایجاد پروژه جدید

ابتدا یک پروژه وب خالی در دات نت ایجاد می‌کنیم. ترمینال یا Command Prompt را باز کرده و دستورات زیر را اجرا کنید. این دستورات یک پروژه جدید ساخته و وارد پوشه آن می‌شود.

bash

dotnet new web -n MySimpleService
cd MySimpleService

گام دوم: نصب پکیج ServiceStack

اکنون باید پکیج اصلی ServiceStack را به پروژه اضافه کنیم. این کار با یک دستور ساده انجام می‌شود.

bash

dotnet add package ServiceStack

گام سوم: تعریف DTOها (قرارداد سرویس)

همانطور که گفتیم، ServiceStack بر پایه DTO کار می‌کند. پس ابتدا مدل‌های درخواست و پاسخ را می‌سازیم. یک فایل جدید به نام NoteDtos.cs ایجاد کنید و کدهای زیر را در آن قرار دهید.

csharp

using ServiceStack;

// تعریف مدل اصلی داده ما
public class Note
{
    public int Id { get; set; }
    public string? Text { get; set; }
}

// تعریف درخواست برای دریافت یادداشت
// این کلاس مسیرهای دسترسی به سرویس را مشخص می‌کند
[Route("/notes", "GET")]
[Route("/notes/{Id}", "GET")]
public class NoteRequest : IReturn<NoteResponse>
{
    public int? Id { get; set; }
}

// تعریف پاسخ سرویس
public class NoteResponse
{
    public List<Note> Results { get; set; }
    public ResponseStatus? ResponseStatus { get; set; } // برای مدیریت خطاها
}

گام چهارم: پیاده‌سازی منطق سرویس

در این مرحله، منطق اصلی سرویس را پیاده‌سازی می‌کنیم. کلاسی به نام NotesService.cs بسازید. این کلاس مسئول پردازش NoteRequest خواهد بود.

csharp

using ServiceStack;

public class NotesService : Service
{
    // یک منبع داده ساده و موقت برای مثال
    private static readonly List<Note> Notes = new()
    {
        new Note { Id = 1, Text = "اولین یادداشت با ServiceStack" },
        new Note { Id = 2, Text = "یادگیری ساخت APIهای سریع" }
    };

    // این متد تمام درخواست‌های GET را مدیریت می‌کند
    public object Get(NoteRequest request)
    {
        // اگر Id در درخواست وجود داشت
        if (request.Id.HasValue)
        {
            var note = Notes.FirstOrDefault(n => n.Id == request.Id.Value);
            return new NoteResponse { Results = note != null ? new List<Note> { note } : new List<Note>() };
        }

        // در غیر این صورت، تمام یادداشت‌ها را برگردان
        return new NoteResponse { Results = Notes };
    }
}

گام پنجم: پیکربندی و راه‌اندازی هاست (Host)

آخرین مرحله، معرفی و پیکربندی ServiceStack در برنامه است. فایل Program.cs را باز کنید و محتوای آن را با کدهای زیر جایگزین نمایید.

csharp

using ServiceStack;

// یک کلاس AppHost برای پیکربندی ServiceStack
public class AppHost : AppHostBase
{
    public AppHost() : base("My Simple Service", typeof(NotesService).Assembly) { }

    public override void Configure(Funq.Container container)
    {
        // اینجا می‌توانید پیکربندی‌های پیشرفته را اضافه کنید
    }
}

// بخش اصلی برنامه
var builder = WebApplication.CreateBuilder(args);

// اضافه کردن ServiceStack به سرویس‌ها
builder.Services.AddServiceStack(new AppHost());

var app = builder.Build();

// استفاده از ServiceStack در pipeline برنامه
app.UseServiceStack(new AppHost
{
    // فعال‌سازی پلاگین‌های کاربردی مانند صفحه متادیتا
    Plugins = {
        new PostmanFeature(),
        new CorsFeature()
    }
});

app.Run();

اکنون پروژه شما آماده است! با اجرای دستور dotnet run در ترمینال، سرویس شما اجرا می‌شود. سپس می‌توانید به آدرس https://localhost:<port>/metadata بروید و مستندات سرویس خود را ببینید.

ثبت‌نام و دسترسی به APIهای بیشتر

یادگیری ServiceStack دروازه‌ای به دنیای APIهای قدرتمند است. بسیاری از سرویس‌های آنلاین نیازمند ثبت‌نام و دریافت کلید API هستند. برای مثال، برای استفاده از سرویس‌های پیشرفته می‌توانید در پلتفرم p.api.ir ثبت‌نام کنید. مراحل ثبت‌نام معمولاً بسیار ساده است. شما اطلاعات اولیه را وارد کرده و به پنل کاربری خود دسترسی پیدا می‌کنید. سپس می‌توانید از APIهای متنوعی استفاده نمایید.

نتیجه‌گیری 📝

در این مقاله، ما با موفقیت یک سرویس ساده با استفاده از ServiceStack ساختیم. شما با مفاهیم اصلی این فریمورک قدرتمند آشنا شدید. دیدید که چگونه با تمرکز بر DTOها می‌توان کدی تمیز و کارآمد نوشت. ServiceStack به دلیل سرعت بالا و سادگی، یک انتخاب هوشمندانه برای پروژه‌های مدرن دات نت است. امیدواریم این راهنما شروعی عالی برای کار شما با این تکنولوژی باشد.

آیا تجربه کار با ServiceStack را دارید؟ نظرات و سوالات خود را در بخش کامنت‌ها با ما در میان بگذارید!

برچسب ها:
ASP.NET MVC
ServiceStack
WCF
Web API