Aliyun Serverless VSCode Extension 是一款 VSCode 图形化开发调试函数计算以及操作函数计算资源的工具。本文介绍了如何通过该创建函数以及该插件的常见功能。

前提条件

如果您期望使用 Aliyun Serverless VSCode Extension 的所有功能,那么您需要确保系统中有以下组件:

背景信息

Aliyun Serverless VSCode Extension 是函数计算提供的 VSCode 插件,该插件结合了函数计算命令行工具 Fun函数计算 SDK 的功能,是基于 VSCode 的开发、调试、部署工具。通过该插件,您可以:

  • 快速地在本地初始化项目、创建函数。
  • 运行、调试本地函数,以及部署服务函数至云端。
  • 拉取云端的服务函数列表、查看服务函数配置信息、调用云端函数。
  • 获得模版文件的语法提示:自动补全、Schema 校验、悬浮提示。

安装插件

  1. 打开 VSCode 并进入插件市场。
  2. 在插件市场中搜索 Aliyun Serverless,查看详情并安装。
  3. 重启 VSCode,左侧导航栏中会展示已安装的 Aliyun Serverless VSCode Extension 插件图标。

快速入门

  1. 绑定阿里云账户。
    1. 在左侧导航栏,单击 Aliyun Serverless VSCode Extension 图标 icon_Aliyun_Serverless_VSCode_Extension,然后单击 Bind New Account
      vscode_bind_account
    2. 依次输入阿里云 Account ID、阿里云 AccessKeyId、阿里云 AccessKeySecret、账户别名(即账户本地名称)。
      vscode_bind_account_toast
      绑定完成后,可以看到所绑定的阿里云账户的云端服务与函数列表。vscode_bind_account_result
      您还可以在 Remote Resources 面板中,单击右上角的更多信息图标,在下拉菜单中,选择 FC: Switch Region 来查看不同地域的服务与函数。vscode_switch_region
  2. 创建函数。
    1. 通过 VSCode,打开一个空的目录文件。单击 LOCAL RESOURCES 中的创建函数图标,可以在本地初始化一个函数计算项目。
      vscode_create_function
    2. 按照导航依次输入或选择服务名称、函数名称、函数运行时、函数类型。填写完毕后,插件会自动创建函数并在 LOCAL RESOURCES 面板中会展示新建的本地服务与函数。
      vscode_create_function_result
      您也可以直接单击 LOCAL RESOURCES 中服务名右侧的创建函数图标,来为该服务创建函数。按照导航依次输入或选择函数名称、函数运行时、函数类型即可。vscode_create_function_underservice
  3. 部署服务以及函数。
    1. 单击 LOCAL RESOURCES 面板中的部署图标,可以将本地的服务与函数部署到云端。
      vscode_deploy
      部署完成后,单击 REMOTE RESOURCES 面板中的刷新图标,可以查看部署到云端的服务与函数。vscode_deploy_result

其余功能介绍

  • 本地调用函数
    LOCAL RESOURCES 面板中,单击函数名称右侧的执行图标或 Handler 文件中的执行链接,可以在本地调用该函数。vscode_local_invoke
    函数的日志以及结果会输出在 TERMINAL 中。vscode_local_invoke_result
    插件会为您在函数入口文件同目录下创建 event.dat 文件,您可以通过修改该文件设置每次调用函数时触发的事件信息。vscode_local_invoke_event
  • 本地调试函数
    注意
    • 若您想要调试 Python 2.7 或 Python 3 runtime 的函数,需要事先在插件安装 Python 插件。
    • 若您想调试 PHP runtime 的函数,需要事先在插件安装 PHP Debug 插件。
    LOCAL RESOURCES 面板中,单击函数名称右侧的调试图标或 Handler 文件中的调试链接,可以在本地调试该函数。vscode_local_debug
    在代码文件中插入断点,启动调试后即可看到调试信息。vscode_local_debug_result

    插件会为您在函数入口文件同目录下创建 event.dat 文件,您可以通过修改该文件设置每次调试函数时触发的事件信息。

  • 执行云端函数
    单击 REMOTE RESOURCES 面板中函数右侧的执行图标,可以执行云端函数。vscode_remote_invoke
    函数的日志以及结果会输出在 TERMINAL 中。vscode_local_invoke_result

    插件会为您在项目根目录下创建 event.dat 文件,您可以通过修改该文件设置每次调用云端函数时触发的事件信息。

  • 跳转到模版文件定义

    函数计算 Fun 工具通过 YAML 格式的模板文件来描述 Serverless 应用。通过 Aliyun Serverless VSCode Extension 创建函数时,会使用默认值自动填充模版文件。若您想修改本地服务或函数的配置,可以通过单击 LOCAL RESOURCES 面板中的服务或函数名,跳转到模版文件中的相关描述,所选择资源在模板文件中的相关描述块会高亮并逐渐褪去。

    vscode_goto_template
  • 模版文件填充提示
    • 自动补全

      支持模版文件 template.yml 内所有资源配置属性的自动补全。自动补全会依据缩进层级给出精准的提示选项。

    • 错误校验

      支持模版文件 template.yml 内所有资源配置信息的校验。在 template.yml 中会检测资源的配置信息是否符合规格说明

    • 悬浮提示

      提供模版文件 template.yml 内所有资源配置的上下文帮助。在 template.yml 中,将鼠标悬浮在相关资源的键名上,会出现关于该键下可配置字段的悬浮信息展示(字段名、字段类型、文档地址)。

反馈

如果您在使用中遇到问题,欢迎扫描以下二维码加入函数计算官方客户群或在 github 中反馈。vscode_qr_code