Node.js

Материал из support.qbpro.ru

Документация JsDoc

jdoc

Серверный JavaScript

Руководство NodeJS Node.js Virtual Machine (vm) Usage (перевод)

Node.JS Parent Process ID

Is it possible to get the parent process-id using Node.JS? I would like to detect if the parent is killed or fails in such a way that it cannot notify the child. If this happens, the parent process id of the child should become 1.

This would be preferable to requiring the parent to periodically send a keep-alive signal and also preferable to running the ps command. 

@Emmerman: I'm not sure what you mean. The parent runs require('child_process').spawn(process.argv[0], ['path_to_child.js']) in order to start the child. Then if it needs to talk to the child, it uses the stdin and stdout of the child. stderr is piped to a log. I am guessing the answer would be yes?
  • You can use pid-file. Something like that
var util = require('util'),
    fs = require('fs'),
    pidfile = '/var/run/nodemaster.pid';

try {
    var pid = fs.readFileSync(pidfile);
    //REPLACE with your signal or use another method to check process existence :)
    process.kill(pid, 'SIGUSR2'); 
    util.puts('Master already running');
    process.exit(1);
} catch (e) {
    fs.writeFileSync(pidfile, process.pid.toString(), 'ascii');
}

//run your childs here

Библиотеки

Socket.IO

Socket.IO is a Node.JS project that makes WebSockets and realtime possible in all browsers. It also enhances WebSockets by providing built-in multiplexing, horizontal scalability, automatic JSON encoding/decoding, and more.

Установка 

npm install socket.io

Использование

First, require socket.io: 

var io = require('socket.io');

Next, attach it to a HTTP/HTTPS server. If you're using the fantastic express web framework: 

Express 3.x
 var app = express()
  , server = require('http').createServer(app)
  , io = io.listen(server);

server.listen(80);

io.sockets.on('connection', function (socket) {
  socket.emit('news', { hello: 'world' });
  socket.on('my other event', function (data) {
    console.log(data);
  });
});


Finally, load it from the client side code: 

<script src="/socket.io/socket.io.js"></script>
<script>
  var socket = io.connect('http://localhost');
  socket.on('news', function (data) {
    console.log(data);
    socket.emit('my other event', { my: 'data' });
  });
</script>
 
For more thorough examples, look at the examples/ directory.

Примеры использования

Sending and receiving events.

Socket.IO allows you to emit and receive custom events. Besides connect, message and disconnect, you can emit custom events: 

// note, io.listen(<port>) will create a http server for you
var io = require('socket.io').listen(80);

io.sockets.on('connection', function (socket) {
  io.sockets.emit('this', { will: 'be received by everyone' });

  socket.on('private message', function (from, msg) {
    console.log('I received a private message by ', from, ' saying ', msg);
  });

  socket.on('disconnect', function () {
    io.sockets.emit('user disconnected');
  });
});

Storing data associated to a client

Sometimes it's necessary to store data associated with a client that's necessary for the duration of the session.

Server side 

var io = require('socket.io').listen(80);

io.sockets.on('connection', function (socket) {
  socket.on('set nickname', function (name) {
    socket.set('nickname', name, function () { socket.emit('ready'); });
  });

  socket.on('msg', function () {
    socket.get('nickname', function (err, name) {
      console.log('Chat message by ', name);
    });
  });
});

Client side 

<script>
  var socket = io.connect('http://localhost');

  socket.on('connect', function () {
    socket.emit('set nickname', prompt('What is your nickname?'));
    socket.on('ready', function () {
      console.log('Connected !');
      socket.emit('msg', prompt('What is your message?'));
    });
  });
</script>

Restricting yourself to a namespace

If you have control over all the messages and events emitted for a particular application, using the default / namespace works.

If you want to leverage 3rd-party code, or produce code to share with others, socket.io provides a way of namespacing a socket.

This has the benefit of multiplexing a single connection. Instead of socket.io using two WebSocket connections, it'll use one.

The following example defines a socket that listens on '/chat' and one for '/news':

Server side 

var io = require('socket.io').listen(80);

var chat = io
  .of('/chat')
  .on('connection', function (socket) {
    socket.emit('a message', { that: 'only', '/chat': 'will get' });
    chat.emit('a message', { everyone: 'in', '/chat': 'will get' });
  });

var news = io
  .of('/news');
  .on('connection', function (socket) {
    socket.emit('item', { news: 'item' });
  });

Client side: 

<script>
  var chat = io.connect('http://localhost/chat')
    , news = io.connect('http://localhost/news');

  chat.on('connect', function () {
    chat.emit('hi!');
  });

  news.on('news', function () {
    news.emit('woot');
  });
</script>

Sending volatile messages.

Sometimes certain messages can be dropped. Let's say you have an app that shows realtime tweets for the keyword bieber.

If a certain client is not ready to receive messages (because of network slowness or other issues, or because he's connected through long polling and is in the middle of a request-response cycle), if he doesn't receive ALL the tweets related to bieber your application won't suffer.

In that case, you might want to send those messages as volatile messages.

Server side 

var io = require('socket.io').listen(80);

io.sockets.on('connection', function (socket) {
  var tweets = setInterval(function () {
    getBieberTweet(function (tweet) {
      socket.volatile.emit('bieber tweet', tweet);
    });
  }, 100);

  socket.on('disconnect', function () {
    clearInterval(tweets);
  });
});

Client side

In the client side, messages are received the same way whether they're volatile or not.

Getting acknowledgements

Sometimes, you might want to get a callback when the client confirmed the message reception.

To do this, simply pass a function as the last parameter of .send or .emit. What's more, when you use .emit, the acknowledgement is done by you, which means you can also pass data along:

Server side 

var io = require('socket.io').listen(80);

io.sockets.on('connection', function (socket) {
  socket.on('ferret', function (name, fn) {
    fn('woot');
  });
});
Client side

<script>
  var socket = io.connect(); // TIP: .connect with no args does auto-discovery
  socket.on('connect', function () { // TIP: you can avoid listening on `connect` and listen on events directly too!
    socket.emit('ferret', 'tobi', function (data) {
      console.log(data); // data will be 'woot'
    });
  });
</script>

Broadcasting messages

To broadcast, simply add a broadcast flag to emit and send method calls. Broadcasting means sending a message to everyone else except for the socket that starts it.

Server side 

var io = require('socket.io').listen(80);

io.sockets.on('connection', function (socket) {
  socket.broadcast.emit('user connected');
  socket.broadcast.json.send({ a: 'message' });
});

Rooms

Sometimes you want to put certain sockets in the same room, so that it's easy to broadcast to all of them together.

Think of this as built-in channels for sockets. Sockets join and leave rooms in each socket.

Server side 

var io = require('socket.io').listen(80);

io.sockets.on('connection', function (socket) {
  socket.join('justin bieber fans');
  socket.broadcast.to('justin bieber fans').emit('new fan');
  io.sockets.in('rammstein fans').emit('new non-fan');
});
Using it just as a cross-browser WebSocket

If you just want the WebSocket semantics, you can do that too. Simply leverage send and listen on the message event:

Server side 

var io = require('socket.io').listen(80);

io.sockets.on('connection', function (socket) {
  socket.on('message', function () { });
  socket.on('disconnect', function () { });
});

Client side 

<script>
  var socket = io.connect('http://localhost/');
  socket.on('connect', function () {
    socket.send('hi');

    socket.on('message', function (msg) {
      // my msg
    });
  });
</script>

Changing configuration

Configuration in socket.io is TJ-style:

Server side 

var io = require('socket.io').listen(80);

io.configure(function () {
  io.set('transports', ['websocket', 'flashsocket', 'xhr-polling']);
});

io.configure('development', function () {
  io.set('transports', ['websocket', 'xhr-polling']);
  io.enable('log');
});

Перевод документации с оф. сайта

Использование Node HTTP server

Установить npm install socket.io

SERVER (APP.JS) 

var app = require('http').createServer(handler)
  , io = require('socket.io').listen(app)
  , fs = require('fs')
 
 app.listen(80);
 
 function handler (req, res) {
  fs.readFile(__dirname + '/index.html',
  function (err, data) {
    if (err) {
      res.writeHead(500);
      return res.end('Error loading index.html');
    }
    res.writeHead(200);
    res.end(data);
  });
 }
 
 io.sockets.on('connection', function (socket) {
  socket.emit('news', { hello: 'world' });
  socket.on('my other event', function (data) {
    console.log(data);
  });
 });

CLIENT (INDEX.HTML) 

<script src="/socket.io/socket.io.js"></script>
 <script>
  var socket = io.connect('http://localhost');
  
  socket.on('news', function (data) {
    console.log(data);
    socket.emit('my other event', { my: 'data' });
  });
 </script>

Использование совместно с Express 3 web framework

Express 3 requires that you instantiate a `http.Server` to attach socket.io to first:


SERVER (APP.JS) 

var app = require('express')()
 , server = require('http').createServer(app)
 , io = require('socket.io').listen(server);

server.listen(80);

app.get('/', function (req, res) {
 res.sendfile(__dirname + '/index.html');
});
 
io.sockets.on('connection', function (socket) {
 socket.emit('news', { hello: 'world' });
 socket.on('my other event', function (data) {
   console.log(data);
 });
});

CLIENT (INDEX.HTML) 

<script src="/socket.io/socket.io.js"></script>
 <script>
  var socket = io.connect('http://localhost');
   
  socket.on('news', function (data) {
    console.log(data);
    socket.emit('my other event', { my: 'data' });
  });
 </script>

Использование совместно с Express web framework

You can serve normal pages and AJAX requests with Express, and attach your socket.io server

For this example, simply run `npm install socket.io express`

SERVER (APP.JS) 

var app = require('express').createServer()
 , io = require('socket.io').listen(app);
app.listen(80);
app.get('/', function (req, res) {
 res.sendfile(__dirname + '/index.html');
});
io.sockets.on('connection', function (socket) {
 socket.emit('news', { hello: 'world' });
 socket.on('my other event', function (data) {
   console.log(data);
 });
});

CLIENT (INDEX.HTML) 

<script src="/socket.io/socket.io.js"></script>
 <script>
  var socket = io.connect('http://localhost');
  socket.on('news', function (data) {
    console.log(data);
    socket.emit('my other event', { my: 'data' });
  });
 </script>

Отправка и прием событий.

Socket.IO позволяет обрабатывать и отправлять произвольные события. Кроме `connect`, `message` and `disconnect`, можно создавать произвольные события:

SERVER 

// note, io.listen(<port>) will create a http server for you
var io = require('socket.io').listen(80);
io.sockets.on('connection', function (socket) {
 io.sockets.emit('this', { will: 'be received by everyone'});
 socket.on('private message', function (from, msg) {
   console.log('I received a private message by ', from, ' saying ', msg);
 });
 socket.on('disconnect', function () {
   io.sockets.emit('user disconnected');
 });
});

Прикрепление данных, ассоциированных с клиентом

Иногда необходимо хранить данные, ассоциированные с клиентом, что необходимо для продолжении (duration) сессии.

SERVER 

var io = require('socket.io').listen(80);
 io.sockets.on('connection', function (socket) {
  socket.on('set nickname', function (name) {
    socket.set('nickname', name, function () {
      socket.emit('ready');
    });
  });
  socket.on('msg', function () {
    socket.get('nickname', function (err, name) {
      console.log('Chat message by ', name);
    });
  });
 });

CLIENT 

<script src="/socket.io/socket.io.js"></script>
 <script>
  var socket = io.connect('http://localhost');
  socket.on('news', function (data) {
    console.log(data);
    socket.emit('my other event', { my: 'data' });
  });
 </script>

Оборачивание себя (своего кода) в namespace.

Если вы контролируете все сообщения и события в коде, используйте namespace works по умолчанию (default namespace works) Если вы хотите использовать сторонний код или предоставлять код другим, socket.io предоставляет возможность использования именованных сокетов (namespacing a socket.)

Это полезно при мультиплексировании соединений. Вместо использования двух соединений WebSocket, будет использовано одно.

'SERVER 

var io = require('socket.io').listen(80);

var chat = io
  .of('/chat')
  .on('connection', function (socket) {
    socket.emit('a message', {
        that: 'only'
      , '/chat': 'will get'
    });
    chat.emit('a message', {
        everyone: 'in'
      , '/chat': 'will get'
    });
  });

var news = io
  .of('/news')
  .on('connection', function (socket) {
    socket.emit('item', { news: 'item' });
  });

CLIENT 

<script>
  var chat = io.connect('http://localhost/chat')
    , news = io.connect('http://localhost/news');
  
  chat.on('connect', function () {
    chat.emit('hi!');
  });
  
  news.on('news', function () {
    news.emit('woot');
  });
</script>

Отправка летучих (volatile) сообщений.

Иногда некоторые сообщения могут быть удалены (отброшены). Скажем, у вас есть приложение, которое показывает в реальном времени количество твитов по ключевому слову Бибер.

Если определенный клиент не готов к приему сообщений (из-за медлительности сети или других вопросов, или потому, что он связан через длинные голосования и находится в середине запрос-ответ цикла), если он не получит всех твитов, связанных с Бибер, то ваша заявка не будет страдать.

В этом случае, вы можете отправить эти сообщения, как летучие сообщений.

SERVER 

var io = require('socket.io').listen(80);

io.sockets.on('connection', function (socket) {
  var tweets = setInterval(function () {
    getBieberTweet(function (tweet) {
      socket.volatile.emit('bieber tweet', tweet);
    });
  }, 100);

  socket.on('disconnect', function () {
    clearInterval(tweets);
  });
});

Отправка и получение данных (подтверждения)

Иногда, вы можете получить обратный вызов, когда клиент подтвердил прием сообщения.

Чтобы сделать это, просто передать функцию в качестве последнего параметра `.send` или `.emit`. Более того, когда вы используете `.emit`, подтверждение было сделано вами, значит, вы также можете продолжить передавать данные.

SERVER 

var io = require('socket.io').listen(80);

io.sockets.on('connection', function (socket) {
  socket.on('ferret', function (name, fn) {
    fn('woot');
  });
});

CLIENT 

<script>
 var socket = io.connect(); // TIP: .connect with no args does auto-discovery
 socket.on('connect', function () { // TIP: you can avoid listening on `connect` and listen on events directly too!
   socket.emit('ferret', 'tobi', function (data) {
     console.log(data); // data will be 'woot'
   });
 });
</script>

Broadcasting messages.

To broadcast, simply add a `broadcast` flag to `emit` and `send` method calls. Broadcasting means sending a message to everyone else except for the socket that starts it.

SERVER 

var io = require('socket.io').listen(80);

io.sockets.on('connection', function (socket) {
  socket.broadcast.emit('user connected');
});

Using it just as a cross-browser WebSocket.

If you just want the WebSocket semantics, you can do that too. Simply leverage `send` and listen on the `message` event:

SERVER 

var io = require('socket.io').listen(80);

io.sockets.on('connection', function (socket) {
  socket.on('message', function () { });
  socket.on('disconnect', function () { });
});

CLIENT 

<script>
  var socket = io.connect('http://localhost/');
  socket.on('connect', function () {
    socket.send('hi');

    socket.on('message', function (msg) {
      // my msg
    });
  });
</script>

Примеры кода

process.nextTick(callback) - Гарантированно вызовет функцию callback в следующем цикле eventloop


Документация

АКСИОМЫ NODE.JS

Callback-driven парадигма

Неблокирующая функция принимает callback последним аргументом: 

function asuncFunction(arg1,arg2,...,argN, callback){

}

Callback принимает ошибку первым аргументом, остальные результат: 

function callback(error, result1,result2,...resultN){

}

Кластер

Кластер на основе NodeJS -

Примеры архитектуры

Tactoom.com изнутри — социальная блог-платформа на NodeJS/NoSQL

Обработка форм и визуализации через NodeJs

[1]http://nodejs.ru/665

[2]http://habrahabr.ru/post/138629/

[3]http://nodeguide.ru/doc/dailyjs-nodepad/node-tutorial-7/

[4]http://habrahabr.ru/post/147571/

[5]http://www.pvsm.ru/node-js/12212

[6]http://www.pixelcom.crimea.ua/rukovodstvo-po-html5-canvas.html

Установка node.js в Debian
  • Express: веб-фреймворк для Node.js. Руководство пользователя

[7]http://jsman.ru/express/

  • Руководство для начинающих

[8]http://vremenno.net/js/node-js-for-beginners/

  • Скелет приложения на Node.js с использованием express, mongoose, backbone.js, socket.io

[9]http://kulakowka.com/tag/express/

  • Русскоязычное сообщество Node.js

[10]http://forum.nodejs.ru/index.php?topic=130.0

Технологии спутники

Перечень модулей для Node.js https://github.com/joyent/node/wiki/modules

Node-sync

Node-sync_—_псевдо-синхронное_программирование_на_nodejs_с_использованием_fibers

socket.io

Express

Отладка и сборка

Примеры кода

Цепочка вызывающих себя через callback'и функций с передачей данных следующей функции (обработка ошибок в одном месте, массив функций в качестве параметра)

С использованием async это пишется так: 

var async = require('async');

async.waterfall([
    function(callback){
        setTimeout(function() {
            console.log('f1 done');
            callback(null, 'data from f1');
        }, 100);
    },
    function(data, callback){
        // работа с data
        // или расширение цепочки через функцию f3, которая по окончании работы вызовет callback
        // f3(callback);
        console.log('f2 done');
        callback(null, 'done');
    }
], function (err, result) {
    // result now equals 'done'
    if (err) {
        // единое место для отлова ошибок
    }
    console.log(result);
});

Дополнительные возможности nodejs

Полезные ресурсы

'Отладка в Node.Js'

@модули для node.js

Запуск приложений node.js в Linux Debian/Ubuntu через /etc/init.d

Daemon init script for node.js based app/server (DEBIAN/UBUNTU)

10 типичных ошибок Node.js разработчиков

Официальная документация nodejs на русском

Различные источники

Использование MD5

Examples:

1) 

var filename = process.argv[2];
var crypto = require('crypto');
var fs = require('fs');

var md5sum = crypto.createHash('md5');

var s = fs.ReadStream(filename);
s.on('data', function(d) {
  md5sum.update(d);
});

s.on('end', function() {
  var d = md5sum.digest('hex');
  console.log(d + '  ' + filename);
});

2) 

var crypto = require('crypto');
var name = 'braitsch';
var hash = crypto.createHash('md5').update(name).digest('hex');
console.log(hash); // 9b74c9897bac770ffc029102a200c5de

3) 

$ npm install sha1

and then

var sha1 = require('sha1');
var hash = sha1("my message");
console.log(hash); // 104ab42f1193c336aa2cf08a2c946d5c6fd0fcdb

or

$ npm install md5

and then

var md5 = require('md5');
var hash = md5("my message");
console.log(hash); // 8ba6c19dc1def5702ff5acbf2aeea5aa

4) 

const crypto = require('crypto');

const sha256 = x => crypto.createHash('sha256').update(x, 'utf8').digest('hex');

sha256('Hello, world. ');

5) 

function encrypt(text,password){
  var cipher = crypto.createCipher(algorithm,password)
  var crypted = cipher.update(text,'utf8','hex')
  crypted += cipher.final('hex');
  return crypted;
}

function decrypt(text,password){
  var decipher = crypto.createDecipher(algorithm,password)
  var dec = decipher.update(text,'hex','utf8')
  dec += decipher.final('utf8');
  return dec;
}

function hashText(text){
    var hash = crypto.createHash('md5').update(text).digest("hex");
    //console.log(hash); 
    return hash;
}

function encryptThenAuthenticate(plainText,pw)
{
    var encryptedText = encrypt(plainText,pw);
    var hash = hashText(encryptedText);
    return encryptedText+"$"+hash;
}
function VerifyThenDecrypt(encryptedAndAuthenticatedText,pw)
{
    var encryptedAndHashArray = encryptedAndAuthenticatedText.split("$");
    var encrypted = encryptedAndHashArray[0];
    var hash = encryptedAndHashArray[1];
    var hash2Compare = hashText(encrypted);
    if (hash === hash2Compare)
    {
        return decrypt(encrypted,pw); 
    }
}

It can be tested with: 

var doom = encryptThenAuthenticate("The encrypted text",user.cryptoPassword);
console.log(VerifyThenDecrypt(doom,user.cryptoPassword));

получить MAC-адрес текущего компьютера с node.js

В NodeJS ≥ 0.11 адрес MAC для каждого сетевого интерфейса находится на выходе os.networkInterfaces(), например.

1. Пример: 

require('os').networkInterfaces()

{ eth0: 
   [ { address: 'fe80::cae0:ebff:fe14:1dab',
       netmask: 'ffff:ffff:ffff:ffff::',
       family: 'IPv6',
       mac: 'c8:e0:eb:14:1d:ab',
       scopeid: 4,
       internal: false },
     { address: '192.168.178.22',
       netmask: '255.255.255.0',
       family: 'IPv4',
       mac: 'c8:e0:eb:14:1d:ab',
       internal: false } ] }

В NodeJS ≤ 0,10 вам нужно узнать собственные адреса mac, но есть пакеты, которые помогут вам в этом:
node-macaddress (отказ от ответственности: я я автор этого пакета).

2. Пример:

В режиме node ≥ 0.11 вам не требуется использовать асинхронную версию: 

var addr = require('node-macaddress').one();

Поскольку вас обычно интересует только "macaddress хостов" (хотя нет такой вещи, как хост может иметь несколько сетевых интерфейсов,
каждый из которых имеет отдельный MAC-адрес), этот вызов даст вам именно это.

Проблемы и их решения

* Проблема:
DeprecationWarning: `node --debug` and `node --debug-brk` are invalid. Please use `node --inspect` or `node --inspect-brk` instead.

* Решение:

1. Переименовываем бинарный файл /usr/local/bin/node в node_bin 

mv /usr/local/bin/node  /usr/local/bin/node_bin

2. Создаем скрипт в bash: 

echo > /usr/local/bin/node
editor /usr/local/bin/node

3. Вставляем скрипт: 

#!/bin/bash
## the script converting parameters for nodejs new version
##
new_name="node_bin";
eval _options="(" $(echo -e $@) ")"
_node=$(whereis -b $new_name|awk '/^'$new_name':/{print $2}');                                                                              
eval _version="(" $(echo -e $($_node --version|sed 's/[^0-9]/ /g')) ")";                                                                    
# local values                                                                                                                              
old_options=( "--debug" "--debug-brk" );                                                                                                    
new_options=( "--inspect" "--inspect-brk" );                                                                                                
_opt=();                                                                                                                                    
                                                                                                                                            
function filtr() {                                                                                                                          
    _opt=${_options[@]};                                                                                                                    
    for ((get_i=0; get_i != ${#old_options[@]}; get_i++))                                                                                   
        do                                                                                                                                  
        if [ ${new_options[$get_i]} = "" ];
            then
                _opt=${_opt[@]};
            else
                _opt=$( echo -e ${_opt[@]}|sed 's/'${old_options[$get_i]}'/'${new_options[$get_i]}'/g');
        fi
    done

}

function convert() {

if [ $(echo -e ${#_options[@]}) = 0 ];
    then 
        $_node;
    else
     filtr;
    
        $_node $(echo -e ${_opt[@]})
fi
exit 0;
}

if (( ${_version[0]} >= 7 ));
 then
   convert;
fi
exit 0;
  • Обратите внимание на выделенное имя - node_bin, в скрипте будет поиск именно такого имени бинарного файла nodejs,

если у вас иное укажите в параметре скрипта.

4. Даем права на запуск скрипта: 

chmod ugo+x /usr/local/bin/node

Все. Теперь если версия nodejs больше или равна 7.х.х - то автоматически параметры
--debug и --debug-brk будут на лету меняться на --inspect и --inspect-brk.

Данное решение на какое то время решит вашу проблему, но обновление среды IDE скорее всего неизбежно.
Я столкнулся с этим в netbeans.

Источники:

Источник — https://support.qbpro.ru/index.php?title=Node.js&oldid=4207