使用 Actix-web 和 SSE 实现 Rust 后端实时事件推送
使用 Actix-web 和 SSE 实现 Rust 后端实时事件推送
在现代 Web 应用中,实时通信变得越来越重要。Server-Sent Events (SSE) 提供了一种简单有效的服务器到客户端单向通信机制。本文将介绍如何在 Rust Actix-web 框架中实现 SSE 功能,实现实时事件推送。
概述
SSE 允许服务器通过 HTTP 连接向客户端推送更新,相比 WebSockets,它更简单且自带重连机制。我们的实现将包含以下核心组件:
- 全局事件广播器 (
SseNotifier) - SSE 流端点
- 业务逻辑中的事件触发机制
核心实现
1. 事件广播器
1
use tokio::sync::broadcast;
2
3
#[derive(Clone)]
4
pub struct SseNotifier {
5
tx: broadcast::Sender<String>,
6
}
7
8
impl SseNotifier {
9
pub fn new() -> Self {
10
let (tx, _) = broadcast::channel(100);
11
SseNotifier { tx }
12
}
13
14
// 创建新的事件通道
15
pub fn create_channel(&self) -> broadcast::Receiver<String> {
16
self.tx.subscribe()
17
}
18
这个结构体使用 Tokio 的广播通道,允许多个消费者订阅同一事件流。
2. SSE 流端点
1
use crate::utils::sse::SseNotifier;
2
use actix_web::{Responder, web};
3
use actix_web_lab::sse::{self, Event, Sse};
4
use futures_util::stream::StreamExt;
5
use std::{convert::Infallible, time::Duration};
6
use tokio_stream::wrappers::BroadcastStream;
7
8
pub async fn sse_stream(notifier: web::Data<SseNotifier>) -> impl Responder {
9
// 订阅全局事件通道
10
let rx = notifier.create_channel();
11
12
// 创建兼容的事件流
13
let sse_stream = BroadcastStream::new(rx)
14
.filter_map(|msg| async move {
15
match msg {
16
Ok(data) => Some(sse::Event::Data(sse::Data::new(data))),
17
Err(_) => None,
18
}
这个端点将广播流转换为 SSE 兼容格式,并设置了 5 秒的心跳间隔以保持连接活跃。
3. 在主函数中集成
1
async fn main() -> Result<()> {
2
let db = create_db_pool()
3
.await
4
.context("Failed to connect to database")?;
5
6
// 将db添加到应用数据中
7
let db_pool = web::Data::new(db);
8
9
// 添加SSE通知器
10
let notifier = web::Data::new(SseNotifier::new());
11
12
let _ = HttpServer::new(move || {
13
let cors = Cors::default()
14
.allowed_origin("http://127.0.0.1:5502")
15
.allowed_methods(vec!["GET", "POST", "PUT", "DELETE", "OPTIONS"])
16
.allowed_headers(vec!["Content-Type", "Authorization", "ACCEPT"])
17
.supports_credentials()
18
.max_age(3600);
4.路由
1
use actix_web::web;
2
3
use crate::routes::user::{delete_demo, get_demo, get_demo_uuid};
4
use crate::routes::{echo, post_demo, sse};
5
6
pub fn config_routes(cfg: &mut web::ServiceConfig) {
7
cfg.service(
8
web::scope("/api")
9
.service(
10
web::scope("/v1")
11
.route("/", web::get().to(get_demo))
12
.route("/{uuid:.*}", web::get().to(get_demo_uuid))
13
.route("/", web::post().to(post_demo))
14
// .route("/{uuid:.*}", web::put().to(put_demo))
15
.route("/{uuid:.*}", web::delete().to(delete_demo)),
16
)
17
.service(web::scope("/ws").route("", web::get().to(echo)))
18
.service(web::scope("/sse").route("/stream", web::get().to(sse::sse_stream))),
5. 在业务逻辑中触发事件
1
pub async fn post_demo(
2
db_pool: web::Data<DatabaseConnection>,
3
user_data: web::Json<RegisterResponse>,
4
notifier: web::Data<SseNotifier>, // 注入通知器
5
) -> HttpResult {
6
// ... 数据验证和业务逻辑
7
8
match new_user.insert(db_pool.as_ref()).await {
9
Ok(user) => {
10
println!("User created successfully: {:?}", user);
11
12
// 创建通知消息
13
let notification = serde_json::json!({
14
"event": "user_updated",
15
"data": {
16
"user_id": user.id,
17
"updated_fields": {
18
"username": &user.user_name,
实现要点
- 广播模式:使用 Tokio 的广播通道实现一对多的消息分发
- 错误处理:过滤掉广播中的错误,确保流稳定性
- 连接保持:设置心跳机制防止连接超时
- 结构化数据:使用 JSON 格式传递事件数据,便于客户端解析
- 依赖注入:通过 Actix-web 的数据共享机制在整个应用中共享通知器
客户端使用示例
1
// 前端JavaScript代码示例
2
const eventSource = new EventSource('http://localhost:2345/sse-stream');
3
4
eventSource.onmessage = function(event) {
5
const data = JSON.parse(event.data);
6
console.log('Received event:', data.event, data.data);
7
};
8
9
eventSource.onerror = function(error) {
10
console.error('EventSource failed:', error);
11
};
总结
本文展示了如何在 Rust Actix-web 框架中实现 SSE 功能,包括:
- 创建全局事件广播器
- 设置 SSE 流端点
- 在业务逻辑中触发事件
- 处理连接保持和错误情况
这种实现方式简单高效,适用于需要实时通知的场景,如实时更新、消息推送、状态同步等。通过使用广播通道,我们可以轻松地向所有连接的客户端发送事件,而无需维护单独的连接列表。
SSE 是构建实时应用的轻量级解决方案,特别适合服务器向客户端推送更新的场景,相比 WebSockets 更简单且具有自动重连等内置优势。
相关文章
查看同分类文章MAVLink 消息处理指南
MAVLink消息处理系统摘要 本系统实现了一套完整的MAVLink消息处理机制,用于无人机通信与控制。核心功能包括: 消息接收:通过UDP连接持续接收飞控消息,支持心跳维持机制 消息处理:分类处理多种MAVLink消息类型,包括心跳、位置、姿态和航点相关消息 航点管理:实现航点下载状态机,支持分片请求和接收航点数据 消息转发:将处理后的消息通过MQTT发布到指定主题 系统采用多线程架构,包含独立的消息接收线程和主处理循环,通过通道进行线程间通信。关键特性包括航点下载状态机、错误处理和日志记录机制,确保通信
304 浏览
M3U8 下载助手油猴脚本 - 技术实现解析
M3U8下载助手技术解析 该油猴脚本通过注入拦截脚本实现对M3U8链接的全面捕获。核心架构包括: 请求拦截层:劫持XHR、fetch和WebSocket请求 DOM监听层:通过MutationObserver监控动态元素变化 跨域通信:iframe间使用postMessage传递数据 UI展示层:提供浮动按钮等交互界面 关键技术点: 使用document-start确保早期注入 通过保存原始方法实现API劫持 在send时而非open时检测URL 全面覆盖各种属性(src/href/data-src等) 脚
362 浏览
我做了一个局域网传文件的小工具,记录一下
本文记录了作者开发局域网文件传输工具的过程。起因是工作中遇到大文件传输不便的问题,作者选择用Rust语言开发,解决了WebSocket状态管理、大文件上传限制等技术难点。最终成品通过浏览器即可使用,支持文字聊天和文件传输,内存占用低。同事们试用后反馈良好,建议增加拖拽上传等功能。作者认为Rust虽开发较繁琐但运行高效稳定,并将项目开源供社区参与改进。
291 浏览
局域网聊天工具
这是一个基于Rust和Axum框架开发的局域网实时聊天工具,支持文本聊天、图片和文件分享功能。项目采用WebSocket实现实时通信,前端使用Tailwind CSS构建界面。主要功能包括实时消息传递、文件上传下载(限制100MB)、在线用户显示和消息历史记录。部署简单,只需Rust环境,通过Cargo编译运行即可启动服务。系统架构清晰,包含后端处理、前端界面和文件存储模块,适合局域网内团队协作使用。
350 浏览