Unsubscribe ⚠️

La méthode subscribe retourne un objet de type Subscription.

import { interval } from 'rxjs';

const data$ = interval(1000);

const subscription = data$.subscribe({
    next: value => console.log(value),
    error: error => console.error(error),
    complete: () => console.log('DONE!')
});

Cet objet sert principalement à se désinscrire d'un Observable via sa méthode unsubscribe.

subscription.unsubscribe();

La méthode unsubscribe va donc :

désinscrire les "callbacks" : next, error et complete;
détruire l'Observable (c'est à dire interrompre les traitements effectués par l'Observable) si celui-ci est de type "cold" ;
éventuellement libérer la mémoire car en désinscrivant les "callbacks", le "garbage collector" libérera la mémoire occupée par les objets référencés dans les "callbacks" (s'ils ne sont plus référencés ailleurs).

Il est important d'unsubscribe les Observables dès qu'il n'y en a plus besoin afin d'éviter les fuites mémoire, la consommation inutile de CPU et les effets de bord associés à ces Observables "zombies".

L'unsubscribe se fait généralement :

lors de la destruction d'un composant via le "lifecycle hook" ngOnDestroy,
ou lorsqu'un Observable doit en remplacer un autre (e.g. : lancement d'une nouvelle recherche par un utilisateur ou rafraichissement du contenu).

Dans certains cas, nous préférons l'utilisation du "pipe" async que nous verrons plus tard ou alors des "helpers" tels que Rx-Scavenger.

Rx-Scavenger

Il permet d'unsubscribe automatiquement au remplacement d'une subscription ou à la destruction d'un composant.

yarn add @wishtack/rx-scavenger

import { Scavenger } from '@wishtack/rx-scavenger';

@Component({
    ...
})
export class WeatherComponent implements OnDestroy, OnInit {

    private _scavenger = new Scavenger(this);

    constructor(private _weatherStation: WeatherStation) {
    }

    ngOnInit() {

        this._weatherStation
            .getWeather('Lyon')
            .pipe(
                this._scavenger.collect()        
            )
            .subscribe(weather => {
                ...
            });

    }

    ngOnDestroy() {
    }

}

PrécédentSubscribe SuivantCréation d'un Observable

Dernière mise à jour il y a 5 ans

import { interval } from 'rxjs'; const data$ = interval(1000); const subscription = data$.subscribe({ next: value => console.log(value), error: error => console.error(error), complete: () => console.log('DONE!') });

Rx-Scavenger

est un "Garbage Collector" de Subscription RxJS pour Angular.

Il permet d'unsubscribe automatiquement au remplacement d'une subscription ou à la destruction d'un composant.

yarn add @wishtack/rx-scavenger

import { Scavenger } from '@wishtack/rx-scavenger';

@Component({
    ...
})
export class WeatherComponent implements OnDestroy, OnInit {

    private _scavenger = new Scavenger(this);

    constructor(private _weatherStation: WeatherStation) {
    }

    ngOnInit() {

        this._weatherStation
            .getWeather('Lyon')
            .pipe(
                this._scavenger.collect()        
            )
            .subscribe(weather => {
                ...
            });

    }

    ngOnDestroy() {
    }

}