الگوی معماری شش ضلعی در سی شارپ – راهنمای کامل 2024 👨🏻‍💻

مقدمه ای بر معماری شش ضلعی

در این راهنمای جامع، همه چیزهایی را که باید در مورد این الگوی معماری قدرتمند بدانید، با شما آشنا خواهیم کرد. ما مفاهیم اساسی و اصلی، مزایای استفاده از معماری شش ضلعی، مثال‌های عملی، آزمایش و بخش پرسش‌های متداول نهایی را در صورت داشتن هر گونه شک و تردید بیشتر پوشش خواهیم داد!

در پایان، نه تنها معماری شش ضلعی را درک خواهید کرد، بلکه آماده اجرای آن در پروژه های C# خود نیز خواهید بود. بیایید شیرجه بزنیم!

معماری شش ضلعی چیست؟

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

مزایای استفاده از معماری شش ضلعی

چرا باید به معماری شش ضلعی اهمیت دهید؟ در اینجا چند دلیل قانع کننده وجود دارد:

• قابلیت نگهداری بهبود یافته: با جدایی واضح بین منطق اصلی و سیستم های خارجی، مدیریت کد شما آسان تر می شود.
• افزایش تست پذیری: اجزای جدا شده نوشتن تست های واحد را آسان تر می کند.
• افزایش انعطاف پذیری: خاموش کردن سیستم های خارجی (به عنوان مثال، پایگاه های داده) یک نسیم می شود.

مفاهیم اصلی معماری شش ضلعی

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

پورت ها و آداپتورها کاوش شدند

در قلب معماری شش ضلعی پورت ها و آداپتورها قرار دارند. اما آنها دقیقا چه هستند؟ بیایید آن را تجزیه کنیم.

پورت ها اینترفیس هایی هستند که عملیاتی را که برنامه شما می تواند انجام دهد را تعریف می کند. آنها را به عنوان “چی” برنامه خود در نظر بگیرید.

آداپتورها پیاده سازی این رابط ها هستند. آنها مسئول “چگونگی” هستند – نحوه انجام عملیات تعریف شده توسط پورت ها.

در اینجا یک مثال ساده در سی شارپ آورده شده است:

// Port: An interface defining a service
public interface IFileStorage
{
    void SaveFile(string fileName, byte[] data);
}

// Adapter: An implementation of the interface
public class LocalFileStorage : IFileStorage
{
    public void SaveFile(string fileName, byte[] data)
    {
        // Saving file locally
        System.IO.File.WriteAllBytes(fileName, data);
    }
}

در این مثال، IFileStorage بندر است و LocalFileStorage آداپتور است.

نقش تزریق وابستگی

تزریق وابستگی (DI) یک بازیکن کلیدی در معماری شش ضلعی است. این به ما اجازه می دهد تا به راحتی آداپتورها را بدون تغییر منطق اصلی تعویض کنیم. آن را به عنوان یک مکانیسم plug-and-play تصور کنید.

در اینجا نحوه تنظیم DI در یک پروژه C# آمده است:

// Configure Dependency Injection in Startup.cs
public void ConfigureServices(IServiceCollection services)
{
    // Register the IFileStorage interface with its implementation
    services.AddTransient<IFileStorage, LocalFileStorage>();
}

با DI، می توانید از آن جابجا شوید LocalFileStorage گفتن، AzureFileStorage.

services.AddTransient<IFileStorage, AzureFileStorage>();

تفکیک نگرانی ها

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

پیاده سازی معماری شش ضلعی در سی

در این بخش، ما به راه اندازی یک پروژه C# با استفاده از معماری شش ضلعی خواهیم پرداخت.

راه اندازی پروژه سی شارپ خود

بیایید با تنظیم ساختار پروژه سی شارپ خود شروع کنیم. شما به طور کلی سه لایه اصلی خواهید داشت:

• هسته: شامل منطق اصلی کسب و کار و پورت ها (رابط) است.
• زیر ساخت: آداپتورها (اجرای پورت ها) را در خود جای می دهد.
• UI: رابط کاربری را مدیریت می کند و از طریق پورت ها با هسته ارتباط برقرار می کند.

راه حل شما ممکن است به این صورت باشد:

/Solution
  /Core
    /Interfaces
  /Infrastructure
  /UI

تعریف رابط ها (پورت ها)

اجازه دهید چند رابط در لایه Core تعریف کنیم. اینها به عنوان بندر ما عمل خواهند کرد.

// IFileStorage.cs
public interface IFileStorage
{
    void SaveFile(string fileName, byte[] data);
}

// IUserRepository.cs
public interface IUserRepository
{
    User GetUserById(int id);
    void SaveUser(User user);
}

پیاده سازی آداپتورها

در مرحله بعد، کلاس های آداپتور را در لایه Infrastructure ایجاد می کنیم.

// LocalFileStorage.cs
public class LocalFileStorage : IFileStorage
{
    public void SaveFile(string fileName, byte[] data)
    {
        System.IO.File.WriteAllBytes(fileName, data);
    }
}

// DatabaseUserRepository.cs
public class DatabaseUserRepository : IUserRepository
{
    private readonly List<User> _users = new List<User>();

    public User GetUserById(int id)
    {
        return _users.FirstOrDefault(u => u.Id == id);
    }

    public void SaveUser(User user)
    {
        _users.Add(user);
    }
}

ساختار پروژه سی شارپ خود را برای معماری شش ضلعی

در حال حاضر، شما باید یک ساختار واضح در محل داشته باشید. راه حل شما باید به این صورت باشد:

/Solution
  /Core
    /Interfaces
      IFileStorage.cs
      IUserRepository.cs
  /Infrastructure
    LocalFileStorage.cs
    DatabaseUserRepository.cs
  /UI
    // Your application logic and UI

این ساختار همه چیز را مرتب و منظم نگه می‌دارد و هدایت و نگهداری آن را آسان می‌کند.

مثال های عملی

ساخت یک برنامه کاربردی ساده با استفاده از معماری شش ضلعی در C

بیایید یک برنامه اساسی بسازیم که داده های کاربر را با استفاده از معماری شش ضلعی ذخیره می کند.

مرحله 1: منطق اصلی را تعریف کنید

// User.cs in Core layer
public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
}

مرحله 2: پیاده سازی مخازن در زیرساخت

// DatabaseUserRepository.cs
public class DatabaseUserRepository : IUserRepository
{
    private readonly List<User> _users = new List<User>();

    public User GetUserById(int id)
    {
        return _users.FirstOrDefault(u => u.Id == id);
    }

    public void SaveUser(User user)
    {
        _users.Add(user);
    }
}

مرحله 3: ایجاد خدمات در Core

// UserService.cs
public class UserService
{
    private readonly IUserRepository _userRepository;

    public UserService(IUserRepository userRepository)
    {
        _userRepository = userRepository;
    }

    public void AddUser(User user)
    {
        _userRepository.SaveUser(user);
    }

    public User GetUser(int id)
    {
        return _userRepository.GetUserById(id);
    }
}

مرحله 4: ادغام با UI

در نهایت، سرویس را با یک رابط کاربری ساده ادغام کنید.

// Program.cs in UI
class Program
{
    static void Main(string[] args)
    {
        // Setup Dependency Injection
        var services = new ServiceCollection();
        services.AddTransient<IUserRepository, DatabaseUserRepository>();
        services.AddTransient<UserService>();
        var serviceProvider = services.BuildServiceProvider();

        // Get UserService
        var userService = serviceProvider.GetService<UserService>();

        // Add a user
        var user = new User { Id = 1, Name = "John Doe" };
        userService.AddUser(user);

        // Retrieve the user
        var retrievedUser = userService.GetUser(1);
        Console.WriteLine($"User retrieved: {retrievedUser.Name}");
    }
}

در مثال بالا، Program کلاس در لایه UI ما با آن تعامل دارد UserService از لایه Core، که به نوبه خود استفاده می کند IUserRepository از لایه زیرساخت

موارد استفاده در دنیای واقعی

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

استراتژی های مهاجرت از معماری سنتی

اگر با یک سیستم قدیمی کار می کنید، مهاجرت به معماری شش ضلعی می تواند دشوار به نظر برسد. اما نگران نباشید، در اینجا یک استراتژی ساده وجود دارد:

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

این رویکرد افزایشی به شما کمک می کند تا معماری شش ضلعی را بدون ایجاد اختلالات قابل توجه اتخاذ کنید.

تست در معماری شش ضلعی

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

تست واحد

تست واحد بر اجزای منفرد متمرکز است. در اینجا یک تست برای UserService:

// UserServiceTests.cs
using Moq;

public class UserServiceTests
{
    [Fact]
    public void AddUser_ShouldSaveUser()
    {
        // Arrange
        var userRepositoryMock = new Mock<IUserRepository>();
        var userService = new UserService(userRepositoryMock.Object);
        var user = new User { Id = 1, Name = "Jane Doe" };

        // Act
        userService.AddUser(user);

        // Assert
        userRepositoryMock.Verify(r => r.SaveUser(user), Times.Once);
    }
}

تست یکپارچه سازی

تست های یکپارچه سازی تعامل بین اجزای مختلف را تایید می کنند. در اینجا یک مثال است:

// UserIntegrationTests.cs
public class UserIntegrationTests
{
    private ServiceProvider serviceProvider;

    public UserIntegrationTests()
    {
        // Setup Dependency Injection
        var services = new ServiceCollection();
        services.AddTransient<IUserRepository, DatabaseUserRepository>();
        services.AddTransient<UserService>();
        serviceProvider = services.BuildServiceProvider();
    }

    [Fact]
    public void UserService_ShouldRetrieveSavedUser()
    {
        // Arrange
        var userService = serviceProvider.GetService<UserService>();
        var user = new User { Id = 1, Name = "John Doe" };
        userService.AddUser(user);

        // Act
        var retrievedUser = userService.GetUser(1);

        // Assert
        Assert.Equal("John Doe", retrievedUser.Name);
    }
}

تست پایان به انتها

تست های End-to-End (E2E) سیستم را به عنوان یک کل ارزیابی می کنند. آنها تعاملات واقعی کاربر را تقلید می کنند و اطمینان می دهند که کل برنامه همانطور که انتظار می رود کار می کند.

بهترین شیوه ها و دام های رایج

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

بهترین روش ها برای معماری شش ضلعی C#

• آن را ساده نگه دارید: بیش از حد مهندسی نکنید. با یک ساختار ساده شروع کنید و در صورت نیاز اصلاح کنید.
• از تزریق وابستگی استفاده کنید: از DI برای مدیریت وابستگی ها به خوبی استفاده کنید.
• تست ها را بنویسید: منطق اصلی و آداپتورهای خود را به طور کامل آزمایش کنید.

تله‌های رایج و نحوه اجتناب از آنها

• پیچیدگی بیش از حد طراحی: از ایجاد لایه ها و انتزاع های زیاد خودداری کنید. آن را صاف نگه دارید.
• بی توجهی به تست ها: رد شدن از تست ها می تواند منجر به اشکالات و نگهداری کد شود. به طور منظم تست بنویسید.
• نادیده گرفتن عملکرد: مطمئن شوید که طراحی شما گلوگاه های عملکردی ایجاد نمی کند.

ملاحظات عملکرد

برای اینکه برنامه کاربردی خود را کارآمد نگه دارید:

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

موضوعات پیشرفته

بیایید با موضوعات پیشرفته ای مانند میکروسرویس ها، طراحی رویداد محور، و مدیریت تراکنش، آن را ارتقا دهیم.

استفاده از معماری شش ضلعی با میکروسرویس ها

معماری شش ضلعی و میکروسرویس ها همسان ساخته شده در بهشت ​​هستند. هر میکروسرویس را می توان با استفاده از معماری شش ضلعی طراحی کرد و آنها را مستقل و به راحتی قابل تعویض ساخت.

طراحی رویداد محور با معماری شش ضلعی

یک طراحی رویداد محور می تواند انعطاف پذیری سیستم شما را افزایش دهد. برای مثال، می‌توانید از یک گذرگاه رویداد برای جدا کردن بیشتر اجزا استفاده کنید.

// EventBus.cs
public class EventBus
{
    private readonly List<IEventListener> listeners = new List<IEventListener>();

    public void Subscribe(IEventListener listener)
    {
        listeners.Add(listener);
    }

    public void Publish(Event e)
    {
        foreach(var listener in listeners)
        {
            listener.Handle(e);
        }
    }
}

مدیریت معاملات در معماری شش ضلعی

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

// UnitOfWork.cs
public interface IUnitOfWork
{
    void Commit();
    void Rollback();
}

public class EFUnitOfWork : IUnitOfWork
{
    private readonly DbContext context;

    public EFUnitOfWork(DbContext context)
    {
        this.context = context;
    }

    public void Commit()
    {
        context.SaveChanges();
    }

    public void Rollback()
    {
        // Implementation to rollback transaction
    }
}

ابزارها و کتابخانه ها

در اینجا چند ابزار و کتابخانه وجود دارد که می تواند زندگی شما را هنگام کار با معماری شش ضلعی در سی شارپ آسان تر کند.

کتابخانه های محبوب برای معماری شش ضلعی C#

• AutoMapper: برای نگاشت شی به شی.
• Moq: برای تمسخر در آزمون های واحد.
• MediatR: برای اجرای الگوی واسطه.

توصیه های IDE و پلاگین

• ویژوال استودیو: IDE نیروگاه برای توسعه C#.
• ReSharper: با این افزونه شگفت انگیز بهره وری خود را افزایش دهید.
• NCrunch: تست مداوم و خودکار در ویژوال استودیو.

نتیجه

در حال حاضر، شما باید درک کاملی از معماری شش ضلعی، مزایای آن و نحوه پیاده سازی آن در سی شارپ داشته باشید. آماده اید انقلابی در برنامه نویسی خود ایجاد کنید؟

خلاصه مطالب کلیدی

• معماری شش ضلعی منطق اصلی را از سیستم های خارجی جدا می کند.
• پورت ها (رابط ها) و آداپتورها (پیاده سازی ها) اجزای کلیدی هستند.
• تزریق وابستگی برای انعطاف پذیری بسیار مهم است.
• آزمایش با معماری شش ضلعی تبدیل به یک نسیم می شود.

سوالات متداول درباره معماری شش ضلعی C#

اصول اصلی معماری شش ضلعی چیست؟

• تفکیک نگرانی ها
• تزریق وابستگی
• الگوی پورت ها و آداپتورها

معماری شش ضلعی چه تفاوتی با سایر الگوها دارد؟

معماری شش ضلعی بر جداسازی منطق هسته از سیستم‌های خارجی تمرکز دارد، برخلاف معماری‌های لایه‌ای که ممکن است مؤلفه‌ها را محکم جفت کنند.

آیا معماری شش ضلعی برای انواع پروژه ها مناسب است؟

در حالی که بسیار همه کاره است، پروژه های کوچک ممکن است آن را بیش از حد بدانند. برای کاربردهای متوسط ​​تا بزرگ که قابلیت نگهداری و آزمایش پذیری بسیار مهم هستند، بهترین است.