ngsw

ngsw

关注
发信
关注(28)粉丝(399)

angular - 通过Angular 6 Service Worker中的新鲜度缓存 Assets

我正在尝试将Angular Service Worker集成到现有项目中。如果我正确理解的话，有两种情况下如何在Angular SW中缓存数据。可以预取或延迟更新资产数据，并缓存特定的API调用和其他XHR请求。

我要实现的目标是首先通过网络加载特定资产，如果请求超时或无法访问，则将通过缓存对其进行处理。就像freshness策略在缓存API调用时一样。
但是似乎没有办法为Angular项目中作为资产加载的JS文件配置这种新鲜度加载机制。
我已经设置了一个示例项目进行测试：https://github.com/philipp-schaerer-lambdait/angular-service-worker-test

以下示例是标准的Angular App，不包含我正在使用的实际项目，但显示了我要缓存的元素，其结构如下所示：

\_ Angular root
 |_ src/
   |_ index.html <----------- links to excluded_asset.js
   |_ app/
   |_ assets/
     |_ excluded_asset.js <-- this one is excluded in ngsw-config.json
     |_ included_asset.js
     |_ ...


这里是相关配置：

ngsw-config.json


{
    "index": "/index.html",
    "assetGroups": [
        {
            "name": "app",
            "installMode": "prefetch",
            "resources": {
                "files": ["/favicon.ico", "/index.html", "/*.css", "/*.js"]
            }
        },
        {
            "name": "assets",
            "installMode": "lazy",
            "updateMode": "prefetch",
            "resources": {
                "files": ["/assets/**", "!/assets/excluded_asset.js"]
            }
        }
    ]
}


通过将freshness和installMode用于资产，是否可以实现类似于updateMode策略的缓存行为？

我尝试将其从资产缓存中排除，并且它是通过网络加载的，但显然在下线后不会由服务人员交付。

之后，我尝试通过dataGroups再次将其包括进来，并将策略设置为freshness，但是一旦资产从资产配置中排除后，该资产似乎就不会再次被缓存。我也不认为dataGroups设置可用于此文件。

"dataGroups": [
    {
        "name": "config",
        "urls": ["assets/excluded_asset.js"],
        "cacheConfig": {
            "maxSize": 10,
            "maxAge": "1d",
            "timeout": "100",
            "strategy": "freshness"
        }
    }
}


我错过了什么吗？还是没有办法通过freshness策略来缓存资产？最好不要移动文件或更改请求文件的方式。

编辑

我试图将其移到缓存的资产目录之外，并将其包含在dataGroups设置中，但也不起作用。

最佳答案

服务人员的新应用

命令如下：

ng new myApp --service-worker (or using the alias — -sw )


有了这个服务工作者标志，Angular CLI 1.6将为我们做一些自动化：


将安装Angular Service Worker软件包。
将启用对NGSW的构建支持。
NGSW将为您的应用程序注册。
NGSW配置文件将使用一些智能默认值创建。


无论如何，即使在发布CLI 1.6之后，也要知道如何重现这些步骤，因为我们必须手动执行这些步骤才能将NGSW支持添加到现有应用中。让我们将Angular Service Worker添加到PWAtter中。

将Angular Service Worker添加到现有应用程序

让我们从上方手动执行相同的4个步骤：

1.安装NGSW

npm install @angular/service-worker --save


2.启用构建支持（仅适用于Angular CLI 1.6，请参见下面的通知）

ng set apps.0.serviceWorker=true


或在.angular-cli.json文件中手动添加/编辑此参数。


重要！目前，当我们使用Angular CLI 1.5时，请确保
确保您在.angular-cli.json中没有此属性，它将
导致构建错误。了解如何在Angular CLI 1.5中模拟此步骤
下面。


3.在您的AppModule中注册NGSW。这就是它在Angular中的外观
CLI 1.6：

import { ServiceWorkerModule } from '@angular/service-worker'
import { environment } from '../environments/environment';

...

@NgModule({
  imports: [
    ...
    environment.production ? ServiceWorkerModule.register('/ngsw-worker.js') : []
  ],
  ...
})
export class AppModule { }


4.创建NGSW配置文件（默认名称为src / ngsw-config.json）。这是Angular CLI 1.6将生成的默认内容。

{
  "index": "/index.html",
  "assetGroups": [{
    "name": "app",
    "installMode": "prefetch",
    "resources": {
      "files": [
        "/favicon.ico",
        "/index.html"
      ],
      "versionedFiles": [
        "/*.bundle.css",
        "/*.bundle.js",
        "/*.chunk.js"
      ]
    }
  }, {
    "name": "assets",
    "installMode": "lazy",
    "updateMode": "prefetch",
    "resources": {
      "files": [
        "/assets/**"
      ]
    }
  }]
}


目前，在使用Angular CLI 1.5时，我们还必须模拟步骤2中的构建支持。实际上，除了ng build --prod命令之外，还应该执行2个额外的操作（使用生产版本以使用NGSW很重要！ ）：

使用NGSW CLI ngsw-config基于NGSW配置文件src / ngsw-config.json生成NGSW控制（清单）文件ngsw.json。

将NGSW本身从npm_modules软件包文件夹复制到我们的dist文件夹。

要使用一个简单的命令来生成具有NGSW支持的生产版本，请添加一些npm脚本：

{
  ...
  "scripts": {
    ...
    "ngsw-config": "node_modules/.bin/ngsw-config dist src/ngsw-config.json",
    "ngsw-copy": "cp node_modules/@angular/service-worker/ngsw-worker.js dist/",
    "build-prod-ngsw": "ng build --prod && npm run ngsw-config && npm run ngsw-copy",
    "serve-prod-ngsw": "npm run build-prod-ngsw && http-server dist -p 8080"
  }
}


现在，如果运行npm run build-prod-ngsw，则在dist文件夹中将有Angular PWA。 （可选）我们可以通过运行http-server使用最简单的npm run serve-prod-ngsw为其提供服务。


重要！不要使用ng serve测试Angular Service Worker。
该开发服务器并非旨在与以下服务器协同工作
PWA流。始终构建应用的生产版本并提供服务
使用任何静态Web服务器从分发文件夹中访问。


应用程序外壳

如果执行上述操作并运行npm run build-prod-ngsw — Angular PWA的默认格式已准备就绪！部署应用程序或仅使用任何静态Web服务器在本地运行该应用程序（在本例中为http-server包，您运行npm run serve-prod-ngsw进行构建和提供服务）。

我们脱机后该应用程序将正常工作。为什么？由于NGSW缓存了配置文件“ assetGroups”部分中列出的所有资源，现在它负责从“缓存存储”中为它们提供服务，该存储现在已充满了记录：

angular - 通过Angular 6 Service Worker中的新鲜度缓存 Assets-LMLPHP

服务人员已注册并处于活动状态

angular - 通过Angular 6 Service Worker中的新鲜度缓存 Assets-LMLPHP

我们可以查看缓存的响应的内容（目前仅在Chrome Canary中可用）

NGSW使用缓存存储来存储HTTP响应数据和一些元数据来处理版本控制：

angular - 通过Angular 6 Service Worker中的新鲜度缓存 Assets-LMLPHP

NGSW的存储类型


带后缀:cache的条目-实际的HTTP响应。
带后缀:meta的条目-用于存储版本控制元信息。以后，可能会将这种存储的数据移至indexedDB。



如果打开DevTools，则“缓存存储”部分中的条目
每次执行以下操作后，极有可能不会自动更新
服务人员方面。如果您想查看实际数据，请右键单击
并选择刷新缓存。


对。对于我们的情况，NGSW配置文件的默认格式还不够，因为我们使用的是Material Icons webfont。显然，这些资源（对应的CSS和WOFF2文件）不是由NGSW缓存的，但是我们可以通过在默认的assetGroups和app之外的assets中再添加一个组来轻松修复它。我们称之为fonts：

{
  ...
  "assetGroups": [
   ...
   {
    "name": "fonts",
    "resources": {
      "urls": [
        "https://fonts.googleapis.com/**",
        "https://fonts.gstatic.com/**"
      ]
    }
  }]
}


使用globs语法指定这些资源很有意义，因为字体文件的确切URL可能会不时更改以支持Webfont版本控制。另外，您可能会注意到我们未指定installMode或updateMode。一方面，这将在生成的NGSW控制文件中均设置为prefetch，因为这是默认值。另一方面，它们仅在被请求后才被缓存，因为urls列出资源的方式的细节。

重建，运行并切换到离线模式后，我们将看到带有所有图标的应用程序的正常状态。

在缓存存储中，我们将看到两个新条目：

angular - 通过Angular 6 Service Worker中的新鲜度缓存 Assets-LMLPHP

NGSW生成的存储

我们甚至可以预览缓存的字体：

angular - 通过Angular 6 Service Worker中的新鲜度缓存 Assets-LMLPHP

assetGroups和dataGroups之间有根本的区别。


assetGroups跟踪应用程序[shell]版本。
dataGroups与应用程序版本无关。他们使用缓存
他们自己的缓存策略，这是处理我们的适当部分
API响应。


运行时缓存

对我的/timeline API端点使用网络优先策略，对/favorites端点使用缓存优先策略。 src/ngsw-config.json中的相应设置如下所示：

{
  ...
  "dataGroups": [{
      "name": "api-freshness",
      "urls": [
        "/timeline"
      ],
      "cacheConfig": {
        "strategy": "freshness",
        "maxSize": 100,
        "maxAge": "3d",
        "timeout": "10s"
      }
    },
    {
      "name": "api-performance",
      "urls": [
        "/favorites"
      ],
      "cacheConfig": {
        "strategy": "performance",
        "maxSize": 100,
        "maxAge": "3d"
      }
    }
  ]
}


有一个主开关定义NGSW的行为：cacheConfig / strategy。对于网络优先策略，为freshness，对于缓存优先-performance。

现在构建，投放，单击“加载我的时间轴”和“加载我的收藏夹”按钮以获取并缓存API响应，然后切换到离线状态。

关于在线模式的优化。返回在线并单击Timeline / Favorites一次或两次。很明显，收藏夹会立即加载，这是因为我们跳过了整个网络行程，并从缓存中获取了数据。指定要缓存多长时间使用cacheConfig部分中的设置－，我们在那里具有细粒度控件。

NGSW通过一些真正智能的网络优化为我们提供了很多帮助，仅需要我们提供一些JSON配置。

关于angular - 通过Angular 6 Service Worker中的新鲜度缓存 Assets ，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/52850760/

10-09 20:05
Powered by LMLPHP ©2024 ngsw 0.045693