EmotionTechテックブログ

株式会社エモーションテックのProduct Teamのメンバーが、日々の取り組みや技術的なことを発信していくブログです。

NgRx ComponentStore の lifecycle hook を使って Subscription を購読解除する

11 月に入社したフロントエンドエンジニアの id:kasaharu です。 エモーションテックではフロントエンドの開発に Angular を使用しているので、今日は Angular に関する小ネタを紹介します!

この記事は エモーションテック Advent Calendar 2022 の 8 日目の記事です。

はじめに

Angular でアプリケーション開発をしているとコンポーネント内の Subscription をコンポーネント破棄時に購読解除する必要が多くあるのではないでしょうか? その際、いくつかの方法があると思いますが、もしお手元のアプリケーションに NgRx ComponentStore を使っている場合、ComponentStore の lifecycle hook を使う選択肢もあるため、この記事ではその方法を説明します。

よく見る購読解除の例

購読解除の例としてよく見るのは RxJS の takeUntil() または unsubscribe() を使う手法だと思います。 例として takeUntil() の方を下記に示します。

@Component(...)
export class MoviesPageComponent implements OnInit, OnDestroy {
  constructor(private readonly store: MoviesStore, private readonly service: MovieService) {}

  movies$ = this.store.movies$;
  private onDestroy$ = new Subject<void>();

  ngOnInit(): void {
    this.service.getMovie('#001')
      .pipe(takeUntil(this.onDestroy$))
      .subscribe((movie) => this.store.addMovie(movie));
  }

  ngOnDestroy(): void {
    this.onDestroy$.next();
    this.onDestroy$.complete();
  }
}

コンポーネントの OnDestroy のときにストリームが流れる onDestroy$ というプライベートフィールドを用意し、それを takeUntil() するというものです。 特に問題はないのですが、プライベートフィールドや ngOnDestroy を準備する必要があります。

NgRx ComponentStore の lifecycle hook を使う

もし、対象のコンポーネントが NgRx ComponentStore を使用している場合、ComponentStore が提供している API を使うことで、購読解除のためのフィールドやメソッドの準備が不要になります。

@Component(...)
export class MoviesPageComponent implements OnInit {
  constructor(private readonly store: MoviesStore, private readonly service: MovieService) {}

  movies$ = this.store.movies$;

  ngOnInit(): void {
    this.service
      .getMovie('#001')
      .pipe(takeUntil(this.store.destroy$))
      .subscribe((movie) => this.store.addMovie(movie));
  }
}

このように this.store.destroy$ を使うことで簡単に実現できます。 ただし、この API は 14.0.0-beta.0 で導入されたので、使用する場合はそれ以上のバージョンである必要があります。

まとめ

いかがでしたか? 普段あまり意識せず、手癖で書いているような処理もライブラリのアップデートに伴いシンプルに書くことができます。

新機能を必要としなくても、こういうアップデートがあるとライブラリの更新も積極的におこないたくなりますね!

明日は mineitsu さんの記事です、お楽しみに!

We're Hiring!

エモーションテックでは顧客体験、従業員体験の改善をサポートし、世の中の体験を変えるプロダクトを開発しています。プロダクトに興味のある方、Angular を使ったアプリケーション開発をしたい方、ぜひ採用ページからご応募をお願いいたします。

hrmos.co

参考リンク