Посібник для початківців щодо RxJS та Redux Observable

Redux-Observable - це проміжне програмне забезпечення для Redux на основі RxJS, яке дозволяє розробникам працювати з асинхронними діями. Це альтернатива redux-thunk та redux-saga.

Ця стаття висвітлює основи RxJS, налаштування Redux-Observables та деякі практичні приклади використання. Але перед цим нам потрібно зрозуміти шаблон спостерігача .

Візерунок спостерігача

У шаблоні Observer об'єкт під назвою "Observable" або "Subject" підтримує колекцію передплатників під назвою "Observers". Коли стан суб'єктів змінюється, він повідомляє всіх своїх Спостерігачів.

У JavaScript найпростішим прикладом можуть бути випромінювачі подій та обробники подій.

Коли ви це зробите .addEventListener, ви штовхаєте спостерігача до колекції спостерігачів суб’єкта. Щоразу, коли трапляється подія, випробуваний повідомляє всіх спостерігачів.

RxJS

Відповідно до офіційного веб-сайту,

RxJS - це реалізація JavaScript ReactiveX, бібліотеки для складання асинхронних програм та програм на основі подій за допомогою спостережуваних послідовностей.

Простіше кажучи, RxJS є реалізацією шаблону Observer. Він також розширює шаблон Observer, надаючи оператори, які дозволяють нам складати спостережувані та суб'єкти декларативно.

Спостерігачі, Спостережувані, Оператори та Суб'єкти є основними елементами RxJS. Тож давайте розглянемо кожен з них детальніше зараз.

Спостерігачі

Спостерігачі - це об’єкти, які можуть передплатити спостережливі та суб’єкти. Після підписки вони можуть отримувати сповіщення трьох типів - наступне, помилкове та повне.

Будь-який об'єкт із наступною структурою може бути використаний як Спостерігач.

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

Коли Спостережувані поштовхи поруч, про помилки і повні повідомлення, спостерігач .next, .errorі .completeвикликаються методи.

Спостережувані

Спостережувані - це об’єкти, які можуть випромінювати дані протягом певного періоду часу. Його можна представити за допомогою «мармурової діаграми».

Де горизонтальна лінія представляє час, кругові вузли представляють дані, випромінювані 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'); });

Виконання спостережуваного

Функція Subscribe, яку ми передали new Observableконструктору, виконується кожного разу, коли спостерігається Observable.

Функція Subscribe приймає один аргумент - Subscriber. Абонент нагадує структуру спостерігача, і вона має ті ж методи 3: .next, .error, і .complete.

Спостережувані можуть надсилати дані до спостерігача, використовуючи .nextметод. Якщо Observable успішно завершився, він може повідомити спостерігача за допомогою .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 одноадресним.

Це як перегляд відео на 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 секунд. Це трапляється тому, що другий спостерігач отримав копію спостережуваного, функція передплати якого знову була викликана. Це ілюструє одноадресну поведінку спостережуваних.

Предмети

Суб'єкт - це особливий тип спостережуваних.

Створення теми

Тема створюється за допомогою 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

Трубопровідні оператори - це функції, які приймають 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-спостережуваний здійснює всі ці відправлені дії та нові стани і створює з них дві спостережувані - дії, що спостерігаються action$, і держави, що спостерігаються 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.