CleanArchitecture 项目使用教程

CleanArchitecture 项目使用教程

CleanArchitectureKotlin backend based on the Clean Architecture principles. Ktor, JWT, Exposed, Flyway, OpenAPI/REST & KGraphQL/GraphQL generated endpoints, Gradle.项目地址:https://gitcode.com/gh_mirrors/cleana/CleanArchitecture

1. 项目的目录结构及介绍

CleanArchitecture 项目的目录结构如下：

CleanArchitecture/
├── src/
│   ├── Application/
│   ├── Infrastructure/
│   ├── WebApi/
│   └── ...
├── tests/
│   ├── Application.IntegrationTests/
│   ├── Application.UnitTests/
│   └── ...
├── .gitignore
├── README.md
└── ...

目录介绍

• src/: 包含项目的源代码。
  • Application/: 包含应用程序的核心逻辑。
  • Infrastructure/: 包含与外部系统交互的代码，如数据库访问、外部 API 调用等。
  • WebApi/: 包含 Web API 的实现。
• tests/: 包含项目的测试代码。
  • Application.IntegrationTests/: 包含集成测试。
  • Application.UnitTests/: 包含单元测试。
• .gitignore: Git 忽略文件配置。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 src/WebApi/ 目录下，主要文件包括：

• Program.cs: 应用程序的入口点，负责配置和启动 Web API。
• Startup.cs: 配置应用程序的服务和中间件。

Program.cs

public class Program
{
    public static void Main(string[] args)
    {
        CreateHostBuilder(args).Build().Run();
    }

    public static IHostBuilder CreateHostBuilder(string[] args) =>
        Host.CreateDefaultBuilder(args)
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
            });
}

Startup.cs

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // 配置服务
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        // 配置中间件
    }
}

3. 项目的配置文件介绍

项目的配置文件主要包括 appsettings.json 和 appsettings.Development.json。

appsettings.json

{
  "ConnectionStrings": {
    "DefaultConnection": "Server=localhost;Database=MyDatabase;User Id=sa;Password=MyPassword;"
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*"
}

appsettings.Development.json

{
  "Logging": {
    "LogLevel": {
      "Default": "Debug",
      "System": "Information",
      "Microsoft": "Information"
    }
  }
}

配置文件介绍

• ConnectionStrings: 数据库连接字符串配置。
• Logging: 日志级别配置。
• AllowedHosts: 允许访问的主机配置。

以上是 CleanArchitecture 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！

CleanArchitectureKotlin backend based on the Clean Architecture principles. Ktor, JWT, Exposed, Flyway, OpenAPI/REST & KGraphQL/GraphQL generated endpoints, Gradle.项目地址:https://gitcode.com/gh_mirrors/cleana/CleanArchitecture