【微软技术栈】.NET（C#）API 开发中的六边形体系结构

1、介绍

在软件开发领域，架构师和工程师不断努力创建不仅高效，而且可维护和适应性强的系统。近年来，为实现这些目标而流行的一种架构模式是六边形架构，也称为端口和适配器。在本文中，我们将探讨六边形架构的原则，并通过实际示例演示如何将其应用于 .NET （C#） API 开发。

2、了解六边形架构

由 Alistair Cockburn 引入的六边形架构是一种架构模式，它促进了软件系统内关注点的分离。它通过将代码组织成层或六边形来帮助创建高度模块化和可测试的应用程序，每个层或六边形都有不同的职责。主要思想是通过定义良好的接口或端口将核心业务逻辑（内部）与外部依赖项（外部）隔离开来。

以下是六边形架构的关键组件。

1. 核心：?这是最内层，包含应用程序的业务逻辑、域实体和用例。它应该不受任何外部依赖和框架的影响。
2. 港口：?端口是在核心层中定义的接口或协定，用于指定应用程序所需的交互。这些可以被视为数据和功能的入口和出口点。
3. 适配器：?适配器是端口的实现。它们弥合了核心和外部系统（如数据库、Web 服务或用户界面）之间的差距。适配器负责将外部请求转换为核心可以理解的操作，反之亦然。

3、设置 .NET API 项目

让我们通过使用六边形体系结构原则创建 .NET API 项目来深入了解实际实现。

第1步、创建新解决方案

打开 Visual Studio 或首选 IDE，然后为项目创建新的解决方案。在此示例中，我们将它命名为“HexagonalApiDemo”。

第2步、定义核心

在解决方案中，为核心层创建一个新项目。此项目应包含您的业务逻辑、域实体和用例。例如，让我们创建一个具有“Product”实体和“ProductService”类的简单电子商务应用程序。

// Core/Entities/Product.cs
public class Product
{
    public int Id { get; set; }
    public string Name { get; set; }
    public decimal Price { get; set; }
}

// Core/UseCases/ProductService.cs
public class ProductService
{
    public IEnumerable<Product> GetProducts()
    {
        // Logic to fetch products from the database or any other source
        // Return a list of products
    }
}

第 3 步、定义端口

在 Core 项目中，定义表示应用程序所需交互的接口或端口。这些可以包括存储库、服务或任何外部依赖项。

// Core/Ports/IProductRepository.cs
public interface IProductRepository
{
    IEnumerable<Product> GetAll();
}

// Core/Ports/IEmailService.cs
public interface IEmailService
{
    void SendOrderConfirmationEmail(Order order);
}

第 4 步、实现适配器

现在，为 Adapters 图层创建单独的项目。在这些项目中，您将实现 Core 中定义的接口。您可以为各种外部系统使用不同的适配器，例如数据库适配器、Web API 适配器等。

// Adapters/Database/ProductRepository.cs
public class ProductRepository : IProductRepository
{
    public IEnumerable<Product> GetAll()
    {
        // Implement database retrieval logic
    }
}

// Adapters/Email/EmailService.cs
public class EmailService : IEmailService
{
    public void SendOrderConfirmationEmail(Order order)
    {
        // Implement email sending logic
    }
}

第 5 步、将其连接在一起

最后，在您的 API 项目中，将所有内容连接在一起。创建使用核心用例的控制器或入口点，并注入适当的适配器。

// API/Controllers/ProductController.cs
[ApiController]
[Route("api/products")]
public class ProductController : ControllerBase
{
    private readonly ProductService _productService;

    public ProductController(ProductService productService)
    {
        _productService = productService;
    }

    [HttpGet]
    public ActionResult<IEnumerable<Product>> GetProducts()
    {
        var products = _productService.GetProducts();
        return Ok(products);
    }
}

确保您的 API 项目同时引用了 Core 和 Adapters 项目。

结论

六边形体系结构提供了一种可靠的方法来构建 .NET API 项目，使其更易于维护、可测试和适应更改。通过使用端口和适配器将核心与外部依赖项分离，您可以实现一个干净灵活的架构，以支持未来的增长和演进。

在本文中，我们提供了 .NET （C#） API 开发中六边形体系结构的高级概述和实际示例。请记住，这仅仅是个开始，您可以通过添加更多用例、适配器和功能来进一步扩展您的项目，以满足您的应用程序的要求，同时保持干净有序的代码库。