阿里云移动推送react-native 封装组件
使用本组件前提是注册过阿里云移动推送服务，注册过 app 并取得了 appKey 及 appSecret, 如果要使用 ios 版还要向苹果公司申请证书并配置好阿里云上的设置。 这里不详细描述，请参考阿里云移动推送文档
ReactNative 0.60.x 及以后
yarn add @hengkx/react-native-aliyun-push
android配置
- 在 Project 根目录下 build.gradle 文件中配置 maven 库 URL:
allprojects {
repositories {
mavenLocal()
jcenter()
maven {
// All of React Native (JS, Obj-C sources, Android binaries) is installed from npm
url "$rootDir/../node_modules/react-native/android"
}
// 下面是添加的代码
maven {
url "http://maven.aliyun.com/nexus/content/repositories/releases/"
}
// 配置HMS Core SDK的Maven仓地址。
maven {
url 'https://developer.huawei.com/repo/'
}
// 添加结束
}
}
- 确保 settings.gradle 中被添加如下代码：
include ':react-native-aliyun-push'
project(':react-native-aliyun-push').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-aliyun-push/android')
- 确保 app/build.gradle 中被添加如下代码：
dependencies {
//下面是被添加的代码
compile project(':react-native-aliyun-push')
//添加结束
}
请参考 [这里]
ios配置
-
执行
react-native link react-native-aliyun-push或手工添加 node_modules/react-native-aliyun-push/ios/RCTAliyunPush.xcodeproj 到 xcode 项目工程 -
点击项目根节点，在 targets app 的
Build Settings中找到Framework search path, 添加$(PROJECT_DIR)/../node_modules/react-native-aliyun-push/ios/libs -
添加阿里云移动推送 SDK
拖拽 node_modules/react-native-aliyun-push/ios/libs 下列目录到 xcode 工程的frameworks目录下，选择create folder references。
- AlicloudUtils.framework
- CloudPushSDK.framework
- UTDID.framework
- UTMini.framework
- 点击项目根节点，在 targets app 的 BuildPhase 的 Link Binary With Libraries 中添加公共包依赖
- libz.tbd
- libresolv.tbd
- libsqlite3.tbd
- CoreTelephony.framework
- SystemConfiguration.framework
- UserNotifications.framework
同时确保 targets app 的 BuildPhase 的 Link Binary With Libraries 包含
- AlicloudUtils.framework
- CloudPushSDK.framework
- UTDID.framework
- UTMini.framework
- 修改 AppDelegate.m 添加如下代码
#import "AliyunPushManager.h"
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
...
// 下面是添加的代码
[[AliyunPushManager sharedInstance] setParams:@"阿里云appKey"
appSecret:@"阿里云appSecret"
lauchOptions:launchOptions
createNotificationCategoryHandler:^{
//create customize notification category here
}];
// 添加结束
return YES;
}
// 下面是添加的代码
// APNs注册成功回调，将返回的deviceToken上传到CloudPush服务器
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
{
[[AliyunPushManager sharedInstance] application:application didRegisterForRemoteNotificationsWithDeviceToken:deviceToken];
}
// APNs注册失败回调
- (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error
{
[[AliyunPushManager sharedInstance] application:application didFailToRegisterForRemoteNotificationsWithError:error];
}
// 打开／删除通知回调
- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult result))completionHandler
{
[[AliyunPushManager sharedInstance] application:application didReceiveRemoteNotification:userInfo fetchCompletionHandler:completionHandler];
}
// 请求注册设定后，回调
- (void)application:(UIApplication *)application didRegisterUserNotificationSettings:(UIUserNotificationSettings *)notificationSettings
{
[[AliyunPushManager sharedInstance] application:application didRegisterUserNotificationSettings:notificationSettings];
}
// 添加结束
使用示例
引入模块
import AliyunPush from 'react-native-aliyun-push';
监听推送事件
componentDidMount() {
//监听推送事件
AliyunPush.addListener(this.handleAliyunPushMessage);
}
componentWillUnmount() {
//移除监听
AliyunPush.removeListener(this.handleAliyunPushMessage);
//也可以用移除全部监听
//AliyunPush.removeAllListeners()
}
handleAliyunPushMessage = (e) => {
console.log("Message Received. " + JSON.stringify(e));
//e结构说明:
//e.type: "notification":通知 或者 "message":消息
//e.title: 推送通知/消息标题
//e.body: 推送通知/消息具体内容
//e.actionIdentifier: "opened":用户点击了通知, "removed"用户删除了通知, 其他非空值:用户点击了自定义action（仅限ios）
//e.extras: 用户附加的{key:value}的对象
};
阿里云SDK接口封装
详细参数说明请参考阿里云移动推送 SDK [android版] [ios版]
获取 deviceId
示例:
AliyunPush.getDeviceId()
.then((deviceId)=>{
//console.log("deviceId:"+deviceId);
})
.catch((error)=>{
console.log("getDeviceId() failed");
});
绑定账号
参数：
- account 待绑定账号
示例:
AliyunPush.bindAccount(account)
.then((data)=>{
console.log("bindAccount success");
console.log(JSON.stringify(data));
})
.catch((error)=>{
console.log("bindAccount error");
console.log(JSON.stringify(error));
});
解绑定账号
示例:
AliyunPush.unbindAccount()
.then((result)=>{
console.log("unbindAccount success");
console.log(JSON.stringify(result));
})
.catch((error)=>{
console.log("bindAccount error");
console.log(JSON.stringify(error));
});
绑定标签
参数：
- target 目标类型，1：本设备；2：本设备绑定账号；3：别名
- tags 标签（数组输入）
- alias 别名（仅当 target = 3 时生效）
示例:
AliyunPush.bindTag(1,["testtag1","testtag2"],"")
.then((result)=>{
console.log("bindTag success");
console.log(JSON.stringify(result));
})
.catch((error)=>{
console.log("bindTag error");
console.log(JSON.stringify(error));
});
解绑定标签
参数:
- target 目标类型，1：本设备；2：本设备绑定账号；3：别名
- tags 标签（数组输入）
- alias 别名（仅当 target = 3 时生效）
示例:
AliyunPush.unbindTag(1,["testTag1"],"")
.then((result)=>{
console.log("unbindTag succcess");
console.log(JSON.stringify(result));
})
.catch((error)=>{
console.log("unbindTag error");
console.log(JSON.stringify(error));
});
查询当前 Tag 列表
参数:
- target 目标类型，1：本设备
示例:
AliyunPush.listTags(1)
.then((result)=>{
console.log("listTags success");
console.log(JSON.stringify(result));
})
.catch((error)=>{
console.log("listTags error");
console.log(JSON.stringify(error));
});
添加别名
参数:
- alias 要添加的别名
示例:
AliyunPush.addAlias("testAlias")
.then((result)=>{
console.log("addAlias success");
console.log(JSON.stringify(result));
})
.catch((error)=>{
console.log("addAlias error");
console.log(JSON.stringify(error));
});
删除别名
参数:
- alias 要移除的别名
示例:
AliyunPush.removeAlias("testAlias")
.then((result)=>{
console.log("removeAlias success");
console.log(JSON.stringify(result));
})
.catch((error)=>{
console.log("removeAlias error");
console.log(JSON.stringify(error));
});
查询别名列表
示例:
AliyunPush.listAliases()
.then((result)=>{
console.log("listAliases success");
console.log(JSON.stringify(result));
})
.catch((error)=>{
console.log("listAliases error");
console.log(JSON.stringify(error));
});
设置桌面图标角标数字 (ios 支持，android 支持绝大部分手机)
参数:
- num 角标数字，如果要清除请设置 0
示例:
AliyunPush.setApplicationIconBadgeNumber(5);
获取桌面图标角标数字 (ios 支持，android 支持绝大部分手机)
示例:
AliyunPush.getApplicationIconBadgeNumber((num)=>{
console.log("ApplicationIconBadgeNumber:" + num);
});
同步角标数到阿里云服务端 (仅 ios 支持)
参数:
- num 角标数字
示例:
AliyunPush.syncBadgeNum(5);
获取用户是否开启通知设定 (ios 10.0+支持)
示例:
AliyunPush.getAuthorizationStatus((result)=>{
console.log("AuthorizationStatus:" + result);
});
获取初始消息
app 在未启动时收到通知后，点击通知启动 app, 如果在向 JS 发消息时，JS 没准备好或者没注册 listener，则先临时保存该消息， 并提供 getInitalMessage 方法可以获取，在 app 的 JS 逻辑完成后可以继续处理该消息
示例:
async componentDidMount() {
//监听推送事件
AliyunPush.addListener(this.handleAliyunPushMessage);
const msg = await AliyunPush.getInitialMessage();
if(msg){
this.handleAliyunPushMessage(msg);
}
}
componentWillUnmount() {
AliyunPush.removeListener(this.handleAliyunPushMessage);
}
handleAliyunPushMessage = (e) => {
.....
}