优酷鸿蒙开发实践 | 鸿蒙卡片开发

鸿蒙开发者社区官方账号

发布于 2021-10-15 15:14

浏览

1收藏

背景

随着华为Harmony OS2.0的发布，各大厂商纷纷抢先与华为展开合作。优酷作为国内领先的长视频在线视听平台，与华为公司长期以来保持紧密的合作，共同为消费者带来优质的影音娱乐体验。因此，优酷技术团队也在第一时间投入对鸿蒙系统以及鸿蒙开发者SDK的研究。优酷技术团队经过多轮的头脑风暴，利用鸿蒙的某些新特性展开鸿蒙应用开发的尝试。

鸿蒙OS支持应用以Ability为单位进行部署。Ability分为两种类型：FA（Feature Ability）和PA（Particle Ability）。FA/PA是应用的基本组成单元，能够实现特定的业务功能。FA有UI界面，而PA无UI界面。

每种类型为开发者提供了不同的模板，以便实现不同的业务功能。

鸿蒙OS的应用软件包以APP Pack（Application Package）形式发布，它是由一个或多个HAP（HarmonyOS Ability Package）以及描述每个HAP属性的pack.info组成。HAP是Ability的部署包，HarmonyOS应用代码围绕Ability组件展开。

优酷鸿蒙开发实践 | 鸿蒙卡片开发-鸿蒙开发者社区

鸿蒙工程通过鸿蒙打包工具链打包后，其产物格式即为HAP。

当前，包含有鸿蒙FA/PA的优酷鸿蒙版已经在华为鸿蒙应用市场上架，鸿蒙混合包在应用市场上会显示为“含HarmonyOS服务”。如果App是100% Pure鸿蒙App，其Icon右下角会有HMOS字样。

在手机桌面上的优酷Icon轻轻上滑,会弹出一个鸿蒙卡片，向用户推荐最近的热剧，点击卡片能快速拉起半屏落地页显示更多信息，点击落地页则跳转到优酷客户端的相应落页面。

点击卡片上的图钉按钮，还可以将这个FA卡片固定在桌面上。

这个FA是100%利用鸿蒙API编写的，可以脱离优酷主客独立运行。由于FA卡片有极其严格的体积限制，而使用native的库体积则会过大。最终，我们的Widget 通过一个Webview，加载JS版本的前端网络库去请求优酷内部的网络接口，获取到数据后再使用鸿蒙的Native图形图像API去绘制Native界面。

这个桌面Widget与iOS桌面Widget的区别在于，它不依赖于优酷主客即可运作。即使优酷主客不被启动，卡片的数据也能够更新。

鸿蒙卡片的开发模式

在鸿蒙系统上，触摸优酷主客的应用图标向上滑动，可以唤起优酷的鸿蒙卡片。实现这一点需要卡片的实现代码与优酷主客做混合打包，一起提交到应用市场。

而如果要实现服务中心免安装使用，则需要卡片的独立包总大小要小于10M。这一体积限制使得很多Native 库都无法引入，否则无法将体积控制在红线之内。

最终，优酷鸿蒙卡片的代码放在一个工程中，方便跟优酷主客进行混合打包。同时，优酷鸿蒙卡片的代码仅依赖极少数的二、三方库（例如JSON解析、图片缓存等），以减小体积。

卡片样式

鸿蒙系统提供4中大小不同的卡片，根据占用桌面图标数量的不同，分别是: 1x2、2x2、2x4、4x4。优酷卡片实现了其中两种: 2x2和2x4，其中2x2的卡片是必选项。

下图显示了两种不同样式的卡片，以及不同的出现场景。

桌面	服务中心	发现

声明卡片

跟Android的应用微件类似，鸿蒙的卡片也需要在一个配置文件中声明。在一个鸿蒙应用中，每个模块都有自己的配置文件，位于该模块的代码main目录下，名字为config.json。

在配置文件中，每个模块有一个abilities属性，其值是一个数组，数组的每一个对象都定义了一个Ability。卡片就定义在其中一个Ability中：

{
  ...
        "formsEnabled": true,
        "forms": [
          {
            "landscapeLayouts": [
              "$layout:youku_widget_2_2",
              "$layout:youku_widget_2_4"
            ],
            "isDefault": true,
            "defaultDimension": "2*2",
            "name": "youku_widget",
            "description": "$string:yk_widget_description",
            "colorMode": "auto",
            "type": "Java",
            "supportDimensions": [
              "2*2",
              "2*4"
            ],
            "portraitLayouts": [
              "$layout:youku_widget_2_2",
              "$layout:youku_widget_2_4"
            ],
            "updateEnabled": true,
            "updateDuration": 1
          }
        ],
  ...
}

鸿蒙系统中，卡片用Form来表示。上述声明中，formsEnabled用于指示这个Ability是用于定义卡片的。forms数组用来定义一系列的卡片。通常多个卡片可以定义在一个数组元素中。其中landscapeLayouts、portraitLayouts、supportDimensions用于定义卡片的布局文件和大小，updateEnabled、updateDuration用于控制卡片的数据更新，updateDuration的单位是半小时。

生命周期

在鸿蒙系统上，卡片的生命周期比普通的Page Ability要简单很多，只有三个相关的回调：

/**
 * 创建卡片时的回调。
 * 在intent中，存有创建卡片的一些重要参数，可以通过Intent.getXXXParam()方法获取。
 * AbilitySlice.PARAM_FORM_IDENTITY_KEY: long类型，用于唯一标识一个卡片
 * AbilitySlice.PARAM_FORM_NAME_KEY: String类型，卡片名称，即在config.json中定义的name属性
 * AbilitySlice.PARAM_FORM_DIMENSION_KEY: int类型，卡片大小标识，
 * 取值范围是1-4，分别表示1x2、2x2、2x4、4x4
 */
protected ProviderFormInfo onCreateForm(Intent intent)

/**
 * 更新卡片时的回调。
 * 这里的formId就是onCreateForm中的AbilitySlice.PARAM_FORM_IDENTITY_KEY参数。
 */
protected void onUpdateForm(long formId)
/**
 * 删除卡片时的回调。
 * 这里的formId就是onCreateForm中的AbilitySlice.PARAM_FORM_IDENTITY_KEY参数。
 */
protected void onDeleteForm(long formId)

传输卡片内容

卡片的创建和显示通常由桌面（或者服务中心、搜索）发起，而决定显示内容的是优酷卡片这个模块，内容提供方和显示方不在同一个进程，甚至由不同开发者开发。在Android上也是一样的情况。

在这种情况下，一般都是内容提供方通过远程View的方式将内容渲染到内容显示方的，鸿蒙系统上这个跨进程的数据传输行为是由ComponentProvider来实现的。

创建ComponentProvider有两种方式:

// 第一种: 在onCreateForm()时，先创建一个卡片对应的ProviderFormInfo实例。
// 再通过ProviderFormInfo的实例拿到向它传输数据的ComponentProvider。
ProviderFormInfo form = new ProviderFormInfo(layoutId, context);
ComponentProvider cp = form.getComponentProvider();

// 第二种: 在onUpdateForm()时，直接创建出一个ComponentProvider。
ComponentProvider cp = new ComponentProvider(layoutId, context);

需要注意的问题 1

其中设置IntentAgent时需要注意，通常一个布局中会有多个View来覆盖根布局的矩形区域。如果设置了IntentAgent的View没有覆盖满根布局，则未覆盖区域被点击时，系统也会响应点击，默认调起这个卡片所属的Ability，传入的Intent只包含formId。

针对这个默认调起的Ability，一般有两种方式解决：一是确保设置了IntentAgent的View覆盖满根布局；二是Ability提供兜底方案，例如页面做成透明，并且自动退出。

需要注意的问题 2

在创建IntentAgent时，需要提供一个IntentAgentInfo实例。这个IntentAgentInfo创建时的第一个参数是一个int类型的请求代码，这个代码必须保持各个卡片的不同点击区都不一样。否则后设置的IntentAgent会覆盖先前设置的同一请求代码的IntentAgent。

需要注意的问题 3

如果是跟优酷主客混合打包，卡片的布局文件中，View的id必须跟主客中所有的id不同，否则系统会无法正确更新布局文件中对应的View。

打开中转页

由于系统的限制，点击卡片打开的页面必须是纯鸿蒙应用中的页面，无法直接打开Android应用页面。优酷卡片的点击，目的是打开优酷主客的播放页。

在这里我们做了分类：

当用户未安装优酷主客时，显示一个中转页，提供下载按钮供用户跳转到华为应用市场去下载优酷主客，当用户安装完优酷主客回来时，下载按钮变成选集列表，对单集视频则变成播放按钮；
当用户已安装优酷主客时，中转页自动打开优酷主客的播放页，并退出。

数据请求

在优酷主客中，网络数据的请求都是通过统一的网络库访问的。由于优酷鸿蒙卡片并未集成网络库，优酷鸿蒙卡片必须使用其他方式请求网络接口。

要实现在鸿蒙上发起数据请求，有两个方案：

一是针对每个数据请求接口，封装一个新的HTTP Open API接口，客户端可以通过HTTP(S)直接访问；
二是客户端通过H5页面里的JS版Network库发起数据请求。

考虑到将来在鸿蒙系统上有可能实现更多其他的需求，且第一种方案有安全性的风险，所以最终我们采用了第二种方案。

前端业务使用的JS版本的网络库，其使用方式是通过JS中的Promise机制来实现异步回调，但是这种方式在Java中并不好实现对应的调用结构。所以这里需要有一层封装，将网络请求结果通过简单回调来通知请求方。相应的在Java侧需要对WebView注册全局的JS对象，实现JS对象的回调方法，打通JS -> Java的调用通路。

这个方案在纸面上看着还不错，但是在实际使用中会发现有严重的性能瓶颈。WebView本身是一个很重的控件，在进程中首次创建的时候会比较耗时，有很多的so加载、初始化等工作。加载HTML是一个网络请求，耗时在百毫秒级，而加载并解析完HTML以后，还要再加载JS版本的网络库，又是一次网络访问。等JS网络库加载并解释执行后，才可以正常服务调用方。

要在这个过程中进行优化，这里有主动权的地方就是加载HTML和JS网络库这两个文件。在鸿蒙系统中，WebView可以通过设置WebAgent来实现特定URL的劫持，将其转化为读取本地资源中的HTML和JS文件。

public class LoadAgent extends WebAgent {
    // ...

    @Override
    public ResourceResponse processResourceRequest(WebView webView, ResourceRequest request) {
        // mInterceptor用于识别HTML和JS网络库的URL，并返回本地资源中的HTML和JS。
        ResourceResponse response = mInterceptor.intercept(request);
        if (response != null) {
            return response;
        }
        return super.processResourceRequest(webView, request);
    }
}

这可以将两个百毫秒级的串行操作缩减为毫秒级，大大减少JS版本的网络库的初始化时间。

数据缓存

从网络请求返回的卡片数据，除了用于即时渲染卡片之外，还会被保存一份到本地存储中。如果下一次发起网络请求的时候，无法正常访问网络（例如手机重启后一时连不上网络），则可以使用缓存中的卡片数据先渲染一下，使用户不至于完全看不到内容。这就需要有一套卡片数据的缓存管理能力。

针对卡片数据的特点，我们使用了两个数据库表来存储卡片的缓存数据。根据卡片大小不同，请求中会提供不同的参数给服务端。反过来说，同样大小的卡片发出请求的参数是相同的，也就是说同样大小的卡片请求得到的数据是相同的。所以有一个表用来存储不同大小的卡片数据，每个卡片大小对应一条记录，包括唯一标识、卡片大小、请求返回的数据、时间戳等。

系统不限制用户向桌面添加卡片的数量，同时在服务中心也可以有已经添加到桌面的卡片。所以同样的卡片数据是可以被显示在多个卡片上的。数据库需要有一个表来记录每一个卡片的信息，包括卡片的唯一标识、卡片大小、数据表中对应的记录等。

优酷鸿蒙开发实践 | 鸿蒙卡片开发-鸿蒙开发者社区

如果在Android中实现过ContentProvider，一般都会比较熟悉SQLite数据库。通常ContentProvider需要管理大量、不同类型且互相有关联的数据，这种需求用SQLite来实现最合适了。这里管理卡片数据的缓存也具有同样的特征，并且鸿蒙系统也提供了SQLite数据库的使用接口。典型的数据库初始化操作如下:

// StoreConfig最常见的作用是配置数据库名字。也可以配置存储模式、加密等高级需求。
StoreConfig config = StoreConfig.newDefaultConfig(DB_NAME_FORM_STORE);

// RdbOpenCallback用于定义创建数据库、升级数据库结构版本等时机的回调。
RdbOpenCallback callback = new FormStoreOpenCallback(context);

DatabaseHelper helper = new DatabaseHelper(context);

// RdbStore是数据库的封装类，最终的增删改查操作都通过它来进行。
RdbStore store = helper.getRdbStore(config, CURRENT_VERSION, callback);

具体的增删改查操作就不一一列举了。

数据更新

前面声明卡片一节提到了config.json中，updateEnabled、updateDuration定义了卡片的数据更新机制。

其中updateEnabled用于指定是否通过系统来自动更新卡片数据，如果希望由应用自身触发数据更新，这个可以设置为false。优酷卡片的场景是希望系统能够自动更新卡片数据的，所以设为了true。

在updateEnabled设为true的情况下，updateDuration才有意义。updateDuration用于指定更新的时间间隔。鸿蒙系统还支持固定时间更新，通过指定scheduledUpateTime来设置更新时间。updateDuration和scheduledUpateTime只能选择其中一种方式。

优酷卡片选择了用updateDuration指定更新间隔。为了避免将来使用卡片的用户多了，对服务端产生过大的压力，更新间隔被控制在4小时，这样用户在上午、下午、晚上等不同时段去看卡片时，内容都会有更新。

但是有些情况下，优酷卡片自身的逻辑也会更新卡片数据，所以为了避免两种更新策略冲突而导致更密集的更新，或者长时间不更新，updateDuration被指定为1，即每半小时系统就会调用一次onUpdateForm()。在onUpdateForm()中，会判断上一次实际发生更新的时间，使更新间隔保持在4小时左右。

容错处理

考虑到一些极端情况，例如用户安装优酷后，在没有网络的情况下就添加了桌面卡片。此时卡片的数据请求是没有返回的，同时由于刚安装，也没有缓存数据，所以卡片展示不出任何数据，只有灰色的打底图作为背景。此时如果点击卡片，也没有任何视频信息，也就无法跳转到某个特定视频的播放页，只能显示一个加载失败的提示，等用户网络恢复后，通过刷新得到有效数据。