Введение.
В области веб-приложений, работающих в режиме реального времени, Server-Sent Events (SSE) — это мощная технология, которая позволяет серверам однонаправленно отправлять обновления клиентам. SSE предоставляет легкое и простое решение для интеграции API в режиме реального времени. В этой статье мы рассмотрим, как реализовать интеграцию API в реальном времени с помощью SSE в приложении Node.js. К концу у вас будет четкое представление о том, как отправлять обновления в реальном времени из API клиентам, использующим SSE.
Предварительные требования.
Чтобы следовать этому руководству, вы должны иметь базовые знания о Node.js и JavaScript. Убедитесь, что на вашем компьютере установлены Node.js и npm (диспетчер пакетов Node).
Шаг 1. Настройка проекта
Начните с создания нового каталога для вашего проекта и перейдите к нему в терминале. Инициализируйте новый проект Node.js, выполнив следующую команду:
```
$ npm init -y
```
Шаг 2: Установите зависимости
Затем установите необходимые зависимости для нашего проекта. Мы будем использовать Express в качестве веб-фреймворка и пакет `sse` для обработки событий, отправленных сервером. Выполните следующую команду, чтобы установить их:
```
$ npm install express sse
```
Шаг 3. Создайте сервер
Создайте новый файл с именем `server.js` и добавьте следующий код для настройки базового сервера Express:
const express = require('express');
const { SSE } = require('sse');
const app = express();
const port = 3000;
// Конечная точка SSE
app.get(‘/sse’, (req, res) =› {
const sse = new SSE();
// Установить заголовки
res.setHeader('Content-Type', 'text/event-stream');
res.setHeader('Cache-Control', 'no-cache');
res.setHeader('Connection', 'keep-alive');
res.setHeader('Access-Control-Allow-Origin', '*');
// Подключить экземпляр SSE к потоку ответов
sse.init(req, res);
// Отправляем начальное событие SSE
sse.send({ data: ‘Initial data’ });
// Обработка отключения клиента SSE
req.on(‘close’, () =› {
// При необходимости выполнить очистку
});
});
// Запускаем сервер
app.listen(port, () =› {
console.log(`Сервер прослушивает порт ${port}`);
});
```
Шаг 4. Отправка данных в реальном времени
Чтобы передавать данные в реальном времени подключенным клиентам SSE, мы можем создать отдельную функцию, которая отправляет события SSE. Измените файл `server.js` следующим образом:
// Конечная точка SSE
app.get(‘/sse’, (req, res) =› {
const sse = new SSE();
// Установить заголовки
// …
// Подключить экземпляр SSE к потоку ответов
sse.init(req, res);
// Отправляем начальное событие SSE
sse.send({ data: ‘Initial data’ });
// Выдача данных в реальном времени
setInterval(() =› {
const eventData = { data: 'Данные в реальном времени' };
sse.send(eventData);
}, 2000);
// Обработка отключения клиента SSE
// …
});
```
В приведенном выше коде мы добавили функцию `setInterval`, которая отправляет событие SSE каждые 2 секунды. Вы можете настроить интервал и отправляемые данные в соответствии с вашими требованиями к API.
Шаг 5. Проверьте конечную точку SSE
Запустите сервер, выполнив в терминале следующую команду:
```
$ node server.js
```
Вы должны увидеть сообщение о том, что сервер прослушивает порт 3000. Откройте браузер и перейдите к https://localhost:3000/sse. Вы должны увидеть непрерывный поток событий SSE, отображаемых в
