Kuinka ladata tietoja React with redux-thunk, redux-saaga, jännitys ja koukut avulla

Johdanto

React on JavaScript-kirjasto käyttöliittymien rakentamiseen. Hyvin usein Reactin käyttö tarkoittaa React with Reduxin käyttöä. Redux on toinen JavaScript-kirjasto globaalin tilan hallintaan. Valitettavasti edes näiden kahden kirjaston kanssa ei ole olemassa yhtä selkeää tapaa käsitellä asynkronisia kutsuja API: lle (backend) tai muita sivuvaikutuksia.

Tässä artikkelissa yritän verrata erilaisia ​​lähestymistapoja tämän ongelman ratkaisemiseen. Määritellään ensin ongelma.

Komponentti X on yksi verkkosivuston monista komponenteista (tai se on myös mahdollista mobiililaitteella tai työpöytäsovelluksella). X kysyy ja näyttää joitain sovellusliittymästä ladattuja tietoja. X voi olla sivu tai vain osa sivua. Tärkeää on, että X on erillinen komponentti, joka tulisi liittää löyhästi muuhun järjestelmään (niin paljon kuin mahdollista). X: n pitäisi näyttää latausindikaattori tietojen noutamisen aikana ja virhe, jos puhelu epäonnistuu.

Tässä artikkelissa oletetaan, että sinulla on jo jonkin verran kokemusta React / Redux -sovellusten luomisesta.

Tässä artikkelissa esitetään neljä tapaa ratkaista tämä ongelma ja verrata kunkin edut ja haitat . Se ei ole yksityiskohtainen opas thunkin, saagan, epäilyksen tai koukkujen käytöstä .

Näiden esimerkkien koodi on saatavana GitHubista.

Alkuasennus

Mock Server

Testaustarkoituksiin aiomme käyttää json-palvelinta. Se on hämmästyttävä projekti, jonka avulla voit rakentaa väärennettyjä REST-sovellusliittymiä erittäin nopeasti. Esimerkissämme se näyttää tältä.

const jsonServer = require('json-server');const server = jsonServer.create();const router = jsonServer.router('db.json');const middleware = jsonServer.defaults();
server.use((req, res, next) => { setTimeout(() => next(), 2000);});server.use(middleware);server.use(router);server.listen(4000, () => { console.log(`JSON Server is running...`);});

Db.json-tiedostomme sisältää testitiedot json-muodossa.

{ "users": [ { "id": 1, "firstName": "John", "lastName": "Doe", "active": true, "posts": 10, "messages": 50 }, ... { "id": 8, "firstName": "Clay", "lastName": "Chung", "active": true, "posts": 8, "messages": 5 } ]}

Palvelimen käynnistämisen jälkeen puhelu // localhost: 4000 / users palauttaa käyttäjäluettelon viiveellä - noin 2 sekuntia.

Projekti- ja API-kutsu

Nyt olemme valmiita aloittamaan koodauksen. Oletan, että sinulla on jo React-projekti, joka on luotu käyttämällä create-reagoi-sovellusta, jossa Redux on määritetty ja käyttövalmis.

Jos sinulla on vaikeuksia sen kanssa, voit tarkistaa tämän ja tämän.

Seuraava vaihe on luoda toiminto, jolla kutsutaan API: ta ( api.js ):

const API_BASE_ADDRESS = '//localhost:4000';
export default class Api { static getUsers() { const uri = API_BASE_ADDRESS + "/users";
 return fetch(uri, { method: 'GET' }); }}

Redux-thunk

Redux-thunk on suositeltava väliohjelmisto Redux-sivuvaikutusten peruslogiikalle, kuten yksinkertaiselle asynkronilogiikalle (kuten pyyntö API: lle). Redux-thunk itse ei tee paljon. Se on vain 14 !!! koodin rivit. Se vain lisää "syntaksisokeria" eikä mitään muuta.

Alla oleva vuokaavio auttaa ymmärtämään, mitä aiomme tehdä.

Aina kun jokin toiminto suoritetaan, vähennysventtiili muuttaa tilaa vastaavasti. Komponentti kartoittaa tilan ominaisuuksiin ja käyttää näitä ominaisuuksia revder () -menetelmässä selvittääkseen, mitä käyttäjän pitäisi nähdä: latausindikaattori , data tai virhesanoma.

Jotta se toimisi, meidän on tehtävä viisi asiaa.

1. Asenna tunk

npm install redux-thunk

2. Lisää thunk-väliohjelmisto myymälää määritettäessä (configureStore.js)

import { applyMiddleware, compose, createStore } from 'redux';import thunk from 'redux-thunk';import rootReducer from './appReducers';
export function configureStore(initialState) 

Rivillä 12–13 määritetään myös redux-devtoolit. Hieman myöhemmin se auttaa osoittamaan yhden tämän ratkaisun ongelmista.

3. Luo toimintoja (redux-thunk / actions.js)

import Api from "../api"
export const LOAD_USERS_LOADING = 'REDUX_THUNK_LOAD_USERS_LOADING';export const LOAD_USERS_SUCCESS = 'REDUX_THUNK_LOAD_USERS_SUCCESS';export const LOAD_USERS_ERROR = 'REDUX_THUNK_LOAD_USERS_ERROR';
export const loadUsers = () => dispatch => { dispatch({ type: LOAD_USERS_LOADING });
 Api.getUsers() .then(response => response.json()) .then( data => dispatch({ type: LOAD_USERS_SUCCESS, data }), error => dispatch() )};

On myös suositeltavaa, että toimintasi tekijät erotetaan (se lisää koodausta), mutta mielestäni tässä yksinkertaisessa tapauksessa on hyväksyttävää luoda toimintoja "lennossa".

4. Luo vähennysventtiili (redux-thunk / reducer.js)

import {LOAD_USERS_ERROR, LOAD_USERS_LOADING, LOAD_USERS_SUCCESS} from "./actions";
const initialState = { data: [], loading: false, error: ''};
export default function reduxThunkReducer(state = initialState, action) { switch (action.type) { case LOAD_USERS_LOADING: { return { ...state, loading: true, error:'' }; } case LOAD_USERS_SUCCESS: { return { ...state, data: action.data, loading: false } } case LOAD_USERS_ERROR: { return { ...state, loading: false, error: action.error }; } default: { return state; } }}

5. Luo reduxiin liitetty komponentti (redux-thunk / UsersWithReduxThunk.js)

import * as React from 'react';import { connect } from 'react-redux';import {loadUsers} from "./actions";
class UsersWithReduxThunk extends React.Component { componentDidMount() { this.props.loadUsers(); };
 render() { if (this.props.loading) { return 
   
Loading }
 if (this.props.error) { return 
   
ERROR: {this.props.error} }
 return ( 
    
       {this.props.data.map(u =>
      <;td>{u.posts}
        )} 
     
First Name Last Name;Active? Posts Messages
{u.firstName} {u.lastName} {u.active ? 'Yes' : 'No'}{u.messages}
); }}
const mapStateToProps = state => ({ data: state.reduxThunk.data, loading: state.reduxThunk.loading, error: state.reduxThunk.error,});
const mapDispatchToProps = { loadUsers};
export default connect( mapStateToProps, mapDispatchToProps)(UsersWithReduxThunk);

Yritin tehdä komponentista mahdollisimman yksinkertaisen. Ymmärrän, että se näyttää kauhealta :)

Latausilmaisin

Tiedot

Virhe

Sinulla on se: 3 tiedostoa, 109 koodirivi (13 (toiminnot) + 36 (vähennysventtiili) + 60 (komponentti)).

Plussat:

  • "Suositeltu" lähestymistapa reaktio- / redux-sovelluksiin.
  • Ei muita riippuvuuksia. Melkein thunk on pieni :)
  • Ei tarvitse oppia uusia asioita.

Haittoja:

  • Paljon koodia eri paikoissa
  • After navigation to another page, old data is still in the global state (see picture below). This data is outdated and useless information that consumes memory.
  • In case of complex scenarios (multiple conditional calls in one action, etc.) code isn’t very readable

Redux-saga

Redux-saga is a redux middleware library designed to make handling side effects easy and readable. It leverages ES6 Generators which allows us to write asynchronous code that looks synchronous. Also, this solution is easy to test.

From a high level perspective, this solution works the same as thunk. The flowchart from the thunk example is still applicable.

To make it work we need to do 6 things.

1. Install saga

npm install redux-saga

2. Add saga middleware and add all sagas (configureStore.js)

import { applyMiddleware, compose, createStore } from 'redux';import createSagaMiddleware from 'redux-saga';import rootReducer from './appReducers';import usersSaga from "../redux-saga/sagas";
const sagaMiddleware = createSagaMiddleware();
export function configureStore(initialState) 

Sagas from line 4 will be added in step 4.

3. Create action (redux-saga/actions.js)

export const LOAD_USERS_LOADING = 'REDUX_SAGA_LOAD_USERS_LOADING';export const LOAD_USERS_SUCCESS = 'REDUX_SAGA_LOAD_USERS_SUCCESS';export const LOAD_USERS_ERROR = 'REDUX_SAGA_LOAD_USERS_ERROR';
export const loadUsers = () => dispatch => { dispatch({ type: LOAD_USERS_LOADING });};

4. Create sagas (redux-saga/sagas.js)

import { put, takeEvery, takeLatest } from 'redux-saga/effects'import {loadUsersSuccess, LOAD_USERS_ERROR, LOAD_USERS_LOADING, LOAD_USERS_SUCCESS} from "./actions";import Api from '../api'
async function fetchAsync(func) { const response = await func();
 if (response.ok) { return await response.json(); }
 throw new Error("Unexpected error!!!");}
function* fetchUser() { try { const users = yield fetchAsync(Api.getUsers);
 yield put({type: LOAD_USERS_SUCCESS, data: users}); } catch (e) { yield put({type: LOAD_USERS_ERROR, error: e.message}); }}
export function* usersSaga() { // Allows concurrent fetches of users yield takeEvery(LOAD_USERS_LOADING, fetchUser);
 // Does not allow concurrent fetches of users // yield takeLatest(LOAD_USERS_LOADING, fetchUser);}
export default usersSaga;

Saga has quite a steep learning curve, so if you’ve never used it and have never read anything about this framework it could be difficult to understand what’s going on here. Briefly, in the userSaga function we configure saga to listen to the LOAD_USERS_LOADING action and trigger the fetchUsersfunction. The fetchUsersfunction calls the API. If the call succeeds, then the LOAD_USER_SUCCESS action is dispatched, otherwise the LOAD_USER_ERROR action is dispatched.

5. Create reducer (redux-saga/reducer.js)

import {LOAD_USERS_ERROR, LOAD_USERS_LOADING, LOAD_USERS_SUCCESS} from "./actions";
const initialState = { data: [], loading: false, error: ''};
export default function reduxSagaReducer(state = initialState, action) { switch (action.type) { case LOAD_USERS_LOADING: { return { ...state, loading: true, error:'' }; } case LOAD_USERS_SUCCESS: { return { ...state, data: action.data, loading: false } } case LOAD_USERS_ERROR: { return { ...state, loading: false, error: action.error }; } default: { return state; } }}

The reducer here is absolutely the same as in the thunk example.

6. Create component connected to redux (redux-saga/UsersWithReduxSaga.js)

import * as React from 'react';import {connect} from 'react-redux';import {loadUsers} from "./actions";
class UsersWithReduxSaga extends React.Component { componentDidMount() { this.props.loadUsers(); };
 render() { if (this.props.loading) { return 
   
Loading }
 if (this.props.error) { return 
   
ERROR: {this.props.error} }
 return ( 
    ; 
     
       {this.props.data.map(u =>
       )} 
     
First Name Last Name;Active? Posts Messages
{u.firstName} ;{u.lastName} {u.active ? 'Yes' : 'No'} {u.posts} {u.messages}
); }}
const mapStateToProps = state => ({ data: state.reduxSaga.data, loading: state.reduxSaga.loading, error: state.reduxSaga.error,});
const mapDispatchToProps = { loadUsers};
export default connect( mapStateToProps, mapDispatchToProps)(UsersWithReduxSaga);

The component is also almost the same here as in the thunk example.

So here we have 4 files, 136 line of code (7(actions) + 36(reducer) + sagas(33) + 60(component)).

Pros:

  • More readable code (async/await)
  • Good for handling complex scenarios (multiple conditional calls in one action, action can have multiple listeners, canceling actions, etc.)
  • Easy to unit test

Cons:

  • A lot of code in different places
  • After navigation to another page, old data is still in the global state. This data is outdated and useless information that consumes memory.
  • Additional dependency
  • A lot of concepts to learn

Suspense

Suspense is a new feature in React 16.6.0. It allows us to defer rendering part of the component until some condition is met (for example data from the API loaded).

To make it work we need to do 4 things (it’s definitely getting better :) ).

1. Create cache (suspense/cache.js)

For the cache, we are going to use a simple-cache-provider which is a basic cache provider for react applications.

import {createCache} from 'simple-cache-provider';
export let cache;
function initCache() { cache = createCache(initCache);}
initCache();

2. Create Error Boundary (suspense/ErrorBoundary.js)

This is an Error Boundary to catch errors thrown by Suspense.

import React from 'react';
export class ErrorBoundary extends React.Component { state = {};
 componentDidCatch(error) { this.setState(); }
 render() { if (this.state.error) { return 
   
ERROR: this.state.error ; }
 return this.props.children; }}
export default ErrorBoundary;

3. Create Users Table (suspense/UsersTable.js)

For this example, we need to create an additional component which loads and shows data. Here we are creating a resource to get data from the API.

import * as React from 'react';import {createResource} from "simple-cache-provider";import {cache} from "./cache";import Api from "../api";
let UsersResource = createResource(async () => { const response = await Api.getUsers(); const json = await response.json();
 return json;});
class UsersTable extends React.Component { render() { let users = UsersResource.read(cache);
 return ( 
    <;td>{u.posts}
        )} 
     
First Name ;Last Name Active? Posts Messages
{u.firstName} {u.lastName} {u.active ? 'Yes' : 'No'}{u.messages}
); }}
export default UsersTable;

4. Create component (suspense/UsersWithSuspense.js)

import * as React from 'react';import UsersTable from "./UsersTable";import ErrorBoundary from "./ErrorBoundary";
class UsersWithSuspense extends React.Component { render() { return ( 
    
     
       ); }}
     
    
export default UsersWithSuspense;

4 files, 106 line of code (9(cache) + 19(ErrorBoundary) + UsersTable(33) + 45(component)).

3 files, 87 line of code (9(cache) + UsersTable(33) + 45(component)) if we assume that ErrorBoundary is a reusable component.

Pros:

  • No redux needed. This approach can be used without redux. Component is fully independent.
  • No additional dependencies (simple-cache-provider is part of React)
  • Delay of showing Loading indicator by setting dellayMs property
  • Fewer lines of code than in previous examples

Cons:

  • Cache is needed even when we don’t really need caching.
  • Some new concepts need to be learned (which are part of React).

Hooks

At the time of writing this article, hooks have not officially been released yet and available only in the “next” version. Hooks are indisputably one of the most revolutionary upcoming features which can change a lot in the React world very soon. More details about hooks can be found here and here.

To make it work for our example we need to do one(!) thing:

1. Create and use hooks (hooks/UsersWithHooks.js)

Here we are creating 3 hooks (functions) to “hook into” React state.

import React, {useState, useEffect} from 'react';import Api from "../api";
function UsersWithHooks() { const [data, setData] = useState([]); const [loading, setLoading] = useState(true); const [error, setError] = useState('');
 useEffect(async () => { try { const response = await Api.getUsers(); const json = await response.json();
 setData(json); } catch (e)  'Unexpected error'); 
 setLoading(false); }, []);
 if (loading) { return 
   
Loading }
 if (error) { return 
   
ERROR: {error} }
 return ( 
    
       ; 
       
       {data.map(u => 
      
       ; 
       ; 
        )} 
     
First Name Last Name Active? PostsMessages
;{u.firstName}{u.lastName} {u.active ? 'Yes' : 'No'} {u.posts} {u.messages}
);}
export default UsersWithHooks;

And that’s it — just 1 file, 56 line of code!!!

Plussat:

  • Reduxia ei tarvita. Tätä lähestymistapaa voidaan käyttää ilman reduxia. Komponentti on täysin riippumaton.
  • Ei muita riippuvuuksia
  • Noin 2 kertaa vähemmän koodia kuin muissa ratkaisuissa

Haittoja:

  • Ensi silmäyksellä koodi näyttää oudolta ja vaikeasti luettavalta ja ymmärrettävältä. Koukkuihin tottuminen vie jonkin aikaa.
  • Joitakin uusia käsitteitä on opittava (jotka ovat osa Reactia)
  • Ei vielä julkaistu virallisesti

Johtopäätös

Järjestetään nämä tiedot ensin taulukkona.

  • Redux on edelleen hyvä vaihtoehto hallita globaalia tilaa (jos sinulla on sitä)
  • Jokaisella vaihtoehdolla on etuja ja haittoja. Mikä lähestymistapa on parempi, riippuu projektista: sen monimutkaisuus, käyttötapaukset, tiimitieto, milloin projekti menee tuotantoon jne.
  • Saga voi auttaa monimutkaisissa käyttötapauksissa
  • Jännitys ja koukut ovat molemmat syytä harkita (tai ainakin oppia) erityisesti uusissa projekteissa

Siinä se - nauti ja onnellinen koodaus!