开源项目 `clean-code-dotnet` 使用教程

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

clean-code-dotnet 项目的目录结构如下：

clean-code-dotnet/
├── .github/
│   └── workflows/
├── src/
│   ├── Clean.Architecture.Sample/
│   ├── Clean.Architecture.Tests/
│   └── ...
├── .gitignore
├── .editorconfig
├── README.md
└── ...

目录结构介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• src/: 包含项目的源代码，包括示例项目和测试项目。
  • Clean.Architecture.Sample/: 示例项目的源代码。
  • Clean.Architecture.Tests/: 测试项目的源代码。
• .gitignore: Git 忽略文件配置。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 src/Clean.Architecture.Sample/ 目录下，主要文件包括：

• Program.cs: 应用程序的入口点，包含 Main 方法。
• Startup.cs: 配置服务和应用程序的请求管道。

Program.cs

using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Hosting;

namespace Clean.Architecture.Sample
{
    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

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

namespace Clean.Architecture.Sample
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();
        }

        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.UseRouting();

            app.UseAuthorization();

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

3. 项目的配置文件介绍

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

appsettings.json

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*"
}

appsettings.Development.json

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

配置文件介绍

• Logging: 配置日志级别。
• AllowedHosts: 配置允许访问的主机。

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