Модуль net Node.js

Java FileВстроенные модули Node.js


Node.jsnetМодуль является встроенным модулем, используемым для создания серверов и клиентов на основе TCP или IPC. Он предоставляет возможности асинхронного сетевого программирования и может использоваться для создания различных сетевых приложений, таких как чат-серверы, прокси-серверы и т. д.

Основные возможности

  1. Создание TCP-серверов и клиентов
  2. Создание серверов и клиентов IPC (межпроцессное взаимодействие)
  3. Обработка сетевых соединений и передача данных
  4. Управление жизненным циклом сетевых соединений

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

Создание TCP-сервера

Пример

const net = require('net');

// Создать TCP-сервер
const server = net.createServer((socket) => {
  console.log('Клиент подключен');
 
  // Получить данные от клиента
  socket.on('data', (data) => {
    console.log(`Полученные данные: ${data}`);
    socket.write(`Сервер получил: ${data}`); // Отправить данные клиенту
  });
 
  // Клиент отключён
  socket.on('end', () => {
    console.log('Клиент отключён');
  });
});

// Прослушивать порт 3000
server.listen(3000, () => {
  console.log('Сервер прослушивает порт 3000');
});

Создание TCP-клиента

Пример

const net = require('net');

// Создать клиента и подключиться к серверу
const client = net.createConnection({ port: 3000 }, () => {
  console.log('Подключено к серверу');
  client.write('Привет, сервер!'); // Отправить данные на сервер
});

// Получить данные от сервера
client.on('data', (data) => {
  console.log(`Получены данные от сервера: ${data}`);
  client.end(); // Отключиться
});

client.on('end', () => {
  console.log('Отключено от сервера');
});

Подробности основного API

net.createServer([options][, connectionListener])

Создаёт новый TCP- или IPC-сервер.

Параметры:

  • options: Необязательный объект конфигурации
    • allowHalfOpen: Разрешать ли полуоткрытые соединения; по умолчанию — false
    • pauseOnConnect: Приостанавливать ли сокет при подключении; по умолчанию — false
  • connectionListener: Автоматически устанавливается в качестве обработчика события 'connection'

net.createConnection(options[, connectListener])

Создаёт TCP-соединение с указанным портом и хостом.

Общие параметры:

  • port: Порт для подключения (обязательно)
  • host: Хост для подключения; по умолчанию — 'localhost'
  • localAddress: Локальный интерфейс, используемый для привязки сетевого соединения
  • family: Семейство протоколов IP (4 или 6)

Сетевой сокет (Socket)

net.SocketЭто основной класс модуля net, представляющий сетевое соединение.

Общие события

  1. connect: Срабатывает, когда соединение успешно установлено
  2. data: Срабатывает при получении данных
  3. end: Срабатывает, когда другой конец соединения отправляет пакет FIN
  4. timeout: Срабатывает при тайм-ауте соединения из-за неактивности
  5. error: Срабатывает при возникновении ошибки
  6. close: Срабатывает при полном закрытии сокета

Общие методы

  1. write(data[, encoding][, callback]): Отправка данных через сокет
  2. end([data][, encoding]): Полузакрыть сокет
  3. destroy(): Убедитесь, что на этом сокете больше не происходит операций ввода-вывода
  4. pause(): Приостановить чтение данных
  5. resume(): Возобновить чтение данных

Расширенные приложения

Обработка нескольких клиентских подключений

Пример

const net = require('net');

const server = net.createServer((socket) => {
  // Задайте уникальный ID для каждого соединения
  socket.id = Date.now();
 
  console.log(`Клиент ${socket.id}подключён`);
 
  socket.on('data', (data) => {
    console.log(`От клиента ${socket.id}получены данные: ${data}`);
    // Отправить сообщение всем клиентам
    server.getConnections((err, count) => {
      if (count > 1) {
        socket.write(`Сейчас в сети ${count-1}других клиентов`);
      }
    });
  });
 
  socket.on('end', () => {
    console.log(`Клиент ${socket.id}отключился`);
  });
});

server.listen(3000);

Обработка тайм-аутов

Пример

const server = net.createServer((socket) => {
  // Установить тайм-аут соединения на 5 минут
  socket.setTimeout(5 * 60 * 1000);
 
  socket.on('timeout', () => {
    console.log('Время соединения истекло, отключаемся');
    socket.end();
  });
});

Методы и свойства

ФункцияОписание
Создание сервераnet.createServer([options][, connectionListener]): Используется для создания TCP-сервера, может прослушивать запросы на подключение.
Подключение к серверуnet.connect(options[, connectListener])илиnet.createConnection(options[, connectListener]): Используется для подключения к указанному серверу (создание клиента).
Объект SocketsocketОбъект представляет собой соединение с TCP-сервером или клиентом и содержит различные методы для отправки, получения и закрытия соединений.

Методы

Нет.Методы и описание
1net.createServer([options][, connectionListener])
Создаёт TCP-сервер. Параметр connectionListener автоматически создаёт обработчик для события 'connection'.
2net.connect(options[, connectionListener])
Возвращает новый 'net.Socket' и подключается к указанному адресу и порту.
Когда сокет установлен, будет сгенерировано событие 'connect'.
3net.createConnection(options[, connectionListener])
Создаёт TCP-соединение к порту port и хосту host. host по умолчанию имеет значение 'localhost'.
4net.connect(port[, host][, connectListener])
Создаёт TCP-соединение с портом port и хостом host. host по умолчанию имеет значение 'localhost'. Параметр connectListener будет добавлен как обработчик для события 'connect'. Возвращает 'net.Socket'.
5net.createConnection(port[, host][, connectListener])
Создаёт TCP-соединение с портом port и хостом host. host по умолчанию имеет значение 'localhost'. Параметр connectListener будет добавлен как обработчик для события 'connect'. Возвращает 'net.Socket'.
6net.connect(path[, connectListener])
Создаёт unix-сокет, подключённый к path. Параметр connectListener будет добавлен как обработчик события 'connect'. Возвращает 'net.Socket'.
7net.createConnection(path[, connectListener])
Создаёт unix-сокет, подключённый к path. Параметр connectListener будет добавлен как обработчик события 'connect'. Возвращает 'net.Socket'.
8net.isIP(input)
Проверяет, является ли input IP-адресом. Возвращает 4 для IPV4, 6 для IPV6 и 0 в противном случае.
9net.isIPv4(input)
Если входной адрес — IPV4, возвращает true, иначе возвращает false.
10net.isIPv6(input)
Если входной адрес — IPV6, возвращает true, иначе возвращает false.

net.Server

net.Server обычно используется для создания TCP-сервера или локального сервера.

Нет.Методы и описание
1server.listen(port[, host][, backlog][, callback])
Прослушивает соединения на указанном порту port и хосте host. По умолчанию host принимает прямые соединения с любого IPv4-адреса (INADDR_ANY). Когда port равен 0, будет назначен случайный порт.
2server.listen(path[, callback])
Запускает локальный сервер сокетов, прослушивая указанный путь.
3server.listen(handle[, callback])
Подключается через указанный handle.
4server.listen(options[, callback])
Свойства options: port port, host host, и backlog, а также необязательная функция callback, вместе вызывают server.listen(port, [host], [backlog], [callback]). Кроме того, параметр path можно использовать для указания UNIX-сокета.
5server.close([callback])
Сервер перестаёт принимать новые соединения и поддерживает существующие соединения. Это асинхронная функция. Когда все соединения завершатся, сервер закроется и будет сгенерировано событие 'close'.
6server.address()
Операционная система возвращает привязанный адрес, имя семейства протоколов и порт сервера.
7server.unref()
Если это единственный активный сервер в системе событий, вызов unref позволит программе завершиться.
8server.ref()
Противоположность unref. Если это единственный сервер, вызов ref для сервера, для которого ранее был вызван unref, не позволит программе завершиться (поведение по умолчанию). Если для сервера уже был вызван ref, повторный вызов ref не даёт эффекта.
9server.getConnections(callback)
Асинхронно получает количество активных в данный момент подключений на сервере. Это действительно только после того, как сокет отправлен дочернему процессу; функция callback имеет 2 параметра: err и count.

Events

Нет.Событие и описание
1listening
Срабатывает, когда сервер вызывает server.listen для привязки.
2соединение
Срабатывает при создании нового подключения. socket — это экземпляр net.Socket.
3close
Срабатывает при закрытии сервера. Примечание: если есть подключения, это событие не будет вызвано, пока все подключения не будут закрыты.
4error
Срабатывает при возникновении ошибки. Событие 'close' будет вызвано непосредственно следующими событиями.

net.Socket

Объект net.Socket — это абстракция TCP или UNIX Socket. Экземпляры net.Socket реализуют интерфейс duplex stream. Они могут использоваться, когда пользователь создаёт клиент (с помощью connect()), или могут быть созданы Node и переданы пользователю через событие connection сервера.

Events

События net.Socket включают:

Нет.Событие и описание
1lookup
Срабатывает после разрешения доменного имени, но до подключения. Не применимо к сокетам UNIX.
2connect
Срабатывает при успешном установлении соединения сокета.
3data
Срабатывает при получении данных.
4end
Срабатывает, когда другой конец сокета отправляет пакет FIN.
5timeout
Срабатывает, когда время ожидания сокета истекает из-за неактивности. Это только указывает на то, что сокет стал бездействующим. Пользователь должен вручную закрыть соединение.
6drain
Срабатывает, когда буфер записи становится пустым. Может использоваться для управления загрузками.
7error
Срабатывает при возникновении ошибки.
8close
Срабатывает, когда сокет полностью закрыт. Параметр had_error — логическое значение, указывающее, был ли сокет закрыт из-за ошибки передачи.

Свойства

net.Socket предоставляет множество полезных свойств для управления взаимодействием с сокетом:

Нет.Свойство & Описание
1socket.bufferSize
Это свойство показывает количество байтов, которые должны быть записаны в буфер.
2socket.remoteAddress
Строка удалённого IP-адреса, например, '74.125.127.100' или '2001:4860:a005::68'.
3socket.remoteFamily
Строка семейства протоколов удалённого IP, например, 'IPv4' или 'IPv6'.
4socket.remotePort
Удалённый порт, представленный числом, например, 80 или 21.
5socket.localAddress
Локальный интерфейс, привязанный к сетевому соединению. Локальный IP-адрес, к которому подключается удалённый клиент, в виде строки. Например, если вы прослушиваете '0.0.0.0' и клиент подключается к '192.168.1.1', значением будет '192.168.1.1'.
6socket.localPort
Локальный адрес порта, представленный числом. Например: 80 или 21.
7socket.bytesRead
Количество полученных байт.
8socket.bytesWritten
Количество отправленных байт.

Методы

Нет.Метод и описание
1new net.Socket([options])
Создаёт новый объект сокета.
2socket.connect(port[, host][, connectListener])
Создаёт соединение сокета с указанными портом и хостом. Параметр host по умолчанию равен localhost. Обычно нет необходимости использовать net.createConnection для открытия сокета. Он используется только когда вы реализуете собственный сокет.
3socket.connect(path[, connectListener])
Открывает unix-сокет по указанному пути. Обычно нет необходимости использовать net.createConnection для открытия сокета. Он используется только когда вы реализуете собственный сокет.
4socket.setEncoding([encoding])
Устанавливает кодировку.
5socket.write(data[, encoding][, callback])
Отправляет данные через сокет. Второй параметр задаёт кодировку строки, по умолчанию используется кодировка UTF8.
6socket.end([data][, encoding])
Полузакрывает сокет. Например, отправляет пакет FIN. Сервер всё ещё может отправлять данные.
7socket.destroy()
Обеспечивает отсутствие активности ввода-вывода для этого сокета. Нужно только при возникновении ошибки. (для обработки ошибок и т. п.)
8socket.pause()
Приостанавливает чтение данных. То есть событие data больше не будет генерироваться. Очень полезно для управления загрузками.
9socket.resume()
Возобновляет чтение данных после вызова pause().
10socket.setTimeout(timeout[, callback])
Устанавливает тайм-аут для сокета после того, как он простаивал дольше timeout миллисекунд.
11socket.setNoDelay([noDelay])
Отключает алгоритм Нейгла. По умолчанию TCP-соединения используют алгоритм Нейгла, который буферизует данные перед отправкой. Установка noDelay в true приведет к немедленной отправке данных при вызове socket.write(). Значение noDelay по умолчанию — true.
12socket.setKeepAlive([enable][, initialDelay])
Отключает/включает функциональность keep-alive и опционально задает начальную задержку перед отправкой первой keep-alive-пробы на неактивном сокете. По умолчанию — false. Установите initialDelay (в миллисекундах), чтобы задать задержку между последним полученным пакетом и первой keep-alive-пробой. Установка initialDelay в 0 сохранит значение по умолчанию (или предыдущее). По умолчанию — 0.
13socket.address()
Возвращает привязанный адрес, имя семейства протоколов и порт сервера, как сообщает операционная система. Возвращаемый объект имеет 3 свойства, например { port: 12346, family: 'IPv4', address: '127.0.0.1' }.
14socket.unref()
Если это единственный активный сервер в системе событий, вызов unref позволит программе завершиться. Если для сервера уже был вызван unref, повторный вызов unref не даст эффекта.
15socket.ref()
Противоположность unref. Если это единственный сервер, вызов ref для сервера, для которого ранее был вызван unref, не позволит программе завершиться (поведение по умолчанию). Если для сервера уже был вызван ref, повторный вызов ref не даст эффекта.

Пример

Создайте файл server.js со следующим кодом:

Пример

var net = require('net');
var server = net.createServer(function(connection) {
   console.log('клиент подключен');
   connection.on('end', function() {
      console.log('Клиент закрыл соединение');
   });
   connection.write('Привет, мир!'\r\n');
   connection.pipe(connection);
});
server.listen(8080, function() {
  console.log('сервер слушает');
});

Запустите приведенный выше код сервера:

$ node server.js
server is listening   # 服务已创建并监听 8080 端口

Откройте новое окно и создайте файл client.js со следующим кодом:

Пример

var net = require('net');
var client = net.connect({port: 8080}, function() {
   console.log('Подключено к серверу!');  
});
client.on('data', function(data) {
   console.log(data.toString());
   client.end();
});
client.on('end', function() {
   console.log('Отключено от сервера');
});

Запустите приведённый выше клиентский код:

连接到服务器!
Hello World!

断开与服务器的连接

Демонстрация примера в GIF


Практические сценарии применения

  1. Чат-приложение: Создание сервера чата в реальном времени
  2. Игровой сервер: Обработка многопользовательского взаимодействия в реальном времени
  3. Прокси-сервер: Перенаправление клиентских запросов
  4. Пользовательский протокол: Реализация конкретных протоколов прикладного уровня
  5. Связь с IoT-устройствами: Взаимодействие со встроенными устройствами

Лучшие практики

  1. Обработка ошибок: Всегда прослушивайте событие 'error'
  2. Управление ресурсами: Своевременно закрывайте соединения, которые больше не используются
  3. Соображения по производительности: Для сценариев с высокой конкурентностью рассмотрите использование пула соединений
  4. Безопасность: реализуйте соответствующие механизмы аутентификации и шифрования
  5. Логирование: записывайте важные события подключения и данные

Пример

// Пример: Полная обработка ошибок
server.on('error', (err) => {
  console.error('Server error:', err);
});

client.on('error', (err) => {
  console.error('Client error:', err);
});

Освоив модуль net, вы сможете создавать разнообразные мощные сетевые приложения, понимать основополагающие принципы сетевого взаимодействия и заложить прочную основу для изучения более продвинутых сетевых фреймворков.

Java FileВстроенные модули Node.js

Другие расширения