RSM:超实用的多场景请求管理方案

各位前端er们,用了那么久的再熟悉不过的接口请求,有没有觉得不妥???你可能会觉得,这有什么不妥,不就axios.get一下,fetch一下,请求就发出了嘛,然后再处理返回的数据,完事。真有这么简单吗?问题来了,针对不同场景下的请求需求,真的可以统一这样处理就完事吗?我们来聊聊请求这事儿!

聊聊前端请求的场景

我们先来聊聊前端请求的各种场景,以下是一些做请求时遇到的高频场景。

  1. 什么时候发出请求,是一进入页面,还是点击某个按钮再触发,还是某个数据改变后就触发,还是...?
  2. 是否要在页面上展示请求状态?
  3. 某个请求是否要封装成一个函数,以便重复调用,比如翻页请求;
  4. 用户可能会高频请求的接口是否做数据缓存,比如在数秒内会重复查看的数据?
  5. 处理完一些数据后需要跨页面或模块操作数据,要怎么做更方便?总不能都放在全局状态内吧;
  6. 离线了还能安全提交数据吗,比如编辑器需要频繁自动保存草稿,突然离线了怎么办?
  7. 其他请求场景...

这些请求场景在不同项目中,或相同项目的不同的位置都需要做不同的处理,如果我们还只是单纯的用请求库发起请求,那就会有失性能和优雅度。

对请求场景进行管理

因为上面这些问题,就产生了一个概念,叫请求场景管理(RSM,Request scene management),下面我们来聊聊这个概念,先上图,英文图,自行翻译。

rsm.png

和Flux概念一样,它仅仅只是提出了一套流程规范,然后各开发者可以根据它进行参考改造变形一通形成自己独有的思路,再然后编码实现它。

我的理解是它更像是给请求库安上了机械臂、喷漆桶什么的,把请求库武装起来了,就像钢铁侠一样。

123.png

在这里,这个规范提出了4个流程,分别如下:

请求时机

描述在什么时候需要发出请求。

  • 初始化展示数据,如刚进入某个界面或子界面;
  • 人机交互触发CS交互,需要变更数据重新发出请求,如翻页、筛选、排序、模糊搜索等;
  • 预加载数据,如分页内预先加载下一页内容、预测用户点击某个按钮后预先拉取数据;
  • 操作服务端数据,需发出增删改查请求,如提交数据、删除数据等;
  • 同步服务端状态,如数据变化较快的场景下轮询请求、操作了某个数据后重新拉取数据;

请求行为

描述以怎样的方式处理请求。

  • 占位请求,请求时展示loading、骨架图、或者是上次使用的真实数据;
  • 缓存高频响应,多次执行请求会使用保鲜数据;
  • 多请求串行与并行;
  • 对频繁的请求进行防抖,避免前端数据闪动,以及降低服务端压力;
  • 重要接口重试机制,降低网络不稳定造成的请求失败概率;
  • 静默提交,当只关心提交数据时,提交请求后直接响应成功事件,后台保证请求成功;
  • 离线提交,离线时将提交数据暂存到本地,网络连接后再提交;

请求事件

表示携带请求参数发送请求,获得响应,这就是我们最常用到的axiosfetchXMLHttpRequest等,看!这里我们要重新认识上面这些请求方案的定位了,它只是作为请求场景管理的环节之一。

响应数据管理

顾名思义,就是统一管理响应数据,任何位置都可以对响应数据进行操作,这部分基本是结合reactvue等MVVM框架的状态机制来使用的,就好像有个专门用来管理响应数据的reduxvuex,你可以跨模块操作这些状态化的响应数据,而不用什么事件机制。

  • 移除缓存响应数据,再次发起请求时将从服务端拉取;
  • 更新缓存响应数据,可更新任意位置响应数据,非常有利于跨页面更新数据;
  • 刷新响应数据,可重新刷新任意位置的响应数据,也非常有利于跨页面更新数据;
  • 自定义设置缓存,在请求批量数据时,可手动对批量数据一一设置缓存,从而满足后续单条数据的缓存命中;

alova,一个RSM实现库

alova是我发现的较为简易上手的RSM实现库,因为它的设计真的很像axios,新手也能很快上手,同时它也可以和任意的请求库进行协作。

简单演示下alova的使用方法,终于要开始实操上代码了,在使用alova之前需要先创建一个实例,假设我们在vue项目中使用。

import { createAlova } from 'alova';
import VueHook from 'alova/vue';
import GlobalFetch from 'alova';

const alovaInstance = createAlova({
    // 请求接口前缀
    baseURL: 'https://api.alovajs.org',
    
    // 用于给mvvm库创建状态化响应数据
    // vue项目传入VueHook,react项目传入ReactHook
    statesHook: VueHook,
    
    // 传一个请求适配器,GlobalFetch是我们提供的fetch api适配器
    // 你想用axios也可以自定义一个适配器
    requestAdapter: GlobalFetch(),
    
    // 是不是有熟悉的味道
    beforeRequest(config) {
        config.headers.token = 'tokenxxx';
    },
    async responsed(response) {
      const json = await response.json();
      if (json.code !== 200) {
        throw new Error(json.message);
      }
      return json.data;
    },
});

以Todo为例,发起todo详情请求

// 先定义一个请求函数,该函数返回的是一个请求对象,表示一次请求的信息,但还不会实际发出请求
// 它的用法很接近axios
const getTodoDetail = id => alovaInstance.Get('/todo', {
    params: {
        id
    },
    
    // 本地缓存50000毫秒,再次请求时将会命中缓存,而不会再次发起请求
    localCache: 50000,
});

// 发起请求
const {
    // loading是加载状态值,当加载时它的值为true,结束后自动更新为false
    // Vue3环境下,它是一个Ref类型的值,你可以通过loading.value访问它,或直接绑定到界面中
    loading,
    

    // 状态化的响应数据
    data: todoDetail,

    // 请求错误对象,请求错误时有值,否则为undefined
    error,

    // 成功回调绑定
    onSuccess,

    // 失败回调绑定
    onError,

    // 完成回调绑定
    onComplete,
    
} = useRequest(getTodoDetail(this.$params.todoId)); // 将请求对象传入即可发送请求
onSuccess(todoListRaw => {
  console.log('请求成功,这里也可以访问响应数据:', todoListRaw);
});
onError(error => {
  console.log('请求失败,错误信息为:', error);
});
onComplete(() => {
  console.log('请求完成,不管成功失败都会调用');
});

你可以直接使用useRequest返回的状态绑定到界面上

<div v-if="loading">Loading...</div>
<div v-else-if="error" class="error">{{ error.message }}</div>
<template v-else>
    <div class="todo-title">{{ todoDetail.title }}</div>
    <div class="todo-time">{{ todoDetail.time }}</div>
</template>

提交数据

// 创建提交数据的请求对象
const createTodo = newTodo => alovaInstance.Post('/create-todo', newTodo);

const {
    loading,
    data,
    error,

    // 手动发送器请求的函数,调用后发送请求
    send: addTodo,
} = useRequest(newTodo => createTodoPoster(newTodo), {
    // 当immediate为false时,默认不发出
    immediate: false
});

// 假设这是我们需要提交的数据
const newTodo = {
    title: '新的todo项',
    time: new Date().toLocaleString()
};

// 用于提交成功后刷新todo列表数据
const { fetch } = useFetcher(alovaInstance);

// 手动发送请求
const handleAddTodo = async () => {
    try {
        cosnt result = await addTodo(newTodo);
        console.log('新增todo项成功,响应数据为:', result);
        
        // 提交成功后可能需要刷新todo列表数据,可以在这里调用fetch函数
        fetch(getTodoList());
    } catch(error) {
        console.log('新增todo项失败,错误信息为:', error);
    }
};

在界面中点击按钮发起请求

<!-- 忽略其他... -->
<button @click="handleAddTodo">创建todo</button>

总结

因为篇幅的原因,今天的分享就先到这啦,这里也只是演示了一点点alova的功能,它的强大还不止于此,它也给了我们很多很实用的请求处理方案,不管是在项目中提升性能,提升代码优越度,亦或是降低服务端压力,都有很大的帮助。有兴趣的小伙伴可以去github上详细了解了解!

各位,你们觉得还有哪些请求场景的例子吗?

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 196,264评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,549评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,389评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,616评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,461评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,351评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,776评论 3 387
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,414评论 0 255
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,722评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,760评论 2 314
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,537评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,381评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,787评论 3 300
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,030评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,304评论 1 252
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,734评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,943评论 2 336

推荐阅读更多精彩内容