uni.request 请求封装
请求和上传文件拦截器
uniapp 拦截器: uni.addInterceptor
- 拼接基础地址
- 设置超时时间(默认 60s 太久)
- 添加请求头标识(比如 miniapp 代表小程序端,app 代表 App 端,方便后端识别)
- 添加 token
参考代码
// src/utils/http.ts
// 请求基地址
const baseURL = 'https://pcapi-xiaotuxian-front-devtest.itheima.net'
// 拦截器配置
const httpInterceptor = {
// 拦截前触发
invoke(options: UniApp.RequestOptions) {
// 1. 非 http 开头需拼接地址
if (!options.url.startsWith('http')) {
options.url = baseURL + options.url
}
// 2. 请求超时
options.timeout = 10000
// 3. 添加小程序端请求头标识
options.header = {
// 自定义请求头作为标识
'source-client': 'miniapp',
...options.header,
}
// 4. 添加 token 请求头标识
const memberStore = useMemberStore()
const token = memberStore.profile?.token
if (token) {
options.header.Authorization = token
}
},
}
// 拦截 request 请求
uni.addInterceptor('request', httpInterceptor)
// 拦截 uploadFile 文件上传
uni.addInterceptor('uploadFile', httpInterceptor)
微信小程序端,需登录 微信公众平台 配置合法域名,比如:👇
https://pcapi-xiaotuxian-front-devtest.itheima.net
封装 Promise 请求函数
-
返回 Promise 对象,用于处理返回值类型
-
成功 resolve
- 提取数据
- 添加泛型
-
失败 reject
- 401 错误
- 其他错误
- 网络错误
参考代码
/**
* 请求函数
* @param UniApp.RequestOptions
* @returns Promise
* 1. 返回 Promise 对象,用于处理返回值类型
* 2. 获取数据成功
* 2.1 提取核心数据 res.data
* 2.2 添加类型,支持泛型
* 3. 获取数据失败
* 3.1 401错误 -> 清理用户信息,跳转到登录页
* 3.2 其他错误 -> 根据后端错误信息轻提示
* 3.3 网络错误 -> 提示用户换网络
*/
type Data<T> = {
code: string
msg: string
result: T
}
// 2.2 添加类型,支持泛型
export const http = <T>(options: UniApp.RequestOptions) => {
// 1. 返回 Promise 对象
return new Promise<Data<T>>((resolve, reject) => {
uni.request({
...options,
// 响应成功
success(res) {
// 状态码 2xx,参考 axios 的设计
if (res.statusCode >= 200 && res.statusCode < 300) {
// 2.1 提取核心数据 res.data
resolve(res.data as Data<T>)
} else if (res.statusCode === 401) {
// 401错误 -> 清理用户信息,跳转到登录页
const memberStore = useMemberStore()
memberStore.clearProfile()
uni.navigateTo({ url: '/pages/login/login' })
reject(res)
} else {
// 其他错误 -> 根据后端错误信息轻提示
uni.showToast({
icon: 'none',
title: (res.data as Data<T>).msg || '请求错误',
})
reject(res)
}
},
// 响应失败
fail(err) {
uni.showToast({
icon: 'none',
title: '网络错误,换个网络试试',
})
reject(err)
},
})
})
}
完整代码
import { useMemberStore } from '@/stores'
/**
* 添加拦截器
* 拦截 request 请求
* 拦截 uploadFile 文件上传
* 1. 拼接地址
* 2. 请求超时
* 3. 添加小程序标识头
* 4. 添加 token 标识
*/
const baseURL = 'https://pcapi-xiaotuxian-front-devtest.itheima.net'
const httpInterceptor = {
// 拦截前触发
invoke(options: UniApp.RequestOptions) {
// 路径拼接
if (!options.url.startsWith('http')) {
options.url = baseURL + options.url
}
// 请求超时
options.timeout = 10000
// 添加小程序标识头
options.header = {
...options.header,
// 自定义小程序标识头
'source-client': 'miniapp',
}
// 添加 token 标识
const memberStore = useMemberStore()
const token = memberStore.profile?.token
if (token) {
options.header.Authorization = token
}
},
}
uni.addInterceptor('request', httpInterceptor)
uni.addInterceptor('uploadFile', httpInterceptor)
interface Data<T> {
code: string
msg: string
data: T
}
/**
* 请求函数
* 1. 返回 Promise 对象
* 2. 请求成功
* 2.1 提取核心数据 res.data
* 2.2 添加类型,支持泛型
* 3. 请求失败
* 3.1 网络错误 提醒用户换网络
* 3.2 401 清理用户信息,跳转到登录页
* 3.3 其他错误 根据后端错误消息轻提示
*/
export const http = <T>(config: UniApp.RequestOptions) => {
return new Promise<Data<T>>((resolve, reject) => {
uni.request({
...config,
// 请求成功
success(res) {
// 状态码 2xx
if (res.statusCode >= 200 && res.statusCode < 300) {
// 2.1 提取核心数据
resolve(res.data as Data<T>)
} else if (res.statusCode === 401) {
// 3.2 401 清理用户信息,跳转到登录页
const memberStore = useMemberStore()
memberStore.clearProfile()
uni.navigateTo({
url: '/pages/login/login',
})
reject(res)
} else {
// 3.3 其他错误 根据后端错误消息轻提示
uni.showToast({
icon: 'none',
title: (res.data as Data<T>).msg || '请求错误',
})
reject(res)
}
},
fail(err) {
// 3.1 网络错误 提醒用户换网络
uni.showToast({
icon: 'none',
title: '网络错误,请检查网络',
})
reject(err)
},
})
})
}