tzssangglass commented on a change in pull request #95: URL: https://github.com/apache/apisix-java-plugin-runner/pull/95#discussion_r767387952
########## File path: docs/zh/Quick Start.md ########## @@ -0,0 +1,110 @@ +### Quick Start + +#### 一、准备工作 + +* JDK 8 + +* Clone the [apisix-java-plugin-runner](https://github.com/apache/apisix-java-plugin-runner) project. + +#### 二、开发扩展插件过滤器 + +在`runner-plugin` 模块 `org.apache.apisix.plugin.runner.filter` 包下编写过滤器处理请求，过滤器要实现`PluginFilter` 接口，可以参考 `apisix-runner-sample` 模块下的样例，官方提供了两个样例还是很全面的，一个是请求重写[RewriteRequestDemoFilter](https://github.com/apache/apisix-java-plugin-runner/blob/main/sample/src/main/java/org/apache/apisix/plugin/runner/filter/RewriteRequestDemoFilter.java)，一个是请求拦截[StopRequestDemoFilter](https://github.com/apache/apisix-java-plugin-runner/blob/main/sample/src/main/java/org/apache/apisix/plugin/runner/filter/StopRequestDemoFilter.java)。 + +```java +@Component +public class CheckTokenFilter implements PluginFilter { + @Override + public String name() { + return "CheckTokenFilter"; + } + + @Override + public Mono<Void> filter(HttpRequest request, HttpResponse response, PluginFilterChain chain) { + /* + * todo your business here + */ + + + return chain.filter(request, response); + } +} +``` + +#### 三、部署 + +插件写好后怎么部署是关键，apisix-java-plugin-runner 与 APISIX 用 Unix Domain Socket 进行进程内通讯， +所以他们要部署在一个服务实例，并且APISIX启动的过程中会带着apisix-java-plugin-runner一起启动，如果是容器化部署就必须在一个容器里运行。 + +所以如果是容器部署就需要把apisix-java-plugin-runner 与 APISIX 生成在一个docker image里。 Review comment: can you see this:  I suspect that github has eaten this -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
