Skip to content

Commit a487efa

Browse files
author
mzkmnk
committed
feat: zoneless.mdの日本語訳
1 parent edbefaa commit a487efa

File tree

1 file changed

+102
-0
lines changed

1 file changed

+102
-0
lines changed
Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# ZoneJSを使わないAngular (Zoneless)
2+
3+
## なぜZonelessを使うのか?
4+
5+
ZoneJSを依存関係として削除する主な利点は次のとおりです。
6+
7+
- **パフォーマンスの向上**: ZoneJSは、アプリケーションの状態が更新された可能性があるタイミングの指標としてDOMイベントと非同期タスクを使用し、その後、アプリケーションのビューで変更検知を実行するためにアプリケーションの同期をトリガーします。ZoneJSは、アプリケーションの状態が実際に変更されたかどうかを把握していないため、この同期は必要以上に頻繁にトリガーされます。
8+
- **Core Web Vitalsの改善**: ZoneJSは、ペイロードサイズと起動時間の両方で、かなりのオーバーヘッドをもたらします。
9+
- **デバッグ体験の向上**: ZoneJSは、コードのデバッグをより困難にします。スタックトレースはZoneJSでは理解しにくくなります。また、コードがAngular Zoneの外部にあるために壊れた場合も理解しにくいです。
10+
- **より良いエコシステム互換性**: ZoneJSはブラウザAPIをパッチ適用することで動作しますが、すべての新しいブラウザAPIに対して自動的にパッチが適用されるわけではありません。一部のAPIは、`async`/`await`のように効果的にパッチを適用できず、ZoneJSで動作するようにダウンレベルする必要があります。場合によっては、エコシステム内のライブラリも、ZoneJSがネイティブAPIにパッチを適用する方法と互換性がないことがあります。ZoneJSを依存関係として削除すると、複雑さ、モンキーパッチ、および継続的なメンテナンスのソースが削除されるため、長期的な互換性が向上します。
11+
12+
## アプリケーションでZonelessを有効にする
13+
14+
Zonelessを有効にするためのAPIは現在、実験的機能です。その仕様や根本的な挙動は安定しておらず、パッチバージョンで変更される可能性があります。サーバーサイドレンダリングでアプリケーションが早期にシリアライズされるのを防ぐための使いやすいAPIが存在しないことが挙げられます。
15+
16+
```typescript
17+
// スタンドアロン ブートストラップ
18+
bootstrapApplication(MyApp, {providers: [
19+
provideExperimentalZonelessChangeDetection(),
20+
]});
21+
22+
// NgModule ブートストラップ
23+
platformBrowser().bootstrapModule(AppModule);
24+
@NgModule({
25+
providers: [provideExperimentalZonelessChangeDetection()]
26+
})
27+
export class AppModule {}
28+
```
29+
30+
## ZoneJSの削除
31+
32+
Zonelessアプリケーションは、バンドルサイズを削減するために、ビルドからZoneJSを完全に削除する必要があります。ZoneJSは通常、`angular.json``polyfills`オプションを介して、`build``test`の両方のターゲットでロードされます。ビルドから削除するには、両方から`zone.js``zone.js/testing`を削除します。明示的な`polyfills.ts`ファイルを使用するプロジェクトは、ファイルから`import 'zone.js';``import 'zone.js/testing';`を削除する必要があります。
33+
34+
ビルドからZoneJSを削除すると、`zone.js`の依存関係も不要になり、パッケージを完全に削除できます。
35+
36+
```shell
37+
npm uninstall zone.js
38+
```
39+
40+
## Zoneless互換性の要件
41+
42+
Angularは、変更検知をいつ、どのビューで実行するかを判断するために、コアAPIからの通知に依存しています。
43+
これらの通知には次のものが含まれます。
44+
45+
- `ChangeDetectorRef.markForCheck` (`AsyncPipe`によって自動的に呼び出されます)
46+
- `ComponentRef.setInput`
47+
- テンプレートで読み取られるシグナルの更新
48+
- バインドされたホストまたはテンプレートリスナーのコールバック
49+
- 上記のいずれかによってダーティーとしてマークされたビューのアタッチ
50+
51+
### `OnPush`互換コンポーネント
52+
53+
コンポーネントが上記の正しい通知メカニズムを使用していることを確認する1つの方法は、[ChangeDetectionStrategy.OnPush](/best-practices/skipping-subtrees#using-onpush)を使用することです。
54+
55+
`OnPush`変更検知戦略は必須ではありませんが、アプリケーションコンポーネントのZoneless互換性への推奨されるステップです。ライブラリコンポーネントが`ChangeDetectionStrategy.OnPush`を使用することが常に可能であるとは限りません。
56+
ライブラリコンポーネントが`ChangeDetectionStrategy.Default`を使用する可能性のあるユーザーコンポーネントのホストである場合、子コンポーネントが`OnPush`互換ではなく、ZoneJSに依存して変更検知をトリガーする場合、子コンポーネントが更新されなくなるため、`OnPush`を使用できません。コンポーネントは、変更検知を実行する必要があるときにAngularに通知する限り(`markForCheck`の呼び出し、シグナルの使用、`AsyncPipe`など)、`Default`戦略を使用できます。
57+
58+
### `NgZone.onMicrotaskEmpty``NgZone.onUnstable``NgZone.isStable`、または`NgZone.onStable`の削除
59+
60+
アプリケーションとライブラリは、`NgZone.onMicrotaskEmpty``NgZone.onUnstable`、および`NgZone.onStable`の使用を削除する必要があります。
61+
アプリケーションがZoneless変更検知を有効にすると、これらのObservableは発行されません。
62+
同様に、`NgZone.isStable`は常に`true`になり、コード実行の条件として使用しないでください。
63+
64+
`NgZone.onMicrotaskEmpty`および`NgZone.onStable`のObservableは、多くの場合、タスクを実行する前にAngularが変更検知を完了するのを待つために最もよく使用されます。代わりに、単一の変更検知を待つ必要がある場合は`afterNextRender`、またはいくつかの変更検知ラウンドにまたがる可能性のある条件がある場合は`afterRender`に置き換えることができます。それ以外の場合、これらのObservableは、使い慣れてお理、必要なタイミングと似ているため使用されました。コードが特定のDOM状態を待つ必要がある場合(Angularのレンダリングフックを介して間接的に待つのではなく)、`MutationObserver`など、より簡単または直接的なDOM APIを代わりに使用できます。
65+
66+
<docs-callout title="NgZone.run and NgZone.runOutsideAngular are compatible with Zoneless">
67+
`NgZone.run``NgZone.runOutsideAngular`は、コードがZonelessアプリケーションと互換性があるために削除する必要はありません。実際、これらの呼び出しを削除すると、ZoneJSに依然として依存しているアプリケーションで使用されるライブラリのパフォーマンスが低下する可能性があります。
68+
</docs-callout>
69+
70+
### サーバーサイドレンダリング(SSR)の`PendingTasks`
71+
72+
AngularでSSRを使用している場合、アプリケーションが「安定」しており、シリアライズできるかどうかを判断するために、ZoneJSに依存していることをご存知かもしれません。シリアライズを妨げる非同期タスクがある場合、ZoneJSを使用していないアプリケーションは、`PendingTasks`サービスを使用してAngularにこれらを認識させる必要があります。シリアライズは、保留中のすべてのタスクが削除された最初の瞬間まで待機します。
73+
74+
```typescript
75+
const taskService = inject(PendingTasks);
76+
const taskCleanup = taskService.add();
77+
await doSomeWorkThatNeedsToBeRendered();
78+
taskCleanup();
79+
```
80+
81+
フレームワークは、非同期タスクが完了するまでシリアライズを防ぐために、このサービスを内部的にも使用します。これには、進行中のルーターナビゲーションや未完了の`HttpClient`リクエストが含まれますが、これらに限定されません。
82+
83+
## テストとデバッグ
84+
85+
### `TestBed`でZonelessを使用する
86+
87+
Zonelessプロバイダー関数は、`TestBed`でも使用して、テスト対象のコンポーネントがZoneless Angularアプリケーションと互換性があることを確認できます。
88+
89+
```typescript
90+
TestBed.configureTestingModule({
91+
providers: [provideExperimentalZonelessChangeDetection()]
92+
});
93+
94+
const fixture = TestBed.createComponent(MyComponent);
95+
await fixture.whenStable();
96+
```
97+
98+
テストが本番コードと最も類似した動作をすることを確認するには、可能な限り`fixture.detectChanges()`の使用を避けてください。これにより、Angularが変更検知をスケジュールしていない場合に、変更検知が強制的に実行されます。テストでは、これらの通知が発生していることを確認し、テストで手動で強制的に発生させるのではなく、Angularが状態を同期するタイミングを処理できるようにする必要があります。
99+
100+
### 更新が検出されることを確認するためのデバッグモードチェック
101+
102+
Angularは、アプリケーションがZoneless互換の方法で状態を更新していることを確認するのに役立つ追加のツールも提供しています。`provideExperimentalCheckNoChangesForDebug`を使用すると、通知なしにバインディングが更新されていないことを定期的に確認できます。Zoneless変更検知によって更新されなかった更新されたバインディングがある場合、Angularは`ExpressionChangedAfterItHasBeenCheckedError`をスローします。

0 commit comments

Comments
 (0)