HTTP工具类文件request.js的完善和优化

发布时间 2023-09-07 16:16:38作者: 优前程

request.js 在现代前端项目中通常被称为一个HTTP请求工具HTTP工具类文件。它的主要作用是对项目中用到的HTTP请求进行统一的配置和处理。

应用示例:

// 查询用户列表
export function listUser(query) {
  return request({
    url: '/system/user/list',
    method: 'get',
    params: query
  })
}

具体来说,这个文件的作用和定义如下:

  1. 请求/响应拦截器: 利用axios的拦截器功能,可以在请求发送前或响应返回后进行特定的操作,如添加统一的头部信息、处理统一的错误反馈等。

  2. 统一处理错误: 通过响应拦截器,可以在接口返回错误时给出统一的用户反馈,而不是在每次请求时都单独处理。

  3. 基础配置: 对所有的HTTP请求进行统一的基础配置,例如设置请求的基础URL、超时时间等。

  4. 封装工具函数: 如示例中的download方法,它是一个专门处理文件下载的函数,提供了更加友好的API和统一的错误处理。

  5. 鉴权: 对需要身份验证的请求进行统一处理,例如添加token。

因此,您可以将request.js定义为项目中用于管理和配置HTTP请求的工具类HTTP请求助手

优化点

当然,对于一个成熟的前端项目,特别是与后端接口交互频繁的系统,对错误处理、优雅降级等都应该有很好的处理。针对您提供的 request.js 文件,我为您提供以下优化点:

  1. 统一错误处理: 抽取一个函数来进行错误处理,使代码更整洁。
  2. 接口请求重试: 当因网络波动或其他原因导致请求失败时,可以尝试再次发起请求。
  3. 前端路由守卫: 当检测到用户未登录或登录已过期时,除了提示用户,还可以使用 Vue Router 的路由守卫将用户重定向到登录页面。
  4. 接口请求节流/防抖: 有时候用户操作过于频繁,为防止频繁的请求,可以在关键的接口请求上增加节流或防抖处理。
  5. 更友好的加载提示: 对于耗时的操作,展示一个加载提示,告诉用户请求正在进行。
  6. API版本管理: 如果后端API可能会有版本迭代,考虑在请求URL中加入版本号,如 /v1/system/role/list

具体到代码,以下是其中一些优化建议:

  1. 统一错误处理

    function handleError(error) {
      const message = error.message || 'Unknown error';
      if (message.includes("Network Error")) {
        showFailToast({ message: "后端接口连接异常" });
      } else if (message.includes("timeout")) {
        showFailToast({ message: "系统接口请求超时" });
      } else if (message.includes("Request failed with status code")) {
        const status = message.substr(message.length - 3);
        showFailToast({ message: `系统接口${status}异常` });
      } else {
        showFailToast({ message });
      }
    }
    
  2. 接口请求重试

    在axios拦截器中,可以增加逻辑来实现请求重试:

    let retries = 3;  // 设置重试次数
    
    service.interceptors.response.use(undefined, async error => {
      const config = error.config;
      if (!config || retries === 0) {
        handleError(error);
        return Promise.reject(error);
      }
    
      retries -= 1;
      return new Promise(resolve => setTimeout(() => resolve(axios(config)), 1000));
    });
    
  3. 前端路由守卫

    在路由守卫中进行登录状态检查:

    router.beforeEach((to, from, next) => {
      if (to.meta.requiresAuth && !getToken()) {
        showWarnToast({ message: '登录已过期,请重新登录' });
        next('/login');
      } else {
        next();
      }
    });
    

以上只是针对您提供的 request.js 文件中的部分内容给出的建议。根据项目的具体需求和复杂性,还可能有其他优化点。

其他

当然,前端开发和优化是一个持续的过程。除了前面提到的一些点,以下还有更多业界常用的优化和最佳实践方法:

  1. 环境区分:
    根据不同的环境(开发、测试、生产等)使用不同的配置。例如,您可能只想在开发环境中打印所有的控制台日志,而在生产环境中关闭它们。

  2. 缓存处理:
    使用HTTP缓存策略或前端存储,如localStorage、sessionStorage或indexedDB,来缓存关键数据,减少不必要的请求。

  3. API Mocking:
    在开发过程中,后端接口可能还没准备好。此时可以使用mock工具,如miragejs,来模拟后端响应。

  4. WebSocket 或 Server-Sent Events:
    对于需要实时交互的功能,传统的轮询方式可能不是最佳选择。考虑使用WebSocket或Server-Sent Events来实现。

  5. Progressive Web Apps (PWA):
    考虑将您的应用转化为PWA,提供离线功能和增强的用户体验。

  6. Content Delivery Network (CDN):
    使用CDN来加速资源加载,尤其是对于大型静态文件如图片、视频、JS和CSS文件。

  7. 代码分割与懒加载:
    使用Vue Router的懒加载功能,按需加载页面组件,减少首屏加载时间。

  8. 使用Compression:
    通过gzip或Brotli等工具压缩资源,减少传输的数据量。

  9. 前端性能监控:
    使用如SentryLogRocket这样的工具来监控前端性能和捕捉运行时错误。

  10. 使用Web Workers:
    对于计算密集型任务,考虑使用Web Workers在后台线程中执行,避免UI线程被阻塞。

  11. 安全性考虑:
    使用Content Security Policy (CSP)、确保API请求都使用HTTPS,避免跨站请求伪造等,增加应用的安全性。

  12. SEO优化:
    考虑使用服务端渲染(例如Nuxt.js或Vue Server Renderer)来优化SEO,或使用预渲染。

  13. 交互与用户体验:
    对关键用户操作提供反馈,如按钮点击动画、加载指示器等。

  14. 访问性优化:
    确保您的应用满足WCAG标准,对于有障碍的用户也具有良好的体验。

以上只是一些常见的最佳实践和优化策略,具体实施应该基于您项目的需求和状况来决定。