魅族厂商通道接入指南

概述

在国内 Android 生态中，推送通道都是由终端与云端之间的长链接来维持，严重依赖于应用进程的存活状态。如今一些手机厂家会在自家 rom 中做系统级别的推送通道，再由系统分发给各个 app，以此提高在自家 rom 上的推送送达率。

JPush SDK 为了尽可能提高开发者在各类 rom 上的推送送达率，对使用魅族的设备推送，自动切换到魅族通道。同时，为了保证 SDK 的易用性，原本 JPush 的所有接口调用逻辑都不用修改,JPush 会对自身支持的功能做兼容.只需在manifest中配置上魅族 SDK 必须的配置组件即可。

功能描述

JPush 初始化的时候可选择是否初始化魅族通道。
在魅族设备上 JPush 通道与魅族通道共存.
魅族通道初始化后支持 tag/alias 这些 JPush 原有的功能,其它的 JPush 未支持的功能目前暂时还不可用 .

注1： 在flyme5.1.11.1及以上才使用 mzpush,因为之前的版本上 mzpush 的通道并非系统通道。

手动集成步骤

主要步骤为:

1. 增加魅族插件包及魅族推送包
2. 修改 minSdkVersion 的值
3. 配置魅族推送sdk所需要的权限
4. 配置JPush接受魅族sdk的消息接受类
5. 将MEIZUAPPKEY与MEIZUAPPID替换为在魅族后台注册对应该应用的AppKey/AppID

1.增加魅族插件包及魅族推送包

将third-push目录下找到meizu目录，从libs中拷贝其中的jar包至工程的libs目录下。
将third-push目录下找到res目录，从res中所有的资源文件拷贝至工程的res目录下。
jar包说明：
jpush-android-plugin-meizu-v3.x.x.jar:插件包
meizu-push-x.x.x.jar:魅族推送包

注1： 极光集成魅族通道在 JPush Android SDK 3.0.6 添加。

注2： JPush Android SDK 3.2.0添加了魅族推送包，对应的魅族sdk版本为：meizu-push-3.8.1.jar

注3： JPush Android SDK 3.6.0更新了魅族推送包，对应的魅族sdk版本为：meizu-push-3.9.0.jar

2. 修改 minSdkVersion 的值

注: 魅族推送会强制将 minSdkVersion 修改为 11。如果当前 app 使用的 minSdkVersion 的值小于 11,则需要使用 tools 避免被强制覆盖。

    <manifest
        xmlns:android="http://schemas.android.com/apk/res/android"
        xmlns:tools="http://schemas.android.com/tools"
    ... >

    <uses-sdk
        android:minSdkVersion="9"
        android:targetSdkVersion="21"
        tools:overrideLibrary="cn.jpush.android.thirdpush.meizu" />

3. 配置魅族推送sdk所需要的权限

    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
    <uses-permission android:name="com.meizu.c2dm.permission.RECEIVE" />
    <permission
        android:name="您应用的包名.permission.C2D_MESSAGE"
        android:protectionLevel="signature"></permission>
    <uses-permission android:name="您应用的包名.permission.C2D_MESSAGE" />

4. 配置魅族推送sdk所需要的必要组件

        <service
            android:name="com.meizu.cloud.pushsdk.NotificationService"
            android:exported="true" />

5. 配置JPush接受魅族sdk的消息接受类

    <receiver android:name="cn.jpush.android.service.PluginMeizuPlatformsReceiver">
        <intent-filter>
            <!-- 接收 push 消息 -->
            <action android:name="com.meizu.flyme.push.intent.MESSAGE" />
            <!-- 接收 register 消息 -->
            <action android:name="com.meizu.flyme.push.intent.REGISTER.FEEDBACK" />
            <!-- 接收 unregister 消息-->
            <action android:name="com.meizu.flyme.push.intent.UNREGISTER.FEEDBACK" />
            <!-- 兼容低版本 Flyme3 推送服务配置 -->
            <action android:name="com.meizu.c2dm.intent.REGISTRATION" />
            <action android:name="com.meizu.c2dm.intent.RECEIVE" />

            <category android:name="您应用的包名"></category>
        </intent-filter>
    </receiver>

注对于同一个应用集成了多个推送SDK，且其他SDK也使用了魅族通道的用户：可以将这个极光内置的Receiver，换成自己定义的Receiver。这个Receiver必须继承魅族的com.meizu.cloud.pushsdk.MzPushMessageReceiver 且在每个回调方法，都回调给极光的PluginMeizuPlatformsReceiver。类似于这样：

public class MyMZPushReceiver extends MzPushMessageReceiver {

    final PluginMeizuPlatformsReceiver receiver = new PluginMeizuPlatformsReceiver();

    @Override
    public void onReceive(Context context, Intent intent) {
        receiver.onReceive(context, intent);
    }

    @Override
    public void onRegister(Context context, String s) {
        receiver.onRegister(context, s);
    }

    @Override
    public void onMessage(Context context, String s) {
        receiver.onMessage(context, s);
    }

    @Override
    public void onNotificationArrived(Context context, MzPushMessage mzPushMessage) {
        receiver.onNotificationArrived(context, mzPushMessage);
    }

    @Override
    public void onNotificationClicked(Context context, MzPushMessage mzPushMessage) {
        receiver.onNotificationClicked(context, mzPushMessage);
    }


    @Override
    public void onUnRegister(Context context, boolean b) {
        receiver.onUnRegister(context, b);
    }

    @Override
    public void onPushStatus(Context context, PushSwitchStatus pushSwitchStatus) {
        receiver.onPushStatus(context, pushSwitchStatus);
    }

    @Override
    public void onRegisterStatus(Context context, RegisterStatus registerStatus) {
        receiver.onRegisterStatus(context, registerStatus);
    }

    @Override
    public void onUnRegisterStatus(Context context, UnRegisterStatus unRegisterStatus) {
        receiver.onUnRegisterStatus(context, unRegisterStatus);
    }

    @Override
    public void onSubTagsStatus(Context context, SubTagsStatus subTagsStatus) {
        receiver.onSubTagsStatus(context, subTagsStatus);
    }

    @Override
    public void onSubAliasStatus(Context context, SubAliasStatus subAliasStatus) {
        receiver.onSubAliasStatus(context, subAliasStatus);
    }

    @Override
    public void onUpdateNotificationBuilder(PushNotificationBuilder pushNotificationBuilder) {
        receiver.onUpdateNotificationBuilder(pushNotificationBuilder);
    }
}

6. 将MEIZUAPPKEY与MEIZUAPPID替换为在魅族后台注册对应该应用的AppKey/AppID

将应用对应的魅族的 appkey 和 appid 加上前缀“MZ-”,填加在 meta-data 标签中

    <meta-data
        android:name="MEIZU_APPKEY"
        android:value="MZ-您的应用对应的魅族的APPKEY" />
    <meta-data
        android:name="MEIZU_APPID"
        android:value="MZ-您的应用对应的魅族的APPID" />

JCenter 自动化集成步骤

确认android studio的 Project 根目录的主 gradle 中配置了jcenter支持。(新建project默认配置就支持)

    buildscript {
        repositories {
        jcenter()
        }
        ......
    }


    allprojets {
        repositories {
        jcenter()
        }
    }

在应用 module 的 gradle 中 dependencies 节点添加如下代码:

    dependencies {
        compile 'cn.jiguang.sdk.plugin:meizu:3.x.x'
    }

在应用 module 的 gradle 中 defaultConfig 节点添加如下代码:

    manifestPlaceholders = [
        // 设置manifest.xml中的变量
        MEIZU_APPKEY : "MZ-0956b96085d54c6087b85c7994b02ddf", // 魅族平台注册的appkey
        MEIZU_APPID : "MZ-110443", // 魅族平台注册的appid
   ]

组装服务集成步骤

请在组包服务界面勾选 JPush 后同时勾选 MEIZU 组包项，组包服务使用方式请参考JPush组包服务指南

在应用 module gradle 中添加 MEIZU 账号配置

android {
    ......
    defaultConfig {
        applicationId "com.xxx.xxx" //JPush 上注册的包名.
        ......

        manifestPlaceholders = [
            JPUSH_PKGNAME : applicationId,
            JPUSH_APPKEY : "你的 Appkey ", //JPush 上注册的包名对应的 Appkey.
            JPUSH_CHANNEL : "developer-default", //暂时填写默认值即可.

            MEIZU_APPKEY  : "MZ-魅族的APPKEY，请注意，（MZ-）的前缀不要落下",
            MEIZU_APPID   : "MZ-魅族的APPID，请注意，（MZ-）前缀不要落下",

        ]
        ......
    }
    ......
}

dependencies {
    ......

    implementation project(':jiguang')
    ......
}

成功集成的标志

插件集成成功后，会向魅族server请求token，拿到这个token即可证明集成没问题。

token是可以在日志里查到的，观察下列日志输出

meizu05

配置魅族通知栏小图标

通过 MzPush SDK 接收的通知，可设置其通知栏 icon，方法如下：

在应用的工程目录 res/drawable-xxxx/ 几个文件夹中添加对应不同分辨率的通知栏 icon 图标，文件名为 mz_push_notification_small_icon。如果文件名错误，将无法正确显示该应用的状态栏图标。

魅族手机状态栏 icon 规范请参考魅族 PushSDK Demo 中的图片文件。

注：如果没有放入符合规范的 icon 文件，会默认使用应用图标作为通知 icon。而应用图标不符合魅族的通知栏 icon 设计规范的话，则会导致通知栏图标无法正确显示。

通知内容长度兼容

功能说明

由于魅族官方的通知内容长度限制为100个字符以内（中英文都算一个），当通知内容（极光的“alert”字段的值）长度超过100时，魅族通道会推送失败。此时调用极光api推送通知时，请在payload 中的 "notification" 的 "android" 节点的"extras"节点添加以下字段：

使用方式

Push API 推送说明

关键字	类型	示例	说明
mzpns_content_forshort	string	"short content"	通知内容（极光的“alert”字段）长度超过100个字符时，可在此字段的值传入不超过100字符的通知内容。

请求json示例：

{
    "platform": [
        "android"
    ],
    "audience": "all",
    "notification": {
        "android": {
            "alert": "在国内 Android 生态中，推送通道都是由终端与云端之间的长链接来维持，严重依赖于应用进程的存活状态。如今一些手机厂家会在自家 rom 中做系统级别的推送通道，再由系统分发给各个 app，以此提高在自家 rom 上的推送送达率。JPush SDK 为了尽可能提高开发者在各类 rom 上的推送送达率，对使用 ColorOS 的设备推送，自动切换到魅族通道。同时，为了保证 SDK 的易用性，原本 JPush 的所有接口调用逻辑都不用修改,JPush 会对自身支持的功能做兼容.只需在manifest中配置上 魅族 SDK 必须的配置组件即可.",
            "title": "概述",
            "extras": {
                "mzpns_content_forshort": "在国内 Android 生态中，推送通道都是由终端与云端之间的长链接来维持，严重依赖于应用进程的存活状态。"
            }
        }

    },
    "message": {
        "msg_content": "自定义消息内容003"
    }
}

集成错误码

名称	Code	Commen
UNKNOWN_ERROR	-1	未知错误
SUCCESS	200	成功
SYSTEM_ERROR	1001	系统错误
SYSTEM_BUSY	1003	服务器忙
PARAMETER_ERROR	1005	参数错误，请参考API文档
INVALID_SIGN	1006	签名认证失败
INVALID_APPLICATION_ID	110000	appId不合法
INVALID_APPLICATION_KEY	110001	appKey不合法
UNSUBSCRIBE_PUSHID	110002	pushId未注册
INVALID_PUSHID	110003	pushId非法
PARAM_BLANK	110004	参数不能为空
APP_IN_BLACK_LIST	110009	应用被加入黑名单
APP_REQUEST_EXCEED_LIMIT	110010	应用请求频率过快
APP_PUSH_TIME_EXCEED_LIMIT	110051	超过该应用的次数限制
APP_REQUEST_PUSH_LIMIT	110019	超过该应用每天推送次数限制
INVALID_APPLICATION_PACKAGENAME	110031	packageName不合法
INVALID_TASK_ID	110032	非法的taskId
INVALID_APPLICATION_SECRET	110033	非法的appSecret

MeizuPush SDK的编译混淆问题

如果使用了 proguard，需要在配置文件中加入,可以防止一个误报的 warning 导致无法成功编译，

-dontwarn com.meizu.cloud.**
-keep class com.meizu.cloud.** { *; }

魅族/极光后台配置引导

1 登录魅族推送后台并创建新应用 ,点击打开应用

注意应用的包名应与极光后台保持一致。

meizu01

2 点击配置管理

meizu02

3 获取配置极光后台以及manifest里的信息

meizu03

4 极光后台配置示例

具体信息位置请对照上面的图

极光控制台地址

路径：我的app-应用设置（左边导航栏最下面）-推送设置-集成设置

meizu04

获取送达率数据

完成上述集成步骤后，通知消息即可通过魅族厂商通道下发，但无通知消息是否送达的数据，若需准确的魅族厂商通道送达率数据，需进行魅族厂商通道回调设置

Keys	Action
`?`	Open this help
`n`	Next page
`p`	Previous page
`s`	Search