# 灰度发布

功能背景

灰度发布功能可针对已导入用户 ID 或对应规则条件的用户，展示不同版本的小程序内容。您可以点击这里 (opens new window)查看演示视频。

# 1. 功能介绍

灰度发布功能是 FinClip 的核心功能之一，开发者可以通过该功能在小范围内发布更新小程序，已验证在新版本中的小程序功能是否达到预期。灰度发布需要通过规则配置确定收到新版本小程序的范围人群。

# 2. 操作说明

由于灰度发布功能需要在「灰度发布规则」的基础上通过「发布计划」的形式实现，我们在下文中按此顺序为您介绍完整的使用流程。

# 2.1 新建、导入发布规则

规则配置是灰度发布的支持功能，您可以预先定义灰度发布时所需要依赖的各种配置数据。

首次进入规则配置页面时，需要点击右上角「初始化规则」按钮，在当前账户中导入对应的灰度规则。我们为您提供了「基础库，系统版本，小程序 SDK」等一些默认规则，便于您使用灰度发布功能。

规则导入后您即可对已有的小程序规则进行详细的配置与二次修改。

# 2.2 查看发布规则

规则配置中的内容包括与小程序相关的基础库或小程序 SDK 版本，或与小程序无关的系统机型、当前网络等内容。在新增规则配置时，我们需要根据自己需要的场景进行合理配置。您可以点击右上角的「新增规则」配置所需要的灰度发布规则。

目前 FinClip 支持如下类型的灰度发布规则：

字符串；
数字；
百分比；
布尔；
正则表达式；

规则内容由如下部分组成：

规则名称：不同灰度发布规则的名称；
规则 ID：灰度发布规则的唯一标识；
规则类型：为了适配不同客户在自有环境中的灰度发布，我们提供了“字符串，布尔，整数，小数”四种规则类型；
资源值：规则命中与匹配的对应资源值。

您可以点击规则配置列表中的「网络」与「机型」了解如何整理出您所需要的规则信息，如：

上图中规则类型为字符串，资源值中的内容为wifi,5G,4G,3G,2G，这也就意味着在小程序 SDK 获取用户当前的网络状态后，灰度发布功能可以根据不同用户所在的网络类型，展示不同版本的小程序信息。

请注意

在 iOS/Android 中也可以基于小程序 SDK 自定义灰度发布规则，以便基于更加丰富的属性配置小程序灰度发布范围，详情请见：

iOS 常见问题-如何设置灰度发布自定义规则？
Android 常见问题-怎样配置灰度发布规则？

# 2.3 新建发布计划

当完成所需要的规则配置后，我们就可以正式开始新建灰度发布计划了，使用前小程序还需要满足如下条件：

小程序有一个「通过审核且暂未上架」的版本可供灰度发布使用；
「通过审核且暂未上架」的小程序版本号不能低于线上环境的版本号。

我们可以点击「小程序管理-我的小程序-小程序详情-灰度发布」进行灰度发布管理的详情页面。如果当前小程序可以进行灰度发布发布，我们会在下方列表对应序列号的右侧看到「创建发布方案」的按钮。

我们需要在新打开的弹窗中，分别补充「方案基础信息，方案规则信息」。

方案基础信息
- 发布生效时间：灰度发布计划的生效时间，灰度发布计划会在这个时间段中生效；
- 发布备注：灰度发布方案的备注与描述说明；
方案规则信息
- 指定用户发布：如果上传了用户信息，则只有当用户的身份信息与此处上传的用户表匹配才可以展示小程序灰度版本（选填项）；
- 指定规则发布：在这里选择来自「规则配置」页面中的对应规则，如城市，系统版本等；
- 配置方案生效方式：当选择了发布规则后，需要在此处配置灰度发布规则的生效方式，若配置了多条规则，则需要补充规则间「与或」的生效规则。

请注意

由于 FinClip 小程序未提供用户体系，当您选择「指定用户发布」时，需要通过小程序自定义 API 的形式，将 App 中的用户信息传入小程序，小程序仅在此时才可以按照指定用户发布（使用自定义 API 传入用户 ID 时，默认的规则 ID 为 xUserId）。

如何使用自定义 API 传入用户 ID，请看下方链接：

iOS 常见问题-如何设置灰度发布自定义规则？
Android 常见问题-怎样配置灰度发布规则？

当完成所有灰度计划的相关内容填写后，点击右下角的「确定」按钮即可创建灰度发布计划。灰度计划发布时，若用户不在规则之中，则会打开当前小程序的线上版本。

# 2.4 查看发布结果

当小程序灰度发布计划开始后，在操作列会出现「查看」按钮，您可点击此处的按钮查看详情。

灰度发布计划详情页面中包括如下内容：

灰度发布方案内容
- 累计发布时长：本次灰度发布的总生效时间，停止灰度发布后将不再计时；
- 灰度版本累计用户数：小程序 SDK 根据 App 生成的唯一 UUID，标识独立用户。如在统计期间内，用户卸载并重新安装 App，将产生重复计数；
- 灰度版本累计打开次数：打开次数指灰度版本小程序每打开一次将被记录一次；
- 灰度版本性能异常次数：本次灰度版本小程序在灰度期间出现的性能异常次数综合，包含：启动失败、小程序奔溃。
命中情况概览
- 打开次数：展示灰度期间内，灰度版本小程序打开次数；
- 用户数：展示灰度期间内，使用灰度版本的用户数量。
命中用户分析
- 地域分析：在灰度期间内，使用灰度版本小程序的用户，都分布在哪些地区；如无法分析、或未上报地理位置，则将汇总为“未知”；
- 终端分析：灰度期间内、灰度版本用户所使用的安卓/iOS分布情况；
灰度版本性能分析
- 小程序启动失败次数：在发布期间内，灰度版本小程序是否包含启动失败或小程序奔溃；
- 小程序崩溃次数：如发生，则将在下方展示对应错误日志，以便利开发者进行问题定位。

# 3. 常见问题

您可以点击这里看到关于灰度发布功能的常见问题。

# 4. 功能与环境对比

当前功能在不同环境中可能有所区别与限制，具体请见下表，如需要进一步了解不同版本间区别与介绍，可以点击这里 (opens new window)。

	社区版环境	SaaS 环境	企业版（年付费或一次性买断）
灰度管理	❌	✅	按需购买