魅族PushSDK3 Eclipse 快速开始

2017-02-21 Renfei Yu 更多博文 » 博客 » GitHub »

原文链接 https://comsince.github.io/2017/02/21/mzpushsdk-eclipse/
注:以下为加速网络访问所做的原文缓存,经过重新格式化,可能存在格式方面的问题,或偶有遗漏信息,请以原文为准。


概述

MzPushSDK 针对Flyme级的系统级推送,定制了针对Flyme的推送SDK,立足减少开发者接入成本,提高应用在Flyme上的推送体验,本文档主要讲解魅族PushSDK AndroidStudio详细接入步骤,对PushSDK的基本的API做出简明的介绍,讲解SDK支持的功能

Eclipse PushSDK jar发布说明

一.准备工作

NOTE: 请按照项目需求选取用的引用方式引用aar包

1.1 PushSDK资源引用配置说明

1.1.1 Lib引用配置说明

PushSDK3.0精简了依赖关系,现在只需要一个jar包,无需引入其他第三方类库

  libs/pushsdk-3.3.XXXXXX.jar

NOTE: 请将PushSDK的jar,拷贝到工程的lib目录即可,jar包具体见PushDemo的lib目录

1.1.2 layout引用配置说明

PushSDK需要依赖三个layout文件,需要工程手动配置 将sdk的res目录下的三个layout文件,拷贝工程的res/layout目录下,具体如下:

  push_expandable_big_image_notification.xml
  push_expandable_big_text_notification.xml
  push_pure_pic_notification.xml

1.1.3 proguard配置说明

由于jar不能打包混淆规则,你需要手动配置pushSDK的混淆规则,具体如下:

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

1.2 必要的配置

1.2.1 权限配置

NOTE: jar无法打包pushSDK的所需的权限,你需要手动配置一下权限

    <!--PushSDK运行必须配置权限-->
    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.READ_PHONE_STATE" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <uses-permission android:name="android.permission.VIBRATE" />
    <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" />

NOTE: 如果你需要支持flyme5以下版本推送,以下内容可以选配

    <!-- 兼容flyme5.0以下版本,魅族内部集成pushSDK必填,不然无法收到消息-->
    <uses-permission android:name="com.meizu.flyme.push.permission.RECEIVE"></uses-permission>
    <permission android:name="包名.push.permission.MESSAGE" android:protectionLevel="signature"/>
    <uses-permission android:name="包名.push.permission.MESSAGE"></uses-permission>

    <!--  兼容flyme3.0配置权限-->
    <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"/>

1.2.2 必要组件配置

    <!-- 必要配置,提高push消息送达率 -->
    <service
         android:name="com.meizu.cloud.pushsdk.NotificationService"
         android:exported="true"/>

    <!-- 必要配置,pushSDK内部组件 -->
    <receiver android:name="com.meizu.cloud.pushsdk.SystemReceiver" >
       <intent-filter>
          <action android:name="com.meizu.cloud.pushservice.action.PUSH_SERVICE_START"/>
          <category android:name="android.intent.category.DEFAULT" />
        </intent-filter>
     </receiver>

1.2.2 注册消息接收Receiver

    <!-- push应用定义消息receiver声明 -->
    <receiver android:name="your.package.MyPushMsgReceiver">
        <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>

1.2.3 实现自有的PushReceiver,实现消息接收,注册与反注册回调

  public class MyPushMsgReceiver extends MzPushMessageReceiver {

    @Override
    @Deprecated
    public void onRegister(Context context, String pushid) {
        //应用在接受返回的pushid
    }

    @Override
    public void onMessage(Context context, String s) {
        //接收服务器推送的消息
    }

    @Override
    @Deprecated
    public void onUnRegister(Context context, boolean b) {
        //调用PushManager.unRegister(context)方法后,会在此回调反注册状态
    }

    //设置通知栏小图标
    @Override
    public PushNotificationBuilder onUpdateNotificationBuilder(PushNotificationBuilder pushNotificationBuilder) {
        pushNotificationBuilder.setmStatusbarIcon(R.drawable.mz_push_notification_small_icon);
    }

    @Override
    public void onPushStatus(Context context,PushSwitchStatus pushSwitchStatus) {
        //检查通知栏和透传消息开关状态回调
    }

    @Override
    public void onRegisterStatus(Context context,RegisterStatus registerStatus) {
        Log.i(TAG, "onRegisterStatus " + registerStatus);
        //新版订阅回调
    }

    @Override
    public void onUnRegisterStatus(Context context,UnRegisterStatus unRegisterStatus) {
        Log.i(TAG,"onUnRegisterStatus "+unRegisterStatus);
        //新版反订阅回调
    }

    @Override
    public void onSubTagsStatus(Context context,SubTagsStatus subTagsStatus) {
        Log.i(TAG, "onSubTagsStatus " + subTagsStatus);
        //标签回调
    }

    @Override
    public void onSubAliasStatus(Context context,SubAliasStatus subAliasStatus) {
        Log.i(TAG, "onSubAliasStatus " + subAliasStatus);
        //别名回调
    }
    @Override
    public void onNotificationArrived(Context context, String title, String content, String selfDefineContentString) {
       //通知栏消息到达回调
       DebugLogger.i(TAG,"onNotificationArrived title "+title + "content "+content + " selfDefineContentString "+selfDefineContentString);
    }

    @Override
    public void onNotificationClicked(Context context, String title, String content, String selfDefineContentString) {
       //通知栏消息点击回调
       DebugLogger.i(TAG,"onNotificationClicked title "+title + "content "+content + " selfDefineContentString "+selfDefineContentString);
    }

    @Override
    public void onNotificationDeleted(Context context, String title, String content, String selfDefineContentString) {
       //通知栏消息删除回调;flyme6以上不再回调
       DebugLogger.i(TAG,"onNotificationDeleted title "+title + "content "+content + " selfDefineContentString "+selfDefineContentString);
    }    

 }

二. 调用新版注册

Note: 至此pushSDK 已经集成完毕,现在你需要在你的Application中调用新版的register方法

/**
  * @param context
  * @param appId
  *         push 平台申请的应用id
  * @param appKey
  *         push 平台申请的应用key
  **/
  public static void register(Context context,String appId,String appKey);

并在你的Receiver中成功回调onRegisterStatus(RegisterStatus registerStatus)方法就可以了, 你现在可以到新版Push平台 找到你的应用推送消息就可以了;以下内容是pushSDK提供的api汇总,具体功能详见api具体说明,请根据需求选用合适的功能

三. 通知栏图标设置

/**
  * 获取smallicon
  * */
  public void onUpdateNotificationBuilder(PushNotificationBuilder pushNotificationBuilder){
     //设置通知栏弹出的小图标
     pushNotificationBuilder.setmStatusbarIcon(R.drawable.mz_push_notification_small_icon);
  };

Note: Flyme6新的通知栏中心需要按照名称来获取状态栏Icon,你需要在相应的drawable不同分辨率文件夹下放置一个名称为mz_push_notification_small_icon的状态栏图标文件,请确保名称正确,否则将无法正确显示你应用的状态栏图标