So erstellen Sie eine Echtzeit-App mit Socket.io, React, Node & MongoDB

Haben Sie sich jemals gefragt, wie Echtzeit-Apps erstellt werden? Haben Sie jemals die Bedeutung und Anwendungsfälle von Echtzeitanwendungen bemerkt?

Wenn Sie neugierig auf die oben genannten Fragen sind und eine Antwort benötigen, ist dieser Blog-Beitrag genau das Richtige für Sie.

Lassen Sie uns zunächst einige Anwendungsfälle identifizieren, für die Echtzeitanwendungen erforderlich sind:

  1. Abrufen von Standortaktualisierungen für Ihr Taxi auf einer Karte einer Taxibuchungsanwendung.
  2. Erhalten Sie sofort neue Nachrichten in Ihrer bevorzugten Chat-Anwendung.
  3. Aktualisierung der Lebensmittelbestellinformationen in der Küche Ihres Lieblingsrestaurants.

Dies alles sind die gängigen Szenarien unseres täglichen Lebens, in denen wir eine Verzögerung bei der Aktualisierung von Informationen nicht tolerieren können und daher Echtzeitkommunikation benötigen.

Technologien , die für die Echtzeitkommunikation verwendet werden können, sind:

  1. Kurzes Polling : AJAX erzeugt starken Verkehr.
  2. Lange Abfrage : Wie AJAX, aber der Server behält die Antwort bei, bis ein Update vorliegt. Nach dem Empfang sendet der Client eine weitere Anforderung und benötigt einen zusätzlichen Header, der hin und her durchlaufen wird, was zusätzlichen Overhead verursacht.
  3. Web Sockets : Ermöglichen das Öffnen der interaktiven Kommunikation zwischen Client und Server. Sie können eine Anfrage an den Server senden und ereignisgesteuerte Antworten empfangen, ohne den Server nach einer Antwort abzufragen. Dies macht Web-Sockets zur besten Wahl für unseren Anwendungsfall.

Weitere Informationen zu den oben genannten drei Technologien finden Sie hier.

Wir werden lernen, eine Echtzeitanwendung zu erstellen, indem wir das folgende Szenario behandeln.

Stellen Sie sich vor, Sie sitzen in Ihrem Lieblingsrestaurant und haben ein digitales Menü. Sie geben die Bestellung auf und die Küche wird in Echtzeit bezüglich Ihrer Bestellung aktualisiert. Wenn die Küche mit der Bestellung fertig ist, wird sie auch in Echtzeit aktualisiert.

Merkmale im Detail:

  1. Bestellung aufgeben: Schnittstelle zur Auswahl der Menge und zur Bestellung eines ausgewählten Lebensmittels in der Küche.
  2. Küche : Schnittstelle, die über mehrere Küchen hinweg geöffnet werden kann und die Köche und Köche in Echtzeit über die Gesamtzahl der erstellten Bestellungen und die vorhergesagte Menge an Lebensmitteln informiert, sodass sie diese flexibel aktualisieren können. Hat auch eine Funktion zum Herunterladen des Berichts in Form eines Excel-Blattes.
  3. Voraussichtliche Änderung : Schnittstelle zum Aktualisieren der vorhergesagten Menge an Lebensmitteln.

Eine Live-Demo dieses Szenarios finden Sie hier.

Öffnen Sie es zum besseren Verständnis gleichzeitig auf verschiedenen Registerkarten / Geräten, um zu sehen, wie sich die Daten in Echtzeit ändern.

Der Quellcode ist hier. Fühlen Sie sich frei, etwas Innovatives / Nützliches darüber zu machen.

Also lasst uns anfangen.

Technologie-Stack:

Frontend : React.js, Reactstrap, Socket.io

Backend : Node.js (Express), MongoDB, Socket.io

Ordnerstruktur:

/* Go to the root directory in the source code and find out the below-mentioned files. This architecture helps in creating a big modular App. */ backend-my-app/ /* Backend code of the app */ server.js /* Socket and backend code resides here*/ build/ /* Optional for deployment of Frontend Build */ package.json /* Backend dependency */ ... public/ src/ /* Frontend Sourcecode */ global/ /* Components getting used everywhere */ header.css header.js main/ Kitchen.js PlaceOrder.js UpdatePredicted.js App.js /* Routing logic and component assembly part */ package.json /* Frontend dependency */ ............

Erklärung des Quellcodes:

Vorderes Ende:

git clone //github.com/honey93/OrderKitchen.git cd OrderKitchen npm install npm start

Verwendete Pakete:

  1. Reactstrap: Einfach zu verwendende Bootstrap4-Komponenten
  2. Socket.io: Socket.io ist eine Bibliothek, die eine bidirektionale und ereignisbasierte Echtzeitkommunikation zwischen dem Browser und dem Server ermöglicht.
  3. react-html-table-to-excel: Bietet eine clientseitige Generierung von Excel-Dateien (.xls) aus HTML-Tabellenelementen.
  4. React-Router-Dom: DOM-Bindungen für React-Router. Es besteht aus vielen wichtigen Komponenten wie BrowserRouter, die verwendet werden, wenn ein Server für dynamische Anforderungen, Switches, Routen usw. vorhanden ist.

App-Komponente

Pfad : src / App.js.

Diese Komponente enthält die Hauptroutinglogik des Frontends. Diese Datei wird in src / index.js im Browser-Router-Modul verwendet. Der folgende Code zeigt einen der Ansätze, um Ihre App modular zu halten.

import React, { Component } from "react"; import "./App.css"; import { Header } from "./global/header"; import { Switch, Route } from "react-router-dom"; import PlaceOrder from "./main/PlaceOrder"; import UpdatePredicted from "./main/UpdatePredicted"; import Kitchen from "./main/Kitchen"; /*The  component is the main part of React Router. Anywhere that you want to only render content based on the location’s pathname, you should use a  element. */ /* The Route component expects a path prop, which is a string that describes the pathname that the route matches */ /* The  will iterate over routes and only render the first one that matches the current pathname */ class App extends Component { render() { return ( ); } } export default App;

Header-Komponente

Pfad : src / global / header.js

Diese Komponente wird häufig verwendet und in den Abschnitten "Bestellung aufgeben", "Voraussichtliche Änderung" und "Küche" verwendet. Dieser Ansatz hilft, Codeduplikationen zu vermeiden und die Anwendung modular zu halten.

import React, { Component } from "react"; import { NavLink } from "react-router-dom"; import socketIOClient from "socket.io-client"; import "./header.css"; // The Header creates links that can be used to navigate // between routes. var socket; class Header extends Component { /* Creating a Socket client and exporting it at the end to be used across the Place Order, Kitchen, etc components*/ constructor() { super(); this.state = { endpoint: '//localhost:3001/' }; socket = socketIOClient(this.state.endpoint); } render() { return (   
  • Place Order
  • Change Predicted
  • Kitchen
); } } export { Header, socket };

Küchenkomponente

Pfad : src / main / Kitchen.js

Die Logik und der HTML-Code der Benutzeroberfläche von Kitchen Screen befinden sich in dieser Komponente:

import React, { Component } from "react"; import { Button, Table, Container } from "reactstrap"; import { socket } from "../global/header"; import ReactHTMLTableToExcel from "react-html-table-to-excel"; class Kitchen extends Component { constructor() { super(); this.state = { food_data: [] // this is where we are connecting to with sockets, }; } getData = foodItems => { console.log(foodItems); this.setState({ food_data: foodItems }); }; changeData = () => socket.emit("initial_data"); /*As soon as the component gets mounted ie in componentDidMount method, firing the initial_data event to get the data to initialize the Kitchen Dashboard */ /* Adding change_data listener for listening to any changes made by Place Order and Predicted Order components*/ componentDidMount() { var state_current = this; socket.emit("initial_data"); socket.on("get_data", this.getData); socket.on("change_data", this.changeData); } /* Removing the listener before unmounting the component in order to avoid addition of multiple listener at the time revisit*/ componentWillUnmount() { socket.off("get_data"); socket.off("change_data"); } /* When Done gets clicked, this function is called and mark_done event gets emitted which gets listened on the backend explained later on*/ markDone = id => { // console.log(predicted_details); socket.emit("mark_done", id); }; getFoodData() { return this.state.food_data.map(food => { return (  {food.name}  {food.ordQty}  {food.prodQty}  {food.predQty}   this.markDone(food._id)}>Done  ); }); } render() { return (  

Kitchen Area

{this.getFoodData()}
NameQuantityCreated Till NowPredictedStatus
); } } export default Kitchen;

Bestellkomponente aufgeben

Path: src/main/PlaceOrder.js

import React, { Component } from "react"; import { Button, Table, Container } from "reactstrap"; import { socket } from "../global/header"; class PlaceOrder extends Component { constructor() { super(); this.state = { food_data: [] // this is where we are connecting to with sockets, }; } getData = foodItems => { console.log(foodItems); foodItems = foodItems.map(food => { food.order = 0; return food; }); this.setState({ food_data: foodItems }); }; componentDidMount() { socket.emit("initial_data"); var state_current = this; socket.on("get_data", state_current.getData); } componentWillUnmount() { socket.off("get_data", this.getData); } //Function to place the order. sendOrder = id => { var order_details; this.state.food_data.map(food => { if (food._id == id) { order_details = food; } return food; }); console.log(order_details); socket.emit("putOrder", order_details); var new_array = this.state.food_data.map(food => { food.order = 0; return food; }); this.setState({ food_data: new_array }); }; // Changing the quantity in the state which is emitted to the backend at the time of placing the order. changeQuantity = (event, foodid) => { if (parseInt(event.target.value)  { if (food._id == foodid) { food.order = parseInt(event.target.value); } return food; }); this.setState({ food_data: new_array }); }; // To get the initial data getFoodData() { return this.state.food_data.map(food => { return (  {food.name}   this.changeQuantity(e, food._id)} value={food.order} type="number" placeholder="Quantity" />  this.sendOrder(food._id)}>Order  ); }); } render() { return (  

Order Menu

{this.getFoodData()}
ProductQuantityOrder
); } } export default PlaceOrder;

One more section called Update Predicted Path: src/main/UpdatePredicted.js similar to above section is there in the code repository.

Backend

Starting the Backend:

cd backend-my-app npm install node server.js

Packages used:

  1. Monk: A tiny layer that provides simple yet substantial usability improvements for MongoDB usage within Node.JS.
  2. Socket.io: Socket.io is a library that enables real-time, bidirectional and event-based communication between the browser and the server.

3. Express: Fast, minimalist web framework for node.

Main Code

Path: backend-my-app/server.js

const express = require("express"); const http = require("http"); const socketIO = require("socket.io"); // Connection string of MongoDb database hosted on Mlab or locally var connection_string = "**********"; // Collection name should be "FoodItems", only one collection as of now. // Document format should be as mentioned below, at least one such document: // { // "_id": { // "$oid": "5c0a1bdfe7179a6ca0844567" // }, // "name": "Veg Roll", // "predQty": 100, // "prodQty": 295, // "ordQty": 1 // } const db = require("monk")(connection_string); const collection_foodItems = db.get("FoodItems"); // our localhost port const port = process.env.PORT || 3000; const app = express(); // our server instance const server = http.createServer(app); // This creates our socket using the instance of the server const io = socketIO(server); io.on("connection", socket => { // console.log("New client connected" + socket.id); //console.log(socket); // Returning the initial data of food menu from FoodItems collection socket.on("initial_data", () => { collection_foodItems.find({}).then(docs => { io.sockets.emit("get_data", docs); }); }); // Placing the order, gets called from /src/main/PlaceOrder.js of Frontend socket.on("putOrder", order => { collection_foodItems .update({ _id: order._id }, { $inc: { ordQty: order.order } }) .then(updatedDoc => { // Emitting event to update the Kitchen opened across the devices with the realtime order values io.sockets.emit("change_data"); }); }); // Order completion, gets called from /src/main/Kitchen.js socket.on("mark_done", id => { collection_foodItems .update({ _id: id }, { $inc: { ordQty: -1, prodQty: 1 } }) .then(updatedDoc => { //Updating the different Kitchen area with the current Status. io.sockets.emit("change_data"); }); }); // Functionality to change the predicted quantity value, called from /src/main/UpdatePredicted.js socket.on("ChangePred", predicted_data => { collection_foodItems .update( { _id: predicted_data._id }, { $set: { predQty: predicted_data.predQty } } ) .then(updatedDoc => { // Socket event to update the Predicted quantity across the Kitchen io.sockets.emit("change_data"); }); }); // disconnect is fired when a client leaves the server socket.on("disconnect", () => { console.log("user disconnected"); }); }); /* Below mentioned steps are performed to return the Frontend build of create-react-app from build folder of backend Comment it out if running locally*/ app.use(express.static("build")); app.use("/kitchen", express.static("build")); app.use("/updatepredicted", express.static("build")); server.listen(port, () => console.log(`Listening on port ${port}`));

Database: MongoDB

Mlab: Database as a service for MongoDB

Collection Name: FoodItems

Document format: At least one document is needed in the FoodItems collection with the below mentioned format.

{ "name": "Veg Roll", // Food Name "predQty": 100, // Predicted Quantity "prodQty": 295, // Produced Quantity "ordQty": 1 // Total Order Quantity }

Hope you got the understanding of how to create a modular real time app using the trending MERN stack. If you found it helpful clap below, give stars to the project repo and share with your friends too.