最近在写信鸽推送中间遇到一些坑,不过好在都逐步解决了,目前写一下做个说明。由于极光推送官方做了相关RN代码,有需要的同学也可以参考他们的步骤来一步步完成自己推送的RN模块.下面来说说我的开发过程吧:
首先我们都得先用RN创建个工程
iOS信鸽推送 RN模块开发
1. iOS先新建一个静态库
导入信鸽推送需要的libXG-SDK.a
和XGPush.h
文件,信鸽推送iOS配置和方法说明参考官方.
然后新建iOS类文件,用于iOS和RN交互,将静态库工程导入RN功能下编写相关功能。
我XGPush静态库的结构如下:
强调一点:就是类名命名规范,如果是带你新建的类带有前缀RCT和RK的话,RN引用导入的时候默认忽略的,比如我这个RCTXGPushModule,RN里面引用的时候默认就是NativeModules.XGPushModule。
这一点可以在RN源码里面RCTBridge的RCTBridgeModuleNameForClass方法找到说明
2. 下面就是iOS原生模块和RN交互了
具体交互说可参考RN中国社区网站原生模块
- 按照说明配置导入相关RN头文件,继承类RCTEventEmitter,遵循相关协议
我的.h文件内容如下 - .m文件就是和RN交互相关
有几点说明:
/**
为了实现RCTBridgeModule协议,需要包含RCT_EXPORT_MODULE()宏。
这个宏也可以添加一个参数用来指定在Javascript中访问这个模块的名字。
如果你不指定,默认就会使用这个Objective-C类的名字
*/
RCT_EXPORT_MODULE();
加上单例方法保持对象唯一,要不然有可能会产生崩溃和其他问题
//保持对象唯一 使用单例
+ (id)allocWithZone:(NSZone *)zone {
static RCTXGPushModule *sharedInstance = nil;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
sharedInstance = [super allocWithZone:zone];
});
return sharedInstance;
}
直接用对象发送事件就会崩溃,类似的采用通知发送事件 原因的RN先生成XGPushModlue对象方可发送事件
否则当用户操作触发时调用sendEventWithName报错bridge is not set,
所以参考极光推送全部采用通知发送事件,类似
导入方法提供给js调用用RN的RCT_EXPORT_METHOD,可以回调参数过去。使用方法类似如下:
最后就是调用RN发送事件方法了
- (void)sendEventWithName:(NSString *)eventName body:(id)body
andriod 信鸽推送 RN模块开发
由于我没做过安卓开发,所以安卓遇到了很多坑,逐步才一一解决。
- 首先使用Android Studio打开RN创建的安卓工程,新建module
- 现在我们需要建立安卓XGPush的RN的module模块
我创建的module模块名称是
xgpush
,创建完成结构如下-
导入信鸽推送安卓模块需要的文件
信鸽推送安卓SDK下载地址
在新建的module的libs
文件下导入信鸽推送jar文件
在新建的module的src/main
下新建文件夹jiniLIbs
,导入信鸽so文件 在module的build.gradle里面配置依赖
dependencies {
//implementation fileTree(include: ['*.jar'], dir: 'libs')
compile 'com.facebook.react:react-native:+'
compile files('libs/Xg_sdk_v3.2.3_20180403_1839.jar')
compile files('libs/wup-1.0.0.E-SNAPSHOT.jar')
compile files('libs/jg_filter_sdk_1.1.jar')
compile files('libs/mid-core-sdk-4.0.6.jar')
}
- 工程依赖xgpush
在主工程目录下的settings.gradle
导入xgpush
,就是新建的module名
include ':app', ':xgpush'
- 信鸽推送安卓SDK与RN交互
我这里java模块如下:
LocalInnerMessageReceiver
本地通知,接受者用于接受信鸽发送本地通知的.没什么好说的
XGMessageReceiver
用于监听信鸽推送相关事件,
官方参考地址
XGPushModule
用于安卓和RN交互很重要
RN与安卓原生交互可 参考
强调几点:
- 一个原生模块是一个继承了
ReactContextBaseJavaModule
的Java类 - 一个原生模块需要监听声明RN周期的,可实现接口
LifecycleEventListener
,然后需要在构造函数中注册一个监听函数:
reactContext.addLifecycleEventListener(this);
-
可在构造函数里面实现监听和进行初始化等操作
ReactContextBaseJavaModule要求派生类实现getName方法。这个函数用于返回一个字符串名字,这个名字在JavaScript端标记这个模块。这里我们把这个模块叫做
RNGFXGPush
,这样就可以在JavaScript中通过React.NativeModules.RNGFXGPush
访问到这个模块
@Override
public String getName() {
return "RNGFXGPush";
}
注意:模块名前的RCT前缀会被自动移除。所以如果返回的字符串为RCTRNGFXGPush
,在JavaScript端依然可以通过React.NativeModules.RNGFXGPush
访问到这个模块。
- 要导出一个方法给JavaScript使用,Java方法需要使用注解
@ReactMethod
类似代码:
/*
* 设置是否开启信鸽Debug日志
* */
@ReactMethod
public void enableDebug(Boolean enable) {
XGPushConfig.enableDebug(this.context,enable);
}
/*
* 注册信鸽推送
* */
@ReactMethod
public void registerPush() {
XGPushManager.registerPush(this.context, new XGIOperateCallback() {
@Override
public void onSuccess(Object data, int flag) {
Log.d("XGPush", "注册成功:" + data);
sendEvent(RNGFXGPushRegisterEvent,data);
}
@Override
public void onFail(Object data, int errCode, String msg) {
Log.d("XGPush", "注册失败,错误码:" + errCode + ",错误信息:" + msg);
WritableMap params = Arguments.createMap();
params.putInt("errCode", (int) errCode);
params.putString("msg",msg);
sendEvent(RNGFXGPushRegisterEvent,params);
}
});
}
- 发送事件 最简单的办法就是通过
RCTDeviceEventEmitter
,这可以通过ReactContext来获得对应的引用,像这样:
-
在Java这边要做的最后一件事就是注册这个模块。我们需要在应用的Package类的createNativeModules方法中添加这个模块。如果模块没有被注册,它也无法在JavaScript中被访问到。
这个package需要在MainApplication.java
文件的getPackages方法中提供。这个文件位于你的react-native
应用文件夹的android目录中。具体路径是: android/app/src/main/java/com/your-app-name/MainApplication.java
.
- 打开主工程 Androidmanifest.xml,添加信鸽安卓配置
配置详情参考官方
如果配置没有问题,运行RN代码交互成功,就会出现和我类似的安卓信鸽推送效果
代码可参考我的Demo