Add files via upload

Author: spatips

README.md

@@ -1 +1,12 @@
-# fizz-simple-cache-plugin
+# 简易缓存(SimpleCache)
+
+## 功能说明
+   1. 本插件根据请求地址与请求参数，缓存目标接口的返回结果。
+
+   2. 本插件默认采用机器内存作为缓存媒介，以求达到性能最优之目的，适用于单机部署。
+
+   3. 本插件也可以使用 Redis 作为缓存媒介，需要配置相应的参数，适用于分布式部署。
+
+   4. 本插件可配置无效数据(非业务数据)，如：多个用户使用同一个缓存。
+
+   5. 本插件可配置缓存有效期，缓存内容长度，缓存容量与清理间隔(本地缓存)。

src/main/java/we/plugin/pathcache/PathCacheConfig.java

@@ -0,0 +1,57 @@
+package we.plugin.pathcache;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+import org.springframework.context.annotation.Configuration;
+
+import we.config.ManualApiConfig;
+import we.plugin.PluginConfig;
+import we.plugin.auth.ApiConfig;
+import we.plugin.requestbody.RequestBodyPlugin;
+
+/**
+ * 定义 DemoApiConfig 继承 ManualApiConfig，并注解为 Configuration，然后实现 setApiConfigs
+ * 方法，在方法中添加路由配置； 本类仅为方便开发和测试，正式环境应该通过管理后台配置路由
+ */
+@Configuration
+public class PathCacheConfig extends ManualApiConfig {
+
+	@Override
+	public List<ApiConfig> setApiConfigs() {
+
+		List<ApiConfig> apiConfigs = new ArrayList<>();
+
+		// 一个路由配置
+		ApiConfig ac = new ApiConfig();
+		// 路由 id，建议从 1000 开始
+		ac.id = 1000;
+		// 前端服务名
+		ac.service = "cache";
+		// 前端路径
+		ac.path = "/test";
+		// 路由类型，此处为反向代理
+		ac.type = ApiConfig.Type.REVERSE_PROXY;
+		// 被代理接口的地址
+		ac.httpHostPorts = Collections.singletonList("http://10.100.113.28:9090");
+		// 被代理接口的路径
+		ac.backendPath = "/web/check";
+		ac.pluginConfigs = new ArrayList<>();
+
+		// 如果你的插件需要访问请求体，则首先要把 RequestBodyPlugin.REQUEST_BODY_PLUGIN 加到 ac.pluginConfigs
+		// 中，就像下面这样
+		PluginConfig pc1 = new PluginConfig();
+		pc1.plugin = RequestBodyPlugin.REQUEST_BODY_PLUGIN;
+		ac.pluginConfigs.add(pc1);
+
+		PluginConfig pc2 = new PluginConfig();
+		pc2.plugin = PathCacheFilter.PATH_CACHE_ID; // 应用 id 为 demoPlugin 的插件
+		ac.pluginConfigs.add(pc2);
+
+		apiConfigs.add(ac);
+
+		log.info("set api configs end");
+		return apiConfigs; // 返回路由配置
+	}
+}