serverless

描述

serverless 的插件有两个，分别是 serverless-pre-function 和 serverless-post-function， 前者会在指定阶段的最开始运行，后者是在指定阶段的最后运行。

这两个插件接收的参数都是一样的。

Parameters

名称类型必选项默认值有效值描述
phasestring可选[“access”][“rewrite”, “access”, “header_filter”, “body_filter”, “log”, “before_proxy”]
functionsarray[string]必须指定运行的函数列表，是数组类型，里面可以包含一个函数，也可以是多个函数，按照先后顺序执行。

需要注意的是，这里只接受函数，而不接受其他类型的 Lua 代码。比如匿名函数是合法的：

  1. return function()
  2.     ngx.log(ngx.ERR, 'one')
  3. end

闭包也是合法的：

  1. local count = 1
  2. return function()
  3.     count = count + 1
  4.     ngx.say(count)
  5. end

但不是函数类型的代码就是非法的：

  1. local count = 1
  2. ngx.say(count)

从 v2.6 版本开始，我们会把 conf 和 ctx 作为头两个参数传递给 serverless 函数，就跟一般的插件一样。

v2.12.0 版本之前，before_proxy 这个 phase 曾被称作 balancer。考虑到这一方法事实上运行在 access 之后，代理到上游之前，跟 balancer 没有关系，新的命名会更加贴切。

示例

启动插件

下面是一个示例，在指定的 route 上开启了 serverless 插件:

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/index.html",
  4.     "plugins": {
  5.         "serverless-pre-function": {
  6.             "phase": "rewrite",
  7.             "functions" : ["return function() ngx.log(ngx.ERR, \"serverless pre function\"); end"]
  8.         },
  9.         "serverless-post-function": {
  10.             "phase": "rewrite",
  11.             "functions" : ["return function(conf, ctx) ngx.log(ngx.ERR, \"match uri \", ctx.curr_req_matched and ctx.curr_req_matched._path); end"]
  12.         }
  13.     },
  14.     "upstream": {
  15.         "type": "roundrobin",
  16.         "nodes": {
  17.             "127.0.0.1:1980": 1
  18.         }
  19.     }
  20. }'

测试插件

使用 curl 访问：

  1. curl -i http://127.0.0.1:9080/index.html

然后你在 error.log 日志中就会发现 serverless pre function 和 match uri /index.html 两个 error 级别的日志， 表示指定的函数已经生效。

移除插件

当你想去掉插件的时候，很简单，在插件的配置中把对应的 json 配置删除即可，无须重启服务，即刻生效：

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "methods": ["GET"],
  4.     "uri": "/index.html",
  5.     "upstream": {
  6.         "type": "roundrobin",
  7.         "nodes": {
  8.             "127.0.0.1:1980": 1
  9.         }
  10.     }
  11. }'

现在就已经移除了 serverless 插件了。其他插件的开启和移除也是同样的方法。