小程序开放平台

文档中心
快速入门
开发准备
本地开发
部署发布
功能服务
函数服务
函数服务概述
云服务开发指南
调试器使用指南
云服务密钥
日志查询
公共错误码
免登录
常见问题

调试器使用指南

开发指南
>
功能服务
>
函数服务
>
调试器使用指南
>
更新时间:2026-01-08 20:36:12

云函数调试器(Function Debugger)是一个本地云函数开发调试工具,提供可视化的代码编辑、实时调试、函数部署等功能,帮助开发者高效完成云函数的开发与测试。

快速开始

前置条件

在使用云函数调试器之前,请确保:

  1. 已安装 Node.js:版本要求 ≥ 18
  2. 已完成 CLI 登录:执行
    rcb login --secretId <secretId> --secretKey <secretKey>
  3. 已创建云环境:可通过
    rcb env list
    查看可用环境,或使用
    rcb env create
    创建新环境

启动调试器

在函数代码目录下执行:

# 在当前目录启动调试器
rcb fun dev

# 指定函数目录并自动打开浏览器
rcb fun dev -d ./functions/demo -o

# 指定云环境 ID(会校验环境是否存在)
rcb fun dev -e env-7k2m9n4p

# 开启文件监听模式
rcb fun dev -w

启动成功后,控制台会输出以下信息:

🧪 [rcb-fun] 函数调试目录: /path/to/functions
🧪 [rcb-fun] 函数调试服务已启动
🧪 [rcb-fun] API URL: http://localhost:9230
🧪 [rcb-fun] WebSocket URL: ws://localhost:9230/ws
🧪 [rcb-fun] 调试 UI: http://localhost:9230
🧪 [rcb-fun] 函数框架服务(rcb-ff)URL: http://localhost:9000

提示:如果使用了

-o/--open
参数,浏览器会自动打开调试 UI。否则,请手动访问控制台输出的调试 UI 地址。

基本工作流程

  1. 启动调试器
    rcb fun dev -d <函数目录> -e <环境ID>
  2. 打开 Web IDE:在浏览器中访问调试 UI 地址
  3. 编辑代码:在代码编辑器中修改函数代码
  4. 配置请求:在右侧调试面板设置请求参数(Method、Body、Query、Headers)
  5. 运行调试:点击"运行"按钮,查看执行结果和日志
  6. 部署函数:调试通过后,通过"发布"功能将代码部署到云端

调试器界面介绍

Web IDE整体界面

说明:Web IDE 采用三栏布局,左侧为文件树,中间为代码编辑器,右侧为调试面板。

左侧文件树

文件树显示当前工作目录的文件结构,支持:

  • 文件浏览:展开/折叠目录,查看所有文件
  • 文件选择:点击文件可在编辑器中打开
  • 文件操作:创建、重命名、删除文件(通过右键菜单)
  • 实时同步:通过 WebSocket 实时同步本地文件变更

左侧文件树

中间代码编辑器

基于 Monaco Editor 的代码编辑器,提供:

  • 语法高亮:支持 JavaScript/TypeScript 等多种语言
  • 代码补全:智能代码提示和自动补全
  • 多文件编辑:支持标签页切换多个文件
  • 自动保存:编辑后自动保存到本地文件系统
  • 代码导航:支持跳转到函数定义、查找引用等

快捷键

快捷键(macOS)
快捷键(Windows/Linux)
功能
⌘ + S
Ctrl + S
保存当前文件
⌘ + P
Ctrl + P
快速打开文件
⌘ + B
Ctrl + B
显示/隐藏文件树
⌘ + ⇧ + L
Ctrl + Shift + L
打开 AI 聊天面板

中间代码编辑器

右侧调试面板

右侧面板包含三个主要标签页:

在线调试标签页

用于配置请求参数和执行调试:

函数选择

  • agent-cloudbase-functions.json
    配置文件中选择要调试的函数
  • 函数列表自动从配置文件的
    functions
    字段解析
  • 切换函数后会自动跳转到对应的函数入口代码位置

请求配置

  • HTTP Method:选择请求方法(GET、POST)
  • 端形态:选择应用类型(小程序、Web)
  • Body 参数:JSON 格式的请求体(支持格式化)
    • 提供 AI 分析按钮(🪄),可自动分析函数代码并生成 Body 参数
  • Query 参数:URL 查询参数(键值对形式)
  • Headers:HTTP 请求头(键值对形式,默认包含
    Content-Type: application/json

运行调试

  • 点击"调试"按钮执行函数
  • 结果会显示在"运行结果"卡片中

运行调试界面

发布记录标签页

记录函数发布历史,支持查看所有已发布的函数版本:

功能特性

  • 历史记录列表:按时间倒序显示所有发布记录,最新的记录显示在最上方
  • 记录信息:每条记录包含:
    • 序号:记录序号(从最新到最旧)
    • 发布描述:部署时填写的备注信息
    • $LATEST 标签:最新发布的记录会标记为
      $LATEST
    • 发布时间:显示相对时间(如"2小时前"、"3天前")
    • 发布人:执行部署的用户名称
    • 发布状态:显示发布状态(成功/失败)
  • 分页查询:支持分页浏览历史记录,可自定义每页显示数量
  • 记录总数:显示总记录数,便于了解发布频率

使用说明

  • 需要先配置云环境 ID,否则会提示"未检测到云环境 ID"
  • 如果没有发布记录,会显示"暂无发布记录"
  • 记录按发布时间倒序排列,方便查看最新版本

注意:查看详情和回滚功能正在开发中,当前操作菜单暂时禁用。

发布记录页面

调试功能详解

函数调试执行

云函数调试器通过调用

/fun/run
接口,将请求转发到真实的云函数框架(rcb-ff)服务进行执行:

  • 真实环境执行:函数在真实的云函数框架环境中运行,与生产环境一致
  • 依赖包支持:可以加载
    node_modules
    中的依赖
  • 端形态支持:支持小程序和 Web 两种端形态的调试
  • 自动跳转:选择函数后会自动跳转到对应的函数入口代码位置

请求配置

HTTP Method

选择请求方法,支持:

  • GET
    :查询操作
  • POST
    :创建/提交操作(默认)

端形态

选择应用类型:

  • 小程序:小红书小程序端形态(默认)
  • Web:Web 应用端形态

Body 参数

请求体内容,支持 JSON 格式:

{
  "userId": "12345",
  "action": "getUserInfo",
  "params": {
    "includeProfile": true
  }
}

编辑器支持:

  • JSON 格式化(自动格式化)
  • 语法高亮
  • 语法校验(无效 JSON 会提示错误)

AI 分析功能

在 Body 标签页中,点击 🪄 按钮可以使用 AI 分析函数代码并自动生成 Body 参数:

  1. 选择要调试的函数
  2. 点击 Body 标签页中的 🪄 按钮
  3. AI 会分析函数代码,识别函数参数和请求体结构
  4. 自动填充 Body 编辑器,生成合理的示例参数值

注意:AI 分析功能需要先选择函数,且函数代码必须可访问。

Query 参数

URL 查询参数,以键值对形式配置:

Key
Value
说明
page
1
页码
limit
10
每页数量

Headers

HTTP 请求头配置,默认包含:

Key
Value
说明
Content-Type
application/json
内容类型(默认,不可删除)

可以添加自定义请求头,例如:

Key
Value
说明
Authorization
Bearer token123
认证令牌
X-Custom-Header
custom-value
自定义头

调试结果展示

执行调试后,结果面板会显示:

响应状态码

HTTP 状态码,例如:

  • 200
    :成功
  • 400
    :请求错误
  • 500
    :服务器错误

响应 Body

函数返回的响应体内容,支持:

  • JSON 格式化显示
  • 原始文本显示
  • 复制响应内容

执行日志

函数执行过程中的日志输出(当前通过

/fun/run
接口转发到云函数框架,日志收集功能待完善)。

调试结果展示界面

执行时长

显示函数执行耗时(毫秒),例如:

durationMs: 125

错误信息

如果函数执行失败,会显示详细的错误信息:

  • 错误类型
  • 错误消息
  • 错误堆栈(如果可用)

运行失败结果展示界面

高级功能

AI 代码分析

在"在线调试"标签页的 Body 编辑器中,点击 🪄 按钮可以使用 AI 分析函数代码并自动生成 Body 参数:

功能说明

  • 代码分析:AI 会分析当前选择的函数代码,识别函数参数、请求体结构、依赖关系
  • 参数生成:根据代码逻辑推断出合理的参数值和类型
  • 自动填充:分析完成后自动填充 Body 编辑器,生成有效的 JSON 格式参数

使用步骤

  1. 在"在线调试"标签页中选择要调试的函数
  2. 切换到 Body 标签页
  3. 点击 🪄 按钮
  4. 等待 AI 分析完成,Body 编辑器会自动填充生成的参数

注意事项

  • 需要先选择函数才能使用 AI 分析功能
  • 函数代码必须可访问
  • 生成的参数为示例值,可根据实际需求调整

文件管理

文件创建

  • 在文件树中右键点击目录
  • 选择"新建文件"
  • 输入文件名(支持子目录,如
    utils/helper.js

文件编辑

  • 点击文件树中的文件,在编辑器中打开
  • 支持多文件同时编辑(标签页切换)
  • 修改后自动保存(或使用
    ⌘/Ctrl + S
    手动保存)

文件删除

  • 在文件树中右键点击文件
  • 选择"删除"
  • 确认删除操作

注意:删除操作会直接删除本地文件,请谨慎操作。

文件同步

  • 通过 WebSocket 实时同步文件变更
  • 本地文件修改后,文件树会自动更新
  • 支持文件变更监听(使用
    -w/--watch
    参数启动时)