Google+
4elements web design & consultancy

Shineyrock

web design & consultancy
Shineyrock web design & consultancy

Shineyrock

  1. web design and consultancy

blog

  1. Home
  2. blog
  3. read
  4. Node.js for Beginners
  • like 1 19

    Node.js for Beginners

    1. January 2014
    2. Daily
    3. read 0

    Event-driven programming can be overwhelming for beginners, which can make Node.js difficult to get started with. But don't let that discourage you. In this article, I will teach you some of the basics of Node.js and explain why it has become so popular.

    Introduction

    To start using Node.js, you must first understand the differences between Node.js and traditional server-side scripting environments like PHP, Python, or Ruby.

    Asynchronous Programming

    Chances are good that you are familiar with asynchronous programming; it is, after all, the "A" in AJAX. Every function in Node is asynchronous. Therefore, everything that would normally block the thread is instead executed in the background using promises. This is the most important thing to remember about Node. For example, if you are reading a file on the file system, you will use an asynchronous function.

    If you are using certain versions of Node functions, you use callbacks, which were designed before promises existed. Most Node functions have promise equivalents now, so it's a good idea to convert the callback functions used here to their promise-based equivalents and compare the syntax.

    You Are Doing Everything!

    With Node, you have to do a lot yourself. For example, the HTTP module is minimal and unopinionated. This can be overwhelming for new users, but the payoff is a high-performing web app (although a large part of JavaScript's performance is because of V8's optimized engine). One script handles all communication with the clients. This considerably reduces the number of resources used by the application. For example, here is the code for a simple Node.js application:

    const i, a, b, c, max;

max = 1000000000;

var d = Date.now();

for (i = 0; i < max; i++) {
    a = 1234 + 5678 + i;
    b = 1234 * 5678 + i;
    c = 1234 / 2 + i;
}

console.log(Date.now() - d);

    And here is the equivalent written in PHP:

    $a = null;
$b = null;
$c = null;
$i = null;
$max = 1000000000;

$start = microtime(true);

for ($i = 0; $i < $max; $i++) {
    $a = 1234 + 5678 + $i;
    $b = 1234 * 5678 + $i;
    $c = 1234 / 2 + $i;
}

var_dump(microtime(true) - $start);

    Now let's look at the benchmark numbers. The following table lists the response times, in milliseconds, for these two simple applications:

    Number of iterations Node.js PHP
    100 2.00 0.14
    10'000 3.00 10.53
    1'000'000 15.00 1119.24
    10'000'000 143.00 10621.46
    1'000'000'000 11118.00 1036272.19

    I executed the two apps from the command line so that no server would delay the apps' execution. I ran each test ten times and averaged the results. PHP is notably faster with a smaller number of iterations, but that advantage quickly dissolves as the number of iterations increases. When all is said and done, PHP is 93% slower than Node.js!

    Node.js is fast, but you will need to learn a few things in order to use it properly.

    Modules

    Node.js uses a module architecture to simplify the creation of complex applications. Modules are akin to libraries in C or units in Pascal. Each module is private by default but can export various values (for example, functions) to other modules, which can import them. For example, the http module contains functions specific to HTTP.

    Node.js provides a few core modules out of the box to help you access files on the file system, create HTTP and TCP/UDP servers, and perform other useful functions. There are two different methods of using modules, CommonJS (CJS) and ECMAScript Modules (ESM). CommonJS is most commonly used in legacy Node programs, whereas ECMAScript Modules are used in browsers and more modern Node programs.

    CommonJS

    Including a module is easy; simply call the require() function, like this:

    const http = require('http');

    The require() function returns the reference to the specified module. In the case of this code, a reference to the http module is stored in the http variable.

    In the above code, we passed the name of a module to the require() function. This causes Node to search for a node_modules folder in our application's directory and search for the http module in that folder. If Node does not find the node_modules folder (or the http module within it), it then looks through the global module cache. You can also specify an actual file by passing a relative or absolute path, like so:

    const myModule = require('./myModule.js');

    To export a value that can be required, use the exports object and populate its properties and methods with the pieces of code that you want to expose. Consider the following module as an example:

    exports.area = function (r) {
  return Math.PI * r ** 2;
};

exports.circumference = function (r) {
  return 2 * Math.PI * r;
};

    This code creates a PI variable that can only be accessed by code contained within the module; it is not accessible outside of the module. Next, two functions are created on the exports object. These functions are accessible outside of the module because they are defined on the exports object. As a result, PI is completely protected from outside interference. Therefore, you can rest assured that area() and circumference() will always behave as they should (as long as a value is supplied for the r parameter).

    ECMAScript Modules

    To include a module, you use the import keyword:

    // file
import myModule from "./myModule.js"
// Node builtin/package
import http from "http"

    In the browser, ESM can only search using relative file paths, like the above. However, in Node, you can pass a path without ./ to search for a Node built-in or NPM package instead. Another way to import Node built-ins and packages is to use the node: prefix.

    However, the previous approach only works with default exports. If you are using named exports (more on those later), you will need to use a slightly different syntax.

    import { exportOne, exportTwo } from "./myModule.js"

    To export something, use the export or export default keyword. Export is for named exports, and export default is for default exports. Named exports allow you to export different things and only use one of them in a different module using the import syntax above. Default exports make it easier if you are only exporting a single thing.

    // Named exports
export function exportOne() {
    ...
}
export function exportTwo() {
    ...
}
// Default exports
export default function defaultFunction() {
    ...
}

    For the rest of this tutorial, we will be using ESM.

    Global Scope

    Node is a JavaScript environment running in Google's V8 JavaScript engine. As such, we should follow the best practices that we use for client-side development. For example, we should avoid putting anything into the global scope. That, however, is not always possible. The global scope in Node is GLOBAL (as opposed to window in the browser), and you can easily create a global variable of a function by omitting the var keyword, like this:

    globalVariable = 1;
globalFunction = function () { ... };

    Once again, globals should be avoided whenever possible. So be careful, and remember to use var when declaring a variable.

    Installation

    Naturally, we need to install Node before we can write and execute an app. Installation is straightforward if you use Windows or macOS; the nodejs.org website offers installers for those operating systems. For Linux, use any package manager. For example, if you are using a distro that supports apt, open up your terminal and type:

    sudo apt-get update
sudo apt-get install node

    or:

    sudo aptitude update
sudo aptitude install node

    Node.js is in sid repositories; you may need to add them to your sources list:

    sudo echo deb https://ftp.us.debian.org/debian/ sid main > /etc/apt/sources.list.d/sid.list

    But be aware that installing sid packages on older systems may break your system. Be careful, and remove /etc/apt/sources.list.d/sid.list after you finish installing Node.

    Installing New Modules

    Node.js has a package manager, called Node Package Manager (NPM). It is automatically installed with Node.js, and you use NPM to install new modules. To install a module, open your terminal/command line, navigate to the desired folder, and execute the following command:

    npm install module_name

    It doesn't matter what OS you have; the above command will install the module you specify in place of module_name.

    The Hello World App

    Naturally, our first Node.js script will print the text 'Hello World!' to the console. Create a file called hello.js, and type the following code:

    console.log('Hello World!');

    Now let's execute the script. Open the terminal/command line, navigate to the folder that contains hello.js, and execute the following command:

    node hello.js

    You should see 'Hello World!' displayed in the console.

    HTTP Server

    Let's move on to a more advanced application; it's not as complicated as you may think. Let's start with the following code. Read the comments and then the explanation below:

    // Include http module.
import { createServer } from "http"

// Create the server. Function passed as parameter is called on every request made.
// request variable holds all request parameters
// response variable allows you to do anything with response sent to the client.
createServer(function (request, response) {
    // Attach listener on end event.
	// This event is called when client sent all data and is waiting for response.
	request.on("end", function () {
		// Write headers to the response.
		// 200 is HTTP status code (this one means success)
		// Second parameter holds header fields in object
		// We are sending plain text, so Content-Type should be text/plain
		response.writeHead(200, {
			'Content-Type': 'text/plain'
		});
		// Send data and end response.
		response.end('Hello HTTP!');
	});
// Listen on the 8080 port.
}).listen(8080);

    This code is very simple. You can send more data to the client by using the response.write() method, but you have to call it before calling response.end(). Save this code as http.js and type the following command into your console:

    node http.js

    Open up your browser and navigate to http://localhost:8080. You should see the text Hello HTTP! on the page.

    Handling URL Parameters

    As I mentioned earlier, we have to do everything ourselves in Node, including parsing request arguments. This is, however, fairly simple. Take a look at the following code:

    // Include createServer
import { createServer} from "http"
// And url module, which is very helpful in parsing request parameters.
    url = require("url");

// Create the server.
createServer(function (request, response) {
	// Attach listener on end event.
	request.on('end', function () {
		// Parse the request for arguments and store them in _get variable.
		// This function parses the url from request and returns object representation.
		var _get = url.parse(request.url, true).query;
		// Write headers to the response.
		response.writeHead(200, {
			'Content-Type': 'text/plain'
		});
		// Send data and end response.
		response.end('Here is your data: ' + _get['data']);
	});
// Listen on the 8080 port.
}).listen(8080);

    This code uses the parse() method of the url module, a core Node.js module, to convert the request's URL to an object. The returned object has a query property, which retrieves the URL's parameters. Save this file as get.js and execute it with the following command:

    node get.js

    Then, navigate to http://localhost:8080/?data=put_some_text_here in your browser. Naturally, changing the value of the data parameter will not break the script.

    Reading and Writing Files

    To manage files in Node, we use the fs module (a core module). We read and write files using the fs.readFile() and fs.writeFile() methods, respectively. I will explain the arguments after the following code:

    // Include createServer,
import { createServer } from "http"
// And fs functions
import { readFile, writeFile } from "fs"

// Create the http server.
createServer(function (request, response) {
	// Attach listener on end event.
	request.on("end", function () {
		// Read the file.
		readFile("test.txt", 'utf-8', function (error, data) {
			// Write headers.
			response.writeHead(200, {
				'Content-Type': 'text/plain'
			});
			// Increment the number obtained from file.
			data = parseInt(data) + 1;
			// Write incremented number to file.
			writeFile('test.txt', data);
			// End response with some nice message.
			response.end('This page was refreshed ' + data + ' times!');
		});
	});
// Listen on the 8080 port.
}).listen(8080);

    Save this as files.js. Before you run this script, create a file named test.txt in the same directory as files.js.

    This code demonstrates the fs.readFile() and fs.writeFile() methods. Every time the server receives a request, the script reads a number from the file, increments the number, and writes the new number to the file. The fs.readFile() method accepts three arguments: the name of the file to read, the expected encoding, and the callback function.

    Writing to the file, at least in this case, is much simpler. We don't need to wait for any results, although you would check for errors in a real application. The fs.writeFile() method accepts the file name and data as arguments. It also accepts third and fourth arguments (both are optional) to specify the encoding and callback function, respectively.

    Now, let's run this script with the following command:

    node files.js

    Open it in the browser at http://localhost:8080 and refresh it a few times. Now, you may think that there is an error in the code because it seems to increment by two. This isn't an error. Every time you request this URL, two requests are sent to the server. The first request is automatically made by the browser, which requests favicon.ico, and of course, the second request is for the URL (http://localhost:8080).

    Even though this behavior is technically not an error, it is behavior that we do not want. We can fix this easily by checking the request URL. Here is the revised code:

    // Include createServer,
import { createServer } from "http"
// And fs functions
import { readFile, writeFile } from "fs"

// Create the http server.
createServer(function (request, response) {
	// Attach listener on end event.
	request.on('end', function () {
		// Check if user requests /
		if (request.url == '/') {
			// Read the file.
			readFile('test.txt', 'utf-8', function (error, data) {
				// Write headers.
				response.writeHead(200, {
					'Content-Type': 'text/plain'
				});
				// Increment the number obtained from file.
				data = parseInt(data) + 1;
				// Write incremented number to file.
				writeFile('test.txt', data);
				// End response with some nice message.
				response.end('This page was refreshed ' + data + ' times!');
			});
		} else {
			// Indicate that requested file was not found.
			response.writeHead(404);
			// And end request without sending any data.
			response.end();
		}
	});
// Listen on the 8080 port.
}).listen(8080);

    Test it now; it should work as expected.

    Accessing MySQL Databases

    Most traditional server-side technologies have a built-in means of connecting to and querying a database. With Node.js, you have to install a library. For this tutorial, I've picked the stable and easy-to-use node-mysql. The full name of this module is mysql@2.0.0-alpha2 (everything after the @ is the version number). Open your console, navigate to the directory where you've stored your scripts, and execute the following command:

    npm install mysql

    This downloads and installs the module, and it also creates the node_modules folder in the current directory. Now let's look at how we can use this in our code; see the following example:

    // Include http module,
import { createServer } from "http"
// And mysql module you've just installed.
import * as mysql from "mysql"

// Create the connection.
// Data is default to new mysql installation and should be changed according to your configuration.
const connection = mysql.createConnection({
	user: "root",
	password: "",
	database: "db_name"
});

// Create the http server.
createServer(function (request, response) {
	// Attach listener on end event.
	request.on('end', function () {
		// Query the database.
		connection.query('SELECT * FROM your_table;', function (error, rows, fields) {
			response.writeHead(200, {
				'Content-Type': 'x-application/json'
			});
			// Send data as JSON string.
			// Rows variable holds the result of the query.
			response.end(JSON.stringify(rows));
		});
	});
// Listen on the 8080 port.
}).listen(8080);

    Querying the database with this library is easy; simply enter the query string and callback function. In a real application, you should check if there were errors (the error parameter will not be undefined if errors occurred) and send response codes dependent upon the success or failure of the query. Also note that we have set the Content-Type to x-application/json, which is the valid MIME type for JSON. The rows parameter contains the result of the query, and we simply convert the data in rows to a JSON structure using the JSON.stringify() method.

    Save this file as mysql.js, and execute it (if you have MySQL installed, that is):

    node mysql.js

    Navigate to http://localhost:8080 in your browser, and you should be prompted to download the JSON-formatted file.

    Conclusion

    Node.js requires extra work, but the payoff of a fast and robust application is worth it. If you don't want to do everything on the lowest level, you can always pick a framework, such as Express, to make it easier to develop applications.

    Node.js is a promising technology and an excellent choice for a high-load application. It has been proven by corporations, like Microsoft, eBay, and Yahoo. If you're unsure about hosting your website or application, you can always use a cheap VPS solution or various cloud-based services, such as Microsoft Azure and Amazon EC2. Both of these services provide scalable environments at a reasonable price.

    Photo

    martijn broeders

    founder/ strategic creative at shineyrock web design & consultancy
    e-mail: .(JavaScript must be enabled to view this email address)
    phone: 434 210 0245
    1
    Add a comment...
    4elements
    Comments

By - category

By - date

Copyright © 1999 - 2026 Shineyrock web design and consultancy, All Rights Reserved / Terms of Conditions / Sitemap: XML, HTML, Images, Mobile, News