etherreq 1.1.14 → 1.1.16

package/README.md

@@ -59,22 +59,22 @@ console.log(login);
 
 
 
-### 请求方法
+## Vue 集成
 
-etherreq.login(url,data)
-
-etherreq.get（url,data）
-
-etherreq.delete（url,data）
-
-etherreq.head（url,data）
-
-etherreq.options（url,data）
+### 安装插件（Vue2/Vue3 通用）
+```javascript
+import { createApp } from 'vue'; // Vue3
+// import Vue from 'vue'; // Vue2
+import { etherreq } from 'etherreq';
 
-etherreq.post（url,data）
+const app = createApp(App); // Vue3
+// const app = new Vue({ ... }); // Vue2
 
-etherreq.put（url,data）
+// 安装插件（可选配置 baseURL）
+app.use(etherreq, { baseURL: 'https://api.example.com' });
 
-etherreq.patch（url,data）
+// 挂载应用
+app.mount('#app');
+```
 
 在login方法执行后后端需要返回token，之后在执行其他方法时不需要配置token，token会自动携带

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "etherreq",
-  "version": "1.1.14",
+  "version": "1.1.16",
   "description": "A lightweight custom HTTP request library.",
   "main": "src/index.js",
   "types": "src/types/etherreq.d.ts",

package/src/cache.js

@@ -2,14 +2,16 @@
 const cacheStore = new Map();
 
 /**
- * 获取缓存 key
+ * 获取缓存 key（包含幂等令牌）
  * @param {string} url 请求地址
  * @param {Object} options 请求参数
  * @returns {string}
  */
 function getCacheKey(url, options) {
   const params = new URLSearchParams(options.params || {});
-  return `${options.method}:${url}?${params.toString()}`;
+  // 新增：若存在幂等令牌则加入缓存键
+  const idempotencyKey = options.idempotencyKey ? `:${options.idempotencyKey}` : '';
+  return `${options.method}:${url}?${params.toString()}${idempotencyKey}`;
 }
 
 export const requestCache = {

package/src/etherreq.js

@@ -18,8 +18,6 @@ const dispatchRequest = async (config) => {
     const nextConfig = await interceptor.fulfilled(config);
     // ✅ 拦截器可以返回一个 response 对象，表示中断请求
     if (nextConfig && nextConfig.isFromCache) {
-      console.log(nextConfig.data);
-      
       return nextConfig.data; // ✅ 直接返回缓存结果，不再往下执行
     }
     config = nextConfig;

package/src/index.js

@@ -1,5 +1,5 @@
 // src/index.js
-import { request, baseURL as _baseURL, setBaseURL } from './request';
+import { request, baseURL as _baseURL, setBaseURL } from './request.js';
 // 示例封装方法
 const createMethod = (method) => (url, data, callback) => {
   let options;
@@ -54,5 +54,26 @@ export const etherreq = Object.assign(
     },
   }
 );
+therreq.install = (app, options = {}) => {
+  // 合并基础 URL 配置
+  if (options.baseURL) {
+    setBaseURL(options.baseURL);
+  }
+
+  // 兼容 Vue2 和 Vue3 的挂载方式
+  if (typeof app === 'function' && app.prototype) { // Vue2
+    app.prototype.$etherreq = etherreq;
+  } else if (app.config) { // Vue3
+    app.config.globalProperties.$etherreq = etherreq;
+  }
+};
 
+// 导出组合式函数（仅 Vue3 可用）
+export const useEtherReq = () => {
+  const instance = getCurrentInstance();
+  if (!instance) {
+    throw new Error('useEtherReq 必须在 Vue 组件的 setup 函数中调用');
+  }
+  return instance.appContext.config.globalProperties.$etherreq;
+};
 export { setBaseURL, _baseURL as baseURL };

package/src/request.js

@@ -1,6 +1,6 @@
 // src/request.js
-import { create } from './etherreq';
-import { requestCache, getCacheKey } from './cache';
+import { create } from './etherreq.js';
+import { requestCache, getCacheKey } from './cache.js';
 
 // 创建一个带有默认配置的请求实例
 const instance = create({
@@ -17,12 +17,13 @@ instance.interceptors.request.use((config) => {
     'Content-Type': 'application/json',
   };
 
-  if (config.method === 'GET' && !config.disableCache) {
+  // 新增：若存在幂等令牌，强制启用缓存校验（即使非GET请求）
+  const useCache = (config.method === 'GET' && !config.disableCache) || !!config.idempotencyKey;
+  if (useCache) {
     const cacheKey = getCacheKey(config.url, config);
     const cached = requestCache.get(cacheKey);
 
     if (cached) {
-      console.log('命中缓存:', cacheKey);
       return Promise.resolve({
         data: cached,
         status: 200,
@@ -43,15 +44,15 @@ instance.interceptors.request.use((config) => {
 instance.interceptors.response.use(
   (response) => {
     if (response.isFromCache) {
-      console.log('从缓存返回');
       return response.data;
     }
 
     const config = response.config;
-    if (config && config.method === 'GET' && !config.disableCache) {
+    // 新增：若存在幂等令牌或GET请求未禁用缓存，则缓存结果
+    const shouldCache = !!config.idempotencyKey || (config.method === 'GET' && !config.disableCache);
+    if (shouldCache) {
       const cacheKey = getCacheKey(config.url, config);
       requestCache.set(cacheKey, response.data);
-      console.log('写入缓存:', cacheKey);
     }
 
     return response.data;
@@ -61,7 +62,7 @@ instance.interceptors.response.use(
     return Promise.reject(error);
   }
 );
-let _baseURL = 'https://api.example.com'; // 内部变量用于保存 base URL
+let _baseURL = 'https://api..com'; // 内部变量用于保存 base URL
 
 /**
  * 封装 request 函数，支持 baseURl 拼接等逻辑

package/src/types/etherreq.d.ts

@@ -4,6 +4,7 @@ interface EtherRequestOptions {
   body?: any;
   params?: Record<string, any>;
   baseURL?: string;
+  idempotencyKey?: string; // 新增：幂等请求令牌
 }
 
 interface EtherRequestResponse<T = any> {
@@ -20,15 +21,23 @@ type EtherRequestMethod = <T = any>(
 ) => Promise<T>;
 
 // 主函数类型（支持调用 + 属性方法）
+// 导入 Vue 类型（需安装 @vue/runtime-core）
+import type { App, ComponentInternalInstance } from 'vue';
+
+// 扩展 EtherreqStatic 类型，添加 install 方法
 interface EtherreqStatic extends EtherRequestMethod {
   get: EtherRequestMethod;
   post: EtherRequestMethod;
   put: EtherRequestMethod;
   delete: EtherRequestMethod;
   del: EtherRequestMethod;
-  login: EtherRequestMethod; 
+  login: EtherRequestMethod;
+  install: (app: App | any, options?: { baseURL?: string }) => void; // 兼容 Vue2/Vue3
 }
 
+// 声明组合式函数类型
+export function useEtherReq(): EtherreqStatic;
+
 // 导出对象
 declare const etherreq: EtherreqStatic;
 

package/src/upload.js

@@ -0,0 +1,88 @@
+// src/upload.js
+import { etherreq } from './index.js';
+
+/**
+ * 分片上传配置项
+ * @typedef {Object} ChunkedUploadOptions
+ * @property {number} chunkSize 分片大小，默认 5MB
+ * @property {function(number): void} onProgress 进度回调
+ * @property {boolean} resume 是否启用断点续传
+ */
+
+/**
+ * 大文件分片上传
+ * @param {string} url 接口地址
+ * @param {File|Blob} file 文件对象
+ * @param {ChunkedUploadOptions} [options] 配置项
+ */
+export async function uploadLargeFile(url, file, options = {}) {
+  const { chunkSize = 5 * 1024 * 1024, onProgress = () => {}, resume = true } = options;
+
+  const totalChunks = Math.ceil(file.size / chunkSize);
+  const uploadedChunks = await getUploadedChunks(url, file, totalChunks, resume);
+
+  let current = 0;
+
+  for (let i = 0; i < totalChunks; i++) {
+    if (uploadedChunks.includes(i)) {
+      current++;
+      onProgress(Math.round((current / totalChunks) * 100));
+      continue;
+    }
+
+    const start = i * chunkSize;
+    const end = Math.min(start + chunkSize, file.size);
+    const chunk = file.slice(start, end);
+
+    const formData = new FormData();
+    formData.append('file', chunk);
+    formData.append('chunkIndex', i);
+    formData.append('totalChunks', totalChunks);
+    formData.append('fileName', file.name);
+
+    try {
+      await etherreq.post(url, formData, {
+        headers: {
+          'Content-Type': 'multipart/form-data',
+        },
+      });
+
+      current++;
+      onProgress(Math.round((current / totalChunks) * 100));
+    } catch (error) {
+      console.error(`上传分片 ${i} 失败`, error);
+      throw error;
+    }
+  }
+
+  // 合并请求
+  await etherreq.post(`${url}/complete`, {
+    fileName: file.name,
+    totalChunks,
+  });
+
+  return {
+    fileName: file.name,
+    size: file.size,
+    status: 'completed',
+  };
+}
+
+/**
+ * 获取已上传的分片索引（用于断点续传）
+ * @param {string} uploadUrl
+ * @param {File} file
+ * @param {number} totalChunks
+ * @param {boolean} enableResume
+ * @returns {Promise<number[]>}
+ */
+async function getUploadedChunks(uploadUrl, file, totalChunks, enableResume) {
+  if (!enableResume) return [];
+
+  try {
+    const res = await etherreq.get(`${uploadUrl}?check=1&fileName=${encodeURIComponent(file.name)}&totalChunks=${totalChunks}`);
+    return res.data.uploadedChunks || [];
+  } catch (e) {
+    return [];
+  }
+}