【ASP.NET Core 基础知识】--项目结构

ASP.NET Core项目结构包括项目文件、wwwroot、Controllers、Models、Views等文件夹，以及配置文件appsettings.json。配置可以通过appsettings.json、环境变量、命令行参数和Secrets Manager等方式管理。

喵叔哟

1905人浏览 · 2024-01-09 00:57:29

喵叔哟 · 2024-01-09 00:57:29 发布

一、ASP.NET Core项目的基本结构

ASP.NET Core项目的基本结构通常遵循一种标准的组织方式，这有助于提高项目的可维护性和可扩展性。以下是一个典型的ASP.NET Core项目的基本结构：
在这里插入图片描述

项目文件 (.csproj): 项目的主要配置文件，定义了项目的依赖项、输出等信息。

<Project Sdk="Microsoft.NET.Sdk.Web">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp3.1</TargetFramework>
    <!-- 其他属性 -->
  </PropertyGroup>

  <!-- 依赖项 -->
  <ItemGroup>
    <PackageReference Include="Microsoft.AspNetCore.App" />
    <!-- 其他NuGet包 -->
  </ItemGroup>

</Project>

wwwroot 文件夹: 存放静态文件（如CSS、JavaScript、图像等），这些文件可以通过浏览器直接访问。
Controllers 文件夹（web api ）: 包含控制器类，控制器处理HTTP请求并负责返回相应的视图或数据。
Models 文件夹: 存放应用程序的数据模型，通常代表数据库表或其他业务实体。
Views 文件夹: 包含应用程序的视图文件，这些文件用于生成HTML响应，通常与控制器相对应。
Areas 文件夹 (可选): 如果你的项目使用了区域（Areas）的功能，这里会包含每个区域的文件夹结构，类似于主项目结构。
Startup.cs 文件: 包含应用程序的启动配置，包括中间件的配置、依赖注入的设置等。

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

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

appsettings.json 文件: 用于存储应用程序的配置信息，例如数据库连接字符串、API密钥等。

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*",
  // 其他配置项
}

Program.cs 文件: 包含应用程序的入口点，负责构建和配置 WebHost。

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>();
            });
}

这是一个简单的ASP.NET Core项目结构，实际项目可能根据需求有所变化。在这个基础上，你可以添加其他文件夹和组织方式，例如用于存放中间件、过滤器、扩展方法等的文件夹。

二、项目文件和文件夹的作用

在ASP.NET Core项目中，项目文件和文件夹的组织结构有助于提高代码的可读性、可维护性和可扩展性。以下是主要的文件和文件夹的作用：

项目文件 (.csproj):
- 作用： 项目文件是项目的主要配置文件，定义了项目的依赖项、输出等信息。它告诉编译器如何构建和组织项目。
- 配置内容： 包括项目的目标框架、引用的NuGet包、编译选项等。
wwwroot 文件夹:
- 作用： 存放静态文件，这些文件可以通过浏览器直接访问。通常包含CSS、JavaScript、图像等资源。
- 访问方式： 在浏览器中，这些文件可以通过相对于站点根目录的路径进行访问。
Controllers 文件夹:
- 作用： 包含控制器类，控制器处理HTTP请求并负责返回相应的视图或数据。
- 组织方式： 通常按功能或领域进行组织，例如将相关的控制器放在同一个文件夹下。
Models 文件夹:
- 作用： 存放应用程序的数据模型，通常代表数据库表或其他业务实体。
- 组织方式： 按照实体的关系或功能进行组织，有时也会将视图模型放在这里。
Views 文件夹:
- 作用： 包含应用程序的视图文件，用于生成HTML响应。Views与Controllers一一对应。
- 组织方式： 通常按照控制器的命名规则进行组织，例如 HomeController 的视图放在 Views/Home 文件夹下。
Areas 文件夹 (可选):
- 作用： 如果使用了区域（Areas）功能，这里会包含每个区域的文件夹结构，类似于主项目结构。
- 组织方式： 每个区域独立组织，有自己的 Controllers、Models、Views 等文件夹。
Startup.cs 文件:
- 作用： 包含应用程序的启动配置，包括中间件的配置、依赖注入的设置等。
- 配置内容： 配置服务和中间件，以及应用程序启动时的初始化操作。
appsettings.json 文件:
- 作用： 用于存储应用程序的配置信息，例如数据库连接字符串、API密钥等。
- 配置内容： 应用程序的各种配置选项，可以通过 Configuration 对象在代码中访问。
Program.cs 文件:
- 作用： 包含应用程序的入口点，负责构建和配置 WebHost。
- 配置内容： 创建 WebHost 对象，并指定 Startup 类用于配置应用程序。

通过这种组织结构，可以清晰地分离不同部分的代码，使项目更易于维护和扩展。此外，ASP.NET Core项目结构的灵活性也允许根据具体需求进行调整和扩展。

四、配置文件

在ASP.NET Core中，配置文件是一种存储应用程序配置信息的方式，允许将应用程序配置从代码中分离出来，以便于修改和管理。主要的配置文件是 appsettings.json，但还可以使用其他配置源，如环境变量、命令行参数等。以下是一些常见的ASP.NET Core配置文件和相关概念：

appsettings.json:

作用： 存储应用程序的配置信息，如数据库连接字符串、日志级别、API密钥等。
位置： 通常位于项目的根目录下。

示例：

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
    "DefaultConnection": "Data Source=sample.db"
  },
  // 其他配置项
}

appsettings.Development.json, appsettings.Production.json 等:
- 作用： 针对不同环境提供特定的配置。例如，appsettings.Development.json 用于开发环境，appsettings.Production.json 用于生产环境。
- 配置方式： 这些文件会覆盖主 appsettings.json 中的相应配置项。
- 示例：
```
// appsettings.Development.json
{
  "Logging": {
    "LogLevel": {
      "Default": "Debug",
      "Microsoft": "Information"
    }
  },
  // 开发环境的其他配置项
}
```
环境变量:
- 作用： 允许在不同环境中设置配置项，覆盖 appsettings.json 中的值。
- 配置方式： 通过系统环境变量或者 .env 文件设置。
- 示例：
```
// appsettings.json
{
  "MyServiceApiKey": "defaultValue"
}
```
  设置环境变量：
```
export MyServiceApiKey="actualValue"
```
命令行参数:
- 作用： 允许通过命令行参数设置配置项，覆盖其他配置源中的值。
- 配置方式： 通过命令行参数传递。
- 示例：
```
dotnet run --MyServiceApiKey=actualValue
```
Secrets Manager:
- 作用： 用于存储敏感信息，如密码、证书等。
- 配置方式： 使用 dotnet user-secrets 命令行工具或其他密钥管理工具。
- 示例：
```
dotnet user-secrets set "MyServiceApiKey" "actualValue"
```