@snail-js/api 0.1.2 → 0.1.3

package/README.md

@@ -2,14 +2,13 @@
   <img src="https://img.shields.io/badge/TypeScript-1e80ff"></img>
   <img src="https://img.shields.io/npm/v/axios?label=axios&labelColor=1e80ff&color=67C23A"></img>
 </p>
-## 项目介绍
 
+## 项目介绍
 - 基于 Axios 二次封装
 - 使用`reflect-metadata`创建和处理元数据
 - 提供装饰器方式定义请求，基本实例`Snail`，请求实例`Api`
 
 ## 安装
-
 `npm install @snail-js/api`
 
 ## 使用
@@ -48,6 +47,7 @@ import { Snail, Server } from "@snail-js/api";
   timeout: 5000,
 })
 class BackEnd extends Snail {}
+
 export const Service = new BackEnd();
 ```
 
@@ -61,6 +61,7 @@ import { Service } from "./service";
 
 @Api("user")
 class UserApi {
+
   @Get()
   get(@Params("id") id: string) {}
 
@@ -88,12 +89,13 @@ if (error !== null) {
 - `baseUrl`：同`Axios`，使用`vite.proxy`时，请使用`\`开头，直接跨域请求请填写完整地址
 - `Versioning`:版本管理器
   - type:管理器类型，enum:Uri,Head,Query,Custom
-  - prifix:前缀
+  - prifix:前缀,字符串；添加在版本号前面的字符，默认为`v`
   - defaultVersion:全局默认版本
 - timenout:全局超时时间，会被 Api 的 timeout 值覆盖
 - CacheManage：缓存管理器
-  - type:缓存管理器类型，CacheType,enum:localStorage,IndexDB,Memory
+  - type:缓存管理器类型，CacheType,`enum:localStorage,IndexDB,Memory`
   - ttl: 缓存过期时间
+- enableLog:  是否打印日志
 
 ## Api 配置
 
@@ -117,6 +119,7 @@ if (error !== null) {
 ```typescript
 @Api("user")
 class UserApi {
+
   @Get()
   get(@Params("id") id: string, @Params("sign") sign: string) {}
 }
@@ -134,6 +137,7 @@ class QueryParams {
 
 @Api("user")
 class UserApi {
+
   @Get()
   get(@Params() params: QueryParams) {}
 }
@@ -151,6 +155,7 @@ class QueryParams {
 
 @Api("user")
 class UserApi {
+
   @Get()
   get(@Params() params: QueryParams, @Params("a") a: number) {}
 }
@@ -286,10 +291,11 @@ export type VersioningOption =
 ```
 
 ### 临时版本修改器`@Version`
-
+- 临时改变方法请求的版本
 ```typescript
 @Api("test")
 class Test {
+
   @Get("HelloWorld")
   @Version("0.2.0")
   test() {}
@@ -299,7 +305,35 @@ class Test {
 > 临时改变 api 版本，便于测试
 
 ### 缓存装饰器`@Cache`
-- 待测试，测试后发布文档
+- `@Cache(string | null)`
+ - 当设置为null时，此方法不应用缓存
+ - 当设置为string时，应为此Api类下的方法名称，当设置的此名称方法被调用且正常响应时，被装饰的方法缓存失效
+
+```typescript
+
+@Api("test")
+class Test {
+
+  @Get("HelloWorld")
+  @Cache("test2")
+  test1() {}
+
+  @Post()
+  test2() {}
+
+  @Get()
+  @Cache(null)
+  test3() {}
+}
+```
+
+> 当请求`[Post]test`成功时，`[Get]test/HelloWorld`的缓存失效
+> 注意：`test2`方法请求成功的前提是需要设置`@Cache(null)`,否则仅第一次请求会发送，后续请求需等待缓存管理设置的ttl时间到期才会发送请求
+> 因此，若未设置`test2`方法的`@Cache(null)`，仅第一次请求会使`[Get]test/HelloWorld`的缓存失效，后续需等待ttl时间到期，才会继续失效
+
+> `test3`方法请求成功时，不缓存
+
+> 注意：要使用缓存，请配置`@Server({CacheManage})`缓存管理器
 
 ### 代码仓库
 

package/dist/core/snail.d.ts

@@ -7,14 +7,22 @@ export declare class Snail<R extends {
     private strategies;
     private cacheStorage?;
     private version?;
+    private sourceMap;
     registerStrategy(strategy: Strategy): void;
     createApi<T extends object>(constructor: new () => T): ApiProxy<T, R>;
     private buildRequestArgs;
     private getStrategies;
     private applyStrategies;
     private applyVersion;
-    private applyCache;
-    private getCacheConfig;
+    private getCache;
+    private initCacheManage;
+    private getHitSource;
+    private setHitSource;
+    private setCache;
+    private expireCache;
+    private getServerConfig;
+    private getApiConfig;
+    private initAxios;
     private handleResponse;
     private handleError;
 }

package/dist/decorators/api.d.ts

@@ -1,7 +1,7 @@
 import "reflect-metadata";
 import { ApiConfig } from "../typings";
-export declare const METHOD_KEY = "SNAIL_METHOD_KEY";
-export declare const API_CONFIG_KEY = "SNAIL_API_CONFIG_KEY";
+export declare const METHOD_KEY: unique symbol;
+export declare const API_CONFIG_KEY: unique symbol;
 export declare const Api: (url?: string, config?: ApiConfig) => ClassDecorator;
 export declare const Get: (path?: string) => (target: any, propertyKey: string | symbol) => void;
 export declare const Post: (path?: string) => (target: any, propertyKey: string | symbol) => void;

package/dist/decorators/cache.d.ts

@@ -1,4 +1,3 @@
 import "reflect-metadata";
-import { CacheManagementOption } from '../typings';
-export declare const CACHE_KEY = "SNALI_CACHE_KEY";
-export declare const Cache: (options: CacheManagementOption) => (target: any, propertyKey?: string) => void;
+export declare const CACHE_OPTIONS_KEY: unique symbol;
+export declare const Cache: (hitSource: string | null) => (target: any, propertyKey?: string) => void;

package/dist/decorators/server.d.ts

@@ -1,4 +1,4 @@
 import "reflect-metadata";
 import { SnailOption } from "../typings";
-export declare const SERVER_CONFIG_KEY = "SANIL_SERVER_CONFIG_KEY";
+export declare const SERVER_CONFIG_KEY: unique symbol;
 export declare const Server: (config: SnailOption) => (target: any) => void;

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 export * from "./core";
-export * from "./decorators/server";
-export * from "./decorators/api";
-export * from "./decorators/cache";
-export * from "./decorators/param";
-export * from "./decorators/strategy";
-export * from "./decorators/versioning";
+export { Server } from "./decorators/server";
+export { Api, Get, Put, Post, Patch, Options, Head, Delete, } from "./decorators/api";
+export { Cache } from "./decorators/cache";
+export { Params, Data } from "./decorators/param";
+export { UseStrategy } from "./decorators/strategy";
+export { Versioning, Version } from "./decorators/versioning";
 export * from "./typings";
 export * from "./utils";

package/dist/snail-api.js

@@ -3741,8 +3741,8 @@ function applyVersioning(version, versioning) {
     versioning
   );
 }
-const METHOD_KEY = "SNAIL_METHOD_KEY";
-const API_CONFIG_KEY = "SNAIL_API_CONFIG_KEY";
+const METHOD_KEY = Symbol("SNAIL_METHOD_KEY");
+const API_CONFIG_KEY = Symbol("SNAIL_API_CONFIG_KEY");
 const Api = (url = "", config) => {
   return (target) => {
     Reflect.defineMetadata(API_CONFIG_KEY, { url, ...config }, target);
@@ -3766,7 +3766,7 @@ const Delete = createMethodDecorator(RequestMethod.DELETE);
 const Patch = createMethodDecorator(RequestMethod.PATCH);
 const Options = createMethodDecorator(RequestMethod.OPTIONS);
 const Head = createMethodDecorator(RequestMethod.HEAD);
-const SERVER_CONFIG_KEY = "SANIL_SERVER_CONFIG_KEY";
+const SERVER_CONFIG_KEY = Symbol("SANIL_SERVER_CONFIG_KEY");
 const Server = (config) => {
   return (target) => {
     Reflect.defineMetadata(SERVER_CONFIG_KEY, config, target);
@@ -3801,11 +3801,11 @@ const Version = (version) => {
     Reflect.defineMetadata(VERSION_KEY, version, target, propertyKey);
   };
 };
-const CACHE_KEY = "SNALI_CACHE_KEY";
-const Cache = (options) => {
+const CACHE_OPTIONS_KEY = Symbol("SNALI_CACHE_OPTIONS_KEY");
+const Cache = (hitSource) => {
   return (target, propertyKey) => {
-    const key = propertyKey ? `${CACHE_KEY}_${propertyKey}` : CACHE_KEY;
-    Reflect.defineMetadata(key, options, target);
+    const key = propertyKey ? `${CACHE_OPTIONS_KEY.toString()}_${propertyKey}` : CACHE_OPTIONS_KEY;
+    Reflect.defineMetadata(key, hitSource, target);
   };
 };
 class Snail {
@@ -3815,39 +3815,25 @@ class Snail {
     __publicField(this, "strategies", []);
     __publicField(this, "cacheStorage");
     __publicField(this, "version");
+    __publicField(this, "sourceMap", /* @__PURE__ */ new Map());
   }
   registerStrategy(strategy) {
     this.strategies.push(strategy);
   }
   createApi(constructor) {
     const instance = new constructor();
-    const serverConfig = Reflect.getMetadata(
-      SERVER_CONFIG_KEY,
-      this.constructor
-    );
-    console.log("serverConfig:", serverConfig);
-    if (!this.axiosInstance) {
-      this.axiosInstance = axios.create({
-        baseURL: serverConfig.baseURL,
-        timeout: serverConfig.timeout
-      });
-    }
-    const cacheManage = Reflect.getMetadata(
-      CACHE_KEY,
-      this
-    );
-    if (!this.cacheStorage && cacheManage !== void 0) {
-      this.cacheStorage = createCache(cacheManage.type, cacheManage.ttl || 300);
-    }
-    const apiConfig = Reflect.getMetadata(
-      API_CONFIG_KEY,
-      constructor
-    );
-    console.log("ApiConfig:", apiConfig);
+    const serverConfig = this.getServerConfig();
+    const { baseURL, timeout, CacheManage, enableLog } = serverConfig;
+    enableLog && console.log("serverConfig:", serverConfig);
+    this.initAxios({ baseURL, timeout });
+    enableLog && console.log("CacheManage:", CacheManage);
+    this.initCacheManage(CacheManage);
+    const apiConfig = this.getApiConfig(constructor);
+    enableLog && console.log("ApiConfig:", apiConfig);
     this.version = apiConfig.version;
     return new Proxy(instance, {
       get: (target, propertyKey) => {
-        console.log("proxy:", target, "|", propertyKey);
+        enableLog && console.log("proxy:", target, "|", propertyKey);
         if (typeof propertyKey !== "string") return;
         const methodConfig = Reflect.getMetadata(
           METHOD_KEY,
@@ -3857,7 +3843,7 @@ class Snail {
         if (!methodConfig) return target[propertyKey];
         return async (...args) => {
           const url = methodConfig.path == "" ? apiConfig.url : apiConfig.url + `/${methodConfig.path}`;
-          console.log("url:", url);
+          enableLog && console.log("url:", url);
           let request = {
             // baseURL: serverConfig.baseURL,
             url,
@@ -3868,35 +3854,11 @@ class Snail {
             ...request,
             ...this.applyVersion(request, target, propertyKey)
           };
-          console.log("版本管理参数:", request);
+          enableLog && console.log("版本管理参数:", request);
           const strategies = this.getStrategies(target, propertyKey);
-          const methodCache = this.getCacheConfig(target, propertyKey) || void 0;
-          if (methodCache == void 0) {
-            const cached = await this.applyCache(request, cacheManage);
-            if (cached && cached.error === null) {
-              let cacheResponse = {
-                data: cached.data,
-                status: 304,
-                headers: {
-                  hitCache: true
-                },
-                statusText: "get response data from cache",
-                config: { headers: new AxiosHeaders2() }
-              };
-              const responseStrategies = strategies.filter(
-                (strategy) => strategy.applyResponse
-              );
-              const strategyResponse = await this.applyStrategies(
-                cacheResponse,
-                responseStrategies,
-                "response"
-              );
-              return strategyResponse;
-            }
-          }
           const params = this.buildRequestArgs(target, propertyKey, args);
           request = { ...request, ...params };
-          console.log("构建请求参数：", request);
+          enableLog && console.log("构建请求参数：", request);
           const requestStrategies = strategies.filter(
             (strategy) => strategy.applyRequest
           );
@@ -3905,10 +3867,24 @@ class Snail {
             requestStrategies,
             "request"
           );
+          const hitSource = this.getHitSource(target, propertyKey);
+          enableLog && console.log("hitSource:", hitSource);
+          if (typeof hitSource == "string") {
+            this.setHitSource(request, hitSource);
+          }
+          if (hitSource !== null) {
+            const cachedResponse = await this.getCache(request, strategies);
+            if (cachedResponse) {
+              enableLog && console.warn("数据从缓存获取");
+              return this.handleResponse(cachedResponse, true);
+            }
+          }
           try {
-            console.log("send request:", request);
+            enableLog && console.log("send request:", request);
             const response = await this.axiosInstance(request);
-            return this.handleResponse(response);
+            hitSource !== null && this.setCache(request, response);
+            this.expireCache(propertyKey);
+            return this.handleResponse(response, false);
           } catch (error) {
             return this.handleError(error);
           }
@@ -3919,7 +3895,6 @@ class Snail {
   buildRequestArgs(target, propertyKey, args) {
     const requestArgs = { params: {}, data: {} };
     const paramConfigs = Reflect.getMetadata(REQUEST_ARGS_KEY, target, propertyKey) || [];
-    console.log("请求参数:", paramConfigs);
     paramConfigs.forEach(({ index, type, key }) => {
       const value = args[index];
       if (type === "params" && !key && typeof value === "object") {
@@ -3939,14 +3914,11 @@ class Snail {
   }
   getStrategies(target, propertyKey) {
     const serverStrategies = Reflect.getMetadata(STRATEGY_KEY, this.constructor) || [];
-    console.log("serverStrategies:", serverStrategies);
     const classStrategies = Reflect.getMetadata(STRATEGY_KEY, target.constructor) || [];
-    console.log("classStrategies:", classStrategies);
     const methodStrategies = Reflect.getMetadata(
       `${STRATEGY_KEY.toString()}_${propertyKey}`,
       target
     ) || [];
-    console.log("methodStrategies:", methodStrategies);
     const allStrategies = [
       ...this.strategies,
       ...serverStrategies,
@@ -3967,7 +3939,6 @@ class Snail {
       VERSIONING_KEY,
       this.constructor
     );
-    console.log("版本管理器：", versioning);
     if (!versioning) return request;
     const version = Reflect.getMetadata(VERSION_KEY, target, propertyKey);
     const currentVersion = version || this.version || versioning.defaultVersion;
@@ -3978,24 +3949,95 @@ class Snail {
     const versionUrl = url ? `${url}/${request.url}` : request.url;
     return { ...request, url: versionUrl, headers, params };
   }
-  async applyCache(request, options) {
+  async getCache(request, strategies) {
+    var _a;
+    if (!this.cacheStorage) return void 0;
+    const cacheKey = apiKey(request);
+    const cached = await ((_a = this.cacheStorage) == null ? void 0 : _a.get(cacheKey));
+    if (cached && cached.error === null) {
+      let cacheResponse = {
+        data: cached.data,
+        status: 304,
+        headers: {},
+        statusText: "get response data from cache",
+        config: { headers: new AxiosHeaders2() }
+      };
+      const responseStrategies = strategies.filter(
+        (strategy) => strategy.applyResponse
+      );
+      const strategyResponse = await this.applyStrategies(
+        cacheResponse,
+        responseStrategies,
+        "response"
+      );
+      return strategyResponse;
+    }
+  }
+  initCacheManage(options) {
+    if (!this.cacheStorage && options !== void 0) {
+      this.cacheStorage = createCache(options.type, options.ttl || 300);
+    }
+  }
+  getHitSource(target, propertyKey) {
+    const methodHitSource = Reflect.getMetadata(
+      `${CACHE_OPTIONS_KEY.toString()}_${propertyKey}`,
+      target
+    );
+    if (methodHitSource !== void 0) return methodHitSource;
+    const apiHitSource = Reflect.getMetadata(
+      CACHE_OPTIONS_KEY,
+      target.constructor
+    );
+    return apiHitSource;
+  }
+  setHitSource(request, hitSource) {
+    const cacheKeys = this.sourceMap.get(hitSource);
+    const currentCacheKey = apiKey(request);
+    if (cacheKeys) {
+      cacheKeys.push(currentCacheKey);
+      this.sourceMap.set(hitSource, cacheKeys);
+    } else {
+      this.sourceMap.set(hitSource, [currentCacheKey]);
+    }
+  }
+  async setCache(request, response) {
     var _a;
     const cacheKey = apiKey(request);
-    if (this.cacheStorage) {
-      return await ((_a = this.cacheStorage) == null ? void 0 : _a.get(cacheKey));
+    await ((_a = this.cacheStorage) == null ? void 0 : _a.set(cacheKey, response.data));
+  }
+  async expireCache(hitSource) {
+    const keys = this.sourceMap.get(hitSource);
+    if (keys) {
+      Promise.all(
+        keys.map(async (key) => {
+          var _a;
+          await ((_a = this.cacheStorage) == null ? void 0 : _a.delete(key));
+        })
+      );
     }
-    return void 0;
   }
-  getCacheConfig(target, propertyKey) {
-    return Reflect.getMetadata(`${CACHE_KEY.toString()}_${propertyKey}`, target) || // 方法级
-    Reflect.getMetadata(CACHE_KEY, target.constructor);
+  getServerConfig() {
+    return Reflect.getMetadata(
+      SERVER_CONFIG_KEY,
+      this.constructor
+    );
+  }
+  getApiConfig(constructor) {
+    return Reflect.getMetadata(API_CONFIG_KEY, constructor);
+  }
+  initAxios(config) {
+    if (!this.axiosInstance) {
+      this.axiosInstance = axios.create({
+        baseURL: config.baseURL,
+        timeout: config.timeout
+      });
+    }
   }
-  handleResponse(response) {
-    console.log("Response:", response);
+  handleResponse(response, hitCache) {
     return {
       data: response.data,
       error: null,
-      hitCache: false
+      hitCache
     };
   }
   handleError(error) {
@@ -4006,31 +4048,23 @@ class Snail {
   }
 }
 export {
-  API_CONFIG_KEY,
   Api,
-  CACHE_KEY,
   Cache,
   CacheType,
   Data,
   Delete,
   Get,
   Head,
-  METHOD_KEY,
   Options,
   Params,
   Patch,
   Post,
   Put,
-  REQUEST_ARGS_KEY,
   RequestMethod,
-  SERVER_CONFIG_KEY,
-  STRATEGY_KEY,
   Server,
   Snail,
   Strategy,
   UseStrategy,
-  VERSIONING_KEY,
-  VERSION_KEY,
   Version,
   Versioning,
   VersioningType,

package/dist/snail-api.umd.cjs

@@ -3745,8 +3745,8 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       versioning
     );
   }
-  const METHOD_KEY = "SNAIL_METHOD_KEY";
-  const API_CONFIG_KEY = "SNAIL_API_CONFIG_KEY";
+  const METHOD_KEY = Symbol("SNAIL_METHOD_KEY");
+  const API_CONFIG_KEY = Symbol("SNAIL_API_CONFIG_KEY");
   const Api = (url = "", config) => {
     return (target) => {
       Reflect.defineMetadata(API_CONFIG_KEY, { url, ...config }, target);
@@ -3770,7 +3770,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
   const Patch = createMethodDecorator(RequestMethod.PATCH);
   const Options = createMethodDecorator(RequestMethod.OPTIONS);
   const Head = createMethodDecorator(RequestMethod.HEAD);
-  const SERVER_CONFIG_KEY = "SANIL_SERVER_CONFIG_KEY";
+  const SERVER_CONFIG_KEY = Symbol("SANIL_SERVER_CONFIG_KEY");
   const Server = (config) => {
     return (target) => {
       Reflect.defineMetadata(SERVER_CONFIG_KEY, config, target);
@@ -3805,11 +3805,11 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       Reflect.defineMetadata(VERSION_KEY, version, target, propertyKey);
     };
   };
-  const CACHE_KEY = "SNALI_CACHE_KEY";
-  const Cache = (options) => {
+  const CACHE_OPTIONS_KEY = Symbol("SNALI_CACHE_OPTIONS_KEY");
+  const Cache = (hitSource) => {
     return (target, propertyKey) => {
-      const key = propertyKey ? `${CACHE_KEY}_${propertyKey}` : CACHE_KEY;
-      Reflect.defineMetadata(key, options, target);
+      const key = propertyKey ? `${CACHE_OPTIONS_KEY.toString()}_${propertyKey}` : CACHE_OPTIONS_KEY;
+      Reflect.defineMetadata(key, hitSource, target);
     };
   };
   class Snail {
@@ -3819,39 +3819,25 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       __publicField(this, "strategies", []);
       __publicField(this, "cacheStorage");
       __publicField(this, "version");
+      __publicField(this, "sourceMap", /* @__PURE__ */ new Map());
     }
     registerStrategy(strategy) {
       this.strategies.push(strategy);
     }
     createApi(constructor) {
       const instance = new constructor();
-      const serverConfig = Reflect.getMetadata(
-        SERVER_CONFIG_KEY,
-        this.constructor
-      );
-      console.log("serverConfig:", serverConfig);
-      if (!this.axiosInstance) {
-        this.axiosInstance = axios.create({
-          baseURL: serverConfig.baseURL,
-          timeout: serverConfig.timeout
-        });
-      }
-      const cacheManage = Reflect.getMetadata(
-        CACHE_KEY,
-        this
-      );
-      if (!this.cacheStorage && cacheManage !== void 0) {
-        this.cacheStorage = createCache(cacheManage.type, cacheManage.ttl || 300);
-      }
-      const apiConfig = Reflect.getMetadata(
-        API_CONFIG_KEY,
-        constructor
-      );
-      console.log("ApiConfig:", apiConfig);
+      const serverConfig = this.getServerConfig();
+      const { baseURL, timeout, CacheManage, enableLog } = serverConfig;
+      enableLog && console.log("serverConfig:", serverConfig);
+      this.initAxios({ baseURL, timeout });
+      enableLog && console.log("CacheManage:", CacheManage);
+      this.initCacheManage(CacheManage);
+      const apiConfig = this.getApiConfig(constructor);
+      enableLog && console.log("ApiConfig:", apiConfig);
       this.version = apiConfig.version;
       return new Proxy(instance, {
         get: (target, propertyKey) => {
-          console.log("proxy:", target, "|", propertyKey);
+          enableLog && console.log("proxy:", target, "|", propertyKey);
           if (typeof propertyKey !== "string") return;
           const methodConfig = Reflect.getMetadata(
             METHOD_KEY,
@@ -3861,7 +3847,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
           if (!methodConfig) return target[propertyKey];
           return async (...args) => {
             const url = methodConfig.path == "" ? apiConfig.url : apiConfig.url + `/${methodConfig.path}`;
-            console.log("url:", url);
+            enableLog && console.log("url:", url);
             let request = {
               // baseURL: serverConfig.baseURL,
               url,
@@ -3872,35 +3858,11 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
               ...request,
               ...this.applyVersion(request, target, propertyKey)
             };
-            console.log("版本管理参数:", request);
+            enableLog && console.log("版本管理参数:", request);
             const strategies = this.getStrategies(target, propertyKey);
-            const methodCache = this.getCacheConfig(target, propertyKey) || void 0;
-            if (methodCache == void 0) {
-              const cached = await this.applyCache(request, cacheManage);
-              if (cached && cached.error === null) {
-                let cacheResponse = {
-                  data: cached.data,
-                  status: 304,
-                  headers: {
-                    hitCache: true
-                  },
-                  statusText: "get response data from cache",
-                  config: { headers: new AxiosHeaders() }
-                };
-                const responseStrategies = strategies.filter(
-                  (strategy) => strategy.applyResponse
-                );
-                const strategyResponse = await this.applyStrategies(
-                  cacheResponse,
-                  responseStrategies,
-                  "response"
-                );
-                return strategyResponse;
-              }
-            }
             const params = this.buildRequestArgs(target, propertyKey, args);
             request = { ...request, ...params };
-            console.log("构建请求参数：", request);
+            enableLog && console.log("构建请求参数：", request);
             const requestStrategies = strategies.filter(
               (strategy) => strategy.applyRequest
             );
@@ -3909,10 +3871,24 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
               requestStrategies,
               "request"
             );
+            const hitSource = this.getHitSource(target, propertyKey);
+            enableLog && console.log("hitSource:", hitSource);
+            if (typeof hitSource == "string") {
+              this.setHitSource(request, hitSource);
+            }
+            if (hitSource !== null) {
+              const cachedResponse = await this.getCache(request, strategies);
+              if (cachedResponse) {
+                enableLog && console.warn("数据从缓存获取");
+                return this.handleResponse(cachedResponse, true);
+              }
+            }
             try {
-              console.log("send request:", request);
+              enableLog && console.log("send request:", request);
               const response = await this.axiosInstance(request);
-              return this.handleResponse(response);
+              hitSource !== null && this.setCache(request, response);
+              this.expireCache(propertyKey);
+              return this.handleResponse(response, false);
             } catch (error) {
               return this.handleError(error);
             }
@@ -3923,7 +3899,6 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     buildRequestArgs(target, propertyKey, args) {
       const requestArgs = { params: {}, data: {} };
       const paramConfigs = Reflect.getMetadata(REQUEST_ARGS_KEY, target, propertyKey) || [];
-      console.log("请求参数:", paramConfigs);
       paramConfigs.forEach(({ index, type, key }) => {
         const value = args[index];
         if (type === "params" && !key && typeof value === "object") {
@@ -3943,14 +3918,11 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     }
     getStrategies(target, propertyKey) {
       const serverStrategies = Reflect.getMetadata(STRATEGY_KEY, this.constructor) || [];
-      console.log("serverStrategies:", serverStrategies);
       const classStrategies = Reflect.getMetadata(STRATEGY_KEY, target.constructor) || [];
-      console.log("classStrategies:", classStrategies);
       const methodStrategies = Reflect.getMetadata(
         `${STRATEGY_KEY.toString()}_${propertyKey}`,
         target
       ) || [];
-      console.log("methodStrategies:", methodStrategies);
       const allStrategies = [
         ...this.strategies,
         ...serverStrategies,
@@ -3971,7 +3943,6 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
         VERSIONING_KEY,
         this.constructor
       );
-      console.log("版本管理器：", versioning);
       if (!versioning) return request;
       const version = Reflect.getMetadata(VERSION_KEY, target, propertyKey);
       const currentVersion = version || this.version || versioning.defaultVersion;
@@ -3982,24 +3953,95 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       const versionUrl = url ? `${url}/${request.url}` : request.url;
       return { ...request, url: versionUrl, headers, params };
     }
-    async applyCache(request, options) {
+    async getCache(request, strategies) {
+      var _a;
+      if (!this.cacheStorage) return void 0;
+      const cacheKey = apiKey(request);
+      const cached = await ((_a = this.cacheStorage) == null ? void 0 : _a.get(cacheKey));
+      if (cached && cached.error === null) {
+        let cacheResponse = {
+          data: cached.data,
+          status: 304,
+          headers: {},
+          statusText: "get response data from cache",
+          config: { headers: new AxiosHeaders() }
+        };
+        const responseStrategies = strategies.filter(
+          (strategy) => strategy.applyResponse
+        );
+        const strategyResponse = await this.applyStrategies(
+          cacheResponse,
+          responseStrategies,
+          "response"
+        );
+        return strategyResponse;
+      }
+    }
+    initCacheManage(options) {
+      if (!this.cacheStorage && options !== void 0) {
+        this.cacheStorage = createCache(options.type, options.ttl || 300);
+      }
+    }
+    getHitSource(target, propertyKey) {
+      const methodHitSource = Reflect.getMetadata(
+        `${CACHE_OPTIONS_KEY.toString()}_${propertyKey}`,
+        target
+      );
+      if (methodHitSource !== void 0) return methodHitSource;
+      const apiHitSource = Reflect.getMetadata(
+        CACHE_OPTIONS_KEY,
+        target.constructor
+      );
+      return apiHitSource;
+    }
+    setHitSource(request, hitSource) {
+      const cacheKeys = this.sourceMap.get(hitSource);
+      const currentCacheKey = apiKey(request);
+      if (cacheKeys) {
+        cacheKeys.push(currentCacheKey);
+        this.sourceMap.set(hitSource, cacheKeys);
+      } else {
+        this.sourceMap.set(hitSource, [currentCacheKey]);
+      }
+    }
+    async setCache(request, response) {
       var _a;
       const cacheKey = apiKey(request);
-      if (this.cacheStorage) {
-        return await ((_a = this.cacheStorage) == null ? void 0 : _a.get(cacheKey));
+      await ((_a = this.cacheStorage) == null ? void 0 : _a.set(cacheKey, response.data));
+    }
+    async expireCache(hitSource) {
+      const keys = this.sourceMap.get(hitSource);
+      if (keys) {
+        Promise.all(
+          keys.map(async (key) => {
+            var _a;
+            await ((_a = this.cacheStorage) == null ? void 0 : _a.delete(key));
+          })
+        );
       }
-      return void 0;
     }
-    getCacheConfig(target, propertyKey) {
-      return Reflect.getMetadata(`${CACHE_KEY.toString()}_${propertyKey}`, target) || // 方法级
-      Reflect.getMetadata(CACHE_KEY, target.constructor);
+    getServerConfig() {
+      return Reflect.getMetadata(
+        SERVER_CONFIG_KEY,
+        this.constructor
+      );
+    }
+    getApiConfig(constructor) {
+      return Reflect.getMetadata(API_CONFIG_KEY, constructor);
+    }
+    initAxios(config) {
+      if (!this.axiosInstance) {
+        this.axiosInstance = axios.create({
+          baseURL: config.baseURL,
+          timeout: config.timeout
+        });
+      }
     }
-    handleResponse(response) {
-      console.log("Response:", response);
+    handleResponse(response, hitCache) {
       return {
         data: response.data,
         error: null,
-        hitCache: false
+        hitCache
       };
     }
     handleError(error) {
@@ -4009,31 +4051,23 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       };
     }
   }
-  exports2.API_CONFIG_KEY = API_CONFIG_KEY;
   exports2.Api = Api;
-  exports2.CACHE_KEY = CACHE_KEY;
   exports2.Cache = Cache;
   exports2.CacheType = CacheType;
   exports2.Data = Data;
   exports2.Delete = Delete;
   exports2.Get = Get;
   exports2.Head = Head;
-  exports2.METHOD_KEY = METHOD_KEY;
   exports2.Options = Options;
   exports2.Params = Params;
   exports2.Patch = Patch;
   exports2.Post = Post;
   exports2.Put = Put;
-  exports2.REQUEST_ARGS_KEY = REQUEST_ARGS_KEY;
   exports2.RequestMethod = RequestMethod;
-  exports2.SERVER_CONFIG_KEY = SERVER_CONFIG_KEY;
-  exports2.STRATEGY_KEY = STRATEGY_KEY;
   exports2.Server = Server;
   exports2.Snail = Snail;
   exports2.Strategy = Strategy;
   exports2.UseStrategy = UseStrategy;
-  exports2.VERSIONING_KEY = VERSIONING_KEY;
-  exports2.VERSION_KEY = VERSION_KEY;
   exports2.Version = Version;
   exports2.Versioning = Versioning;
   exports2.VersioningType = VersioningType;

package/dist/typings/snail.option.d.ts

@@ -1,8 +1,6 @@
 import { CacheManagementOption } from "./cache.management.option";
-import { VersioningOption } from "./versioning.option";
 export interface SnailOption {
     baseURL?: string;
-    Versioning?: VersioningOption;
     CacheManage?: CacheManagementOption;
     enableLog?: boolean;
     timeout?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snail-js/api",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Http Request with Decorators Api, build on axios",
   "type": "module",
   "main": "./src/index.ts",