快速上手|飞书低代码平台

阅读本文档，你将会了解到：

安装 CLI 的具体步骤

如何使用 CLI 的第一条命令

如何基于 CLI 获取应用包并开发第一个自定义组件

命令行工具，在业界统称是英文版本的 CLI（Command Line Interface）。为精简篇幅，后续关于命令行工具的内容同样统称为 CLI ，两者含义等同。

环境准备

Node 与 CLI 工具安装

可参考《安装指南》进行开发工具的安装。

Golang 安装

如果不需要开发 golang 函数，可以跳过此步骤

安装地址：https://go.dev/dl/（推荐版本：V 1.16）

安装完毕后在终端输入go version查看版本信息

开发流程

获取项目代码到本地

点击低代码开发后台「查看工程」->「代码管理」-> 「下载」，查看代码获取指引

250px|700px|reset

终端指令已根据租户和应用信息自动生成，可将指令直接 copy 到终端中执行

根据指引，通过终端将代码克隆到本地

开发低代码

💡

若基于本地历史代码项目开发，开发前建议先通过 ae source pull 同步最新远端代码

自定义组件

通过 ae component create {componentApiName} 创建自定义组件

在 index.meta.json（配置文件）文件中填写组件配置信息

在 index.tsx（入口文件/主代码文件）文件中开发自定义组件

其他工具代码通过 export/import 的方式供组件主代码调用，以该方式复用的工具代码在部署后不会解析为自定义组件

250px|700px|reset

250px|700px|reset

函数

通过 ae function create {functionApiName} 创建函数，并选择函数模块开发语言（目前支持 nodejs 和 golang 两种语言）；函数创建完成后，项目代码的「functions」目录下会根据选择的开发语言生成相应的文件夹和配置文件：

nodejs

package.json: 依赖管理文件

tsconfig.json: 智能提示配置文件

golang

go.mod: 依赖管理文件

init.go: 全局初始化文件，函数部署时调用该文件内部 GlobalInit() 方法（方法名不支持修改）进行初始化操作，GlobalInit() 异常会导致函数部署失败。

每个函数包含三个基础文件：

index.meta.json 函数配置信息

apiID：系统字段、不可修改；函数的唯一 ID、标识一个函数，修改后视为删除、再新建另一个函数

apiName、label、description：函数基本信息

isPublicAPI：是否开启 PublicAPI

frontendSDKInvokable：是否允许前端 SDK 调用

longTaskMode：通过设置 longTaskMode 为 true（默认为 false），可以为该函数开启「长任务模式」，在长任务模式下函数将能够运行三小时（普通云函数为 15 分钟），但同时将会降低该函数的请求并发度，请慎重选择开启（该参数第一次设置完成并成功部署函数后，不支持修改）；也可以在创建函数时指定函数为长任务模式

250px|700px|reset

input、output：通过修改该属性可以定义函数的入参、出参

input 参数项类型说明（采用 TypeScript 描述）

class InputItem {    key string;              // 必填    type string;             // 必填，可填值：Text，Multilingual，RichText，Number，Boolean，Date，DateTime，Email，MobileNumber，Record，RecordList    required: boolean;       // 必填    description: string;    label: string;    objectApiName: string;   // 当 type 为 Record 或 RecordList 时，该参数必填    fieldApiNames: string[]; // 当 type 为 RecordList 时，该参数必填    example: string;         // 用来生成 Open API 文档，可不填写}}

output 参数项类型说明（采用 TypeScript 描述）

// 没有 required 参数，所有参数都是必填class OutputItem {    key string;              // 必填    type string;             // 必填，可填值：Text，Multilingual，RichText，Number，Boolean，Date，DateTime，Email，MobileNumber，Record，RecordList    description: string;    label: string;    objectApiName: string;   // 当 type 为 Record 或者 RecordList 时，该参数必填    fieldApiNames: string[]; // 当 type 为 RecordList 时，该参数必填    example: string;         // 用来生成 Open API 文档，可不填写}}