كيف صممت تطبيق React أحادي الصفحة

مع هياكل البيانات والمكونات والتكامل مع Redux

لقد أنشأت مؤخرًا تطبيقًا من صفحة واحدة يتفاعل مع خادم JSON API الخلفي. اخترت استخدام React لتعميق فهمي لأساسيات React وكيف يمكن لكل أداة أن تساعد في بناء واجهة قابلة للتطوير.

تتكون حزمة هذا التطبيق من:

  • الواجهة الأمامية مع React / Redux
  • خادم JSON API للخلفية مع Sinatra ، متكامل مع Postgres لاستمرار قاعدة البيانات
  • عميل API يقوم بجلب البيانات من OMDb API ، مكتوبة بلغة Ruby

بالنسبة إلى هذا المنشور ، سنفترض أن الواجهة الخلفية قد اكتملت. لذلك دعونا نركز على كيفية اتخاذ قرارات التصميم في الواجهة الأمامية.

ملاحظة جانبية: القرارات المقدمة هنا هي للإشارة فقط وقد تختلف حسب احتياجات التطبيق الخاص بك. مثال على تطبيق OMDb Movie Tracker يُستخدم هنا للتوضيح.

التطبيق

يتكون التطبيق من نموذج إدخال البحث. يمكن للمستخدم إدخال عنوان فيلم لإرجاع نتيجة فيلم من OMDb. يمكن للمستخدم أيضًا حفظ فيلم بتصنيف وتعليق قصير في قائمة المفضلة.

لعرض التطبيق النهائي ، انقر هنا. لعرض كود المصدر ، انقر هنا.

عندما يبحث المستخدم عن فيلم على الصفحة الرئيسية ، يبدو الأمر كما يلي:

من أجل البساطة ، سنركز فقط على تصميم الميزات الأساسية للتطبيق في هذه المقالة. يمكنك أيضًا التخطي إلى الجزء الثاني: إعادة التشغيلمن السلسلة.

هيكل البيانات

يجب أن يكون تحديد هياكل البيانات المناسبة أحد أهم جوانب تصميم التطبيق. يجب أن يأتي هذا كخطوة أولى ، لأنه لا يحدد فقط كيفية عرض الواجهة الأمامية للعناصر ، ولكن أيضًا كيف يجب أن يعرض خادم واجهة برمجة التطبيقات استجابات JSON.

لهذا التطبيق، سوف نحتاج قطعتين الرئيسي للمعلومات لتقديم بشكل صحيح لدينا UI: نتيجة فيلم واحد و قائمة الأفلام تفضيلا .

كائن نتيجة الفيلم

ستحتوي نتيجة فيلم واحد على معلومات مثل العنوان والسنة والوصف وصورة الملصق. بهذا ، نحتاج إلى تحديد كائن يمكنه تخزين هذه السمات:

{ "title": "Star Wars: Episode IV - A New Hope", "year": "1977", "plot": "Luke Skywalker joins forces with a Jedi Knight...", "poster": "//m.media-amazon.com/path/to/poster.jpg", "imdbID": "tt0076759"}

و posterالخاصية هي مجرد URL لصورة الملصق الذي سيتم عرضه في النتائج. إذا لم يتوفر ملصق لهذا الفيلم ، فسيكون "N / A" ، والذي سنعرض عنصرًا نائبًا. سنحتاج أيضًا إلى imdbIDسمة لتعريف كل فيلم بشكل فريد. يفيد ذلك في تحديد ما إذا كانت نتيجة فيلم موجودة بالفعل في قائمة المفضلة أم لا. سنستكشف لاحقًا كيف يعمل.

قائمة المفضلة

ستحتوي قائمة المفضلة على جميع الأفلام المحفوظة كمفضلة. ستبدو القائمة كما يلي:

[ { title: "Star Wars", year: "1977", ..., rating: 4 }, { title: "Avatar", year: "2009", ..., rating: 5 }]

ضع في اعتبارك أننا سنحتاج إلى البحث عن فيلم معين من القائمة ، والتعقيد الزمني لهذا النهج هو O (N) . بينما يعمل بشكل جيد مع مجموعات البيانات الأصغر ، تخيل الاضطرار إلى البحث عن فيلم في قائمة المفضلة التي تنمو إلى أجل غير مسمى.

مع وضع هذا في الاعتبار ، اخترت استخدام جدول تجزئة مع مفاتيح imdbIDوقيم ككائنات فيلم مفضلة:

{ tt0076759: { title: "Star Wars: Episode IV - A New Hope", year: "1977", plot: "...", poster: "...", rating: "4", comment: "May the force be with you!", }, tt0499549: { title: "Avatar", year: "2009", plot: "...", poster: "...", rating: "5", comment: "Favorite movie!", }}

باستخدام هذا ، يمكننا البحث عن فيلم في قائمة المفضلة في وقت O (1) بحلوله imdbID.

ملاحظة: من المحتمل ألا يكون تعقيد وقت التشغيل مهمًا في معظم الحالات نظرًا لأن مجموعات البيانات عادةً ما تكون صغيرة من جانب العميل. سنقوم أيضًا بإجراء التقطيع والنسخ (أيضًا عمليات O (N)) في Redux على أي حال. ولكن كمهندس ، من الجيد أن تكون على دراية بالتحسينات المحتملة التي يمكننا إجراؤها.

مكونات

المكونات هي قلب React. سنحتاج إلى تحديد تلك التي ستتفاعل مع متجر Redux وأيها مخصصة للعرض التقديمي فقط. يمكننا أيضًا إعادة استخدام بعض مكونات العرض أيضًا. سيبدو التسلسل الهرمي للمكونات كما يلي:

الصفحة الرئيسية

نقوم بتعيين مكون التطبيق لدينا في المستوى الأعلى. عندما تتم زيارة مسار الجذر ، فإنه يحتاج إلى عرض SearchContainer . يحتاج أيضًا إلى عرض رسائل فلاش للمستخدم والتعامل مع التوجيه من جانب العميل.

سيقوم SearchContainer باسترداد نتيجة الفيلم من متجر Redux الخاص بنا ، مع توفير المعلومات كدعامات لـ MovieItem لتقديمها . سيتم أيضًا إرسال إجراء بحث عندما يرسل المستخدم بحثًا في SearchInputForm . المزيد عن Redux لاحقًا.

أضف إلى المفضلة

عندما ينقر المستخدم على زر "إضافة إلى المفضلة" ، سنعرض AddFavoriteForm ، وهو مكون متحكم فيه.

نقوم باستمرار بتحديث حالته كلما قام المستخدم بتغيير التصنيف أو نص الإدخال في منطقة نص التعليق. هذا مفيد للتحقق من صحة عند تقديم النموذج.

يعتبر RatingForm مسؤولاً عن عرض النجوم الصفراء عندما ينقر المستخدم عليها. كما تُعلم قيمة التصنيف الحالية لـ AddFavoriteForm .

علامة التبويب "المفضلة"

عندما ينقر المستخدم على علامة التبويب "المفضلة" ، يعرض التطبيق " حاوية المفضلة" .

إن FavoritesContainer مسؤولة عن استرداد قائمة المفضلة من متجر Redux. كما يرسل الإجراءات عندما يغير المستخدم تصنيفًا أو ينقر على زر "إزالة".

Our MovieItem and FavoritesInfo are simply presentational components that receive props from FavoritesContainer.

We’ll reuse the RatingForm component here. When a user clicks on a star in the RatingForm, the FavoritesContainer receives the rating value and dispatches an update rating action to the Redux store.

Redux Store

Our Redux store will include reducers that handle the search and favorites actions. Additionally, we’ll need to include a status reducer to track state changes when a user initiates an action. We’ll explore more on the status reducer later.

//store.js
import { createStore, combineReducers, applyMiddleware } from 'redux';import thunk from "redux-thunk";
import search from './reducers/searchReducer';import favorites from './reducers/favoritesReducer';import status from './reducers/statusReducer';
export default createStore( combineReducers({ search, favorites, status }), {}, applyMiddleware(thunk))

We’ll also apply the Redux Thunk middleware right away. We’ll go more into detail on that later. Now, let’s figure out how we manage the state changes when a user submits a search.

Search Reducer

When a user performs a search action, we want to update the store with a new search result via searchReducer. We can then render our components accordingly. The general flow of events looks like this:

We’ll treat “Get search result” as a black box for now. We’ll explore how that works later with Redux Thunk. Now, let’s implement the reducer function.

//searchReducer.js
const initialState = { "title": "", "year": "", "plot": "", "poster": "", "imdbID": "",}
export default (state = initialState, action) => { if (action.type === 'SEARCH_SUCCESS') { state = action.result; } return state;}

The initialState will represent the data structure defined earlier as a single movie result object. In the reducer function, we handle the action where a search is successful. If the action is triggered, we simply reassign the state to the new movie result object.

//searchActions.jsexport const searchSuccess = (result) => ({ type: 'SEARCH_SUCCESS', result});

We define an action called searchSuccess that takes in a single argument, the movie result object, and returns an action object of type “SEARCH_SUCCESS”. We will dispatch this action upon a successful search API call.

Redux Thunk: Search

Let’s explore how the “Get search result” from earlier works. First, we need to make a remote API call to our backend API server. When the request receives a successful JSON response, we’ll dispatch the searchSuccess action along with the payload to searchReducer.

Knowing that we’ll need to dispatch after an asynchronous call completes, we’ll make use of Redux Thunk. Thunk comes into play for making multiple dispatches or delaying a dispatch. With Thunk, our updated flow of events looks like this:

For this, we define a function that takes in a single argument title and serves as the initial search action. Thisfunction is responsible for fetching the search result and dispatching a searchSuccess action:

//searchActions.jsimport apiClient from '../apiClient';
...
export function search(title) { return (dispatch) => { apiClient.query(title) .then(response => { dispatch(searchSuccess(response.data)) }); }}

We’ve set up our API client beforehand, and you can read more about how I set up the API client here. The apiClient.query method simply performs an AJAX GET request to our backend server and returns a Promise with the response data.

We can then connect this function as an action dispatch to our SearchContainer component:

//SearchContainer.js
import React from 'react';import { connect } from 'react-redux';import { search } from '../actions/searchActions';
...
const mapStateToProps = (state) => ( { result: state.search, });
const mapDispatchToProps = (dispatch) => ( { search(title) { dispatch(search(title)) }, });
export default connect(mapStateToProps, mapDispatchToProps)(SearchContainer);

When a search request succeeds, our SearchContainer component will render the movie result:

Handling Other Search Statuses

Now we have our search action working properly and connected to our SearchContainer component, we’d like to handle other cases other than a successful search.

Search request pending

When a user submits a search, we’ll display a loading animation to indicate that the search request is pending:

Search request succeeds

If the search fails, we’ll display an appropriate error message to the user. This is useful to provide some context. A search failure could happen in cases where a movie title is not available, or our server is experiencing issues communicating with the OMDb API.

To handle different search statuses, we’ll need a way to store and update the current status along with any error messages.

Status Reducer

The statusReducer is responsible for tracking state changes whenever a user performs an action. The current state of an action can be represented by one of the three “statuses”:

  • Pending (when a user first initiates the action)
  • Success (when a request returns a successful response)
  • Error (when a request returns an error response)

With these statuses in place, we can render different UIs based on the current status of a given action type. In this case, we’ll focus on tracking the status of the search action.

We’ll start by implementing the statusReducer. For the initial state, we need to track the current search status and any errors:

// statusReducer.jsconst initialState = { search: '', // status of the current search searchError: '', // error message when a search fails}

Next, we need to define the reducer function. Whenever our SearchContainer dispatches a “SEARCH_[STATUS]” action, we will update the store by replacing the search and searchError properties.

// statusReducer.js
...
export default (state = initialState, action) => { const actionHandlers = { 'SEARCH_REQUEST': { search: 'PENDING', searchError: '', }, 'SEARCH_SUCCESS': { search: 'SUCCESS', searchError: '', }, 'SEARCH_FAILURE': { search: 'ERROR', searchError: action.error, }, } const propsToUpdate = actionHandlers[action.type]; state = Object.assign({}, state, propsToUpdate); return state;}

We use an actionHandlers hash table here since we are only replacing the state’s properties. Furthermore, it improves readability more than using if/else or case statements.

With our statusReducer in place, we can render the UI based on different search statuses. We will update our flow of events to this:

We now have additional searchRequest and searchFailure actions available to dispatch to the store:

//searchActions.js
export const searchRequest = () => ({ type: 'SEARCH_REQUEST'});
export const searchFailure = (error) => ({ type: 'SEARCH_FAILURE', error});

To update our search action, we will dispatch searchRequest immediately and will dispatch searchSuccess or searchFailure based on the eventual success or failure of the Promise returned by Axios:

//searchActions.js
...
export function search(title) { return (dispatch) => { dispatch(searchRequest());
apiClient.query(title) .then(response => { dispatch(searchSuccess(response.data)) }) .catch(error => { dispatch(searchFailure(error.response.data)) }); }}

We can now connect the search status state to our SearchContainer, passing it as a prop. Whenever our store receives the state changes, our SearchContainer renders a loading animation, an error message, or the search result:

//SearchContainer.js
...(imports omitted)
const SearchContainer = (props) => (   props.search(title) } /> { (props.searchStatus === 'SUCCESS') ?  : null } { (props.searchStatus === 'PENDING') ?    : null } { (props.searchStatus === 'ERROR') ?  

{ props.searchError }

: null } );
const mapStateToProps = (state) => ( { searchStatus: state.status.search, searchError: state.status.searchError, result: state.search, });
...

Favorites Reducer

We’ll need to handle CRUD actions performed by a user on the favorites list. Recalling from our API endpoints earlier, we’d like to allow users to perform the following actions and update our store accordingly:

  • Save a movie into the favorites list
  • Retrieve all favorited movies
  • Update a favorite’s rating
  • Delete a movie from the favorites list

To ensure that the reducer function is pure, we simply copy the old state into a new object together with any new properties usingObject.assign. Note that we only handle actions with types of _SUCCESS:

//favoritesReducer.js
export default (state = {}, action) => { switch (action.type) { case 'SAVE_FAVORITE_SUCCESS': state = Object.assign({}, state, action.favorite); break;
case 'GET_FAVORITES_SUCCESS': state = action.favorites; break;
case 'UPDATE_RATING_SUCCESS': state = Object.assign({}, state, action.favorite); break;
case 'DELETE_FAVORITE_SUCCESS': state = Object.assign({}, state); delete state[action.imdbID]; break;
default: return state; } return state;}

We’ll leave the initialState as an empty object. The reason is that if our initialState contains placeholder movie items, our app will render them immediately before waiting for the actual favorites list response from our backend API server.

From now on, each of the favorites action will follow a general flow of events illustrated below. The pattern is similar to the search action in the previous section, except right now we’ll skip handling any “PENDING” status.

Save Favorites Action

Take the save favorites action for example. The function makes an API call to with our apiClient and dispatches either a saveFavoriteSuccess or a saveFavoriteFailure action, depending on whether or not we receive a successful response:

//favoritesActions.jsimport apiClient from '../apiClient';
export const saveFavoriteSuccess = (favorite) => ({ type: 'SAVE_FAVORITE_SUCCESS', favorite});
export const saveFavoriteFailure = (error) => ({ type: 'SAVE_FAVORITE_FAILURE', error});
export function save(movie) { return (dispatch) => { apiClient.saveFavorite(movie) .then(res => { dispatch(saveFavoriteSuccess(res.data)) }) .catch(err => { dispatch(saveFavoriteFailure(err.response.data)) }); }}

We can now connect the save favorite action to AddFavoriteForm through React Redux.

To read more about how I handled the flow to display flash messages, click here.

Conclusion

Designing the frontend of an application requires some forethought, even when using a popular JavaScript library such as React. By thinking about how the data structures, components, APIs, and state management work as a whole, we can better anticipate edge cases and effectively fix errors when they arise. By using certain design patterns such as controlled components, Redux, and handling AJAX workflow using Thunk, we can streamline managing the flow of providing UI feedback to user actions. Ultimately, how we approach the design will have an impact on usability, clarity, and future scalability.

References

Fullstack React: The Complete Guide to ReactJS and Friends

About me

أنا مهندس برمجيات موجود في مدينة نيويورك وأحد مؤسسي SpaceCraft. لدي خبرة في تصميم التطبيقات ذات الصفحة الواحدة ، ومزامنة الحالة بين العديد من العملاء ، ونشر تطبيقات قابلة للتطوير باستخدام Docker.

أنا أبحث حاليًا عن فرصتي القادمة بدوام كامل! يرجى الاتصال إذا كنت تعتقد أنني سأكون مناسبًا لفريقك.