项目介绍
CleanArchitecture 项目是一个面向使用 ASP.NET Core 的开发者的起点,旨在推广一种被称为 “清洁架构”的设计理念。这种架构模式以松耦合和依赖反转为核心思想,类似于六边形架构、端口和适配器架构以及洋葱架构。
清洁架构简介
清洁架构是一种新的软件架构设计理念,目的是在复杂的软件开发过程中保持各个模块间的低耦合和高内聚关系。这种架构鼓励以核心业务逻辑为中心,取消对外部工具框架的直接依赖,从而增强应用程序的灵活性、可维护性和可测试性。
开始使用
对于希望快速上手该架构的开发人员,可以通过多种方式使用这个项目模板:
- 使用命令行工具
dotnet new
安装模板 - 下载 GitHub 仓库并根据项目需要进行修改
使用 dotnet CLI 模板
安装模板的命令:
dotnet new install Ardalis.CleanArchitecture.Template
安装成功后,可使用以下命令创建项目结构:
dotnet new clean-arch -o Your.ProjectName
该命令会在指定目录下创建一个名为 Your.ProjectName
的子文件夹,并在其中构建项目解决方案。
添加控制器和 Razor 页面
虽然默认模板只支持 API 端点,但开发者可以通过修改项目配置文件轻松添加控制器和 Razor 页面。
架构设计决策
CleanArchitecture 模板的目标是提供一个基础的解决方案结构,适合构建基于领域驱动设计(DDD)的项目或其他遵循 SOLID 原则的良好项目。模板中的各种项目和文件夹都有特定的角色和用途:
- 核心项目:包含领域模型、实体、聚合根、值对象、领域事件及其处理程序等。
- 用例项目:按照命令-查询责任分离(CQRS)模式组织。
- 基础设施项目:实现对外部资源的访问,如数据库或者第三方服务。
- Web 项目:ASP.NET Core 的启动项目,定义项目的入口。
项目目标
CleanArchitecture 旨在为开发者提供一套基础的、可直接用于构建企业级应用程序的架构模板。其设计无意提供一个完整的示例应用程序,而是期望开发者能够以此为原型,创建出适合自己需求的应用程序。
模式使用
在 CleanArchitecture 项目中,使用了一些常见的设计模式,如:
- 领域事件:用于在实体之间解耦触发操作和具体实现。
- API 端点:使用 FastEndpoints 库来简化 API 端点的开发。
版本信息
项目的主分支当前使用 .NET 9,对应的 NuGet 包版本为 10.x。同时也保持若干早期版本的可用性,以方便兼容性需求。
总之,CleanArchitecture 项目为开发者提供了一个结构清晰、可扩展的项目模板,帮助开发者实现高质量的现代化 .NET 应用程序。通过灵活的架构设计和实践经验的集合,该项目致力于成为开发人员在构建复杂软件系统时的可靠工具。