首页 > 其他分享 >前端fetch 实现流式接口

前端fetch 实现流式接口

时间:2024-05-24 17:57:12浏览次数:31  
标签:const 流式 res value 接口 return fetch

遇到这样一个需求,通过ai动态生成大纲文本,前端在接收到后端的文本内容时,接收的文本是“动态”的,视角表现层面上逐字生成渲染的,效果如下,那么如何实现这种效果?这里就要用到流式接口,也就是流式传输。

<iframe allowfullscreen="true" data-mediaembed="csdn" frameborder="0" id="Cc93M4VJ-1716447247361" src="https://live.csdn.net/v/embed/390240"></iframe>

屏幕录制2024-05-23 11.58.55

什么是流式传输

  先说说传统传输吧,我们日常接触的大多数是传统传输方式,就也是整段传输,前后端将数据一次性传送给对方;相比于传统传输方式,流式传输则采用分段的方式将要传输的数据分层n段,后端一次性传一段给前端,直到传输完成为止,当然在传输的过程中,前端也可以提前中断传输,后端收到中断传输的消息后,也不再继续往前端传输剩下没传完的数据段。 当然,前端流式传输需要在后端支持分块传输的情况下才能实现。

前端实现流式传输的几种主流方式

查阅了资料,目前前端实现流式传输主要有以下几种方式:fetch、SSE、websocket,详情移步另一位博主,没错我查阅的资料就是他的文章,链接chatGPT流式输出前端实现fetch、SSE、websocket_fetch sse-CSDN博客

我用的是fetch,fetch 本身不直接支持流式输出,但你可以使用fetch ai 中的 ReadableStream实现流式数据处理。

什么是fetch?

简单来说fetch 是一种 HTTP 数据请求的方式, XMLHttpRequest(以下简称 XHR)的一种替代方案。与基于回调的API的XMLHttpRequest不同,fetch是基于Promise的,可以链式分块化地处理数据,更重要的是Fetch API能够处理流式响应。

更多关于fetch 的文档可以参考以下文档,我们重点讲fetch 处理流式响应

fetch 官方文档: 官方文档 

 js ES6 fetch 方法_js fetch-CSDN博客

fetch实现流式输出的实现原理_fetch nodejs 客户端 流式输出-CSDN博客

fetch处理流式响应

要实现 fetch 的流式输出,关键在于如何正确地处理返回的 ReadableStream 对象。ReadableStream 是 HTML 标准的一部分,它代表了一个可以从内部读取数据的源头。在 Fetch API 中,Response 对象的 body 属性就是一个 ReadableStream 实例。

  return fetch(input, { ...init, headers })
    .then((res) => {
      console.log('res.body', res.body);
      if (res.ok) return Promise.resolve(res);
    })

实现步骤:

  1.创建一个阅读器并将流锁定到它。

 //创建一个阅读器并将流锁定到它。当流被锁定时,在这个阅读器发布之前,无法获得其他阅读器
      const reader = res_.body.getReader();
      return reader.read().then(({ value, done }) => {
        console.log('value', value);
      });

          

 可以看到阅读器一次只接收一次响应数据,且接收到的数据为utf-8编码数据,这时我们需要让阅读器重复获取数据(发布这个阅读器),直到数据获取完或者手动中止为止,并且还要对 utf-8编码数据进行转码

2. 发布阅读器我们 可以使用递归函数去重复发布阅读器

 const reader = res_.body.getReader();
      return reader.read().then(function push({ value, done }) {
        console.log('done, value', done, value);
        return reader.read().then(push);
      });

 3. 转码的话我们需要使用 文本解码器(TextDecoder)进行转码 ,详情可以看我另一篇文章浅识TextDecoder-CSDN博客

 const reader = res_.body.getReader();
      const utf8Decoder = new TextDecoder('utf-8');
      return reader.read().then(function push({ value, done }) {
        let _value = value ? utf8Decoder.decode(value, { stream: true }) : '';
        console.log('转码后的数据', _value);
        return reader.read().then(push);
      });

4.中止fetch
  要中止不完整的fetch()操作,请使用AbortControllerAbortSignal接口。

   定义

  const controllerRef = useRef(null);
 controllerRef.current = new AbortController();
      const signal = controllerRef.current.signal;
      fetch(input, { headers, signal })

  使用

 <button onClick={() => controllerRef.current.abort()}>停止生成 </button>

5.完整代码

//存储中断器
  const controllerRef = useRef(null);

  const getStreamData = () => {
    const input = 'xxxxxx';
    //fetch 其它配置项
    const token = utils.getToken();
    const headers = {
      ...(token ? { Authorization: 'Bearer ' + token } : null),
    };

    controllerRef.current = new AbortController();
    const signal = controllerRef.current.signal;

    //存储拿到的数据
    let outline = '';

    fetch(input, { headers, signal })
      .then((res) => {
        //res.ok 表示成功状态
        if (res.ok) return Promise.resolve(res);
      })
      .then((res_) => {
        //创建一个阅读器并将流锁定到它。当流被锁定时,在这个阅读器发布之前,无法获得其他阅读器
        const reader = res_.body.getReader();
        const utf8Decoder = new TextDecoder('utf-8');
        //定义一个对象存储每次拿到的数据
        return reader.read().then(function push({ value, done }) {
          if (done) {
            //表示数据流结束
            return outline;
          } else {
            let _value = value ? utf8Decoder.decode(value, { stream: true }) : '';
            let _data = _value?.split('\n\n') || [];
            for (const it of _data) {
              let _it = it.replace(/^(data: \[DONE\])|^(data:)/, '');
              if (_it) {
                let res: { code; data; msg } = JSON.parse(_it);
                if (res?.code == 0) {
                  outline = outline + res?.data?.text;
                  console.log('接收到的数据为:', outline);
                } else {
                  return Promise.reject(res);
                }
              }
            }
          }
          return reader.read().then(push);
        });
      });
  };

​​​​​​​

​​​​​​​


标签:const,流式,res,value,接口,return,fetch
From: https://blog.csdn.net/weixin_44405693/article/details/139000453

相关文章

  • keycloak~登出的回调接口
    对于用户的登出/注销操作,都可以设置一个回调接口,这个接口是作用到client上面的,并且必须是POST接口,相关回调方法的调用,可以参考keycloak14.0.0的这个方法:org.keycloak.services.managers.sendBackChannelLogoutRequestToClientUri核心代码段LogoutTokenlogoutToken=sessio......
  • vite config proxy 代理 外网接口 配置单写法
    viteconfigproxy代理外网接口配置单写法之前一个小坑target:'http://yourdomain/',之前域名后面我写子目录了,导致一直不好使。在这之前,用nginx配置,没配置出来~,所以搞成vite配置走起。。vite.config.jsserver:{proxy:{'/ci':{target:'http:/......
  • 实时识别关键词API接口,将搜索结果提升至新的高度!
      实时识别关键词是一种能够将搜索结果提升至新的高度的API接口。它可以帮助我们更有效地分析文本,并提取出关键词,以便进行进一步的处理和分析。该接口是挖数据平台提供的,有三种模式:精确模式、全模式和搜索引擎模式。不同的模式在分词的方式上有所不同,适用于不同的场景。首......
  • Postman 如何处理接口关联?
    postman设置接口关联在实际的接口测试中,后一个接口经常需要用到前一个接口返回的结果,从而让后一个接口能正常执行,这个过程的实现称为关联。在postman中实现关联操作的步骤如下:1、利用postman获取上一个接口指定的返回值,可以在tests中提取响应中的字典做全局变量;如下图2、编写......
  • LLM-文心一言:什么是北向接口?
    北向接口(NorthboundInterface)是指在网络管理架构中,用于上层应用或管理系统与下层网络控制或管理系统之间进行交互的接口。它通常是一种开放、标准化的接口,允许上层系统通过该接口对下层系统进行配置、监控和管理。在SDN(软件定义网络)和NFV(网络功能虚拟化)等新型网络架构中,北向接......
  • JAVA——接口
                               前言:接口是一种规范和标准,它是一些方法特征的集合,但无具体的实现细节。接口可以被类或其他接口实现,通过面向接口的编程,可以提高代码的复用率、可维护性、可扩展性。1.接口概念在现实......
  • 接口设计的18条军规
    前言之前写过一篇文章《表设计的18条军规》,发表之前,在全网广受好评。今天延续设计的话题,给大家总结了接口设计的18条军规,希望对你会有所帮助。1.签名为了防止API接口中的数据被篡改,很多时候我们需要对API接口做签名。接口请求方将请求参数+时间戳+密钥拼接成一个字符串......
  • 【Golang】在Go语言中如何实现接口
    文章目录前言一、函数解释二、代码实现三、总结前言接口是Go语言中的一个核心概念,它为类型定义了行为。接口提供了一种方式,使得不同的类型可以被同样对待,只要它们实现了相同的接口。在这篇博客中,我们将讨论如何在Go语言中实现接口。一、函数解释在Go语言中,接口是......
  • 二、接口自动化测试(1)
    一、什么是接口测试先回顾一下原理:参考网站:https://blog.csdn.net/HUA1211/article/details/131959650接口测试的原理就是模拟客户端向服务器发送请求,服务器接收请求报文后对相应的报文做处理并向客户端返回应答,客户端接收应答的过程。接口测试采用的方法其实与黑盒测试一致的,甚......
  • TS类,接口,泛型的简介
    //1.类的属性和方法classDog{name:string="旺财";age:number=2;shout(){console.log("汪汪汪")}}letdog=newDog()//2.类的构造函数(用于给类中的属性设定初始值,在创建类的实例时会被触发)classCat{name:string;ag......