WebEssentials.AspNetCore.ServiceWorker 开源项目教程

2025-05-21 13:53:17作者：侯霆垣

1. 项目介绍

WebEssentials.AspNetCore.ServiceWorker 是一个开源项目，旨在为 ASP.NET Core 应用程序提供对 Progressive Web Apps (PWA) 的支持。PWA 是一组可以应用于任何类型的网站和 Web 应用程序的技术，包括三个核心组件：通过 HTTPS 提供服务的网站、Web App Manifest (一个简单的 JSON 文件) 以及 Service Worker (一个 JavaScript 文件)。该项目通过预构建的服务工人，使得在 ASP.NET Core 应用程序中实现 PWA 变得更加简单。

2. 项目快速启动

步骤 1 - 添加项目依赖

首先，需要在 ASP.NET Core 2.0 应用程序中添加 NuGet 包 WebEssentials.AspNetCore.PWA。可以通过 Visual Studio 的 NuGet 包管理器进行添加，或使用以下命令行指令：

dotnet add package WebEssentials.AspNetCore.PWA

步骤 2 - 添加图标

在项目中添加两个图标文件（192x192 和 512x512 尺寸），并存放在 wwwroot 文件夹中。可以使用 PNG 或 JPEG 格式。

步骤 3 - 创建 manifest JSON 文件

在 wwwroot 文件夹中添加一个名为 manifest.json 的文件，并填写相关信息。以下是一个示例：

{
    "name": "Awesome Application",
    "short_name": "Awesome",
    "description": "The most awesome application in the world",
    "icons": [
        {
            "src": "/img/icon192x192.png",
            "sizes": "192x192"
        },
        {
            "src": "/img/icon512x512.png",
            "sizes": "512x512"
        }
    ],
    "display": "standalone",
    "start_url": "/"
}

步骤 4 - 注册服务

在 Startup.cs 文件中的 ConfigureServices 方法内，添加以下代码来注册 PWA 服务：

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc();
    services.AddProgressiveWebApp();
}

步骤 5 - 验证

在浏览器中运行应用程序，并检查是否已成功注册为 PWA。可以通过以下步骤验证：

确保在 Visual Studio 中关闭了 JavaScript 调试。
在 Chrome 浏览器中启动应用程序。
查看页面源代码，确保 <head> 部分包含 <link rel="manifest" href="/manifest.webmanifest" />。
打开 Chrome 开发者工具，转到 "Application" 选项卡，并选择 "Service Workers"。如果看到服务工人已列出，则表示注册成功。