UniApp 中封装 HTTP 请求与 Token 管理(附Demo)

1. 基本知识

从实战代码中学习,上述实战代码来源:芋道源码/yudao-mall-uniapp

在这里插入图片描述

该代码中,通过自定义 request 函数对 HTTP 请求进行了统一管理,并且结合了 Token 认证机制

  1. 请求封装原理,request 函数是对 uni.request 的一个封装
  • 动态设置请求头:根据 config 的配置,决定是否需要在请求头中附加 Authorization(Bearer Token)。Token 是从本地存储中获取的
  • 根据环境区分不同的 Base URL:根据当前的开发环境(development 或 production),动态设置请求的基础 URL(baseUrl)
  • 统一处理请求参数:config.params 会被转化成查询字符串,拼接到请求的 URL 后面
  • Promise 封装异步操作:请求通过 uni.request 发出,并将返回的 response 数据封装为一个 Promise,使得调用 request 的地方可以使用 then 或 catch 来处理结果
  1. Token 认证管理原理
  • Token 存储:uni.setStorageSync 和 uni.getStorageSync 被用来在客户端本地存储 ACCESS_TOKEN 和 REFRESH_TOKEN,这两个 Token 被用于身份验证
  • 获取 Token:在每次 HTTP 请求时,首先会检查请求是否需要 Token(通过 config.headers.isToken 判断)。如果需要,就从本地存储中获取 AccessToken 并加入到请求头中
  • Token 过期处理:当请求返回的状态码为 401 时,表示 Token 已过期,此时会弹出提示框,让用户重新登录并清除旧的 Token
  1. 错误处理机制
  • 网络错误:封装了常见的网络错误(如超时、服务器错误等),并提供了友好的提示
  • 接口返回错误:统一处理接口返回的错误,错误信息根据 res.data.code 的值来决定,如果返回的是 500 错误或其他非 200 的错误,则通过 toast 提示给用户
  • 401 错误处理:当返回状态码为 401 时,表示 Token 过期或无效,代码会自动处理登出流程

2. Demo

根据实战中的Demo,给出一版通用的Demo:

封装request的时候,需要与token结合:

// utils/request.js
import { getAccessToken, setToken, removeToken } from '@/utils/auth';
import config from '@/config';
import errorCode from '@/utils/errorCode';
import { toast, showConfirm } from '@/utils/common';

let timeout = 10000;
let baseUrl = process.env.NODE_ENV === 'development' ? config.devbaseUrl : config.prodbaseUrl;

const request = config => {
  const isToken = (config.headers || {}).isToken === false;
  config.header = config.header || {};
  
  if (getAccessToken() && !isToken) {
    config.header['Authorization'] = 'Bearer ' + getAccessToken();
  }

  config.header['tenant-id'] = '1'; // 强制设置租户 ID

  if (config.params) {
    let url = config.url + '?' + tansParams(config.params);
    url = url.slice(0, -1);
    config.url = url;
  }

  return new Promise((resolve, reject) => {
    uni.request({
      method: config.method || 'get',
      timeout: config.timeout || timeout,
      url: config.baseUrl || baseUrl + config.url,
      data: config.data,
      header: config.header,
      dataType: 'json'
    }).then(response => {
      let [error, res] = response;
      if (error) {
        toast('后端接口连接异常');
        reject('后端接口连接异常');
        return;
      }
      const code = res.data.code || 200;
      const msg = errorCode[code] || res.data.msg || errorCode['default'];
      
      if (code === 401) {
        showConfirm('登录状态已过期,您可以继续留在该页面,或者重新登录?').then(res => {
          if (res.confirm) {
            removeToken();
            uni.reLaunch({ url: '/pages/login' });
          }
        });
        reject('无效的会话,或者会话已过期,请重新登录。');
      } else if (code === 500) {
        toast(msg);
        reject('500');
      } else if (code !== 200) {
        toast(msg);
        reject(code);
      }
      resolve(res.data);
    }).catch(error => {
      let { message } = error;
      if (message === 'Network Error') message = '后端接口连接异常';
      else if (message.includes('timeout')) message = '系统接口请求超时';
      else if (message.includes('Request failed with status code')) message = '系统接口' + message.substr(message.length - 3) + '异常';
      toast(message);
      reject(error);
    });
  });
};

export default request;

对应的token文件:

// utils/auth.js
const AccessTokenKey = 'ACCESS_TOKEN';
const RefreshTokenKey = 'REFRESH_TOKEN';

export function getAccessToken() {
  return uni.getStorageSync(AccessTokenKey);
}

export function getRefreshToken() {
  return uni.getStorageSync(RefreshTokenKey);
}

export function setToken(token) {
  uni.setStorageSync(AccessTokenKey, token.accessToken);
  uni.setStorageSync(RefreshTokenKey, token.refreshToken);
}

export function removeToken() {
  uni.removeStorageSync(AccessTokenKey);
  uni.removeStorageSync(RefreshTokenKey);
}

相关接口请求:

// 在页面中调用封装的请求方法
import request from '@/utils/request';

export default {
  methods: {
    fetchData() {
      request({
        url: '/api/getData',
        method: 'GET',
        params: { id: 123 }
      }).then(response => {
        console.log('数据:', response);
      }).catch(error => {
        console.log('请求失败:', error);
      });
    }
  }
}

3. 拓展

process.env.NODE_ENV 是 Node.js 环境中用于获取当前应用运行环境的一个变量

在大多数前端框架(如 Vue、React)以及后端框架(如 Express)中,process.env.NODE_ENV 被广泛用于区分不同的开发环境

前端vue中可能已经标明了
在开发模式下:NODE_ENV=development npm run dev
在生产模式下:NODE_ENV=production npm run build
在 npm 脚本中,可以通过 cross-env 等工具来跨平台设置环境变量:

"scripts": {
  "dev": "cross-env NODE_ENV=development vue-cli-service serve",
  "build": "cross-env NODE_ENV=production vue-cli-service build"
}

另外一个接口超时时间,全局默认是20秒,如果时长不对,可以在单独某个接口设置:

// 上传图片
uploadImage(data) {
  return upload({
    url: '/infra/file/upload',
    method: 'upload',
    filePath: data.filePath,
    timeout: 30000  // 设置超时时间为30秒
  });
}
### 封装带有 TokenHTTP 请求UniApp 应用程序中,通过合理封装 HTTP 请求可以有效简化开发流程并提高代码可维护性。对于需要带认证令牌(Token)的请求来说,最佳实践之一是利用拦截器机制来自动化这一过程。 #### 使用拦截器处理 Token 为了确保每一次 API 调用都包含有效的 `Authorization` 头部信息,可以在全局范围内安装一个请求拦截器。此拦截器会在实际发出请求之前读取本地存储中的 token,并将其加到请求头部[^2]。 ```javascript const TOKEN_KEY = 'token'; // 定义处理函数以向配置对象添加授权字段 const handleToken = (config) => { let token = uni.getStorageSync(TOKEN_KEY); if (token) { config.header['Authorization'] = `Bearer ${token}`; } }; // 注册请求拦截器 uni.addInterceptor('request', { invoke: function (config) { handleToken(config); return config; }, }); ``` 上述代码片段展示了如何创建一个名为 `handleToken` 的辅助函数,该函数负责从本地缓存获取 token 并更新传入的请求配置对象。接着,通过调用 `uni.addInterceptor()` 方法注册了一个针对所有 `request` 类型操作的事前处理器(`invoke`),它会自动执行 `handleToken` 来准备每次请求所需的认证信息。 #### 创建统一的 Request 工具类 除了设置通用的行为外,还可以进一步抽象出专门用于发起网络请求的服务模块。这不仅有助于保持业务逻辑清晰分离,而且使得后续扩展更加容易。下面是一个基于前面提到的方法构建的基础请求工具的例子: ```javascript import { addInterceptor } from '@dcloudio/uni-app'; import axios from 'axios'; class ApiService { constructor(baseURL) { this.instance = axios.create({ baseURL, timeout: 5000, headers: {} }); // 添加响应拦截器以便于集中管理错误情况下的重定向或其他动作 this.instance.interceptors.response.use( response => Promise.resolve(response), error => Promise.reject(error) ); // 如果项目依赖的是原生uni.request,则替换此处为对应的addInterceptor实现 addInterceptor('request', { invoke: config => { const token = uni.getStorageSync('token'); if (token && !config.headers.Authorization) { config.headers.Authorization = `Bearer ${token}`; } return config; } }); } async post(url, params={}) { try { const res = await this.instance.post(url, params); return res.data; } catch (err) { console.error(err.message || err); throw new Error('POST request failed.'); } } async get(url, query={}) { try { const res = await this.instance.get(url, {params:query}); return res.data; } catch (err) { console.error(err.message || err); throw new Error('GET request failed.'); } } } export default ApiService; ``` 这段代码定义了一个简单的 Axios 实例作为底层通信层,并为其设置了默认选项以及必要的拦截器支持。值得注意的是,这里还实现了两个常用的操作——`get` 和 `post` ——它们能够接收 URL 及参数作为输入,并返回经过解析后的 JSON 数据结构。此外,当遇到异常状况时也会抛出自定义的消息提示给上层应用知道发生了什么问题[^3]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

码农研究僧

你的鼓励将是我创作的动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值