Clean Architecture DotNet 项目教程

2024-09-19 08:07:00作者：卓艾滢Kingsley

clean-architecture-dotnet

🕸 Yet Another .NET Clean Architecture, but for Microservices project. It uses Minimal Clean Architecture with DDD-lite, CQRS-lite, and just enough Cloud-native patterns apply on the simple eCommerce sample and run on Tye with Dapr extension 🍻

1. 项目目录结构及介绍

clean-architecture-dotnet/
├── src/
│   ├── Application/
│   ├── Domain/
│   ├── Infrastructure/
│   ├── Presentation/
│   └── WebApi/
├── tests/
│   ├── Application.Tests/
│   ├── Domain.Tests/
│   ├── Infrastructure.Tests/
│   └── Presentation.Tests/
├── .gitignore
├── README.md
├── docker-compose.yml
├── global.json
├── nuget.config
└── CleanArchitecture.sln

目录结构介绍

src/: 项目的源代码目录。
- Application/: 包含应用程序的业务逻辑和用例。
- Domain/: 包含核心业务实体和规则。
- Infrastructure/: 包含数据访问、外部服务和其他基础设施代码。
- Presentation/: 包含用户界面相关的代码，如Web API控制器。
- WebApi/: 包含Web API的启动文件和配置。
tests/: 项目的测试代码目录。
- Application.Tests/: 应用程序层的单元测试。
- Domain.Tests/: 领域层的单元测试。
- Infrastructure.Tests/: 基础设施层的单元测试。
- Presentation.Tests/: 表示层的单元测试。
.gitignore: Git忽略文件配置。
README.md: 项目说明文档。
docker-compose.yml: Docker容器编排文件。
global.json: 项目全局配置文件。
nuget.config: NuGet包管理配置文件。
CleanArchitecture.sln: 项目解决方案文件。

2. 项目的启动文件介绍

WebApi/Program.cs

using CleanArchitecture.Infrastructure;
using CleanArchitecture.Presentation;

var builder = WebApplication.CreateBuilder(args);

// 添加服务到容器
builder.Services.AddInfrastructure(builder.Configuration);
builder.Services.AddPresentation();

var app = builder.Build();

// 配置HTTP请求管道
if (app.Environment.IsDevelopment())
{
    app.UseDeveloperExceptionPage();
}

app.UseHttpsRedirection();
app.UseRouting();
app.UseAuthorization();
app.UseEndpoints(endpoints =>
{
    endpoints.MapControllers();
});

app.Run();

启动文件介绍

Program.cs: 这是Web API项目的启动文件。它负责配置和启动Web应用程序。
- AddInfrastructure: 注册基础设施服务。
- AddPresentation: 注册表示层服务。
- UseDeveloperExceptionPage: 在开发环境中启用异常页面。
- UseHttpsRedirection: 启用HTTPS重定向。
- UseRouting: 启用路由。
- UseAuthorization: 启用授权。
- UseEndpoints: 配置端点路由。

3. 项目的配置文件介绍

appsettings.json

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
    "DefaultConnection": "Server=localhost;Database=CleanArchitecture;User Id=sa;Password=yourStrong(!)Password;"
  },
  "JwtSettings": {
    "Secret": "your-secret-key",
    "Issuer": "your-issuer",
    "Audience": "your-audience",
    "ExpiryMinutes": 60
  }
}

配置文件介绍

Logging: 配置日志记录级别。
- LogLevel: 定义不同日志源的日志级别。
AllowedHosts: 配置允许访问的主机。
ConnectionStrings: 数据库连接字符串配置。
- DefaultConnection: 默认数据库连接字符串。
JwtSettings: JWT认证配置。
- Secret: JWT密钥。
- Issuer: JWT发行者。
- Audience: JWT受众。
- ExpiryMinutes: JWT过期时间（分钟）。