前言
之前接触的通信方式主要是HTTP请求和WebSocket,这次有机会了解到EventSource,记录一下。
简介
EventSource是一个浏览器端用于接收服务器推送事件(Server-Sent Events, SSE)的 JS API。与 WebSocket 不同,SSE 是单向的(服务器到客户端),适用于更新频率不高的实时通知、消息推送等场景。
基本用法
创建连接
const eventSource = new EventSource('后台提供的接口地址');
监听数据上报
eventSource.addEventListener('后台定义的事件类型这个名字前后端需要保持一致', (event) => {
console.log('Custom Event:', event.data);
});
捕获错误
我用的时候想在这个error里获取接口的状态码,但是发现没有,所以作罢。
eventSource.onerror = (error: any) => {
console.log(error);
}
关闭连接
eventSource.close();
应用
通过一个简易的滚动日志功能来运用一下EventSource吧。语法是vue3+ts。
其中滚动条始终滚动到最底部相关的逻辑参考如下,这位大佬分享的很详细!VUE中如何让滚动条保持在最底部(数据实时更新,页面高度随时变化)_vue滚动条自动滚动到底部-CSDN博客
HTML代码
<template>
<div ref="logElRef">
<div v-for="log in logList" :key="log">{{ log }}</div>
</div>
</template>
JS代码
<script setup lang="ts">
import { inject, ref, nextTick, onMounted, onBeforeUnmount } from 'vue';
const logElRef = ref();
const logList = ref([]);
const oldScrollTop = ref(0);
const scrollFlag = ref(true);
const eventSource = ref();
// 建立连接
const initSSE = () => {
eventSource.value = new EventSource('后台提供的接口地址');
// 监听自定义的事件
eventSource.value.addEventListener('后台定义的事件类型这个名字前后端需要保持一致', (event) => {
console.log('Custom Event:', event.data);
logList.push(event.data);// 保存流式数据
if (scrollFlag.value) {
scrollToBottom(); // 数据更新后滚动到最底部,始终让最新的数据可见
}
});
// 监听接收到的消息,但我用这个方式监听不到数据,不知道为啥
//eventSource.value.onmessage = (event: any) => {
// console.log('Event:', event.data);
//}
// 捕获异常
eventSource.value.onerror = (error: any) => {
console.log(error);
}
}
// 关闭连接
const closeSSE = () => {
eventSource.value?.close();
};
// 使滚动条置底
const scrollToBottom = () => {
nextTick(() => {
logElRef.value.scrollTop = logElRef.value.scrollHeight;
})
}
// 监听滚动事件
const scrolling = () => {
let scrollTop = logElRef.value.scrollTop;
// 更新——滚动前,滚动条距文档顶部的距离
let scrollStep = scrollTop - oldScrollTop.value;
oldScrollTop.value = scrollTop;
//判断当前是向上or向下滚动
if (scrollStep < 0) {
//向上
scrollFlag.value = false;
} else {
scrollFlag.value = true;
}
}
onMounted(() => {
// 进入页面后开始创建连接监听数据上报并监听滚动条事件,始终让滚动条在最底部,最新的数据可见
initSSE();
logElRef.value.addEventListener('scroll', scrolling);
scrollToBottom();
})
onBeforeUnmount(() => {
closeSSE();
logElRef.value.removeEventListener('scroll', scrolling);
})
</script>
样式代码
<style scoped>
.log-wrap {
width: 100%;
min-height: 500px;
max-height: 1780px;
overflow-x: hidden;
overflow-y: auto;
}
</style>