Hogyan készítsünk valós idejű csevegőalkalmazást a Node.js-ben az Express, a Mongoose és a Socket.io használatával

Ebben az oktatóanyagban a Node.js platform segítségével valós idejű csevegőalkalmazást készítünk, amely az oldal frissítése nélkül azonnal üzeneteket küld és jelenít meg a címzettnek. Ehhez a JavaScript Express.js keretrendszert, valamint a Mongoose és a Socket.io könyvtárakat fogjuk használni.

Mielőtt elkezdenénk, nézzük át gyorsan a Node.js alapjait

Node.js

A Node.js egy nyílt forráskódú, több platformon futó JavaScript futási környezet, amely a böngészőn kívül futtatja a JavaScript kódot. A Node használatának legfontosabb előnye, hogy a Java-t mind front-end, mind back-end nyelvként használhatjuk.

Mint tudjuk, a JavaScript-et elsősorban kliensoldali szkripteléshez használták, amelyben a szkripteket egy weboldal HTML-be ágyazta, és kliensoldalt futtatott egy JavaScript-motor a felhasználó böngészőjében.

A Node.js lehetővé teszi a fejlesztők számára a JavaScript használatát a parancssori eszközök írásához és a szerveroldali parancsfájlokhoz - a szkriptek szerveroldali futtatásával dinamikus weboldal-tartalmat állíthatnak elő, mielőtt az oldalt elküldenék a felhasználó webböngészőjébe.

A csomópont telepítése:

//nodejs.org/en/download/

Annak ellenére, hogy a csomópont egyszálú, mégis gyorsabb az aszinkron függvények használata. Például a Node más dolgokat is feldolgozhat, miközben egy fájlt olvas le a lemezről, vagy vár egy HTTP-kérelem befejezésére. Az aszinkron viselkedés visszahívásokkal valósítható meg. A JavaScript jól működik a JSON és a No-SQL adatbázisokkal is.

NPM modulok

A Nodejs lehetővé teszi a könyvtárak moduljainak az alkalmazásba történő felvételét. Ezek a modulok lehetnek felhasználó által definiált vagy harmadik féltől származó modulok.

A harmadik fél moduljai a következő paranccsal telepíthetők:

npm install module_name

és a telepített modulok a need () függvény segítségével használhatók :

var module = require(‘module_name’)

A Node alkalmazásokban a package.json fájlt fogjuk használni a modul verzióinak karbantartására. Ez a fájl a következő paranccsal hozható létre:

npm init

és a csomagokat a következőképpen kell felszerelni:

npm install -s module_name

Számos keretrendszer adható modulként a Node alkalmazásunkhoz. Ezeket a továbbiakban szükség szerint elmagyarázzuk.

Egyszerű Chat alkalmazás

Az alkalmazásnak lehetővé kell tennie több felhasználó beszélgetését. Az üzeneteket az oldal frissítése nélkül kell frissíteni. Az egyszerűség kedvéért elkerüljük a hitelesítési részt.

Kezdhetjük egy új projektkönyvtár létrehozásával és belépéssel. Ezután a következő paranccsal kezdeményezhetjük projektünket:

npm init

Ez arra késztet bennünket, hogy adjuk meg a projektünk részleteit.

Ezt követően egy package.json fájl jön létre:

{ “name”: “test”, “version”: “1.0.0”, “description”: “”, “main”: “index.js”, “scripts”: { “test”: “echo \”Error: no test specified\” && exit 1" }, “author”: “”, “license”: “ISC” }

Az alkalmazáskönyvtárunk most beállítva.

Az első dolog, amit létre kell hoznunk, az egy szerver. Ennek létrehozásához egy Express nevű keretrendszert fogunk használni .

Express.js

Az Express.js vagy egyszerűen az Express egy webalkalmazás-keretrendszer a Node.js fájlhoz. Az Express robusztus funkciókat kínál webes és mobilalkalmazásokhoz. Az Express vékony réteg alapvető webalkalmazás-szolgáltatásokat biztosít, anélkül, hogy eltakarja a Node.js szolgáltatásait.

Az Express.js fájlt a következő paranccsal telepítjük:

npm install -s express

A package.json fájlon belül egy új sor kerül hozzáadásra:

dependencies”: { “express”: “⁴.16.3” }

Ezután létrehozunk egy server.js fájlt.

Ebben a fájlban szükségünk van az Express-re, és hivatkozást kell létrehoznunk egy változóra az Express egyik példányából. Statikus tartalmak, például HTML, CSS vagy JavaScript, az express.js használatával szolgáltathatók:

var express = require(‘express’); var app = express();

és elkezdhetjük hallgatni a portot a kód segítségével:

var server = app.listen(3000, () => { console.log(‘server is running on port’, server.address().port); });

Most létre kell hoznunk egy index.html HTML fájlt, amely megjeleníti a felhasználói felületünket. Hozzáadtam a bootstrap-ot és a JQuery cdn-t.

//index.html    
    

Send Message

Send

Felhívjuk figyelmét, hogy az üres < ; / script> címke lesz az a hely, ahova az ügyféloldali JavaScript kódot írjuk.

Annak érdekében, hogy ezt elmondhassuk az Express-nek, statikus fájlt fogunk használni. Hozzáadunk egy új sort a server.js-en belül :

app.use(express.static(__dirname));

A server.js parancsot futtathatjuk

node ./server.js

or a package called nodemon, so that the changes made in the code will be automatically detected. We will download nodemon using the command

npm install -g nodemon

-g — global, so that it is accessible in all projects.

We will run the code using the command

nodemon ./server.js

If you go to localhost:3000 we can see the index file:

Now that our server is up and running, we need to create our database. For this app we will having a No-SQL database and will be using Mongodb. I am setting up my mongodb in mlab.com. Our database will contain a single collection called messages with fields name and message.

In-order to connect this database to the app, we will use another package called Mongoose.

Mongoose

Mongoose is a MongoDB object modeling tool designed to work in an asynchronous environment. Mongoose can be installed using the command

npm install -s mongoose

Inside server.js we will require mongoose:

var mongoose = require(‘mongoose’);

And we will assign a variable, the URL of our mlab database:

var dbUrl = ‘mongodb://username:[email protected]:57981/simple-chat’

Mongoose will connect to the mlab database with the connect method:

mongoose.connect(dbUrl , (err) => { console.log(‘mongodb connected’,err); })

And we will be defining our message model as

var Message = mongoose.model(‘Message’,{ name : String, message : String})

We can implement the chat logic now. But before that there is one more package that needs to be added.

Body-Parser

Body-Parser extracts the entire body portion of an incoming request stream and exposes it on req.body. The middleware was a part of Express.js earlier, but now you have to install it separately.

Install it using the following command:

npm install -s body-parser

Add the following codes to server.js:

var bodyParser = require(‘body-parser’) app.use(bodyParser.json()); app.use(bodyParser.urlencoded({extended: false}))

Routing

Routing refers to how an application’s endpoints (URIs) respond to client requests. You define routing using methods of the Express app object that correspond to HTTP methods: app.get() to handle GET requests and app.post() to handle POST requests.

These routing methods specify a callback function (sometimes called “handler functions”) called when the application receives a request to the specified route (endpoint) and HTTP method. In other words, the application “listens” for requests that match the specified routes and methods, and when it detects a match, it calls the specified callback function.

Now we need to create two routes to the messages for our chat to work.

Inside server.js:

get : will get all the message from database

app.get('/messages', (req, res) => { Message.find({},(err, messages)=> { res.send(messages); }) })

post : will post new messages created by the user to the database

app.post('/messages', (req, res) => { var message = new Message(req.body); message.save((err) =>{ if(err) sendStatus(500); res.sendStatus(200); }) })

In order to connect these routes to the front end we need to add the following code in the client side script tag in the index.html:

$(() => { $("#send").click(()=>{ sendMessage({ name: $("#name").val(), message:$("#message").val()}); }) getMessages() }) function addMessages(message){ $(“#messages”).append(` 

${message.name}

${message.message}

`) } function getMessages(){ $.get(‘//localhost:3000/messages', (data) => { data.forEach(addMessages); }) } function sendMessage(message){ $.post(‘//localhost:3000/messages', message) }

Here the sendMessage is used to invoke the post route of the messages, and save a message sent by the user. The message is created when a user clicks the send button.

Similarly the getMessage is used to invoke the get route of messages. This will get all the messages saved in the database and will be appended to the messages div.

The only issue now is that there is no way for the client to know if the server is updated. So each time we post a message we need to refresh the page to see the new messages.

To solve this we can add a push notification system that will send messages from server to client. In Node.js we use socket.io.

Socket.io

Socket.IO is a JavaScript library for realtime web applications. It enables realtime, bi-directional communication between web clients and server. It has two parts: a client-side library that runs in the browser, and a server-side library for Node.js. Socket.io enables real-time bidirectional event-based communication.

To install socket.io:

npm install -s socket.io

we also need an HTTP package for Socket.io to work:

npm install -s http

Add the following code to server.js:

var http = require(‘http’).Server(app); var io = require(‘socket.io’)(http);

And we can create a connection:

io.on(‘connection’, () =>{ console.log(‘a user is connected’) })

In the index.html add the following tag:

Now we need to create an emit action when a message is created in server.js. So the post route becomes this:

app.post('/messages', (req, res) => { var message = new Message(req.body); message.save((err) =>{ if(err) sendStatus(500); io.emit('message', req.body); res.sendStatus(200); }) })

And in the client side script tag in index.html, add the following code:

var socket = io(); socket.on(‘message’, addMessages)

So each time a message is posted, the server will update the messages in the message div.

Great!!

This is very basic application that we can create in Node.js. There is lot of scope for improvement. The finished code can be found in //github.com/amkurian/simple-chat

server.js

var express = require('express'); var bodyParser = require('body-parser') var app = express(); var http = require('http').Server(app); var io = require('socket.io')(http); var mongoose = require('mongoose'); app.use(express.static(__dirname)); app.use(bodyParser.json()); app.use(bodyParser.urlencoded({extended: false})) var Message = mongoose.model('Message',{ name : String, message : String }) var dbUrl = 'mongodb://username:[email protected]:57981/simple-chat' app.get('/messages', (req, res) => { Message.find({},(err, messages)=> { res.send(messages); }) }) app.get('/messages', (req, res) => { Message.find({},(err, messages)=> { res.send(messages); }) }) app.post('/messages', (req, res) => { var message = new Message(req.body); message.save((err) =>{ if(err) sendStatus(500); io.emit('message', req.body); res.sendStatus(200); }) }) io.on('connection', () =>{ console.log('a user is connected') }) mongoose.connect(dbUrl ,{useMongoClient : true} ,(err) => { console.log('mongodb connected',err); }) var server = http.listen(3001, () => { console.log('server is running on port', server.address().port); });

Hope this was helpful in understanding some basic concepts.

Some useful links

Socket.IO

SOCKET.IO 2.0 IS HERE FEATURING THE FASTEST AND MOST RELIABLE REAL-TIME ENGINE ~/Projects/tweets/index.js var io =…socket.ioExpress - Node.js web application framework

Express is a minimal and flexible Node.js web application framework that provides a robust set of features for web and…expressjs.com

//mongoosejs.com/