react naive封装原生UI(android篇)

本文对于UI组件的封装,主要从两部分介绍:

  • 基本视图封装
  • 事件处理

demo中是封装原生Button组件,记录使用过程及需要注意的问题。

一、基本视图封装

  • 创建一个ViewManager的子类。
  • 实现createViewInstance方法。
  • 导出视图的属性设置器:使用@ReactProp(或@ReactPropGroup)注解。
  • 把这个视图管理类注册到应用程序包的createViewManagers里。
  • 实现JavaScript模块。

1.1创建一个ViewManager的子类

SimpleViewManager是ViewManager的派生类,通过该类创建和管理视图对象。

public class RCTButton extends SimpleViewManager<Button> {

    private static final String EVENT_NAME_ONCLICK = "onClick";
    private ThemedReactContext mContext;

    @Override
    public String getName() {
        return "RCTButton";
    }

}

SimpleViewManager<Button>中的Button是需要封装的UI组件,该组件可以是自定义组件。

实现方法getName,返回值RCTButton在实现JavaScript模块时需要用到。

1.2实现createViewInstance方法

RCTButton类中,实现createViewInstance方法,创建、返回View对象。

@Override
protected Button createViewInstance(ThemedReactContext reactContext) {
    this.mContext = reactContext;
    Button button = new Button(reactContext);
    return button;
}

1.3导出视图的属性设置器

使用@ReactProp(或@ReactPropGroup)注解,这里介绍@ReactProp。

@ReactProp(name = "text")
public void setText(Button button,String text){
    button.setText(text);
}
  • name="text" : name对应的值是在js代码中使用该封装组件时的属性名。

1.4 视图管理类注册

//自定义RTCViewPackage
public class RTCViewPackage implements ReactPackage {
    @Override
    public List<NativeModule> createNativeModules(ReactApplicationContext reactContext) {
        return Collections.EMPTY_LIST;
    }

    @Override
    public List<ViewManager> createViewManagers(ReactApplicationContext reactContext) {
        return Arrays.<ViewManager>asList(new RCTButton());
    }
}

实现了两个方法,在createViewManagers方法中添加自定义的视图管理类RCTButton。
自定义RTCViewPackage类需要在MainApplication中添加:

    @Override
    protected List<ReactPackage> getPackages() {
      return Arrays.<ReactPackage>asList(
          new MainReactPackage(),
          new RTCViewPackage()
      );
    }

1.5 实现JavaScript模块

'use strict';
import React, { Component } from 'react';

import {
    requireNativeComponent
} from 'react-native';

let RTCBtn = requireNativeComponent("RCTButton",RCTButton);

export default class RCTButton extends Component {

    render() {
        return <RTCBtn {...this.props}/>;
    }

}
  • requireNativeComponent关联js和原生组件,方法中的两个参数:第一个参数是JS模块名称,第二个参数是原生封装该UI组件时的名称,对应getName返回值。
  • {...this.props} 必须有,否则组件不显示。

二、事件处理

当一个原生事件发生的时候,它应该也触发JS端视图上的事件,这两个视图会依据getId()而关联在一起。(可以理解为原生层View给JS层View发送消息--个人理解O(∩_∩)O~)

2.1 事件映射

重写getExportedCustomDirectEventTypeConstants方法,将原生事件name映射到js事件name,类似于key-value。

public class RCTButton extends SimpleViewManager<Button> {
    private static final String EVENT_NAME_ONCLICK_NATIVE = "nativeClick";
    private static final String EVENT_NAME_ONCLICK_JS = "jsClick";
    @Nullable
    @Override
    public Map<String, Object> getExportedCustomDirectEventTypeConstants() {
        return MapBuilder.<String,Object>builder().put(EVENT_NAME_ONCLICK_NATIVE,MapBuilder.of("registrationName",EVENT_NAME_ONCLICK_JS)).build();
    }
}

2.2 接受事件,传递给JS层

在RCTButton类中重写addEventEmitters方法,添加点击事件监听。

    @Override
    protected void addEventEmitters(final ThemedReactContext reactContext, final Button view) {
        super.addEventEmitters(reactContext, view);
        view.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                WritableMap data = Arguments.createMap();
                data.putString("msg","点击btn2");
                reactContext.getJSModule(RCTEventEmitter.class).receiveEvent(
                        view.getId(),
                        EVENT_NAME_ONCLICK,
                        data
                );
            }
        });
    }

关键代码:reactContext.getJSModule(RCTEventEmitter.class).receiveEvent( view.getId(), EVENT_NAME_ONCLICK_NATIVE, data ); } });
该代码的类似于:view组件接收到了事件,传递给JS层。
receiveEvent的第一个参数是关联原生组件和js组件,第二个参数是事件映射中的key值,第三个参数是传递给js层的数据。

另外,如果不重写addEventEmitters方法,在createViewInstance方法中发送事件给js端也可。但是优先级低于addEventEmitters

@Override
    protected Button createViewInstance(final ThemedReactContext reactContext) {
        this.mContext = reactContext;
        final Button button = new Button(reactContext);
        button.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                //创建数据传递信使,雷士android中的bundle
                WritableMap data = Arguments.createMap();
                data.putString("msg","点击了btn");
                mContext.getJSModule(RCTEventEmitter.class).receiveEvent(
                        button.getId(),
                        EVENT_NAME_ONCLICK_NATIVE,//通过该string,查找js层对应的方法名
                        data
                );
            }
        });
        return button;
    }

2.3 js模块

'use strict';
import React, { Component } from 'react';

import {
    requireNativeComponent
} from 'react-native';

let RTCBtn = requireNativeComponent("RCTButton",RCTButton,{nativeOnly:{jsClick:true}});

export default class RCTButton extends Component {

    _onClick = (event)=>{
        if (!this.props.onPress){
            return;
        }
        //使用event.nativeEvent.msg获取原生层传递的数据
        this.props.onPress(event.nativeEvent.msg);
    }

    render() {
        return <RTCBtn
            {...this.props} jsClick = {(event)=>this._onClick(event)}/>;
    }

}

关键代码:

  • {nativeOnly:{jsClick:true}} : 故名思议,nativeOnly--只在原生中生效的属性,该属性将不再propType中定义,若不添加编译时将会报错。
  • jsClick = {(event)=>this._onClick(event)} :通过event可以获取到原生传递的数据
  • jsClick 对应原生代码中的事件映射中的private static final String EVENT_NAME_ONCLICK_JS = "jsClick"

2.4 使用JS模块**

render() {
    return (
      <View style={styles.container}>
        <RCTButton text="原生btn" style = {{width:80,height:40}} onPress = {
          (msg)=>{
            alert("原生传递的数据为:"+msg)}}/>
      </View>
    );
  }

使用过程中,添加了onPress属性。

拓展知识:

1.原生发送消息,js层注册监听

reactContext
            .getJSModule(RCTNativeAppEventEmitter.class)
            .emit(eventName, params);
           //eventName:String JS中通过eventName接收  
           //params:WritableMap 需要传递的参数 

js层接收:

NativeAppEventEmitter.addListener('onVolumeChange', () => {})
//onVolumeChange =>原生代码中的eventName

2.自定义组件时,js层给native层发送消息
native层需重写getCommandsMapreceiveCommand方法。

/**  
 * 接收交互通知  
 * @return  
 */  
@Nullable  
@Override  
public Map<String, Integer> getCommandsMap() {  
    return MapBuilder.of("handleTask",1);  
}  
//根据RN层发送的对应通知ID,处理对应任务请求
@Override  
public void receiveCommand(ImageView root, int commandId, @Nullable ReadableArray args) {  
    switch (commandId){  
        case 1:  
            if(args != null) {  
                String name = args.getString(0);//获取第一个位置的数据  
                Toast.makeText(context, "收到RN层的任务通知...", Toast.LENGTH_SHORT).show();  
            }  
            break;  
        default:  
            break;  
    }  
}  

js层发送任务通知

import {  UIManager, findNodeHandle } from 'react-native';

sendNotification() {  
  //向native层发送命令  
  UIManager.dispatchViewManagerCommand(  
      findNodeHandle(this.refs.rctBtn),  
      UIManager.RCTButton.Commands.handleTask, // Commands后面的值与原生层定义的`handleTask`一致  
      ["from React Native"] // 向原生层传递的参数数据,数据形如:["第一个参数","第二个参数",...]  
  );  
}  
render() {
        return <RTCBtn
            ref = 'rctBtn'
            {...this.props} onClick = {(event)=>this._onClick(event)}/>;
    }
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,468评论 5 473
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,620评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,427评论 0 334
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,160评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,197评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,334评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,775评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,444评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,628评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,459评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,508评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,210评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,767评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,850评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,076评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,627评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,196评论 2 341

推荐阅读更多精彩内容