Skip to content

Latest commit

 

History

History
626 lines (444 loc) · 41 KB

README.ja-JP.md

File metadata and controls

626 lines (444 loc) · 41 KB

Angular パフォーマンスチェックリスト

序論

このドキュメントは、Angularアプリケーションのパフォーマンスを向上させるのに役立つ実践方法の一覧を含みます。 「Angular パフォーマンスチェックリスト」では、実行時パフォーマンスとフレームワークによって実行される変更検出の最適化のための、サーバーサイドでのプリレンダリングならびにアプリケーションのバンドルについて説明しています。

この文章は大きく分けて2つの章に分かれています。

  • ネットワークパフォーマンス - 主に私たちのアプリケーションのロード時間を改善するための一覧です。これは待機時間と帯域幅を削減するための方法が含まれています。
  • 実行時のパフォーマンス - アプリケーション実行時のパフォーマンスを向上させる一覧です。主に変更の検出とレンダリング関連の最適化が含まれます。

いくつかの項目は両方に影響するため、多少被っている可能性がありますが、ユースケースの違いと理由については明確に言及します。

ほとんどの節では、特定の実践方法に関連したツール一覧を書いています、それにより開発フローを自動化し、効率を良くします。

ほとんどの内容はHTTP/1.1 と HTTP/2 の両方に有効です。 将来的に適用される可能性のあるプロトコルのバージョンは、節ごとに適宜指定することにより、例外的な実践方法についても別記します。

目次

ネットワークパフォーマンス

この章にあるいくつかのツールはまだ開発中なので、変更される可能性があります。 Angularコアチームは、可能な限りアプリケーションのビルドプロセス自動化に取り組んでいるため、多くのことが透過的に行われています。

バンドリング

バンドリングは、ユーザーにアプリケーションを配信するために、ブラウザ側が実行するリクエストの数を減らすことを目的とした、標準的な方法です。 本質的に、バンドラーは入力としてエントリーポイントの一覧を受け取り、1つ以上のバンドルを生成します。 そうすることで、ブラウザが個々のリソースを個別に要求するのではなく、少ないリクエストでアプリケーション全体を取得することを可能にします。

アプリケーションが大きくなるにつれ、すべてを1つバンドルに纏めていくのは逆効果になる可能性があります。 その場合、Webpackを使ったコード分割を行う必要が出てきます。

サーバプッシュによりhttp/2はhttpリクエストを含みません。server push 機能を参照してください

ツール一覧

アプリケーションを効率的にバンドルできるツールは次のようなものがあります:

  • Webpack - ツリーシェイキングを行うことによって効率的なバンドリングを提供します。

  • Webpack Code Splitting - コード分割のためのテクニック。

  • Webpack & http2 - http2を使った分割する時に必要です。

  • Rollup - ES2015モジュールの静的な性質を利用し、効率的なツリーシェイキングによるバンドルを提供します。

  • Google Closure Compiler - 十分な最適化と、バンドルのサポートを提供します。 元となるJavaで書かれたものがあり、ここには最近JavaScriptで書かれたバージョンもあります。

  • SystemJS Builder - 依存関係の混在したモジュールツリーとなる、SystemJSベースとなる単一ファイルのビルド構成を提供します。

  • Browserify.

  • ngx-build-modern - Angular-CLI用のプラグインで、アプリケーションのバンドルを2種類にビルドできます:

    1. ES2015モジュールと、必要となるpolyfillだけを搭載した、最新のブラウザでのみ動作するバンドルが小さい構成。
    2. 多くのpolyfillと幅広いコンパイラターゲットを使用する、追加のレガシーバージョン構成(基本の設定)。

参考文献

ミニファイと不要コードの削除

この方法により、アプリケーションのペイロードを減らすことができ、通信量を最小限に抑えることができます。

ツール一覧

  • Uglify - 変数の名前修飾(mangling)、コメントと空白の削除、不要なコードの削除などでファイルサイズの縮小を実行します。すべてJavaScriptで書かれており、ほとんどのタスクランナーのためのプラグインが用意されています。
  • Google Closure Compiler - uglifyによるファイルサイズの縮小と動作が似ています。高度な利用方法には洗練された最適化を実行できるように、プログラムのASTを積極的に変換します。JavaScriptのバージョンが存在し、ここで詳細を見ることができます。 GCCはほとんどのES2015モジュール構文をサポートしているため、ツリーシェイキングで実行ができます。

参考文献

テンプレート中の空白を削除

空白文字(正規表現の\sと言った文字)は見えませんが、ネットワーク上で転送されるバイト数として数えられます。空白をテンプレートからなるべく減らすことで、AoTコードのバンドルサイズをさらに減らすことが可能になります。

幸いなことに、これは手動で行う必要はありません。 ComponentMetadataインターフェースは初期値としてfalseを持つプロパティpreserveWhitespacesを提供します。空白を取り除くことは常にDOM側のレイアウトに影響するかもしれないからです。 このプロパティを trueに設定した場合、Angularは不要な空白を削除してバンドルサイズをさらに縮小します。

ツリーシェイキング

私たちのアプリケーションの最終版では、Angularやサードパーティのライブラリ、そして私たちが書いたものでさえ全てのコードを使うことは通常ありません。 ES2015モジュールの静的な性質のおかげで、アプリで参照のないコードを取り除くことができます。

サンプルコード

// foo.js
export foo = () => 'foo';
export bar = () => 'bar';

// app.js
import { foo } from './foo';
console.log(foo());

app.jsをツリーシェイキングでバンドルすると、以下のようになります。

let foo = () => 'foo';
console.log(foo());

これは、未使用のエクスポートbarが最終的なバンドルに含まれないことを意味します。

ツール一覧

  • Webpack - ツリーシェイキングを実行することで効率的なバンドリングを提供します。 アプリケーションがバンドルされる時に、未使用のコードはエクスポートされず不要なコードと見なされ、結果としてUglifyによって削除されます。
  • Rollup - ES2015モジュールの静的な性質を利用して、効率的なツリーシェイキングを実行したバンドルを提供します。
  • Google Closure Compiler - 十分な最適化と、バンドルのサポートを提供します。 元となるJavaで書かれたものがあり、ここには最近JavaScriptで書かれたバージョンもあります。

注意: GCCはまだ export * をサポートしていません。これは"バレル"パターンが多用されるAngularアプリケーションの構築には重要な要素です。

参考文献

ツリーシェイキング可能なプロバイダ

Angularのバージョン 6 以降のリリースでは、Angularチームはサービスをツリーシェイキング可能にするための新機能を提供しました。 つまり、他のサービスまたはコンポーネントによって使用されていない限り、そのサービスは最終的なバンドルに含まれません。 これは、バンドルから未使用のコードを削除することによってバンドルサイズを減らすのに役立ちます。

providedIn属性を使ってサービスをツリーシェイキング可能にするには、@Injectable()デコレータを使う時にサービスをどこに初期化するかを定義します。 次に、 NgModule宣言のprovider属性とimport文から以下のように削除します。

修正前:

// app.module.ts
import { NgModule } from '@angular/core'
import { AppRoutingModule } from './app-routing.module'
import { AppComponent } from './app.component'
import { environment } from '../environments/environment'
import { MyService } from './app.service'

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    ...
  ],
  providers: [MyService],
  bootstrap: [AppComponent]
})
export class AppModule { }
// my-service.service.ts
import { Injectable } from '@angular/core'

@Injectable()
export class MyService { }

修正後:

// app.module.ts
import { NgModule } from '@angular/core'
import { AppRoutingModule } from './app-routing.module'
import { AppComponent } from './app.component'
import { environment } from '../environments/environment'

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    ...
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }
// my-service.service.ts
import { Injectable } from '@angular/core'

@Injectable({
  providedIn: 'root'
})
export class MyService { }

MyServiceがどのコンポーネントやサービスにも注入されていない場合、バンドルには含まれません。

参考文献

Ahead-of-Time (AoT) コンパイル

既存のツール(GCC、Rollupなど)に対する課題は、コンポーネント中にあるHTMLテンプレートです。これらは既存ツールの機能では分析できません。 そしてこれは、どのディレクティブがテンプレート内で参照されているのかわからないため、ツリーシェイキングのサポートを非効率にしてしまいます。 AoTコンパイラは、AngularのHTMLテンプレートをES2015モジュールのインポートを利用しJavaScriptまたはTypeScriptに変換します。 このようにして、バンドル中に効率的にツリーシェイキングを行い、Angularのサードパーティ製ライブラリや自分たちの未使用ディレクティブを削除することができます。

参考文献

圧縮

レスポンスのデータ転送量の圧縮は、帯域幅使用量を減らすための標準的な方法です。 ヘッダに Accept-Encodingの値を指定することで、ブラウザはどの圧縮アルゴリズムがクライアントのマシンで利用可能であるかをサーバに教えます。 一方、サーバーは、レスポンスを圧縮するためにどのアルゴリズムが選択されたかをブラウザに伝えるために、レスポンスの Content-Encodingヘッダに値を設定します。

ツール一覧

このツールはAngular固有のものではなく、私たちが使用しているWeb/アプリケーションサーバーに完全に依存します。 代表的な圧縮アルゴリズムは次のとおりです:

  • deflate - LZ77アルゴリズムとハフマン符号化の組み合わせを使用するデータ圧縮アルゴリズムおよび関連ファイル形式。
  • brotli - 最新のLZ77アルゴリズムの変種、ハフマン符号化、および2次コンテキストモデリングの組み合わせを使用して、現在利用可能な最善の汎用圧縮方法に匹敵する圧縮率でデータを圧縮できる汎用目的の可逆圧縮アルゴリズム。 それはdeflateと同じくらいの速度だが、より高密度な圧縮を提供します。

参考文献

リソースの事前読込み

リソースの事前読込みは、ユーザーエクスペリエンスを向上させるための優れた方法です。 アセット(画像、スタイル、遅延読み込みされるモジュールなど)やデータは事前読み込みすることができます。 さまざまな事前読みの戦略がありますが、それらのほとんどはアプリケーションの仕様に依存します。

リソースの遅延読み込み

ターゲットのアプリケーションが数百の依存関係を持つ巨大なコードベースを持っている場合、上記のプラクティスは私たちのバンドルを合理的なサイズにするのを助けることができないかもしれません。(妥当サイズは100K~2M辺りですが、これも完全にビジネス目標に依存します)

そのような場合の良い解決策はアプリケーションのモジュールのいくつかを遅延してロードすることです。 たとえば、電子商取引システムを構築しているとします。 この時にユーザー向けのUIとは別に管理パネルをロードできるようにておくことで、管理者が新しい製品を追加する必要なときだけに必要なUIを提供できます。 この提供する内容は要件次第で「製品ページの追加」か「管理パネル全体」のいずれかになるでしょう。

ツール一覧

  • Webpack - 非同期モジュールの読み込みを可能にします。
  • ngx-quicklink - 画面に表示されているリンクに関連付けられている遅延ロードモジュールを自動的にダウンロードするルーター事前ロード戦略

デフォルトのルートを遅延読み込みにしない

次のようなルーティング設定があるとしましょう:

// 良くない例
const routes: Routes = [
  { path: '', redirectTo: '/dashboard', pathMatch: 'full' },
  { path: 'dashboard',  loadChildren: () => import('./dashboard.module').then(mod => mod.DashboardModule) },
  { path: 'heroes', loadChildren: () => import('./heroes.module').then(mod => mod.HeroesModule) }
];

ユーザーが初めて url:https://example.com/ にアクセスしてアプリケーションを開くと、パスdashboardの遅延ルートをトリガーする/dashboardにリダイレクトされます。 Angularがモジュールのブートストラップコンポーネントをレンダリングするためには、ファイル dashboard.moduleとそのすべての依存関係をダウンロードした後に、ファイルをJavaScript VMで解析し評価する必要があります。

最初のページのロード中に余分なHTTPリクエストをトリガーして不必要な計算を実行すると、最初のページレンダリングが遅くなるため、あまり良くありません。 デフォルトのページルートを遅延しないように宣言することを検討してください。

キャッシング

キャッシングとは、あるリソースが最近要求された場合、近い将来また要求される可能性があるという推測に基づいてアプリケーションを高速化する一般的な方法です。

データをキャッシュするためには、一般的に独自のキャッシュの仕組みを使います。 静的資産のキャッシュには、標準のブラウザキャッシュまたはService WorkersとCacheStorage APIを使用することができます。

アプリケーションシェルを使う

アプリケーションのパフォーマンスをより速くするためには、アプリケーションシェルを使用してください。

アプリケーションシェルは、ユーザーにアプリケーションがもう間もなく動作しはじめる事を伝えるための最小のユーザーインターフェイスです。 アプリケーションシェルを動的に生成するため、使用するレンダリングプラットフォーム毎に要素の表示を切り替えるカスタムディレクティブを付けてAngular Universalを使用できます。(つまり、platform-serverを使うときはApp Shell以外のものはすべて隠蔽してください)

ツール一覧

参考文献

サービスワーカーを使う

サービスワーカーは、ブラウザ内にあるHTTPプロキシのようなものです。クライアントから送信されたすべての要求は最初にサービスワーカーによって傍受され、サービスワーカーは受け取ったデータを処理、またはネットワークを介して引き渡します。

次のコマンドを実行するだけで、Angularプロジェクトにサービスワーカーを追加できます。 ng add @angular/pwa

ツール一覧

参考文献

実行時の最適化

このセクションには、毎秒60フレーム(fps)のスムーズなユーザーエクスペリエンスを提供するために利用できる実践的な方法が含まれています。

enableProdModeを使う

開発モードのAngularは、変更検出を実行した時のバインディングが追加の変更が加えられないことを確認するために、いくつかの追加チェックを実行します。 これにより、フレームワークは単方向データフローに従ったことを保証します。

本番では開発モードを無効化する必要があるため、忘れずにenableProdModeを実行するようにしてください。

import { enableProdMode } from '@angular/core';

if (ENV === 'production') {
  enableProdMode();
}

Ahead-of-Time コンパイル

AoTは、ツリーシェイキングを実行してより効率的なバンドリングを実現するだけでなく、アプリケーション実行時のパフォーマンスを向上させます。 AoTではない時に実行されているのはJust-in-Timeコンパイル(JiT)です。 つまり、ビルドプロセスの一部としてコンパイルを実行することで、アプリケーションのレンダリングに必要な計算量を減らすことができます。

ツール一覧

  • angular2-seed - AoTコンパイルのサポートを含むスタータープロジェクト。
  • angular-cli ng serve --prodコマンドを使う

参考文献

Webワーカー

一般的なシングルページアプリケーション(SPA)の問題は、通常のコードがシングルスレッドで動作することにあります。 つまり、60fpsのスムーズなユーザーエクスペリエンスを実現したい場合は、個々のフレームの間隔である最大16msの間に処理を完了しなければならず、出来ない場合ユーザーエクスペリエンスは悪くなってしまうでしょう。

巨大なコンポーネントツリーを使用した複雑なアプリケーションでは、変更検出で毎秒数百万のチェックをしているので、フレームを減らし始めるのは難しくありません。 DOMアーキテクチャーはAngularのプラットフォームにより切り離されているため、Webワーカーでアプリケーション全体(変更検出を含む)を実行し、レンダリングのみをメインのUIスレッドに任せることができます。

ツール一覧

  • コアチームによってサポートされているウェブワーカーでアプリケーションを実行できるようにするモジュールです。 使い方はこちらを参照してください。
  • Webpack Web Worker Loader -webpack用のウェブワーカーローダー

参考文献

サーバーサイドレンダリング

従来からあるSPAの大きな問題として、最初のレンダリングに必要なJavaScriptを読み込み終わるまで画面の表示ができませんでした。 これは2つの大きな問題を引き起こします:

  • すべての検索エンジンがそのページ内のJavaScriptを実行しているわけではないので、アプリケーションの動的コンテンツに適切にインデックスを付けることはできません。
  • ページ内のJavaScriptをダウンロード、解析、実行されるまで、ユーザーには空白/ロード中の画面しか表示されず、ユーザーエクスペリエンスが低下します。

サーバーサイドレンダリングは、要求されたページをサーバー上で事前にレンダリングし、最初のページの読み込み時に描画が完了したマークアップを提供することによってこの問題を解決します。

ツール一覧

  • Angular Universal - Angularに対する Universal (isomorphic) JavaScriptをサポートします。
  • Preboot - サーバーで生成されたWebビューからクライアントで生成されたWebビューへの状態(イベント、フォーカス、データ)の移行を管理するのに役立つライブラリ。

参考文献

変更検出

非同期イベントが発生する毎に、Angularはコンポーネントツリー全体の変更検出を行います。 変更検出するコードはインラインキャッシュ用に最適化されていますが、複雑なアプリケーションでは重い処理になることがあります。 変更検出のパフォーマンスを向上させる方法は、直近の動作で変更のされないサブツリーに対しては実行しないことです。

ChangeDetectionStrategy.OnPush

OnPush変更検出戦略により、コンポーネントツリーのサブツリーに対する変更検出メカニズムを無効にすることができます。 任意のコンポーネントに対する変更検出方法をChangeDetectionStrategy.OnPushと設定することで、コンポーネントが異なる入力を受け取ったときにのみ変更検出を実行します。 Angularは参照によって以前の入力と比較した場合に入力が異なると見なし、参照チェックの結果は「false」になります。 不変のデータ構造と組み合わせると、OnPushはこのような「純粋なコンポーネント」に大きなパフォーマンス改善をもたらすことができます。

Resources

Change Detectorの切り離し

カスタム変化検出メカニズムを実装するもう一つの方法として、 特定のコンポーネントの変化検出の機能(CD)の切り離し再接続を行うことができます。AngularのCDが一度切り離されると、コンポーネントサブツリー全体のチェックは実行されません。

この方法は一般的に、ユーザーの操作や外部サービスとのやり取りによって、必要以上の変更検出が行われる場合に使用します。 この場合、必要な変更検出を実行する必要がある場合にだけ変更検出機能を再接続することを検討してください。

Run outside Angular

Angularの変化検出メカニズムはzone.jsによって実行されます。 Zone.jsのモンキーパッチは、ブラウザ内のすべての非同期APIにパッチを適用し、非同期コールバックの実行終了時に変更の検出が引き起します。 レアケースとして、変更検出メカニズムを実行したくないために、Angular Zoneのコンテキスト外で特定のコードを実行したい場合があります。 そんな時は、NgZoneインスタンスのメソッドrunOutsideAngularを使うことができます。

以下の小さなコードサンプルで、この方法を使ったコンポーネントの具体例を見ることができます。 _incrementPointsメソッドが呼ばれると、コンポーネントは(基本的に)10ms毎に_pointsプロパティの増加を始めていきます。 値の増加はアニメーションのような錯覚をさせるでしょう。 この時に、10msごとにコンポーネントツリー全体の変更検出メカニズムを起動したくないので、Angular Zoneのコンテキスト外で _incrementPointsを実行してDOMを手動で更新することができます。(points setter を参照)

@Component({
  template: '<span #label></span>'
})
class PointAnimationComponent {

  @Input() duration = 1000;
  @Input() stepDuration = 10;
  @ViewChild('label') label: ElementRef;

  @Input() set points(val: number) {
    this._points = val;
    if (this.label) {
      this.label.nativeElement.innerText = this._pipe.transform(this.points, '1.0-0');
    }
  }
  get points() {
    return this._points;
  }

  private _incrementInterval: any;
  private _points: number = 0;

  constructor(private _zone: NgZone, private _pipe: DecimalPipe) {}

  ngOnChanges(changes: any) {
    const change = changes.points;
    if (!change) {
      return;
    }
    if (typeof change.previousValue !== 'number') {
      this.points = change.currentValue;
    } else {
      this.points = change.previousValue;
      this._ngZone.runOutsideAngular(() => {
        this._incrementPoints(change.currentValue);
      });
    }
  }

  private _incrementPoints(newVal: number) {
    const diff = newVal - this.points;
    const step = this.stepDuration * (diff / this.duration);
    const initialPoints = this.points;
    this._incrementInterval = setInterval(() => {
      let nextPoints = Math.ceil(initialPoints + diff);
      if (this.points >= nextPoints) {
        this.points = initialPoints + diff;
        clearInterval(this._incrementInterval);
      } else {
        this.points += step;
      }
    }, this.stepDuration);
  }
}

警告: 正確に実行されないとDOMの状態に矛盾が生じる可能性があります、自分が何をしているか確実に理解できるときだけこの方法を使用してください。 また、上記のコードはウェブワーカーでは実行できません。 ウェブワーカー互換にするためには、Angularのレンダラを使用して表示するラベルの値を設定する必要があります。

純粋なpipeを使う

@Pipeデコレータは引数に以下のような形式のオブジェクトリテラルを受け取れます。

interface PipeMetadata {
  name: string;
  pure: boolean;
}

pureフラグは、パイプがどのグローバルの状態にも依存してなく、副作用を引き起こさないことを示します。 つまり、同じ入力で呼び出された場合、どんな時もパイプは同じ出力を返します。 こうすることでAngularはパイプが呼び出されたすべての入力パラメータの出力をキャッシュすることができ、それぞれの評価時に再計算するせず再利用を可能にしています。

pureプロパティの初期値はtrueです。

*ngFor ディレクティブ

*ngForディレクティブはコレクション(データやオブジェクトなどをまとめて格納するデータ構造)を表示するために使われます。

trackBy オプションを使う

基本的なふるまいとして*ngForは参照によってオブジェクトの一意性を識別します。

つまり、開発者がアイテムのコンテンツ更新中にオブジェクトへの参照を破棄した場合、Angularは古いオブジェクトが削除されて別のオブジェクトが生成されたと判断します。 これは、一覧にある古いDOMノードを破棄し、その場所に新しいDOMノードを追加するといった影響として現れます。

開発者は、オブジェクトの一意性を識別するためにAngularへヒントを教えることができます: *ngForディレクティブのtrackByオプションへカスタムトラッキング関数を設定します。 トラッキング関数には2つの引数があります: indexitemです。 Angularは、トラッキング関数から返された値を使用してアイテムの識別情報を追跡します。 固有のキーとして特定のレコードのIDを使用することはよくある例です。

@Component({
  selector: 'yt-feed',
  template: `
  <h1>Your video feed</h1>
  <yt-player *ngFor="let video of feed; trackBy: trackById" [video]="video"></yt-player>
`
})
export class YtFeedComponent {
  feed = [
    {
      id: 3849, // "id"フィールドに注意してください、"trackById"関数でそれを参照します
      title: "Angular in 60 minutes",
      url: "http://youtube.com/ng2-in-60-min",
      likes: "29345"
    },
    // ...
  ];

  trackById(index, item) {
    return item.id;
  }
}

DOM要素を小さくする

DOMのレンダリングは、要素をUIに追加する時に最もコストのかかる操作です。 よくある操作は、DOMに要素を挿入しスタイルを適用することによって起こります。 *ngForで大量の要素を描画する時、ブラウザ(特に古いもの)は遅くなり、すべての要素の表示に多くの時間が必要となってしまうかもしれません。 そしてこれはAngularに限った話ではありません。

描画時間を短くするために、次のことを試してください:

  • CDKngx-virtual-scrollerを使い仮想スクロールを適用します。
  • テンプレートの *ngForセクションで表示されるDOM要素の量を減らす。 不要または未使用のDOM要素はテンプレートを幾度となく拡張することによって発生します。その構造を再考すれば、もっとシンプルにすることができるでしょう。
  • 可能であればng-container使ってください。

参考文献

テンプレート中の式を最適化する

Angularは全ての変更検知サイクルを実行した後、テンプレートの式を評価します。 変更検知サイクルは、promiseの解決、httpの結果、タイマーイベント、キー操作、マウスの動きなどの様々な非同期となる動作によって引き起こされます。

式はすぐに終了する必要があります。そうしないと、特に遅いデバイスではユーザーエクスペリエンスが悪化する可能性があります。 計算にコストがかかる場合は値をキャッシュすることを検討してください。

参考文献

終わりに

これらの実践方法の一覧は、新たな/更新され、時間が経つにつれてダイナミックに進化します。 何かが足りない事に気付いた場合や、慣習のいずれかを改善できると思えた場合は、躊躇わずissuesやPRをしてください。 詳細については、次の「貢献する」セクションをご覧ください。

貢献する

何かのミス、中途半端なもの、または間違いに気付いた場合はプルリクエストをいただければ幸いです。 文書に含まれていない慣習についての議論はissueを開いてください

License

MIT