抖音云本地调试
收藏
我的收藏功能概述
抖音开发者工具支持在本地创建、开发、调试和部署抖音云函数服务,帮助开发者在抖音开发者工具中管理云端函数服务。
版本支持
准备
创建项目
首先需要使用 IDE 打开抖音云项目,若本地没有抖音云项目可通过如下两种方式创建抖音云项目。
新建抖音云项目
在创建项目时,将后端服务勾选为抖音云,点击「新建」即可直接创建抖音云项目。
将现有项目中切换为抖音云项目
在现有工程项目中的
project.config.json
文件里新增cloudfunctionRoot
配置,其值为抖音云函数服务所在的根目录名称。创建完成
当抖音云项目创建完成后,资源管理器中相应目录名称后会新增「函数服务」标记,该目录为抖音云函数的存放位置。
功能介绍
同步函数服务
该操作可以将云端的函数服务下载到本地,如果本地已经存在同名的函数服务则会跳过:
- 1.右键点击函数服务目录
- 2.点击「同步函数服务」选项
- 3.同步完成后会通过弹窗展示函数服务同步信息
新建函数服务
在 IDE 中支持快速创建函数服务模板:
- 1.右键点击函数服务目录
- 2.点击「新建函数服务」选项
- 3.输入函数服务名称即可完成模板快速创建
本地调试函数服务
在完成函数服务开发后,可在本地直接调试函数服务:
- 1.右键点击函数服务目录中的文件或目录
- 2.点击「本地调试函数服务」选项
- 3.输出面板中可查看调试过程中的日志信息
- 4.调试启动完成后可在「抖音云」面板中对指定函数服务的函数进行接口调试
- 5.除了可在「抖音云」面板中调试对应的函数服务,也支持在模拟器或真机预览过程中访问本地启动的函数服务
- a.抖音云侧边栏中将 callContainer 的域名配置为本地域名
- b.在代码中通过
tt.createCloud
访问指定的函数服务(由于在小程序环境中需要envId
与serviceID
参数,因此该种方式只能调试已经部署过的函数服务)。创建并部署函数服务
若需要将本地创建并开发完成的函数服务部署到云端,则可通过以下方式完成:
- 1.右键点击函数服务目录中无「已关联」标记的函数服务目录
- 2.点击「创建并部署函数服务」选项
- 3.输入表单中需要填写的信息并确认
- 4.在输出面板中查看部署日志
部署函数服务
若本地更新了已经部署过的函数服务里的代码,可通过以下方式将本地代码部署到云端:
- 1.右键点击函数服务目录中有「已关联」标记的函数服务目录
- 2.点击「部署服务」选项
- 3.输入表单中需要填写的信息并确认
- 4.在输出面板中查看部署日志
复制调用示例
如果想在小程序中调试函数服务,IDE 支持快捷方式复制小程序端的调用示例:
- 1.右键菜单获取调用示例
- a.右键菜单点击函数服务中有「已关联」标记的
JS
或TS
文件- b.点击「复制小程序端调用示例」,并将结果粘贴到小程序代码中
- 2.「抖音云」面板获取调用示例
- a.在「抖音云」面板中将右上角切换为指定的函数服务名称
- b.请求路径切换为指定的
JS
或TS
文件- c.点击「复制调用示例」按钮,并将结果粘贴到小程序代码中
注:在「抖音云」面板中复制调用示例时,会在调用示例中自动填充表单里的参数信息
常见问题
Q:为什么在云端已经部署过的函数服务,在 IDE 中没有「已关联」标记。
A:可执行「同步函数服务」操作或刷新资源管理器重新获取云端的部署信息。
Q:为什么启动调试时提示端口号被占用。
A:因为目前启动调试服务时会默认占用 8001 端口号,请确保本地没有其他工程也在进行抖音云调试或者有其他服务占用了 8001 端口号。