《微信小程序》第三章:Request封装

系列文章

《微信小程序》https://blog.csdn.net/sen_shan/category_13069009.html

第二章:第一个程序https://blog.csdn.net/sen_shan/article/details/153685143?spm=1001.2014.3001.5501

文章目录

目录

系列文章

文章目录

前言

Toast封装

Request封装

后续


前言

本文介绍了微信小程序开发中的两个核心工具封装:Toast提示和Request请求。

Toast封装通过统一配置解决了提示时长不一致、图标类型错误和错误提示样式问题;

Request封装则构建了一个类型安全的网络请求层,统一处理域名配置、超时设置、Header管理、Token携带、错误提示等功能,并内置了401登录失效自动处理机制。文章重点展示了如何通过TypeScript类型系统提升开发体验,使业务代码只需关注核心逻辑,同时保持对请求参数和返回数据的类型安全。这些封装旨在减少重复代码,提高开发效率和代码可维护性。

Toast封装

在 WechatMiniApp 项目下新建 src/utils/toast.ts

javascript 复制代码
type ToastIcon = 'success' | 'loading' | 'none' | undefined

const DEFAULT_OPTS = {
  duration: 4000, // 统一 4 秒
  icon: 'success' as ToastIcon,
}

export function toast(title: string, icon?: ToastIcon, duration = DEFAULT_OPTS.duration) {
  uni.showToast({ title, icon: icon ?? DEFAULT_OPTS.icon, duration })
}

// 可选:错误专用(红色图标/更长)
export function toastError(title: string) {
  toast(title, 'none', 5000)
}

解决调用 uni.showToast 时出现的 3 类问题:

  1. 提示时长不统一(2 s / 3 s / 5 s 随意写)。

  2. 图标类型写错(success 拼成 succes、loading 写成 load)。

  3. 错误提示样式与正常提示无区分,用户感知弱。

Request封装

在 WechatMiniApp 项目下新建 src/utils/reques.ts

javascript 复制代码
// 顶部引入
import { toastError } from './toast'
/* 配置 ------------------------------------------------------------------ */
const BASE_URL = 'http://127.0.0.1:8080' // 替换你的后端域名
const TIMEOUT = 10_000 // ms

/* 类型定义 --------------------------------------------------------------- */
export type Method = 'GET' | 'POST' | 'PUT' | 'DELETE'

export interface RequestOptions<T = any> {
  url: string
  method?: Method
  data?: T
  headers?: Record<string, string>
  noToken?: boolean // 跳过 token
  noBaseURL?: boolean // 跳过 baseURL
  timeout?: number
}

// 后端统一返回格式(按你的实际改)
export interface HttpResponse<T = any> {
  status_code: number
  message: string
  data: T
}

/* 核心请求 --------------------------------------------------------------- */
export function request<R = any, T = any>(options: RequestOptions<T>): Promise<R> {
  return new Promise((resolve, reject) => {
    const token = uni.getStorageSync('token')
    const header: AnyObject = {
      'Content-Type': 'application/json; charset=utf-8',
	  'x-api-key': 'ae139f8f6a8efc2a74a1e852c5cdaa43', // ← 新增这一行
      ...options.headers,
    }

    if (!options.noToken && token) header.Authorization = `Bearer ${token}`

    uni.request({
      url: options.noBaseURL ? options.url : `${BASE_URL}${options.url}`,
      method: options.method || 'GET',
      data: options.data || {},
      header,
      timeout: options.timeout || TIMEOUT,
      success: (res) => handleSuccess<R>(res, resolve, reject),
      fail: (err) => handleFail(err, reject),
    })
  })
}

/* 成功处理 --------------------------------------------------------------- */
function handleSuccess<R>(
  res: UniApp.RequestSuccessCallbackResult,
  resolve: (value: R) => void,
  reject: (reason?: any) => void,
) {
  const { statusCode, data } = res
  // 成功区间
  if (statusCode >= 200 && statusCode < 300) {
    const resp = data as HttpResponse<R>
	console.log(resp)
    // 后端业务码自定义,这里以 0 为成功
    if (resp.status_code === 200) resolve(resp.data)
    else {
      toastError( resp.message)
      reject(resp)
    }
    return
  }
  // 401 登录态失效
  // if (statusCode === 401) {
  //   uni.clearStorageSync()
  //   uni.reLaunch({ url: '/pages/login/index' })
  //   reject(new Error('登录已过期'))
  //   return
  // }
  if (statusCode === 401) {
    const detail = (data as any)?.detail || '登录已过期'
    // uni.showToast({ title: detail, 
  				// 	icon: 'none',
  				// 	duration: 5000, // 5 秒
  				// })   // 需要提示就留,不需要就删
  	toastError( detail)   // 需要提示就留,不需要就删
    uni.clearStorageSync()
    uni.reLaunch({ url: '/pages/login/index' })
    reject(new Error(detail))
    return
  }
  if (statusCode !== 401 && statusCode >= 300 ) {
    const detail = (data as any)?.detail || '登录已过期'
    // uni.showToast({ title: detail, 
				// 	icon: 'none',
				// 	duration: 5000, // 5 秒
				// })   // 需要提示就留,不需要就删
	toastError( detail)   // 需要提示就留,不需要就删
    uni.clearStorageSync()
    // uni.reLaunch({ url: '/pages/login/index' })
    reject(new Error(detail))
    return
  }
  // 其他 HTTP 错误
  //uni.showToast({ title: `请求失败(${statusCode})`, icon: 'none' })
  toastError( `请求失败(${statusCode})`)
  reject(new Error(JSON.stringify(data)))
}

/* 失败处理 --------------------------------------------------------------- */
function handleFail(err: any, reject: (reason?: any) => void) {
  // uni.showToast({ title: '网络异常', icon: 'none' })
  toastError( `网络异常`)
  reject(err)
}

/* 上传文件 --------------------------------------------------------------- */
export function upload<R = any>(
  url: string,
  filePath: string,
  formData?: Record<string, any>,
  timeout = 30_000,
): Promise<R> {
  const token = uni.getStorageSync('token')
  return new Promise((resolve, reject) => {
    uni.uploadFile({
      url: `${BASE_URL}${url}`,
      filePath,
      name: 'file',
      formData,
      header: { Authorization: `Bearer ${token}` },
      timeout,
      success: (res) => {
        // uploadFile 返回字符串,先 parse
        const data: HttpResponse<R> = JSON.parse(res.data)
        if (data.status_code === 0) resolve(data.data)
        else {
          uni.showToast({ title: data.message || '上传失败', icon: 'none' })
          reject(data)
        }
      },
      fail: reject,
    })
  })
}

/* 导出别名(可选)-------------------------------------------------------- */
export const http = { get: <R = any>(url: string, params?: any) => request<R>({ url, data: params }),
                     post: <R = any>(url: string, data?: any) => request<R>({ url, method: 'POST', data }),
                     put: <R = any>(url: string, data?: any) => request<R>({ url, method: 'PUT', data }),
                     delete: <R = any>(url: string) => request<R>({ url, method: 'DELETE' }) }

目的

  1. 在 uni-app 项目里提供"一处配置、处处可用"的网络请求层,统一接管:

域名、超时、header、token、错误提示;

业务状态码与 HTTP 状态码的双重校验;

401 登录失效的自动清理与跳登录页;

所有异常统一使用 toastError 弹出红色错误提示,避免每个接口重复写 uni.showToast 。

  1. 通过 TypeScript 泛型与类型定义,让调用者在编译期即可获得:

请求参数提示 ( RequestOptions<T> );

返回数据结构提示 ( HttpResponse<R> → 直接拿到 R )。

  1. 额外内置文件上传常用 get/post/put/delete 别名,业务层基本不再需要自己拼 uni.request 。

核心功能

自动携带 x-api-key 与 Authorization (Bearer token),其中x-api-key自定义字段,按需增加

支持开关 noToken 、 noBaseURL ,方便调第三方开放接口。

200--300 之间且业务码 status_code === 200 才走 resolve ,否则弹错并 reject 。

401 场景:清缓存 → 跳登录页 → 返回 reject ,防止死循环。

网络层或 HTTP 异常统一 toastError 提示,业务只需 .catch() 即可,无需再写提示逻辑。

把"发请求-拼头-验码-弹错-登出"全部收拢,业务代码只关心 url 和 data 。

后续

1.Request应用案例

2.参数封装

相关推荐
千寻技术帮6 小时前
50013_基于微信小程序的校园志愿者系统
mysql·微信小程序·springboot·文档·ppt
2501_915909067 小时前
深入理解HTTPS和HTTP的区别、工作原理及安全重要性
安全·http·ios·小程序·https·uni-app·iphone
汤姆yu8 小时前
基于微信小程序的民宿预定系统
微信小程序·小程序·民宿预定
小小王app小程序开发9 小时前
淘宝扭蛋机小程序:电商娱乐化赛道的机遇挖掘与风险防控
小程序·娱乐
说私域9 小时前
基于开源AI智能名片链动2+1模式与S2B2C商城小程序的商家活动策略研究
人工智能·小程序
低代码布道师9 小时前
医疗小程序07设置默认卡
低代码·小程序
黑夜世界16 小时前
微信小程序map组件聚合簇样式自定义
微信小程序·小程序
菠菠萝宝18 小时前
【AI应用探索】-10- Cursor实战:小程序&APP - 下
人工智能·小程序·kotlin·notepad++·ai编程·cursor
qq_124987075319 小时前
基于微信小程序的茶叶茶具销售和管理系统(源码+论文+部署+安装)
微服务·微信小程序·小程序·毕业设计
CDwenhuohuo19 小时前
微信小程序里用 setData() 修改数据并打印输出 的几种写法
javascript·微信小程序·小程序