使用 Java 编写 Apache APISIX 插件

Zhengsong Tu

更新时间 6/21/2021

Apache APISIX 支持多语言编写插件了!不会 Lua 也没关系,现在可以用你熟悉的语言编写插件,文末还有视频教程

简介

为什么 Apache APISIX 要支持多语言编写插件

在支持多语言编程插件前,Apache APISIX 只支持使用 Lua 语言编写插件,需要开发者掌握 Lua 和 OpenResty 相关的开发能力。然而相对于主流开发语言 Java 和 Go 来说,Lua 和 OpenResty 属于相对小众的技术,开发者很少。如果从头开始学习 Lua 和 OpenResty,需要付出相当多的时间和精力。

开发团队在进行技术选型的时候,最重要的考量就是所选技术是否与本团队技术栈相匹配,然而小众的技术栈就限制了 Apache APISIX 在更广阔的场景下进行技术落地。

现在 Apache APISIX 支持多语言开发插件,更重要的是支持语言所在的开发生态圈,使用者可以使用自己熟悉的技术栈来开发 Apache APISIX。以支持 Java 为例,使用者不仅可以使用 Java 语言编写插件,还可以融入 Spring Cloud 生态圈,广泛使用生态圈内的各种技术组件。

Apache APISIX 多语言支持架构图

APISIX arch

上图左边是 Apache APISIX 的工作流程,右边的 plugin runner 是指插件运行器,泛指多语言支持的项目。本文档下面提到的 apisix-java-plugin-runner 项目就是支持 Java 语言的 plugin runner。

当你在 Apache APISIX 中配置一个 plugin runner 时,Apache APISIX 会启动一个子进程运行 plugin runner,该子进程与 Apache APISIX 进程属于同一个用户。当我们重启或重新加载 Apache APISIX 时,plugin runner 也将被重启。

如果你为一个给定的路由配置了 ext-plugin-* 插件,命中该路由的请求将触发 Apache APISIX,通过 unix socket 向 plugin runner 执行 RPC 调用。调用细分为两个阶段:

  • ext-plugin-pre-req: 在执行 Apache APISIX 内置插件(Lua 语言插件)之前
  • ext-plugin-post-req: 在执行 Apache APISIX 内置插件(Lua 语言插件)之后

根据需要配置 plugin runner 的执行时机。

plugin runner 会处理 RPC 调用,在其内部创建一个模拟请求,然后运行多语言编写的插件,并将结果返回给 Apache APISIX。

多语言插件的执行顺序是在 ext-plugin-* 插件配置项中定义的。像其他插件一样,它们可以被启用并在运行中重新定义。

搭建开发环境

首先需要搭建 Apache APISIX 的运行环境或者开发环境,参考 构建 Apache APISIX,以及 Java 项目的开发环境,参考 构建 apisix-java-plugin-runner

注意:Apache APISIX 和 apisix-java-plugin-runner 需要位于同一实例上。

进入调试模式

设置 Apache APISIX 进入调试模式

这里是指让 Apache APISIX 以调试的方式运行外部插件,在 config.yaml 中增加以下配置

1ext-plugin:
2  path_for_test: /tmp/runner.sock

这个配置的意思是,Apache APISIX 相当于 client 端,会监听位于 /tmp/runner.sock 位置上的 Unxi Domain Socket 链接。

设置 apisix-java-plugin-runner 进入调试模式

在启动 Main class(org.apache.apisix.plugin.runner.PluginRunnerApplication)之前,需要配置用户级的环境变量 APISIX_LISTEN_ADDRESS=unix:/tmp/runner.sockAPISIX_CONF_EXPIRE_TIME=3600

如果你是使用 IDEA 进行开发,那么配置好的环境变量示意如下:

IDEA Environment Variables

apisix-java-plugin-runner 相当于 server 端,在启动时会主动创建 /tmp/runner.sock 文件,并在这个文件上与 Apache APISIX 进行 Unix Domain Socket 通信。

开发指南

场景

我们以一个场景来代入开发过程:需要验证请求 header 中 token 的有效性,验证 token 的方式是用请求中携带 token 作为参数,访问 SSO 固定的接口,如果 token 验证通过则放行请求,验证失败则阻止请求。

配置 Apache APISIX

先给插件命名为 TokenValidator,然后设计属性,为了尽可能做到动态配置,属性设计如下

1{
2  "validate_header": "token",
3  "validate_url": "https://www.sso.foo.com/token/validate",
4  "rejected_code": "403"
5}

启动 Apache APISIX,然后新增一条路由配置,指定该路由需要调用 apisix-java-plugin-runner 的 TokenValidator 插件,示例如下

1curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
2{
3    "uri":"/get",
4    "plugins":{
5        "ext-plugin-pre-req":{
6            "conf":[
7                {
8                    "name":"TokenValidator",
9                    "value":"{\"validate_header\":\"token\",\"validate_url\":\"https://www.sso.foo.com/token/validate\",\"rejected_code\":\"403\"}"
10                }
11            ]
12        }
13    },
14    "upstream":{
15        "nodes":{
16            "httpbin.org:80":1
17        },
18        "type":"roundrobin"
19    }
20}

需要注意的是,TokenValidator 的属性需要经过 json 转义,作为 string 类型进行配置。

(这里上游地址配置为 httpbin.org,方便调试)

开发 Java 插件

在 runner-plugin/src/main/java/org/apache/apisix/plugin/runner/filter 目录下,新增 TokenValidatr.java,代码初始骨架如下

1package org.apache.apisix.plugin.runner.filter;
2
3import org.apache.apisix.plugin.runner.HttpRequest;
4import org.apache.apisix.plugin.runner.HttpResponse;
5import org.springframework.stereotype.Component;
6import reactor.core.publisher.Mono;
7
8
9@Component
10public class TokenValidator implements PluginFilter {
11
12    @Override
13    public String name() {
14        return "TokenValidator";
15    }
16
17    @Override
18    public Mono<Void> filter(HttpRequest request, HttpResponse response, PluginFilterChain chain) {
19        return chain.filter(request, response);
20    }
21}

需要继承 PluginFilter接口,重写 namefilter函数。

重写 name 的返回值,和前面配置 APISIX 的路由属性中 "name" 保持一致。

完整代码如下:

1package org.apache.apisix.plugin.runner.filter;
2
3import com.google.gson.Gson;
4import org.apache.apisix.plugin.runner.HttpRequest;
5import org.apache.apisix.plugin.runner.HttpResponse;
6import org.springframework.stereotype.Component;
7import reactor.core.publisher.Mono;
8
9import java.util.HashMap;
10import java.util.Map;
11
12@Component
13public class TokenValidator implements PluginFilter {
14
15    @Override
16    public String name() {
17        return "TokenValidator";
18    }
19
20    @Override
21    public Mono<Void> filter(HttpRequest request, HttpResponse response, PluginFilterChain chain) {
22        // parse `conf` to json
23        String configStr = request.getConfig(this);
24        Gson gson = new Gson();
25        Map<String, Object> conf = new HashMap<>();
26        conf = gson.fromJson(configStr, conf.getClass());
27
28        // get configuration parameters
29        String token = request.getHeader((String) conf.get("validate_header"));
30        String validate_url = (String) conf.get("validate_url");
31        boolean flag = validate(token, validate_url);
32
33        // token verification results
34        if (!flag) {
35            String rejected_code = (String) conf.get("rejected_code");
36            response.setStatusCode(Integer.parseInt(rejected_code));
37            return chain.filter(request, response);
38        }
39
40        return chain.filter(request, response);
41    }
42
43    private Boolean validate(String token, String validate_url) {
44        //TODO: improve the validation process
45        return true;
46    }
47}

测试

在 Apache APISIX 上配置的上游服务是 httpbin.org,可以访问 Apache APISIX,触发路由,让 Apache APISIX 调用 apisix-java-plugin-runner 去执行 TokenValidator 插件,测试一下 Java 插件效果。

1curl -H 'token: 123456' 127.0.0.1:9080/get
2{
3 "args": {},
4 "headers": {
5 "Accept": "/",
6 "Host": "127.0.0.1",
7 "Token": "123456",
8 "User-Agent": "curl/7.71.1",
9 "X-Amzn-Trace-Id": "Root=1-60cb0424-02b5bf804cfeab5252392f96",
10 "X-Forwarded-Host": "127.0.0.1"
11 },
12 "origin": "127.0.0.1",
13 "url": "http://127.0.0.1/get"
14}

部署

插件开发完成后,部署操作可以参考 部署 apisix-java-plugin-runner

视频教程