快速入门

最近更新时间:2019-08-16 20:15:03

操作场景

Tencent Serverless Toolkit for VS Code 是腾讯云 Serverless 产品的 VS Code(Visual Studio Code)IDE 的插件。该插件可以让您更好的在本地进行 Serverless 项目开发和代码调试,并且轻松将项目部署到云端。

通过该 VS Code 插件,您可以:

  • 拉取云端的云函数列表,并触发云函数。
  • 在本地快速创建云函数项目。
  • 在本地开发、调试及测试您的云函数代码。
  • 使用模拟的 COS、CMQ、CKafka、API 网关等触发器事件来触发函数运行。
  • 上传函数代码到云端,更新函数配置。

前提条件

Tencent Serverless 均可在 Windows,Linux 和 MacOS 中安装。在安装 Tencent Serverless 之前,需要确保系统中已有以下组件/信息:

  • VS Code :在 VS Code下载页面 下载对应的 IDE 并安装,其版本要求为 v1.33.0 +
  • Python 2.7+ 或 Python 3.6+,以及对应版本 pip。
  • 对应的开发语言环境:当前主要支持 Node.js 和 Python 的开发环境。
  • 已注册腾讯云账户。

步骤1:安装插件

可通过以下两种方式安装 Tencent Serverless 插件:

通过插件市场直接安装

进入 插件市场 ,单击【install】进行安装。

通过 VS Code IDE 安装

  1. 运行 VS Code IDE。
  2. 打开 VS Code 插件市场。
  3. 在搜索框中输入 “Tencent Serverless”,单击搜索框下方列表中的 Tencent Serverless 插件查看详情并选择【install】。如下图所示:

    安装完成后,左侧栏中会展示已安装完毕的 Tencent Serverless 插件。

VS Code 插件借助于 SCF 命令行工具 进行本地函数的创建,触发和调试。插件安装完成后,会自动检测 SCF CLI 是否已安装。如果插件未检测到 SCF CLI ,会在右下角弹框提示安装 SCF CLI ,单击 【Go】进行安装。

说明:

部分 PC 环境配置可能导致安装 SCF CLI 失败,请参见 手动安装 CLI

步骤2:配置插件

如果您已经在 SCF CLI 中配置了账户信息,无需再次配置,请跳过此步骤。

  1. 单击左侧导航栏的,打开已安装好的 Tencent Serverless 插件。
  2. 单击创建一个腾讯云用户凭证。如下图所示:
    Alt text
  3. 根据提示依次输入账号的 APPID,SecretId 及 SecretKey 信息,作为插件调用云 API 时的认证信息。并在认证成功后,选择您希望部署函数的地域。配置信息获取途径如下:
    • 账号的 APPID:通过访问控制台中的 账号信息,可以查看您的 APPID。
    • SecretId 及 SecretKey:通过访问控制台中的 API 密钥管理,获取相关密钥或创建相关密钥。
    • 地域:地域列表及对应的英文写法可 点此 参阅。

步骤3:初始化函数

  1. 在配置账户对应地域下的云端函数列表中,单击【创建一个函数】,在本地初始化新的函数项目。如下图所示:
    说明:

    暂不支持不同的命名空间(无论是否在同一区域)下创建同名的本地函数

  2. 根据提示依次选择函数所在的命名空间,运行时 runtime,输入函数名。
  3. 函数信息录入成功后,将开始创建。创建成功后,列表页中会展示新建的本地函数(以vsCode 函数为例)。如下图所示:

步骤4:本地调用函数

单击左侧列表中的本地函数,选择【本地调用】,即可对函数进行本地测试。如下图所示:

说明:

当前仅支持 Python 及 Node.js 函数的本地触发能力。

步骤5:函数部署

完成上述步骤后,可通过插件将函数一键部署到云端。

  1. 单击左侧列表中的函数名称,进入该函数基本信息页面。
  2. 单击【上传函数】,等待函数上传完毕,即可在 函数服务 列表页中查看到函数的相关信息。如下图所示:

更多功能

云端函数操作

云端调用

针对云端的函数,可以通过 VS Code 插件进行云端的触发,更改事件模板等操作。
单击左侧列表中的云函数名称,在右侧页面中单击【云端调用】,即可在页面中查看到函数在云端运行的相关信息。如下图所示:

导入本地

说明:

如果您已经在 腾讯云云函数控制台 创建了函数,则可以在 VS Code 插件里直接将云端函数导入到本地。

  1. 右键单击目标远端函数,选择【导入到本地】。如下图所示:
  2. 单击右下角弹出框中的【Yes】。如下图所示:
  3. 创建完成后会自动打开代码工作区。
  4. 在插件页,您也可以右键单击目标函数,选择【编辑代码】,即可打开函数代码编辑视图。如下图所示:

测试模板

本地调用时,可根据函数功能选择不同的测试模板,也可以自定义模板。如下图所示:

更多测试模版相关内容,详情请参见 触发器

本地调试函数

针对 Python 函数,可以利用 SCF CLI 的本地调试能力,结合 VS Code 插件进行本地调试。

  1. 单击左侧导航栏第一个图标,进入本地编辑页面,给函数设置断点。如下图所示:
  2. 单击左侧列表中的本地函数,打开函数基本信息页面。
  3. 单击左侧导航栏【调试图标】(或 ctrl+shift+D),新建调试配置文件,并选择SCF Debugger For Node 或者 SCF Debugger For Python调试模板。如下图所示:
    注意:

    不同的 runtime 须选择对应的调试模板,可根据您当前的调试文件类型,区分选择 Python 和 Node.js。

  4. 单击,即可看到调试信息。如下图所示:

欢迎交流

如果您对 Tencent Serverless 感兴趣,您可以加入QQ群(537539545)与我们交流。
Alt text