Writing and connecting your module to Node.js

Компьютер, программы

→

Node.js (this is a web server that executes JS files)

Пишем и подключаем наш модуль в Node.js

посмотрели 12000 раз

обновлено: 21 April 2018

Шаг 1) Создадим свой модуль т.е. создадим новый файл myBook.js в текстовом редакторе

JavaScript Файл D:/NodeApp/myBook.js

// моя переменная
var bookName = 'Волшебник Земноморья';

// моя функция
function getBookInfo()
{
return "Я читаю книгу " + bookName + " на 219 странице";
}

// экспортные переменные и функции
module.exports.name = bookName;
module.exports.info = getBookInfo;

Чтобы переменные и функции описанные в вашем модуле были доступны основной программе, мы их добавили в module.exports

Шаг 2) Создадим главный файл test.js в текстовом редакторе

JavaScript Файл D:/NodeApp/test.js

// подключаем свой модуль
var myBookModule = require('./myBook');

// подключаем встроенный модуль
var http = require('http');

// создаем web server
var server = http.createServer(function (request, response)
{
     response.writeHead(200, {'Content-Type': 'text/html;charset=utf-8'});

     // отображаем в браузер 'Волшебник Земноморья'
     response.write(myBookModule.name);

     // новая строка
     response.write('<BR>');

     // отображаем в браузер 'Я читаю книгу Волшебник Земноморья на 219 странице'
     response.write(myBookModule.info());

     // завершаем отображение в браузере
     response.end();
});

// прослушиваем web server
server.listen(3000);

Внимание!
Чтобы подключить наш модуль нужно писать путь ./
Это означает что мы подключаем свой модуль с текущей папки
var myBookModule = require('./myBook');

Встроенные модули подключаются просто по имени
var http = require('http');

Внимание!
Чтобы использовать переменные или функции вашего модуля нужно писать объект_модуля.экспротное_имя
Пример:
используем переменную
myBookModule.name

используем функцию
myBookModule.info()

Шаг 3) Запускаем Node.js сервер

Создадим новый файл run.bat в текстовом редакторе

Файл D:/NodeApp/run.bat

node test.js

Шаг 4) Открываем браузер и вводим web адрес

http://localhost:3000/test.js

Глобальные переменые в нашем модуле

Node.js предоставляет специальный объект global который виден для любого модуля.

JavaScript Наш модуль myBook.js

// мои переменные
var bookName = 'Волшебник Земноморья';
var bookPrice = '180';

// моя функция
function getBookInfo()
{
return "Я читаю книгу " + bookName + " на 219 странице";
}

// экспортные переменные и функции
module.exports.name = bookName;
module.exports.info = getBookInfo;

// глобальная переменная
global.price = bookPrice;

JavaScript Главный файл test.js

// подключаем свой модуль
var myBookModule = require('./myBook');

// подключаем встроенный модуль
var http = require('http');

// создаем web server
var server = http.createServer(function (request, response)
{
response.writeHead(200, {'Content-Type': 'text/html;charset=utf-8'});

// отображаем в браузер 'Волшебник Земноморья'
response.write(myBookModule.name);

// новая строка
response.write('<BR>');

// отображаем в браузер 'Я читаю книгу Волшебник Земноморья на 219 странице'
response.write(myBookModule.info());

// новая строка
response.write('<BR>');

// отображаем в браузер ГЛОБАЛЬНУЮ переменную '180'
response.write(price);

// завершаем отображение в браузере
response.end();
});

// прослушиваем web server
server.listen(3000);

К нашей глобальной переменной мы можем обращаться через global.price или просто price

По правилам хорошего написания программы не рекомендуется использование глобальных переменных, а лучше использовать экспортные переменные внутри модуля.

Наш модуль возвращающий только один объект

JavaScript Наш модуль myBook.js

// мой класс
function BookInfo()
{
     this.bookName = 'Волшебник Земноморья';
     this.bookPrice = '180';

     this.getBookInfo = function()
     {
return "Я читаю книгу " + this.bookName + " на 219 странице";
     }
}

// экспорт
module.exports = BookInfo;

JavaScript Главный файл test.js

// подключаем свой модуль
var myBookModule = require('./myBook');

// создаем объект
var book = new myBookModule();

// подключаем встроенный модуль
var http = require('http');

// создаем web server
var server = http.createServer(function (request, response)
{
response.writeHead(200, {'Content-Type': 'text/html;charset=utf-8'});

// отображаем в браузер 'Я читаю книгу Волшебник Земноморья на 219 странице'
response.end(book.getBookInfo());
});

// прослушиваем web server
server.listen(3000);

Вывод !!!

Вариант 1) Если в нашем новом модуле 'myBook.js' мы пишем
exports.экспортное_название1 = название_переменной1;
exports.экспортное_название2 = название_переменной2;
...
exports.экспортное_названиеA = название_функции1;
...
то в главном файле test.js мы используем экспортные_названия

Вариант 2) Если в нашем новом модуле 'myBook.js' мы пишем
exports = название_класса;
то в главном файле test.js мы НЕ используем экспортные_названия

Подробнее в примерах:

Наш новый модуль myBook.js

главный файл test.js

Вариант1

// мои переменные
var bookName = 'Волшебник моря';
var bookPrice = '180';

// моя функция
function getBookInfo()
{
return "Я читаю книгу";
}

// экспортные переменные и функции
module.exports.name = bookName;
module.exports.price = bookPrice;
module.exports.info = getBookInfo;

// подключаем свой модуль myBook.js
var myBookModule = require('./myBook');

// используем свойства
myBookModule.name = "aaa";
myBookModule.price = "120";

// используем функциию
myBookModule.info();

Вариант2

// мой класс
function BookInfo()
{
    this.bookName = 'Волшебник моря';
    this.bookPrice = '180';

    this.getBookInfo = function()
    {
        return "Я читаю книгу"
    }
}

// экспорт
module.exports = BookInfo;

// подключаем свой модуль myBook.js
var myBookModule = require('./myBook');

// создаем объект класса
var book = new myBookModule();

// используем свойства
book.bookName;
book.bookPrice;

// используем функции
book.getBookInfo();

← Previous topic
How the require function works inside and what happens when we write require("ModuleName") in Node.js

Next topic →
"Express" module Node.js !!!!!!!!!!!!