更新记录

0.0.1（2025-09-21） 下载此版本

• 初始版本
• 基于 uni.request 封装的网络请求库
• 支持请求和响应拦截器
• 支持错误处理
• 支持多种请求方法（GET、POST、PUT、DELETE、HEAD、OPTIONS、TRACE、CONNECT）
• 支持文件上传和下载
• 支持请求取消
• 支持自定义配置

平台兼容性

uni-app(4.74)

uni-app x(4.74)

lime-request 网络请求库

一个基于 uni.request 封装的网络请求库，支持请求和响应拦截器、错误处理、多种请求方法等特性。适用于各种网络请求场景，简化接口调用流程，提高开发效率。

插件依赖：无

文档链接

📚 插件详细文档请访问以下站点：

• 网络请求库文档 - 站点1
• 网络请求库文档 - 站点2
• 网络请求库文档 - 站点3

安装方法

1. 在uni-app插件市场中搜索并导入lime-request
2. 在项目中引入并使用

代码演示

配置请求实例

创建自定义配置的请求实例。

import { Request, type LimeRequestConfig } from '@/uni_modules/lime-request'

// 创建请求实例
const request = new Request({
  baseURL: 'https://api.example.com',
  timeout: 10000,
  header: {
    'Content-Type': 'application/json'
  }
} as LimeRequestConfig)

GET 请求

// 使用实例发起请求
type User = {
    id : string
    username : string
    email : string
    phone : string
    avatar : string
    nickname : string
    gender : string
    birthday : string
}

request.get<User[]>('/users', {
    params: {
        ID: 12345,
    },
} as LimeRequestConfig).then(res => {
  console.log(res.data)
})

POST 请求

request
    .post<any>('/pet', {
        name: 'Hello Kitty',
        status: 'sold',
    })
    .then((response) => {
        // 处理成功情况
        console.log('onPost response:::', response.data)
        // console.log('response:::2',  JSON.parse<Name[]>(JSON.stringify(response.data))?.[0])
    })
    .catch((error) => {
        // 处理错误情况
        console.log('onPost error:::', error)
    })

请求拦截器

添加请求拦截器，可以在请求发送前修改请求配置。

// 添加请求拦截器
request.interceptors.request.use(
    (config) : LimeRequestConfig => {
        // 在发送请求之前做些什么
        console.log('interceptors use fulfilled')
        return config
    },
    (error) : Promise<LimeRequestFail> => {
        console.log('interceptors use rejected')
        // 对请求错误做些什么
        return Promise.reject(error) as Promise<LimeRequestFail>
    },
)

响应拦截器

添加响应拦截器，可以在获取响应数据后进行处理。

// 添加响应拦截器
request.interceptors.response.use(
    (response) => {
        response as LimeRequestResponse<any>
        // 对响应数据做点什么
        if (response.statusCode == 200) {
            // return response.data
        }
        return response //Promise.reject(new Error('请求失败'))
    }, 
    (error):Promise<LimeRequestFail> => {
        // 对响应错误做点什么
        console.error('请求出错', error)
        return Promise.reject(error) as Promise<LimeRequestFail>
})

上传文件

使用 upload 方法上传文件。

// 上传文件
request.upload('/upload', {
  filePath: '/path/to/file.jpg',
  name: 'file',
  formData: {
    'user': 'test'
  }
} as LimeRequestConfig).then(res => {
  console.log('上传成功', res)
}).catch(err => {
  console.error('上传失败', err)
})

下载文件

使用 download 方法下载文件。

// 下载文件
request.download('/download', {
  filePath: '/storage/file.jpg'
} as LimeRequestConfig).then(res => {
  console.log('下载成功', res.tempFilePath)
}).catch(err => {
  console.error('下载失败', err)
})

API文档

Request 类

构造函数

new Request(config?: LimeRequestConfig)

创建一个新的请求实例。

方法

注意 除了upload和download其它的请求都要传入类型，例如：

request.get<any>('/users')
request.post<any>('/users')
request.put<any>('/users')
request.delete<any>('/users')
request.head<any>('/users')
request.options<any>('/users')
request.trace<any>('/users')
request.connect<any>('/users')

拦截器

请求实例提供了拦截器功能，可以在请求发送前和响应接收后进行处理。

// 请求拦截器
request.interceptors.request.use(
  (config) => { /* 处理请求配置 */ return config },
  (error) => { /* 处理请求错误 */ return Promise.reject(error) }
)

// 响应拦截器
request.interceptors.response.use(
  (response) => { /* 处理响应数据 */ return response },
  (error) => { /* 处理响应错误 */ return Promise.reject(error) }
)

配置选项

LimeRequestConfig 接口支持以下配置选项：

响应结构

请求响应对象 LimeResponseImpl<T> 包含以下属性：

错误处理

请求错误对象 LimeRequestFail 包含以下属性：

高级用法

取消请求

可以通过 getTask 获取请求任务对象，然后调用 abort 方法取消请求。

let task: RequestTask | null = null

request.get<any>('/api/users', {
  getTask: (t) => {
    task = t as RequestTask
  }
} as LimeRequestConfig)

// 取消请求
if (task != null) {
  task?.abort()
}

自定义实例默认配置

可以通过创建新的请求实例并设置默认配置来满足不同的请求需求。

// 创建用于API1的请求实例
const api1Request = new Request({
  baseURL: 'https://api1.example.com',
  timeout: 5000
} as LimeRequestConfig)

// 创建用于API2的请求实例
const api2Request = new Request({
  baseURL: 'https://api2.example.com',
  timeout: 10000,
  header: {
    'X-Custom-Header': 'value'
  }
} as LimeRequestConfig)

支持与赞赏

如果你觉得本插件解决了你的问题，可以考虑支持作者：

支付宝赞助	微信赞助