跳到主要内容

使用指南

本指南详细介绍清林云的使用流程和控制台的各部分功能,能够快速了解并掌握清林云 BaaS 的使用。

使用流程#

  1. 以新用户为例,登录控制台后会自动创建一个默认组织,一个默认环境。

组织类似于公司或团队的概念。新用户会自动创建一个默认组织。

环境类似于一套服务器环境,使用某环境信息调用应用 API 产生的数据都储存在该环境下。

  1. 点击环境的查看详情按钮进入环境页面,创建环境密匙,拿到环境密匙信息keyId

环境密匙

  1. 点击左侧边栏应用市场 前往应用市场 AppHub 页面,搜索并点选希望使用的应用。

apphub

  1. 查看应用详情、应用 API 文档等,如果是想要使用的应用,那么点击右侧的安装按钮安装到当前组织。

  2. 在前端项目中使用API 格式调用应用 API 实现业务逻辑。

  3. 在应用数据页查询数据或操作数据。

  4. 如果该应用有微前端,可以在控制台直接使用该应用的后台,当然你也可以根据应用 API 和云数据库 API 自行搭建一个后台应用去处理业务数据。

  5. 清林云 BaaS V2.5 版本将会推出 OLAP 大数据在线计算分析功能,实现多应用互通、超大量数据的统计和计算,完成从应用逻辑到数据存储再到业务分析的闭环。

  6. 如果应用市场没有符合需求的应用,则可以在组织应用界面创建自定义应用,使用低代码编辑器设计 API。同时你也可以将其公开到应用市场,供其他人使用,赚取 RU。

  7. 新用户默认环境赠送 10000RU,如果用尽,可以前往环境详情页面进行充值(实名认证后开通)。也可以使用自定义应用在应用市场中赚取到的 RU 进行兑换。

页面功能#

清林云控制台当前共有以下几个模块:

概览#

控制台界面如图所示:

控制台

我们从左往右分为三个部分详解:

侧边栏#

左侧边栏是组织信息、页面导航、组织已安装的应用等:

siderbar

点开组织信息的下拉菜单有几个页面导航,可以前往编辑组织资料,可以去管理组织成员,可以去组织财务中心查询环境订单和应用收入等,也可以切换当前组织,用户可以加入多个组织。

如果组织还未实名认证,会出现待认证导航。

组织应用 导航的页面说明详见下方

应用市场 导航的页面说明详见下方

再下方的列表会显示当前组织所有已安装的应用,点击某个应用会导航到该应用的应用数据页页面。

当然为了防止组织安装应用过多,扰乱主要使用的应用,可以点击设置图标设置个性化的显示:

siderbarSet

主信息#

上方四个卡片从左到右依次是:

卡片 1:所有环境总共请求消耗了的 RU 数;主信息数据刷新按钮;

卡片 2:所有环境今日请求消耗了的 RU 数;所有环境昨日请求消耗了的 RU 数;

卡片 3:所有自定义应用的 API 被调用消耗的 RU 数;所有自定义应用 API 被调用后定价减去成本的总和再减去已兑换到环境消耗了的剩余 RU 数;

卡片 4:所有自定义应用最新版本的 API 数量;前往组织应用页面的导航按钮;

下方是所有环境的卡片,有环境的基础信息:

名称、环境的 envId、地域、总储备 RU、已使用 RU、最近七天的 RU 使用曲线。

点击查看详情可前往环境详情页面

右边栏#

上方是一个简单的欢迎卡片,可以设置今日要事,类似于 Moment 浏览器标签页插件。

下方是通知消息,显示账号收到的未读消息。

环境详情#

点击概览页面环境卡片右上角的查看详情可进入环境详情界面,显示环境的基本数据和近 30 天的 RU 使用曲线。

环境详情

点击选项卡的“环境密匙”切换到环境密匙界面。

环境密匙

列出所有环境密匙,可以新建和删除,也可以设置域名白名单和分应用权限提高安全性。

ak

域名白名单就是使用该密匙时,只能由白名单中的网站发出。比如设置白名单网站www.baasapi.com,那么只有用户在该网站产生的请求才能通过,如果有其他人恶意盗用你的环境信息在其他网站使用,请求会失败。

原理是检查请求headers中的originreferer,两者任意一个匹配域名白名单的其中一个即可通过。

所以在小程序中请求 API 时,白名单需要加上 https://servicewechat.com 这种小程序自带的 referer 域名。

分应用权限代表该密匙可以请求哪些应用的 API,适用于高安全性场景。

另外对于更高安全性的场景,清林云支持非对称加密模式,如有需要可以联系客服开通。

应用市场#

apphub

左侧应用列表显示所有公开的应用,点击后出现该应用的详情。

不同版本的文档和 API 都可能不一样,默认显示 latest 最新版本。

API 文档包括调用参数、请求示例和返回示例:

api

具体调用格式参考API 格式

这里的示例可以用来复制粘贴,方便前端开发者使用。

当前组织未安装的应用在右侧会显示安装按钮,点击后即可将其安装在当前组织中,可以在组织应用页面查看到所有已安装应用。

安装应用的同时也会安装该应用依赖的所有应用。

组织应用#

组织应用 导航至的页面是当前组织所有已安装和自定义的应用:

apps

右侧是官方推荐但该组织还未安装的应用。

应用上有基本信息,也可以点击右侧按钮前往配置页面配置应用环境变量,也可以前往文档页面查看该应用的 API 文档。

如果该应用是自定义应用,也会出现编辑按钮前往编辑页面进行自定义应用编辑

应用配置#

应用配置类似于环境变量,可以用每个环境不同的值去执行 API 中的一些需要动态参数的逻辑。

set

详见此处

数据页 OneTable#

点击左侧边栏的某个已安装的应用后,进入数据页,出现该应用的所有数据库表,选择环境后可查看该环境下的所有数据。也可以进行增删改查等操作。

dataPage

视图列表#

参考上图,左一栏是视图列表,上方可以选择查询视图数据的环境和对应密匙。下方有四个一级目录,分别为:

  • 应用表:可以选择组织安装的所有应用,然后会出现该应用对应的所有表,点击表后右侧视图框中会出现该表的原始视图。
  • 应用视图:展示所有选择应用的自带视图,自带视图由应用开发者编辑配置好,其他安装了的用户可以直接使用。
  • 我的视图:用户自行编辑配置的视图,仅自己能看到。
  • 组织视图:当前组织内的所有视图,组织成员可查看编辑,有不同的权限。

视图目录的二级目录为该类别下的分组,比如默认分组。展开分组后是具体视图名称。

视图导航#

上图右侧为视图层,最上方的 Tab 导航栏可以切换多个视图,就像浏览器标签页一样。

参数栏#

视图框左侧为参数栏。

上方是视图参数,可以编辑当前视图的类型、名称、描述、分组、类别,修改后点击保存视图可以将该名称的视图保存在相应的类别和分组下。

应用开发者可以选择类别为应用视图。

viewType

当前的视图类型暂支持表格类型,就是右侧的表格,后续将推出不同类型的视图,便于不同类型的数据展示。

下方是查询参数,会出现当前视图对应的表的主键 ID 起始范围输入框,比如说现在有一张文章表中有一亿条数据,它们只有一个主键 ID postId,是自增类型,即 ID 为 1- 100000000 。我们当然不可能在 web 直接查询一亿条数据,以下是不同查询目标的示例:

  • 默认查询:起点和终点为空,代表无限大到无限小,查询行数 1000,则会按照排序 倒序从后往前查 1000 条数据。
  • 查前 100 条:起点和终点为空,代表无限小到无限大,排序为 正序,查询行数 100 。
  • 查 ID 为 666 的文章:起点和终点为 666,查询行数 1 。
  • 查从 ID 为 666 开始后面的 100 条:起点为 666,终点为空代表无限大,排序为 正序,查询行数 100 。
  • 查从 ID 为 666 开始前面的 100 条:起点为 666,终点为空代表无限小,排序为 倒序,查询行数 100 。
  • 查从 ID 为 666 开始前面的 1000 条:终点为 666,起点为空代表无限小,排序为 正序,查询行数 1000 。

同时,你也可以添加多个过滤条件,直接在数据库端就过滤掉不符合条件的数据,传输速度更快。

queryCondition

如图所示,即代表只返回文章标题为 标题并且创建时间大于 1633688080937这个时间戳的数据。

另外,如果该表采用 S1 引擎,那么可以支持高级搜索。

search

如图所示,可以添加多个搜索条件和排序条件,从超大规模数据中精确查询符合条件的数据。

后续我们会在其他引擎中都加上高级搜索功能。

返回数据列 可以筛选查询数据中只需要的数据列,默认是全部返回,当表中有长文本列时使用该功能将有效降低网络传输延迟。

表格视图#

前图右侧为表格类型的视图。

上方为工具栏:

  • 添加数据:为视图对应的表新增一条数据
  • 保存视图:保存当前的视图状态,包括视图信息、查询参数、列的设置、筛选、排序、密度、列视图类型等配置
  • 列:可以设置哪些列隐藏哪些列显示
  • 筛选器:见下图 1 所示,可以筛选符合要求的数据显示
  • 表格密度:设置数据行高,紧凑、标准、宽松
  • 导出:可以将当前数据导出为 CSV 表格
  • 关闭视图:关闭当前视图
  • 删除视图:删除当前视图并关闭

注意在表格视图中的所有筛选、排序等操作是独立的,和查询参数不同。你可以理解为查询参数的作用是从数据库中查询相符的数据放入表格中,然后再由表格进行更细粒度的操作。

gridFilter

再下方是表头,显示该列的名称:

gridHeader

点击表头可以表格中的数据以该列为基准进行排序,有正序和倒序。

按住列中间的竖线可以调整列宽度。

按住并拖动列名可以移动该列的横向排序。

点击菜单图标可以显示列菜单:

menu

升序降序和默认排序和点击列名类似。筛选器和隐藏、显示同样类似于前面的工具栏控制。

不同点在于自定义列视图,可以选择不同的列类型进行展示,将数据库的原始数据转换为人类易读的数据。

columnType

有很多数据类型可供选择,比如此处,创建时间在数据库中是时间戳的形式,这里我们要将它转换为可以看懂的时间,就选择时间类型,然后就可以看到熟悉的日期了。

我们将在后续支持更多的列类型供选择,如您有需求请告知我们,将优先添加。

表格的第一列为操作栏,依次为:查看数据、编辑数据、删除数据。点击编辑后可以修改该列的数据,点击保存即可更改。

表格的列由对应的表构成,灰色背景的是主键区域,不可编辑。

右下角为当前表格视图存在数据的行数。

视图协同#

每个人或团队对于数据的展现、搜索条件、排序等都不相同。

比如说,运营 A 组仅需要了解最新注册的用户的手机号,运营 B 组仅需要查看用户的地域分布,那么虽然他们共用一张用户表,但是查询参数和列排序等都不同。

所以将不同的视图状态保存为不同的视图,分别放入对于分组,这样,他们就可以直接点击自己对应的分组中的视图就可以查看到符合的视图数据。

以此类推,OneTable 将数据、表格设置、查询参数等都独立开来,可以灵活搭配使用,为组织的协作创造了良好的流程优化,相信能够对数据的使用带来更有效的进步。

我的资料#

点击右上角用户名下拉菜单进入我的资料页面,可以修改账号基础信息。

profile

组织资料#

点击左上角组织名称下拉菜单进入组织资料页面,可以修改组织基础信息,仅限组织 admin 权限用户可修改。

org

组织成员#

组织成员界面可以邀请用户加入组织、管理组织成员、管理组织分组、管理成员权限。

修改组织成员的组织内昵称、身份和权限如下:

memberInfo

组织内的高级权限可以修改组织自定义应用的信息。

  • 环境相关功能操作:需要admin权限;
  • 自定义应用相关功能操作:需要manager权限;

在应用数据页内:

  • 查看数据需要成员用于该应用的member权限
  • 更新或新增数据需要manager权限
  • 删除数据需要admin权限

这里的应用权限只对应该应用,和上面的组织权限不相关。

right

在两个模块的权限级别中,admin > manager > member,高级权限可覆盖低级权限。

实名认证#

依据国家网络安全规定,需要更多环境 RU 的用户需要进行实名认证。

cert

未认证的组织点击左上角组织名称下拉菜单进入实名认证页面,企业用户可以使用电子营业执照方式完成,其他政府和组织或个人用户在图片资料上传中上传身份证等资料完成认证。

相关资料认证后会删除。

后续个人认证会接入第三方如支付宝等渠道完成认证。

自定义应用#

在组织应用界面点击创建应用或点击自定义应用的编辑按钮即可进入自定义应用页面。

edit

本页面包含 API、数据库、自定义函数、应用配置、应用信息五个模块,能够完成一个 BaaS 应用的完整功能,具体使用可以查阅自定义应用章节

高级功能#

与原有业务集成#

尽管清林云 BaaS 的目标是替代后端,但不可避免需要与很多企业的已有业务结合使用。

有四种方法结合:

  1. 在前端,根据不同的功能,分别请求原有业务 API 和 BaaS 应用 API;
  2. 在原有业务后端中请求 BaaS 应用 API;
  3. 在原有业务后端中使用管理员权限 token 请求 BaaS 应用 API;
  4. 在原有业务后端中使用云数据库 API 直接处理数据;

云数据库 OneDB API#

云数据库 OneDB API 主要用于集成原有业务和原有数据上云。

使用云数据库 OneDB API 能够直接对数据进行 CRUD,不再需要应用 API 进行处理,功能逻辑减少,操作更底层。

详细使用方法和请求格式参考云数据库 API 章节。

团队协作#

清林云的团队协作能力主要体现在 OneTable 中。一方面,OneTable 可以作为产品的通用后台,对数据进行管理,那么不管是运营团队还是技术团队,都可以在 OneTable 中直接操作数据,免去了以往部门之间的协调沟通。

另一方面,也可以将 OneTable 当做在线的 Excel 文档,能够处理超大规模的结构化数据,同时能将其数据互联互通。比如说,运营人员直接在一个活动表中填写数据,产品前端直接能够拿到实时数据进行展示。

在后续的迭代中,我们将重点优化团队协作功能,使得团队成员能够灵活使用数据,有更好的权限控制,更好的数据交互,更好的流程管理和更好的外部分享。

跨应用大数据分析和 BI 能力#

在线数据分析和 BI 报表功能将在清林云 V2.5 版本发布。