使用 fun local 进行本地调试 - 函数计算

运行函数的命令格式如下。

fun local invoke [options] <[service/]function>

fun local invoke function
fun local invoke service/function

本地运行 Java 类型的函数

fun build java8

using template: template.yml
start building function dependencies without docker

building localdemo/java8
running task flow MavenTaskFlow
running task: MavenCompileTask
running task: MavenCopyDependencies
running task: CopyMavenArtifacts

Build Success
Built artifacts: .fun/build/artifacts
Built template: .fun/build/artifacts/template.yml

Tips for next step======================
* Invoke Event Function: fun local invoke
* Invoke Http Function: fun local start
* Deploy Resources: fun deploy

fun local invoke 支持 -d, —debug-port 选项，可以对函数进行本地单步调试。Fun Local 涉及到的 debugging 技术全部都基于各个语言通用的调试协议实现的，使用对应语言的 remote debugging 方法都可以进行调试。

• 本地调试 Nodejs、Python 类型的函数

  对于 Nodejs6、Nodejs8、Python2.7、Python3、JAVA8 类型的函数，调试方法基本一致。下面通过 Nodejs8 举例。

  我们上面演示了可以通过 fun local invoke nodejs8 来运行名称为 Nodejs8 的函数，如果想对该函数进行调试，只需要使用 -d 参数，并配置相应的端口号即可。

  比如我们以调试方式运行函数，并将调试端口设定在 3000，可以通过下面的命令：

  fun local invoke -d 3000 nodejs8

  另外，推荐添加 —config 参数，在调试的同时，可以输出用来调试的 IDE 的配置信息：

  fun local invoke -d 3000 --config VSCode nodejs8

  命令执行结果如下：

  skip pulling images ...
  you can paste these config to .vscode/launch.json, and then attach to your running function
  ///////////////// config begin /////////////////
  {    
    "version": "0.2.0",    
    "configurations": [
          {
              "name": "fc/localdemo/nodejs8",
              "type": "node",
              "request": "attach",
              "address": "localhost",
              "port": 3000,
              "localRoot": "/Users/tan/code/fun/examples/local/nodejs8",
              "remoteRoot": "/code",
              "protocol": "inspect",
              "stopOnEntry": false
          }
      ]
  }
  ///////////////// config end /////////////////
  Debugger listening on ws://0.0.0.0:3000/b65c288b-bd6a-4791-849b-b03e0d16b0ce
  For help see https://nodejs.org/en/docs/inspector

  程序会阻塞在这里，并不会继续往下执行。只有 IDE 的连接上来后，程序才会继续执行。接下来，我们针对 VSCode 配置、VSCode 调试两个方面分别进行讲解。

  其中 VSCode 配置只有在第一次对函数进行调试时才需要，如果已经配置过，则不需要再次配置。

  1. VSCode 配置
     1. 创建 vscode launch.json 文件。
     2. 复制日志中的 config begin 与 config end 之间的配置到 launch.json 中。
     3. 完成上面配置后，在 Debug 视图可以看到配置的函数列表。

        至此，VSCode 配置完成。VSCode 更多配置知识可参见官方文档

  2. VSCode 调试
     1. VSCode 配置成功后，只需要在 VSCode 编辑器侧边栏单击设置断点，然后点击“开始调试”按钮，即可开始调试。
     2. 以下是一个 nodejs8 函数本地单步调试的流程例子：
• 本地调试 Java 类型的函数
  • 使用 VSCode 调试 java

    使用 VSCode 调试 java 时，需要安装两个插件：Language Support for Java(TM) by Red Hat、Debugger for Java。利用 VSCode 的插件市场安装插件很简单，请参见此 操作介绍

    以下是一个使用 VSCode 调试 java 类型函数的例子：

    
  • 使用 IDEA 调试 java
    IDEA 配置 remote debugging ，首先在菜单栏选择 Run… > Edit Configurations…
    1. 新建一个 Remote Debugging。
    2. 输出一个名字，并配置端口号为 3000。
    3. 以下是配置 IDEA remote debugging 的完整流程演示:
  • 使用 IDEA 开始调试
    先将 Java 函数以 debug 的方式运行起来：

    fun local invoke -d 3000 java8

    

    可以看到函数停止在这里了，接着我们使用 IDEA 连接并开始调试。可以通过菜单栏上的 Run > Debug… 或者工具栏直接点击 Debug 按钮，即可开始调试。

    以下是一个用 IDEA 进行 remote debugging 的完整流程演示：

php 的调试与其他类型的函数调试在流程上有一些不同。

fun local invoke -d 3000 --config VSCode php72

skip pulling images ...
you can paste these config to .vscode/launch.json, and then attach to your running function
///////////////// config begin /////////////////
{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "fc/localdemo/php72",
            "type": "php",
            "request": "launch",
            "port": 3000,
            "stopOnEntry": false,
            "pathMappings": {
                "/code": "/Users/tan/code/fun/examples/local/php7.2"
            },
            "ignore": [
                "/var/fc/runtime/**"
            ]
        }
    ]
}
///////////////// config end /////////////////
FunctionCompute php7.2 runtime inited.
FC Invoke Start RequestId: 6e8f7ed7-653d-4a6a-94cc-1ef0d028e4b4
FC Invoke End RequestId: 6e8f7ed7-653d-4a6a-94cc-1ef0d028e4b4
hello world
RequestId: 6e8f7ed7-653d-4a6a-94cc-1ef0d028e4b4          Billed Duration: 48 ms          Memory Size: 1998 MB        Max Memory Used: 58 MB

这是因为，对于 php 程序，需要首先启动 vscode 的调试器。

php 类型的函数启动 VSCode 调试器的流程与其他类型的函数一致：复制上面日志中的 vscode 配置到 launch.json，单击“开始调试”即可。然后在终端重新以调试模式启动 php 函数即可开始调试：

fun local invoke -d 3000 php72

函数计算提供了丰富的触发器，包括但不局限于对象存储触发器、日志服务触发器、CDN 事件触发器等。在本地无论是运行还是调试函数时，为了能够完全模拟线上环境，通常需要构造触发事件。

{
    "testKey": "testValue"
}

fun local start [options]

其中 options 是可以省略的。

执行 fun local start 后，fun 会首先启动一个 http server，以提供 http 的服务。然后 fun 会扫描 template.yml 中描述的所有配置了 Http Trigger 的函数，注册到 http server 中。注册成功后，就可以通过浏览器或者其他的 http 工具访问了。

比如，对于在 local_http 下执行 fun local start 后，会显示所有的 http trigger 信息：打开任意一个 url，即可通过 http trigger 的方式触发函数运行。

以下是一个访问 nodejs http trigger 的动态演示（其他类型的 runtime，比如 python、php 使用体验一致）：

Http Trigger 本地调试的方法与使用事件触发函数的方法一致，通过 -d, —debug-port 选项。同时还支持 -c, —config ，支持在调试时，显示调试 ide 配置。

调试方法为，首先通过 fun local start —debug 3000 —config vscode 启动服务，然后会看到 template.yml 中声明的函数都被注册成功：根据服务名、函数名或者 http trigger 触发器名称选择合适的 url，使用浏览器打开会看到浏览器页面一直无响应，但在终端会看到日志输出：

skip pulling image aliyunfc/runtime-python3.6:1.2.0...
you can paste these config to .vscode/launch.json, and then attach to your running function
///////////////// config begin /////////////////
{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "fc/local-http-demo/python3",
            "type": "python",
            "request": "attach",
            "host": "localhost",
            "port": 3000,
            "pathMappings": [
                {
                    "localRoot": "/Users/tan/fun_local_http_demo/python3",
                    "remoteRoot": "/code"
                }
            ]
        }
    ]
}
///////////////// config end /////////////////
FunctionCompute python3 runtime inited.
FC Invoke Start RequestId: 04c57fba-cbe9-4c1f-8c57-f8e0b539fa08

将日志中的配置信息复制到 vscode 调试器中，在代码中下好断点，单击开始调试即可。

以下是一个调试 python http trigger 的动态演示（其他类型的 runtime，比如 nodejs、php 使用体验基本一致）：

本地运行、调试 Http Trigger 时，支持热加载。

当通过 fun local start 启动本地服务后，即使修改了代码，也无需重启本地服务，可以直接刷新网页或者重新触发函数即可运行变更后的函数。

以下是一个 nodejs 热加载的动态演示（其他类型的 runtime，比如 php、python 类似）。请提前在函数目录执行 npm install，用于初始化函数依赖的 nodejs 模块。

fun local start [options]

其中 options 是可以省略的。

执行 fun local start 后，fun 会首先启动一个 http server，以提供 http 的服务。然后 fun 会扫描 template.yml 中描述的所有的函数，并将所有没有配置 Http Trigger 的函数，注册到 http server 中。注册成功后，就可以通过 InvokeFunction API 或 SDK 进行调用。详情请参见 API 定义和 SDK 列表。

$ fun local start

api localdemo/php72 was registered
    url: http://localhost:8000/2016-08-15/services/localdemo/functions/php72/invocations/
api localdemo/python27 was registered
    url: http://localhost:8000/2016-08-15/services/localdemo/functions/python27/invocations/
api localdemo/python3 was registered
    url: http://localhost:8000/2016-08-15/services/localdemo/functions/python3/invocations/
api localdemo/nodejs6 was registered
    url: http://localhost:8000/2016-08-15/services/localdemo/functions/nodejs6/invocations/
api localdemo/nodejs8 was registered
    url: http://localhost:8000/2016-08-15/services/localdemo/functions/nodejs8/invocations/
api localdemo/java8 was registered
    url: http://localhost:8000/2016-08-15/services/localdemo/functions/java8/invocations/
function compute app listening on port 8000!

pip install aliyun-fc2

import fc2

client = fc2.Client(endpoint='http://localhost:8000', accessKeyID='<your access key id>', accessKeySecret='your access key secret')

resp = client.invoke_function('localdemo', 'php72')

print resp.headers
print resp.data

执行效果如下图所示：

在 template.yml 中配置的 EnvironmentVariables 会与线上行为一致，当函数运行时，可以通过代码获取到。更多信息参考

在本地运行函数时，除了 EnvironmentVariables

通过这个环境变量，用户可以区分是本地运行还是线上运行，以便于进行一些特定的逻辑处理。

用户可以通过 Credentials 中存储的 ak 信息访问阿里云的其他服务。Fun local 在本地运行函数时，会按照与 fun deploy 相同的策略寻找 ak 信息。

关于函数计算 Credentials 的描述，可以参考。

local = bool(os.getenv('local', ""))
if (local):
    print 'thank you for running function in local!!!!!!'
    auth = oss2.Auth(creds.access_key_id,
                     creds.access_key_secret)
else:
    auth = oss2.StsAuth(creds.access_key_id,
                        creds.access_key_secret,
                        creds.security_token)