ASP.NET Core 服务员工具项目启动和配置教程

1. 项目目录结构及介绍

在展开开源项目 WebEssentials.AspNetCore.ServiceWorker 后，你将看到以下目录结构：

WebEssentials.AspNetCore.ServiceWorker/
│
├── .gitattributes
├── .gitignore
├── .editorconfig
├── appveyor.yml
├── LICENSE
├── README.md
│
├── src/
│   ├── WebEssentials.AspNetCore.Pwa.sln
│   ├── Properties/
│   │   └── LaunchSettings.json
│   ├── Controllers/
│   │   └── ...
│   ├── Models/
│   │   └── ...
│   ├── Views/
│   │   ├── Home/
│   │   │   └── ...
│   │   └── Shared/
│   │       └── ...
│   ├── wwwroot/
│   │   ├── css/
│   │   ├── img/
│   │   ├── js/
│   │   └── manifest.webmanifest
│   └── ...
│
└── test/
    └── ...

以下是目录及文件的简要说明：

• .gitattributes：定义如何处理不同文件类型的 Git 属性。
• .gitignore：指定 Git 忽略跟踪的文件和目录。
• .editorconfig：定义代码编辑器的配置，例如缩进和换行符。
• appveyor.yml：用于配置持续集成服务 AppVeyor 的配置文件。
• LICENSE：项目的许可证文件。
• README.md：项目的自述文件，包含项目描述和使用说明。
• src/：源代码目录。
  • WebEssentials.AspNetCore.Pwa.sln：Visual Studio 解决方案文件。
  • Properties/：包含项目属性，如启动设置。
  • Controllers/：MVC 控制器。
  • Models/：数据模型。
  • Views/：视图文件。
  • wwwroot/：静态文件目录，如 CSS、JS、图片和网站应用清单文件。
• test/：测试目录。

2. 项目的启动文件介绍

项目的启动主要通过 Startup.cs 文件来配置。以下是 Startup.cs 文件的基本结构和说明：

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        // 添加 MVC 服务
        services.AddMvc();

        // 添加 PWA 服务
        services.AddProgressiveWebApp();
    }

    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
        // 如果环境是开发，使用开发者异常页面
        if (env.IsDevelopment())
        {
            app.UseDeveloperExceptionPage();
        }
        else
        {
            // 其他环境下的错误处理
            app.UseExceptionHandler("/Home/Error");
            // HTTPS 红利
            app.UseHsts();
        }

        // 使用静态文件
        app.UseStaticFiles();

        // 使用 MVC 路由
        app.UseRouting();

        app.UseAuthorization();

        app.UseEndpoints(endpoints =>
        {
            endpoints.MapControllerRoute(
                name: "default",
                pattern: "{controller=Home}/{action=Index}/{id?}");
        });
    }
}

在 Startup.cs 文件中，ConfigureServices 方法用于注册项目所需的服务，包括 MVC 服务和 PWA 服务。Configure 方法用于配置 HTTP 请求的处理管道。

3. 项目的配置文件介绍

项目的主要配置文件是 appsettings.json，它包含了应用程序的配置信息。以下是一个 appsettings.json 文件的示例：

{
  "pwa": {
    "registerWebmanifest": true,
    "routesToPreCache": "/, /contact.html, /data.json",
    "strategy": "cacheFirst"
  }
}

在这个配置文件中，你可以定义 PWA 的相关配置，如是否注册网站应用清单、需要预缓存的路线以及服务工人的缓存策略。此外，还可以根据不同的环境设置不同的配置文件，例如 appsettings.Development.json、appsettings.Staging.json 和 appsettings.Production.json。