Hippy/docs/development/native-component.md

自定义组件

App 开发中有可能使用到大量的UI组件，Hippy SDK 已包括其中常用的部分，如View、Text、Image 等，但这极有可能无法满足你的需求，这就需要对 UI 组件进行扩展封装。支持 Android、iOS、Flutter、Web(同构) 等平台。

Android

---

组件扩展

我们将以MyView为例，从头介绍如何扩展组件。

扩展组件包括：

1. 扩展 HippyViewController。
2. 实现 createViewImpl方法、
3. 实现 Props 设置方法。
4. 手势事件处理。
5. 注册 HippyViewController。

HippyViewController 是一个视图管理的基类（如果是ViewGroup的组件，基类为 HippyGroupController）。 在这个例子中我们需要创建一个 MyViewController 类，它继承 HippyViewController<MyView>。MyView 是被管理的UI组件类型，它应该是一个 Android View 或者 ViewGroup。 @HippyController 注解用来定义导出给JS使用时的组件信息。

@HippyController(name = "MyView")
public class MyViewController extends HippyViewController<MyView>
{
    ...
}

实现 createViewImpl 方法

当需要创建对视图时，引擎会调用 createViewImpl 方法。

@Override
protected View createViewImpl(Context context)
{
    // context实际类型为HippyInstanceContext
    return new MyView(context);
}

实现属性 Props 方法

需要接收 JS 设置的属性，需要实现带有 @HippyControllerProps 注解的方法。

@HippyControllerProps 可用参数包括：

• name（必须）：导出给JS的属性名称。
• defaultType（必须）：默认的数据类型。取值包括 HippyControllerProps.BOOLEAN、HippyControllerProps.NUMBER、HippyControllerProps.STRING、HippyControllerProps.DEFAULT、HippyControllerProps.ARRAY、HippyControllerProps.MAP。
• defaultBoolean：当 defaultType 为 HippyControllerProps.BOOLEAN 时，设置后有效。
• defaultNumber：当 defaultType 为 HippyControllerProps.NUMBER 时，设置后有效。
• defaultString：当 defaultType 为 HippyControllerProps.STRING 时，设置后有效。

@HippyControllerProps(name = "text", defaultType = HippyControllerProps.STRING, defaultString = "")
public void setText(MyView textView, String text)
{
    textView.setText(text);
}

手势事件处理

Hippy手势处理，复用了 Android 系统手势处理机制。扩展组件时，需要在控件的 onTouchEvent 添加部分代码，JS才能正常收到 onTouchDown、onTouchMove、onTouchEnd 事件。事件的详细介绍，参考 Hippy 事件机制。

@Override
public NativeGestureDispatcher getGestureDispatcher()
{
    return mGestureDispatcher;
}

@Override
public void setGestureDispatcher(NativeGestureDispatcher dispatcher)
{
    mGestureDispatcher = dispatcher;
}

@Override
public boolean onTouchEvent(MotionEvent event)
{
    boolean result = super.onTouchEvent(event);
    if (mGestureDispatcher != null)
    {
        result |= mGestureDispatcher.handleTouchEvent(event);
    }
    return result;
}

注册 HippyViewController

需要在 HippyPackage 的 getControllers 方法中添加这个Controller，这样它才能在JS中被访问到。

@Override
public List<Class<? extends HippyViewController>> getControllers()
{
    List<Class<? extends HippyViewController>> components = new ArrayList<>();
    components.add(MyViewController.class);
    return components;
}

更多特性

处理组件方法调用

在有些场景，JS需要调用组件的一些方法，比如 MyView 的 changeColor。这个时候需要在 HippyViewController重载 dispatchFunction 方法来处理JS的方法调用。

public void dispatchFunction(MyView view, String functionName, HippyArray var)
{
    switch (functionName)
    {
        case "changeColor":
            String color = var.getString(0);
            view.setColor(Color.parseColor(color));
            break;
    }
    super.dispatchFunction(view, functionName, var);
}

事件回调

Hippy SDK 提供了一个基类 HippyViewEvent，其中封装了UI事件发送的逻辑，只需调用 send 方法即可发送事件到JS对应的组件上。比如我要在 MyView 的 onAttachedToWindow 的时候发送事件到前端的控件上面。 示例如下：

@Override
protected void onAttachedToWindow() {
    super.onAttachedToWindow();

    // this is show how to send message to js ui
    HippyMap hippyMap = new HippyMap();
    hippyMap.pushString("test", "code");
    new HippyViewEvent(" onAttachedToWindow").send(this, hippyMap);
}

HippyViewController 的回调函数

• onAfterUpdateProps：属性更新完成后回调。
• onBatchComplete：一次上屏操作完成后回调（适用于 ListView 类似的组件，驱动 Adapter刷新等场景）。
• onViewDestroy：视图被删除前回调（适用于类似回收视图注册的全局监听等场景）。
• onManageChildComplete：在 HippyGroupController 添加、删除子视图完成后回调。

混淆说明

扩展组件的 Controller 类名和属性设置方法名不能混淆，可以增加混淆例外。

-keep class * extends com.tencent.mtt.hippy.uimanager.HippyGroupController{ public *;}
-keep class * extends com.tencent.mtt.hippy.uimanager.HippyViewController{ public *;}

iOS

---

组件扩展

我们以创建MyView为例，从头介绍如何扩展一个组件。

本文仅介绍ios端工作，前端工作请查看对应的文档。

扩展一个UI组件需要包括以下工作：

1. 创建对应的ViewManager
2. 注册类并绑定前端组件
3. 绑定View属性及方法
4. 创建对应的RenderObject(可选)和View

创建对应的ViewManager

ViewManager 是对应的视图管理组件，负责前端视图和终端视图直接进行属性、方法的调用。 SDK 中最基础的 ViewManager 是 NativeRenderViewManager，封装了基本的方法，负责管理 NativeRenderView。 用户自定的 ViewManager 必须继承自 NativeRenderViewManager。

NativeRenderMyViewManager.h

@interface NativeRenderMyViewManager:NativeRenderViewManager
@end

NativeRenderMyViewManager.m

@implementation NativeRenderMyViewManager

NATIVE_RENDER_EXPORT_VIEW(MyView)

NATIVE_RENDER_EXPORT_VIEW_PROPERTY(backgroundColor, UIColor)
NATIVE_RENDER_REMAP_VIEW_PROPERTY(opacity, alpha, CGFloat)

NATIVE_RENDER_CUSTOM_VIEW_PROPERTY(overflow, CSSOverflow, NativeRenderView)
{
    if (json) {
        view.clipsToBounds = [HPConvert CSSOverflow:json] != CSSOverflowVisible;
    } else {
        view.clipsToBounds = defaultView.clipsToBounds;
    }
}

- (UIView *)view {
    return [[NativeRenderMyView alloc] init];
}

- (NativeRenderObjectView *)shadowView {
    return [[NativeRenderObjectView alloc] init];
}

NATIVE_RENDER_COMPONENT_EXPORT_METHOD(focus:(nonnull NSNumber *)reactTag) {
    // do sth
}

NATIVE_RENDER_COMPONENT_EXPORT_METHOD(focus:(nonnull NSNumber *)reactTag callback:(RenderUIResponseSenderBlock)callback) {
    // do sth
    NSArray *result = xxx;
    callback(result);
}

类型导出

NATIVE_RENDER_EXPORT_VIEW() 将NativeRenderMyViewManager 类注册，前端在对 MyView 进行操作时会通过 NativeRenderMyViewManager 进行实例对象指派。

NATIVE_RENDER_EXPORT_VIEW()中的参数可选。代表的是 ViewManager 对应的View名称。 若用户不填写，则默认使用类名称。

参数导出

NATIVE_RENDER_EXPORT_VIEW_PROPERTY 将终端View的参数和前端参数绑定。当前端设定参数值时，会自动调用 setter 方法设置到终端对应的参数。

NATIVE_RENDER_REMAP_VIEW_PROPERTY() 负责将前端对应的参数名和终端对应的参数名对应起来。以上述代码为例，前端的opacity 参数对应终端的alpha参数。此宏一共包含三个参数，第一个为前端参数名，第二个为对应的终端参数名称，第三个为参数类型。另外，此宏在设置终端参数时使用的是keyPath方法，即终端可以使用keyPath参数。

NATIVE_RENDER_CUSTOM_VIEW_PROPERTY() 允许终端自行解析前端参数。SDK将前端传递过来的原始json类型数据传递给函数体（用户可以使用HPConvert类中的方法解析对应的数据），用户获取后自行解析。

这个方法带有两个隐藏参数-view, defaultView。view是指当前前端要求渲染的view。defaultView指当前端渲染参数为nil时创建的一个临时view，使用其默认参数赋值。

方法导出

NATIVE_RENDER_COMPONENT_EXPORT_METHOD 能够使前端随时调用终端对应的方法。前端通过三种模式调用，分别是 callNative, callNativeWithCallbackId。终端调用这三种方式时，函数体写法可以参照上面的示例。

• callNative：此方法不需要终端返回任何值。

• callNativeWithCallbackId: 此方法需要终端在函数体中以单个block形式返回数据。block类型为 RenderUIResponseSenderBlock，参数为一个id变量。

一个ViewManager可以管理一种类型的多个实例，为了在ViewManager中区分当前操作的是哪个View，每一个导出方法对应的第一个参数都是View对应的tag值，用户可根据这个tag值找到对应操作的view。

由于导出方法并不会在主线程中调用，因此如果用户需要进行UI操作，则必须将其分配至主线程。推荐在导出方法中使用[NativeRenderImpl addUIBlock:]方法。其中的block类型为NativeRenderRenderUIBlock。

typedef void (^NativeRenderRenderUIBlock)(NativeRenderImpl *renderContext, NSDictionary<NSNumber *, __kindof UIView *> *viewRegistry)。第二个参数为字典，其中的key就是对应的view tag值，value就是对应的view。

创建RenderObject和View

在OC层，NativeRenderImpl负责构建Render树，对应的每一个节点都是一个RenderObjectView。Render树结构不保证与dom树一致，因为Render可能有自己的渲染逻辑。

NativeRenderView会根据NativeRenderObjectView的映射结果构建真正的View视图。因此对于大多数情况下的自定义view manager来说，直接创建一个NativeRenderObjectView即可。

NativeRenderImpl将调用[NativeRenderMyViewManager view]方法去创建一个真正的view，用户需要实现这个方法并返回自己所需要的NativeRenderMyView。

到此，一个简单的NativeRenderMyViewManager与NativeRenderMyView创建完成。

Voltron

---

组件扩展

实际应用开发中，我们经常会遇到需要展示二维码的场景，所以我们这里就以 QrImage 为例，从头介绍如何扩展组件。

本文主要介绍flutter侧工作，前端工作请查看对应的文档。

扩展一个 UI 组件需要包括以下工作：

1. 创建对应的 Controller，
2. 创建对应的 ViewModel
3. 创建对应的 Widget
4. 终端注册组件
5. 前端注册组件及使用

创建对应的 Controller

import 'package:flutter/material.dart';
import 'package:flutter/widgets.dart';
import 'package:qr_flutter/qr_flutter.dart';
import 'package:voltron_renderer/voltron_renderer.dart';

class QrController extends BaseViewController<QrRenderViewModel> {
  static const String kClassName = "QrImage";

  // 提供创建对应 Widget 的方法
  @override
  Widget createWidget(BuildContext context, QrRenderViewModel viewModel) {
    return QrWidget(viewModel);
  }

  // 创建创建对应 ViewModel 的方法
  @override
  QrRenderViewModel createRenderViewModel(
    RenderNode node,
    RenderContext context,
  ) {
    return QrRenderViewModel(
      node.id,
      node.rootId,
      node.name,
      context,
    );
  }

  // 组件属性设置，将前端的 Props 对应设置到 ViewModel 中，可类比 Native Renderer 中的 View
  @override
  Map<String, ControllerMethodProp> get extendRegisteredMethodProp {
    var extraMap = <String, ControllerMethodProp>{};
    // 这里注意默认值的类型
    extraMap[NodeProps.kText] = ControllerMethodProp<QrRenderViewModel, String>(setText, '');
    extraMap[NodeProps.kLevel] = ControllerMethodProp<QrRenderViewModel, String>(setLevel, enumValueToString(QrErrorCorrectLevel.L));
    return extraMap;
  }

  // 给 ViewModel 设置对应属性
  @ControllerProps(NodeProps.kText)
  void setText(QrRenderViewModel viewModel, String text) {
    viewModel.text = text;
  }

  // 给 ViewModel 设置对应属性
  @ControllerProps(NodeProps.kLevel)
  void setLevel(QrRenderViewModel viewModel, String level) {
    switch (level) {
      case 'l':
        viewModel.level = QrErrorCorrectLevel.L;
        break;
      case 'm':
        viewModel.level = QrErrorCorrectLevel.M;
        break;
      case 'q':
        viewModel.level = QrErrorCorrectLevel.Q;
        break;
      case 'h':
        viewModel.level = QrErrorCorrectLevel.H;
        break;
      default:
        viewModel.level = QrErrorCorrectLevel.L;
    }
  }

  // 处理 UI 事件，类似于 this.$refs.input.focus(); 这里可以参考 TextInput 设计
  @override
  void dispatchFunction(
    QrRenderViewModel viewModel,
    String functionName,
    VoltronArray array, {
    Promise? promise,
  }) {
    super.dispatchFunction(viewModel, functionName, array, promise: promise);
  }

  @override
  String get name => kClassName;
}

创建对应的 ViewModel

这里重点关注对于属性的设置，类似于 text 和 level ， text 指的是二维码对应的数据，level 则可以参考 https://pub.dev/packages/qr_flutter

!> 千万注意要重写相等操作符，Voltron 底层使用了 Provider 来做状态管理，我们会根据 ViewModel 是否相等来判断当前 Widget 是否需要更新

import 'package:qr_flutter/qr_flutter.dart';
import 'package:voltron_renderer/voltron_renderer.dart';

class QrRenderViewModel extends GroupViewModel {
  String? text;
  int level = QrErrorCorrectLevel.L;

  QrRenderViewModel(
    int id,
    int instanceId,
    String className,
    RenderContext context,
  ) : super(id, instanceId, className, context);

  QrRenderViewModel.copy(
      int id,
      int instanceId,
      String className,
      RenderContext context,
      QrRenderViewModel viewModel,
      ) : super.copy(id, instanceId, className, context, viewModel) {
    text = viewModel.text;
    level = viewModel.level;
  }

  @override
  bool operator ==(Object other) {
    return other is QrRenderViewModel &&
        text == other.text &&
        level == other.level;
  }

  @override
  int get hashCode =>
      text.hashCode |
      level.hashCode |
      super.hashCode;
}

创建对应的 Widget

这里需要注意，如果你的组件需要参与 css 位置计算，那么需要包裹在 PositionedWidget 中（大部分的组件均是如此，例如 TextInput，View 等），如果只需要参与 css 宽高计算，则需要包裹在 BoxWidget 中（例如可以参考 ListView 中的 ListItem ），还有一部分不需要实际存在的组件，则可以自行定制（例如 Modal 组件，本身并不需要实际存在，打开之后是新的蒙层）。

import 'package:flutter/material.dart';
import 'package:provider/provider.dart';
import 'package:qr_flutter/qr_flutter.dart';
import 'package:voltron_renderer/voltron_renderer.dart';

class QrWidget extends FRStatefulWidget {
  final QrRenderViewModel _viewModel;

  QrWidget(this._viewModel) : super(_viewModel);

  @override
  State<StatefulWidget> createState() {
    return _QrWidgetState();
  }
}

class _QrWidgetState extends FRState<QrWidget> {
  @override
  Widget build(BuildContext context) {
    LogUtils.dWidget(
      "ID:${widget._viewModel.id}, node:${widget._viewModel.idDesc}, build qr widget",
    );
    // 这里注意一定要使用 Provider，以实现数据变更驱动视图变更
    return ChangeNotifierProvider.value(
      value: widget._viewModel,
      child: Consumer<QrRenderViewModel>(
        builder: (context, viewModel, widget) {
          return PositionWidget(
            viewModel,
            child: qrView(viewModel),
          );
        },
      ),
    );
  }

  Widget qrView(QrRenderViewModel viewModel) {
    LogUtils.dWidget(
      "ID:${widget._viewModel.id}, node:${widget._viewModel.idDesc}, build qr inner widget",
    );
    var text = viewModel.text;
    if (text != null && text.isNotEmpty) {
      return QrImage(
        data: text,
        errorCorrectionLevel: viewModel.level,
        padding: const EdgeInsets.all(0),
      );
    } else {
      return Container();
    }
  }
}

注册组件

上面的工作做完后，我们需要把组件注册进入 Voltron 应用，还记得初始化时的 MyAPIProvider 吗，这里我们要传入

class MyAPIProvider implements APIProvider {

  // 这个是模块扩展
  @override
  List<ModuleGenerator> get nativeModuleGeneratorList => [];

  // 这里是 JavaScript 模块生成器
  @override
  List<JavaScriptModuleGenerator> get javaScriptModuleGeneratorList => [];

  // 这里是组件扩展，将我们扩展的组件按照对应格式写进即可，注意这里的 KClassName 要与前端注册保持一致
  @override
  List<ViewControllerGenerator> get controllerGeneratorList => [
      ViewControllerGenerator(
        QrController.kClassName,
        (object) => QrController(),
      )
    ];
}

在引擎初始化的时候传入即可

// ...
initParams.providers = [
  MyAPIProvider(),
];
// ...

前端使用

如果您使用的是hippy-vue

可以参考 hippy-vue/customize

如果您是用的是hippy-react

可以参考 hippy-react/customize

手势事件处理

Voltron 手势处理集成在 PositionWidget 或者 BoxWidget 中，无需用户手动处理，只要外层包裹在上述两种Widget下，则默认自带 onClick , onLongclick , onTouchDown, onTouchMove , onTouchEnd 等等一系列手势事件

更多特性

处理组件方法调用

在有些场景，JavaScript 需要调用组件的一些方法，比如 QrView 的 changeText。这个时候需要在 QrController重载 dispatchFunction 方法来处理JS的方法调用。对应的前端调用文档 hippy-react/customize

@override
void dispatchFunction(
  QrRenderViewModel viewModel,
  String functionName,
  VoltronArray array, {
  Promise? promise,
}) {
  super.dispatchFunction(viewModel, functionName, array, promise: promise);
  if (functionName == "changeText") {}
  switch (functionName) {
    case "changeText":
      String? text = array.get<String>(0);
      if (text != null) {
        viewModel.text = text;
        // 需要注意，如果在调用事件时涉及到界面更新，则需要调用 ViewModel 的 update 方法来触发更新，如果是类似于 input 的 focus()，不涉及 UI 更新，则不需要
        viewModel.update();
      }
      break;
  }
}

事件回调

Voltron SDK 提供了 context.bridgeManager.sendComponentEvent(rootId, id, eventName, params);方法，封装了 UI 事件发送的逻辑，在任意地方找到 RenderContext 调用即可发送事件到 JavaScript 对应的组件上。比如我要在 QrView 的 build 的时候发送事件到前端的控件上面。 示例如下：

@override
Widget build(BuildContext context) {
  var params = VoltronMap();
  params.push("test", "code");
  widget._viewModel.context.bridgeManager.sendComponentEvent(
    widget._viewModel.rootId,
    widget._viewModel.id,
    "eventName",
    params,
  );
  // return SomeWidget();
}

Web

组件扩展

扩展组件主要包括：

1. 扩展 HippyView
2. 实现构造方法
3. 实现设置自定义组件的 tagName
4. 实现构造自定义组件的 dom
5. 实现自定义组件的 API 能力
6. 实现自定义组件的属性

其中 HippyView 类，实现了一些 HippyBaseView 的接口和属性定义，在一个自定义组件中有几个比较重要的属性：

• id: 每一个实例化 component 的唯一标识，默认会赋值给组件 dom 的 id 属性
• pId: 每一个实例化 component 的父组件标识
• tagName: 是用来区分组件的类型，也是业务侧代码使用该组件时在 nativeName 属性上填写的值，用来关联自定义组件的 key
• dom: 真正挂载到document上的节点
• props: 承载了从业务侧传递过来的属性和style的记录

例子

下面这个例子中，我们创建了 CustomView 的自定义组件，用来显示一个视频

• 第一步，进行初始化

import { HippyView, HippyWebEngine, HippyWebModule } from '@hippy/web-renderer';

// 继承自 `HippyView`
class CustomView extends HippyView {
  // 实现构造方法
  constructor(context, id, pId) {
    super(context, id, pId);
    // 设置自定义组件的 `tagName` 为 `CustomView`，
    // 这样 JS 业务使用的时候就可以设置 `nativeName="CustomView"` 进行关联。
    this.tagName = 'CustomView';
    // 构造自定义组件的 dom，我们创建了一个 video 节点并赋值给 dom 成员变量。注意 dom 成员变量在构造方法结束前一定要设置上
    this.dom = document.createElement('video'); 
  }
}

• 第二步，实现自定义组件的 API 能力和相关属性

  我们为 CustomView 实现了一个属性 src，当 JS 业务侧修改 src 属性时就会触发 set src() 方法并且获取到变更后的 value。

  我们还实现了组件的两个方法 play 和 pause，当 JS 业务侧使用 callUIFunction(this.instance, 'play'/'pause', []); 的时就会调用到这两个方法。

  在 pause() 方法中，我们使用 sendUiEvent 向 JS 业务侧发送了一个 onPause 事件，属性上设置的回调就会被触发。

import { HippyView, HippyWebEngine, HippyWebModule } from '@hippy/web-renderer';

class CustomView extends HippyView {
  
   set src(value) {
     this.dom.src = value;
   } 
   
   get src() {
    return this.props['src'];
   }
    
   play() {
    this.dom.play();
   }
   
   pause() {
    this.dom.pause();
    this.context.sendUiEvent(this.id, 'onPause', {});
   }
}

关于 props: HippyWebRenderer 底层默认会将业务侧传递过来的原始 props 存储到组件的 props 属性上，然后针对更新的 prop 项逐个调用与之对应 key 的 set 方法，让组件获得一个更新时机，从而执行一些行为。 props 里面有一个对象 style，承载了所有业务侧设置的样式。默认也是由 HippyWebRenderer 设置到自定义组件的 dom 上，中间会有一层转换，因为style 中的有一些值是 hippy 特有的，需要进行一次翻译才可以设置到 dom 的 style 上。

关于 context: 自定义组件被构造的时候会传入一个 context，它提供了一些关键的方法:

export interface ComponentContext {
     sendEvent: (type: string, params: any) => void; // 向业务侧发送全局事件
     sendUiEvent: (id: number, type: string, params: any) => void; // 向某个组件实例发送事件
     sendGestureEvent: (e: HippyTransferData.NativeGestureEvent) => void; // 发送手势事件
     subscribe: (evt: string, callback: Function) => void; // 订阅某个事件
     getModuleByName: (moduleName: string) => any; // 获取模块实例，通过模块名
}

复杂组件

有的时候我们可能需要提供一个容器，用来装载一些已有的组件。而这个容器有一些特殊的形态或者行为，比如需要自己管理子节点插入和移除，或者修改样式和拦截属性等。那么这个时候就需要使用一些复杂的组件实现方式。

• 关于组件自己实现子节点的 dom 插入和删除，HippyWebRender 默认的组件 dom 插入和删除，是使用 Web 的方法：

Node.insertBefore<T extends Node>(node: T, child: Node | null): T;
Node.removeChild<T extends Node>(child: T): T;

• 如果组件不希望以这种默认的形式来实现，可以自行通过 insertChild 和 removeChild 方法管理节点的插入和移除逻辑。

class CustomView extends HippyView{
    insertChild (child: HippyBaseView, childPosition: number) {
      // ...
    }
    removeChild (child: HippyBaseView){
      // ...
   }
}

• 关于组件 props 更新的拦截，需要实现组件的 updateProps 方法。

例子中，data 是组件本次更新的 props 数据信息，defaultProcess() 是 HippyWebRenderer 默认处理 props 更新的方法，开发者可以在这里拦截修改更新的数据后，依然使用默认的 props 进行更新，也可以不用默认的方法自行进行属性更新的遍历操作。

class CustomView extends HippyView{
    
    updateProps (data: UIProps, defaultProcess: (component: HippyBaseView, data: UIProps) => void) {
      // ...
    }
}