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

2023-12-17 13:20

本文主要是介绍【微软技术栈】.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 开发中六边形体系结构的高级概述和实际示例。请记住,这仅仅是个开始,您可以通过添加更多用例、适配器和功能来进一步扩展您的项目,以满足您的应用程序的要求,同时保持干净有序的代码库。

这篇关于【微软技术栈】.NET(C#)API 开发中的六边形体系结构的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/504519

相关文章

这15个Vue指令,让你的项目开发爽到爆

1. V-Hotkey 仓库地址: github.com/Dafrok/v-ho… Demo: 戳这里 https://dafrok.github.io/v-hotkey 安装: npm install --save v-hotkey 这个指令可以给组件绑定一个或多个快捷键。你想要通过按下 Escape 键后隐藏某个组件,按住 Control 和回车键再显示它吗?小菜一碟: <template

Hadoop企业开发案例调优场景

需求 (1)需求:从1G数据中,统计每个单词出现次数。服务器3台,每台配置4G内存,4核CPU,4线程。 (2)需求分析: 1G / 128m = 8个MapTask;1个ReduceTask;1个mrAppMaster 平均每个节点运行10个 / 3台 ≈ 3个任务(4    3    3) HDFS参数调优 (1)修改:hadoop-env.sh export HDFS_NAMENOD

2. c#从不同cs的文件调用函数

1.文件目录如下: 2. Program.cs文件的主函数如下 using System;using System.Collections.Generic;using System.Linq;using System.Threading.Tasks;using System.Windows.Forms;namespace datasAnalysis{internal static

嵌入式QT开发:构建高效智能的嵌入式系统

摘要: 本文深入探讨了嵌入式 QT 相关的各个方面。从 QT 框架的基础架构和核心概念出发,详细阐述了其在嵌入式环境中的优势与特点。文中分析了嵌入式 QT 的开发环境搭建过程,包括交叉编译工具链的配置等关键步骤。进一步探讨了嵌入式 QT 的界面设计与开发,涵盖了从基本控件的使用到复杂界面布局的构建。同时也深入研究了信号与槽机制在嵌入式系统中的应用,以及嵌入式 QT 与硬件设备的交互,包括输入输出设

OpenHarmony鸿蒙开发( Beta5.0)无感配网详解

1、简介 无感配网是指在设备联网过程中无需输入热点相关账号信息,即可快速实现设备配网,是一种兼顾高效性、可靠性和安全性的配网方式。 2、配网原理 2.1 通信原理 手机和智能设备之间的信息传递,利用特有的NAN协议实现。利用手机和智能设备之间的WiFi 感知订阅、发布能力,实现了数字管家应用和设备之间的发现。在完成设备间的认证和响应后,即可发送相关配网数据。同时还支持与常规Sof

【专题】2024飞行汽车技术全景报告合集PDF分享(附原数据表)

原文链接: https://tecdat.cn/?p=37628 6月16日,小鹏汇天旅航者X2在北京大兴国际机场临空经济区完成首飞,这也是小鹏汇天的产品在京津冀地区进行的首次飞行。小鹏汇天方面还表示,公司准备量产,并计划今年四季度开启预售小鹏汇天分体式飞行汽车,探索分体式飞行汽车城际通勤。阅读原文,获取专题报告合集全文,解锁文末271份飞行汽车相关行业研究报告。 据悉,业内人士对飞行汽车行业

活用c4d官方开发文档查询代码

当你问AI助手比如豆包,如何用python禁止掉xpresso标签时候,它会提示到 这时候要用到两个东西。https://developers.maxon.net/论坛搜索和开发文档 比如这里我就在官方找到正确的id描述 然后我就把参数标签换过来

C#实战|大乐透选号器[6]:实现实时显示已选择的红蓝球数量

哈喽,你好啊,我是雷工。 关于大乐透选号器在前面已经记录了5篇笔记,这是第6篇; 接下来实现实时显示当前选中红球数量,蓝球数量; 以下为练习笔记。 01 效果演示 当选择和取消选择红球或蓝球时,在对应的位置显示实时已选择的红球、蓝球的数量; 02 标签名称 分别设置Label标签名称为:lblRedCount、lblBlueCount

poj 1258 Agri-Net(最小生成树模板代码)

感觉用这题来当模板更适合。 题意就是给你邻接矩阵求最小生成树啦。~ prim代码:效率很高。172k...0ms。 #include<stdio.h>#include<algorithm>using namespace std;const int MaxN = 101;const int INF = 0x3f3f3f3f;int g[MaxN][MaxN];int n

金融业开源技术 术语

金融业开源技术  术语 1  范围 本文件界定了金融业开源技术的常用术语。 本文件适用于金融业中涉及开源技术的相关标准及规范性文件制定和信息沟通等活动。