Ръководство за начинаещи за RxJS & Redux Observable

Redux-Observable е базиран на RxJS междинен софтуер за Redux, който позволява на разработчиците да работят с асинхронни действия. Това е алтернатива на redux-thunk и redux-saga.

Тази статия обхваща основите на RxJS, как да настроите Redux-Observables и някои от практическите му случаи на употреба. Но преди това трябва да разберем модела на наблюдателя .

Модел на наблюдател

В модел на наблюдател обект, наречен „Наблюдаем“ или „Тема“, поддържа колекция от абонати, наречена „Наблюдатели“. Когато състоянието на субектите се промени, той уведомява всички свои наблюдатели.

В JavaScript най-простият пример би бил излъчватели на събития и обработчици на събития.

Когато го направите .addEventListener, вие тласкате наблюдател в колекцията от наблюдатели на субекта. Винаги, когато се случи събитието, субектът уведомява всички наблюдатели.

RxJS

Според официалния уебсайт,

RxJS е JavaScript реализация на ReactiveX, библиотека за съставяне на асинхронни и базирани на събития програми чрез използване на наблюдаеми последователности.

С прости думи, RxJS е изпълнение на модела на наблюдател. Той също така разширява модела Observer, като предоставя оператори, които ни позволяват да съставяме Observables и Subjects по декларативен начин.

Наблюдатели, наблюдаеми, оператори и субекти са градивните елементи на RxJS. Затова нека разгледаме всеки по-подробно сега.

Наблюдатели

Наблюдателите са обекти, които могат да се абонират за Наблюдаеми и Субекти. След като се абонират, те могат да получават известия от три вида - следващи, грешки и пълни.

Всеки наблюдател със следната структура може да се използва.

interface Observer { closed?: boolean; next: (value: T) => void; error: (err: any) => void; complete: () => void; }

Когато наблюдаемата избутва следващия, за грешка и допълване на уведомленията, съответната държава наблюдателка .next, .errorи .completeметодите, които се прави позоваване.

Наблюдаеми

Наблюдаемите са обекти, които могат да излъчват данни за определен период от време. Тя може да бъде представена с помощта на „мраморна диаграма“.

Когато хоризонталната линия представлява времето, кръговите възли представляват данните, излъчвани от Observable, а вертикалната линия показва, че Observable е завършил успешно.

Наблюдаемите могат да срещнат грешка. Кръстът представлява грешката, излъчена от Observable.

Състоянията „завършено“ и „грешка“ са окончателни. Това означава, че Observables не могат да излъчват никакви данни след успешно завършване или срещане на грешка.

Създаване на наблюдаемо

Наблюдаемите се създават с помощта на new Observableконструктора, който приема един аргумент - функцията абонамент. Наблюдаеми също могат да бъдат създадени с помощта на някои оператори, но ще говорим за това по-късно, когато говорим за оператори.

import { Observable } from 'rxjs'; const observable = new Observable(subscriber => { // Subscribe function });

Абониране за Observable

Наблюдаемите могат да бъдат абонирани, използвайки техния .subscribeметод и предавайки наблюдател.

observable.subscribe({ next: (x) => console.log(x), error: (x) => console.log(x), complete: () => console.log('completed'); });

Изпълнение на наблюдаемо

Функцията абонамент, която предадохме на new Observableконструктора, се изпълнява всеки път, когато Observable е абониран.

Функцията абонамент приема един аргумент - Абонатът. Абонатът наподобява структурата на наблюдател, и има същите 3 методи: .next, .error, и .complete.

Наблюдателните могат да изпращат данни към наблюдателя, използвайки .nextметода. Ако Observable завърши успешно, той може да уведоми Observer, използвайки .completeметода. Ако Observable е срещнал грешка, той може да изпрати грешката към Observer, използвайки .errorметода.

// Create an Observable const observable = new Observable(subscriber => { subscriber.next('first data'); subscriber.next('second data'); setTimeout(() => { subscriber.next('after 1 second - last data'); subscriber.complete(); subscriber.next('data after completion'); //  console.log(x), error: (x) => console.log(x), complete: () => console.log('completed') }); // Outputs: // // first data // second data // third data // after 1 second - last data // completed

Наблюдаемите са едноадресни

Наблюдаемите са едноадресни , което означава, че наблюдаемите могат да имат най-много един абонат. Когато Observer се абонира за Observable, той получава копие на Observable, което има свой собствен път за изпълнение, което прави Observables unicast.

Това е като да гледате видеоклип в YouTube. Всички зрители гледат едно и също видео съдържание, но те могат да гледат различни сегменти от видеоклипа.

Пример : нека създадем Observable, който излъчва 1 до 10 за 10 секунди. След това се абонирайте за Observable веднъж веднага и отново след 5 секунди.

// Create an Observable that emits data every second for 10 seconds const observable = new Observable(subscriber => { let count = 1; const interval = setInterval(() => { subscriber.next(count++); if (count > 10) { clearInterval(interval); } }, 1000); }); // Subscribe to the Observable observable.subscribe({ next: value => { console.log(`Observer 1: ${value}`); } }); // After 5 seconds subscribe again setTimeout(() => { observable.subscribe({ next: value => { console.log(`Observer 2: ${value}`); } }); }, 5000); /* Output Observer 1: 1 Observer 1: 2 Observer 1: 3 Observer 1: 4 Observer 1: 5 Observer 2: 1 Observer 1: 6 Observer 2: 2 Observer 1: 7 Observer 2: 3 Observer 1: 8 Observer 2: 4 Observer 1: 9 Observer 2: 5 Observer 1: 10 Observer 2: 6 Observer 2: 7 Observer 2: 8 Observer 2: 9 Observer 2: 10 */

В изхода можете да забележите, че вторият наблюдател е започнал да печата от 1, въпреки че се е абонирал след 5 секунди. Това се случва, защото вторият наблюдател е получил копие на Observable, чиято функция за абониране е била извикана отново. Това илюстрира еднопосочното поведение на Observables.

Субекти

Субектът е специален тип наблюдаем.

Създаване на тема

Субект се създава с помощта на new Subjectконструктора.

import { Subject } from 'rxjs'; // Create a subject const subject = new Subject();

Абониране за тема

Абонирането за субект е подобно на абонирането за Observable: вие използвате .subscribeметода и подавате Observer.

subject.subscribe({ next: (x) => console.log(x), error: (x) => console.log(x), complete: () => console.log("done") });

Изпълнение на субект

Unlike Observables, a Subject calls its own .next, .error, and .complete methods to push data to Observers.

// Push data to all observers subject.next('first data'); // Push error to all observers subject.error('oops something went wrong'); // Complete subject.complete('done');

Subjects are Multicast

Subjects are multicast: multiple Observers share the same Subject and its execution path. It means all notifications are broadcasted to all the Observers. It is like watching a live program. All viewers are watching the same segment of the same content at the same time.

Example: let us create a Subject that emits 1 to 10 over 10 seconds. Then, subscribe to the Observable once immediately, and again after 5 seconds.

// Create a subject const subject = new Subject(); let count = 1; const interval = setInterval(() => { subscriber.next(count++); if (count > 10) { clearInterval(interval); } }, 1000); // Subscribe to the subjects subject.subscribe(data => { console.log(`Observer 1: ${data}`); }); // After 5 seconds subscribe again setTimeout(() => { subject.subscribe(data => { console.log(`Observer 2: ${data}`); }); }, 5000); /* OUTPUT Observer 1: 1 Observer 1: 2 Observer 1: 3 Observer 1: 4 Observer 1: 5 Observer 2: 5 Observer 1: 6 Observer 2: 6 Observer 1: 7 Observer 2: 7 Observer 1: 8 Observer 2: 8 Observer 1: 9 Observer 2: 9 Observer 1: 10 Observer 2: 10 */ 

In the output, you can notice that the second Observer started printing from 5 instead of starting from 1. This happens because the second Observer is sharing the same Subject. Since it subscribed after 5 seconds, the Subject has already finished emitting 1 to 4. This illustrates the multicast behavior of a Subject.

Subjects are both Observable and Observer

Subjects have the .next, .error and .complete methods. That means that they follow the structure of Observers. Hence, a Subject can also be used as an Observer and passed to the .subscribe function of Observables or other Subjects.

Example: let us create an Observable and a Subject. Then subscribe to the Observable using the Subject as an Observer. Finally, subscribe to the Subject. All the values emitted by the Observable will be pushed to the Subject, and the Subject will broadcast the received values to all its Observers.

// Create an Observable that emits data every second const observable = new Observable(subscriber => { let count = 1; const interval = setInterval(() => { subscriber.next(count++); if (count > 5) { clearInterval(interval); } }, 1000); }); // Create a subject const subject = new Subject(); // Use the Subject as Observer and subscribe to the Observable observable.subscribe(subject); // Subscribe to the subject subject.subscribe({ next: value => console.log(value) }); /* Output 1 2 3 4 5 */

Operators

Operators are what make RxJS useful. Operators are pure functions that return a new Observable. They can be categorized into 2 main categories:

  1. Creation Operators
  2. Pipeable Operators

Creation Operators

Creation Operators are functions that can create a new Observable.

Example: we can create an Observable that emits each element of an array using the from operator.

const observable = from([2, 30, 5, 22, 60, 1]); observable.subscribe({ next: (value) => console.log("Received", value), error: (err) => console.log(err), complete: () => console.log("done") }); /* OUTPUTS Received 2 Received 30 Received 5 Received 22 Received 60 Received 1 done */

The same can be an Observable using the marble diagram.

Pipeable Operators

Pipeable Operators са функции, които приемат Observable като вход и връщат нов Observable с модифицирано поведение.

Пример: нека вземем Observable, който създадохме с помощта на fromоператора. Сега, използвайки този Observable, можем да създадем нов Observable, който излъчва само числа, по-големи от 10, използвайки filterоператора.

const greaterThanTen = observable.pipe(filter(x => x > 10)); greaterThanTen.subscribe(console.log, console.log, () => console.log("completed")); // OUTPUT // 11 // 12 // 13 // 14 // 15

Същото може да бъде представено с помощта на мраморната диаграма.

Има много повече полезни оператори там. Можете да видите пълния списък на операторите заедно с примери в официалната RxJS документация тук.

От решаващо значение е да се разберат всички често използвани оператори. Ето някои оператори, които често използвам:

  1. mergeMap
  2. switchMap
  3. exhaustMap
  4. map
  5. catchError
  6. startWith
  7. delay
  8. debounce
  9. throttle
  10. interval
  11. from
  12. of

Redux Observables

Според официалния уебсайт,

Базиран на RxJS междинен софтуер за Redux. Съставяне и отмяна на асинхронни действия за създаване на странични ефекти и други.

В Redux, когато дадено действие се изпраща, то преминава през всички функции на редуктора и се връща ново състояние.

Redux-observable предприема всички тези изпратени действия и нови състояния и създава от тях две наблюдаеми - Action observable action$и States observable state$.

Действията, които могат да се наблюдават, ще излъчат всички действия, изпратени с помощта на store.dispatch(). Наблюдаемите състояния ще излъчват всички нови държавни обекти, върнати от главния редуктор.

Епични

Според официалния уебсайт,

Това е функция, която взема поток от действия и връща поток от действия. Действия вътре, действия навън.

Epics are functions that can be used to subscribe to Actions and States Observables. Once subscribed, epics will receive the stream of actions and states as input, and it must return a stream of actions as an output. Actions In - Actions Out.

const someEpic = (action$, state$) => { return action$.pipe( // subscribe to actions observable map(action => { // Receive every action, Actions In return someOtherAction(); // return an action, Actions Out }) ) }

It is important to understand that all the actions received in the Epic have already finished running through the reducers.

Inside an Epic, we can use any RxJS observable patterns, and this is what makes redux-observables useful.

Example: we can use the .filter operator to create a new intermediate observable. Similarly, we can create any number of intermediate observables, but the final output of the final observable must be an action, otherwise an exception will be raised by redux-observable.

const sampleEpic = (action$, state$) => { return action$.pipe( filter(action => action.payload.age >= 18), // can create intermediate observables and streams map(value => above18(value)) // where above18 is an action creator ); }

Every action emitted by the Epics are immediately dispatched using the store.dispatch().

Setup

First, let's install the dependencies.

npm install --save rxjs redux-observable

Create a separate folder named epics to keep all the epics. Create a new file index.js inside the epics folder and combine all the epics using the combineEpics function to create the root epic. Then export the root epic.

import { combineEpics } from 'redux-observable'; import { epic1 } from './epic1'; import { epic2 } from './epic2'; const epic1 = (action$, state$) => { ... } const epic2 = (action$, state$) => { ... } export default combineEpics(epic1, epic2);

Create an epic middleware using the createEpicMiddleware function and pass it to the createStore Redux function.

import { createEpicMiddleware } from 'redux-observable'; import { createStore, applyMiddleware } from 'redux'; import rootEpic from './rootEpics'; const epicMiddleware = createEpicMiddlware(); const store = createStore( rootReducer, applyMiddleware(epicMiddlware) );

Finally, pass the root epic to epic middleware's .run method.

epicMiddleware.run(rootEpic);

Some Practical Usecases

RxJS has a big learning curve, and the redux-observable setup worsens the already painful Redux setup process. All that makes Redux observable look like an overkill. But here are some practical use cases that can change your mind.

Throughout this section, I will be comparing redux-observables with redux-thunk to show how redux-observables can be helpful in complex use-cases. I don't hate redux-thunk, I love it, and I use it every day!

1. Make API Calls

Usecase: Make an API call to fetch comments of a post. Show loaders when the API call is in progress and also handle API errors.

A redux-thunk implementation will look like this,

function getComments(postId){ return (dispatch) => { dispatch(getCommentsInProgress()); axios.get(`/v1/api/posts/${postId}/comments`).then(response => { dispatch(getCommentsSuccess(response.data.comments)); }).catch(() => { dispatch(getCommentsFailed()); }); } }

and this is absolutely correct. But the action creator is bloated.

We can write an Epic to implement the same using redux-observables.

const getCommentsEpic = (action$, state$) => action$.pipe( ofType('GET_COMMENTS'), mergeMap((action) => from(axios.get(`/v1/api/posts/${action.payload.postId}/comments`).pipe( map(response => getCommentsSuccess(response.data.comments)), catchError(() => getCommentsFailed()), startWith(getCommentsInProgress()) ) );

Now it allows us to have a clean and simple action creator like this,

function getComments(postId) { return { type: 'GET_COMMENTS', payload: { postId } } }

2. Request Debouncing

Usecase: Provide autocompletion for a text field by calling an API whenever the value of the text field changes. API call should be made 1 second after the user has stopped typing.

A redux-thunk implementation will look like this,

let timeout; function valueChanged(value) { return dispatch => { dispatch(loadSuggestionsInProgress()); dispatch({ type: 'VALUE_CHANGED', payload: { value } }); // If changed again within 1 second, cancel the timeout timeout && clearTimeout(timeout); // Make API Call after 1 second timeout = setTimeout(() => { axios.get(`/suggestions?q=${value}`) .then(response => dispatch(loadSuggestionsSuccess(response.data.suggestions))) .catch(() => dispatch(loadSuggestionsFailed())) }, 1000, value); } }

It requires a global variable timeout. When we start using global variables, our action creators are not longer pure functions. It also becomes difficult to unit test the action creators that use a global variable.

We can implement the same with redux-observable using the .debounce operator.

const loadSuggestionsEpic = (action$, state$) => action$.pipe( ofType('VALUE_CHANGED'), debounce(1000), mergeMap(action => from(axios.get(`/suggestions?q=${action.payload.value}`)).pipe( map(response => loadSuggestionsSuccess(response.data.suggestions)), catchError(() => loadSuggestionsFailed()) )), startWith(loadSuggestionsInProgress()) );

Now, our action creators can be cleaned up, and more importantly, they can be pure functions again.

function valueChanged(value) { return { type: 'VALUE_CHANGED', payload: { value } } }

3. Request Cancellation

Usecase: Continuing the previous use-case, assume that the user didn't type anything for 1 second, and we made our 1st API call to fetch the suggestions.

Let's say the API itself takes an average of 2-3 seconds to return the result. Now, if the user types something while the 1st API call is in progress, after 1 second, we will make our 2nd API. We can end up having two API calls at the same time, and it can create a race condition.

To avoid this, we need to cancel the 1st API call before making the 2nd API call.

A redux-thunk implementation will look like this,

let timeout; var cancelToken = axios.cancelToken; let apiCall; function valueChanged(value) { return dispatch => { dispatch(loadSuggestionsInProgress()); dispatch({ type: 'VALUE_CHANGED', payload: { value } }); // If changed again within 1 second, cancel the timeout timeout && clearTimeout(timeout); // Make API Call after 1 second timeout = setTimeout(() => { // Cancel the existing API apiCall && apiCall.cancel('Operation cancelled'); // Generate a new token apiCall = cancelToken.source(); axios.get(`/suggestions?q=${value}`, { cancelToken: apiCall.token }) .then(response => dispatch(loadSuggestionsSuccess(response.data.suggestions))) .catch(() => dispatch(loadSuggestionsFailed())) }, 1000, value); } }

Now, it requires another global variable to store the Axios's cancel token. More global variables = more impure functions!

To implement the same using redux-observable, all we need to do is replace .mergeMap with .switchMap.

const loadSuggestionsEpic = (action$, state$) => action$.pipe( ofType('VALUE_CHANGED'), throttle(1000), switchMap(action => from(axios.get(`/suggestions?q=${action.payload.value}`)).pipe( map(response => loadSuggestionsSuccess(response.data.suggestions)), catchError(() => loadSuggestionsFailed()) )), startWith(loadSuggestionsInProgress()) );

Since it doesn't require any changes to our action creators, they can continue to be pure functions.

Similarly, there are many use-cases where Redux-Observables actually shines! For example, polling an API, showing snack bars, managing WebSocket connections, etc.

To Conclude

If you are developing a Redux application that involves such complex use-cases, it is highly recommended to use Redux-Observables. After all, the benefits of using it are directly proportional to the complexity of your application, and it is evident from the above mentioned practical use-cases.

I strongly believe using the right set of libraries will help us to develop much cleaner and maintainable applications, and in the long term, the benefits of using them will outweigh the drawbacks.