全部产品

Android SDK配置(V3.0.0及以上版本)

更新时间:2020-11-27 15:35:13

本章节介绍移动推送Android SDK V3.0.0及以上版本的集成操作。

前提条件

样例代码

移动推送服务Android SDK接入工程样例参见:移动推送Android Demo

集成步骤

  1. 添加依赖

    注意

    • 使用移动推送Android SDK 3.2.0或以上版本,需同时将辅助通道SDK版本升级到3.2.0或以上版本。

    • Maven库快速集成,配置简单,不容易出问题,后续更新方便,建议开发者采用此方式进行集成。

    1. 方式一:Maven快速添加

      在Project根目录build.gradle项目文件中进以下配置:

      1. 在repositories{}代码段中配置maven仓库地址。

        allprojects {
            repositories {
                jcenter()
                maven {
                    url 'http://maven.aliyun.com/nexus/content/repositories/releases/'
                }
            }
        }
      2. 在android{}代码段中配置应用包名和NDK。

        android {
            ......
            defaultConfig {
                applicationId "com.xxx.xxx" //包名
                ......
                ndk {
                    //选择要添加的对应cpu类型的.so库。
                    abiFilters 'armeabi', 'x86'
                }
                ......
            }
            ......
        }

        错误处理:如果在添加以上abFilter配置后Android Studio出现以下提示:

        NDK integration is deprecated in the current plugin. Consider trying the new experimental plugin.

        则在Project根目录的gradle.properties文件中添加:

        android.useDeprecatedNdk=true

      3. 在dependencies{}代码段中添加SDK依赖。

        说明

        以下代码为示例代码,请参考Android SDK版本说明使用最新SDK依赖版本。

        dependencies {
            ......
            compile 'com.aliyun.ams:alicloud-android-push:3.x.x'
            // 或
            compile 'com.aliyun.ams:alicloud-android-push:3.x.x@aar'
            compile 'com.aliyun.ams:alicloud-android-utdid:2.x.x-proguard'
            compile 'com.aliyun.ams:alicloud-android-utils:1.x.x.x'
            compile 'com.aliyun.ams:alicloud-android-ut:5.x.x'
            compile 'com.aliyun.ams:alicloud-android-beacon:1.x.x.x'
            compile 'com.aliyun.ams:alicloud-android-agoo:4.x.x-emas'
            compile 'com.taobao.android:accs_sdk_taobao:4.x.x-emas'
            compile 'com.taobao.android:networksdk:3.x.x.x-open'
            compile 'com.taobao.android:tnet4android:3.x.x.x-all'
            ......
        }
        注意

        请使用固定版本号集成,不要使用动态版本号。错误示例:3.+或者3.2.+。

    2. 方式二:Android Studio手动集成

      解压在控制台下载的SDK包,可将所有SDK拷贝到libs目录下,同时在build.gradle文件中进行如下配置:

      说明

      以下代码为示例代码,请参考Android SDK版本说明使用最新SDK依赖版本。

          android {
          ...
          repositories {
              flatDir {
                  dirs 'libs' //this way we can find the .aar file in libs folder
              }
          }
          dependencies {
          compile fileTree(include: ['*.jar'], dir: 'libs')
          compile (name:'alicloud-android-push-3.x.x', ext: 'aar')
          compile (name:'alicloud-android-accs-4.x.x', ext: 'aar')
          // 把所有的aar都添加上
          }
    3. 方式三:EMAS统一接入

      自移动推送Android SDK V3.1.2版本开始,支持EMA统一接入功能,使用统一接入无需再在AndroidManifest文件中设置AppKey,AppSecret。具体配置可参考Emas统一接入文档(Android)

  2. AndroidManifest配置

    1. AppKey、AppSecret配置

      说明

      使用统一接入无需进行此配置。

      在AndroidManifest文件中设置AppKey、AppSecret:

      <application android:name="*****">
          <meta-data android:name="com.alibaba.app.appkey" android:value="*****"/> <!-- 请填写你自己的- appKey -->
          <meta-data android:name="com.alibaba.app.appsecret" android:value="****"/> <!-- 请填写你自己的appSecret -->
      </application>

      com.alibaba.app.appkeycom.alibaba.app.appsecret为您在EMAS平台上的App对应信息。在EMAS控制台的应用管理中或在下载的配置文件中查看AppKey和AppSecret。

      AppKey和AppSecret请务必写在application标签下,否则SDK会报找不到AppKey的错误。

      说明

      如果您是百川云推送用户,不能直接使用百川平台的AppKey和AppSecret,需要登录EMAS控制台,登录账号为您的百川平台账号,并使用阿里EMAS平台的appKeyappSecret

    2. 应用权限配置

      说明

      使用maven库快速集成可跳过此步骤。

      将以下uses-permission片段拷贝进Androidmanifest中的permission申明区域中:

      <!-- 阿里云推送相关权限 -->
      <uses-permission android:name="android.permission.INTERNET" />
      <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
      <uses-permission android:name="android.permission.WAKE_LOCK" />
      <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" /><!-- 接收推送主要权限 -->

      需要考虑是否需要声明如下权限:

      <uses-permission android:name="android.permission.GET_TASKS" /><!-- 获取近期运行任务,用于应用是否活跃的判断 -->
      <uses-permission android:name="android.permission.REORDER_TASKS" /><!-- 获取近期运行任务,用于应用是否活跃的判断 -->
      说明

      GET_TASKS & REORDER_TASKS权限说明:

      通知打开方式为打开应用时,如果有上述权限,当应用在后台时,点击通知会把已有的应用任务栈移到前台。如果没有上述权限,点击通知,某些Android会打开新界面,而不是把已有的任务栈移到前台。

    3. 消息接收Receiver配置

      创建消息接收Receiver,继承自com.alibaba.sdk.android.push.MessageReceiver,并在对应回调中添加业务处理逻辑,可参考以下代码:

      public class MyMessageReceiver extends MessageReceiver {
          // 消息接收部分的LOG_TAG
          public static final String REC_TAG = "receiver";
          @Override
          public void onNotification(Context context, String title, String summary, Map<String, String> extraMap) {
              // TODO 处理推送通知
              Log.e("MyMessageReceiver", "Receive notification, title: " + title + ", summary: " + summary + ", extraMap: " + extraMap);
          }
          @Override
          public void onMessage(Context context, CPushMessage cPushMessage) {
                  Log.e("MyMessageReceiver", "onMessage, messageId: " + cPushMessage.getMessageId() + ", title: " + cPushMessage.getTitle() + ", content:" + cPushMessage.getContent());
          }
          @Override
          public void onNotificationOpened(Context context, String title, String summary, String extraMap) {
              Log.e("MyMessageReceiver", "onNotificationOpened, title: " + title + ", summary: " + summary + ", extraMap:" + extraMap);
          }
          @Override
          protected void onNotificationClickedWithNoAction(Context context, String title, String summary, String extraMap) {
              Log.e("MyMessageReceiver", "onNotificationClickedWithNoAction, title: " + title + ", summary: " + summary + ", extraMap:" + extraMap);
          }
          @Override
          protected void onNotificationReceivedInApp(Context context, String title, String summary, Map<String, String> extraMap, int openType, String openActivity, String openUrl) {
              Log.e("MyMessageReceiver", "onNotificationReceivedInApp, title: " + title + ", summary: " + summary + ", extraMap:" + extraMap + ", openType:" + openType + ", openActivity:" + openActivity + ", openUrl:" + openUrl);
          }
          @Override
          protected void onNotificationRemoved(Context context, String messageId) {
              Log.e("MyMessageReceiver", "onNotificationRemoved");
          }
      }

      将该receiver添加到AndroidManifest.xml文件中:

      <!-- 消息接收监听器 (用户可自主扩展) -->
      <receiver
          android:name=".MyMessageReceiver"
          android:exported="false"> <!-- 为保证receiver安全,建议设置不可导出,如需对其他应用开放可通过android:permission进行限制 -->
          <intent-filter>
              <action android:name="com.alibaba.push2.action.NOTIFICATION_OPENED" />
          </intent-filter>
          <intent-filter>
              <action android:name="com.alibaba.push2.action.NOTIFICATION_REMOVED" />
          </intent-filter>
          <intent-filter>
              <action android:name="com.alibaba.sdk.android.push.RECEIVE" />
          </intent-filter>
      </receiver>
      注意

      旧版本 SDK集成说明:

      如果是从如果是从V2.3.7及以下版本升级到V3.0.0及以上版本的用户,需将<action android:name="org.agoo.android.intent.action.RECEIVE" />改为<action android:name="com.alibaba.sdk.android.push.RECEIVE" />,否则会接收不到推送。

    4. Android 8+适配

      请参见Android 8.0以上设备接收不到推送通知

  3. 混淆配置

    如果您的项目中使用Proguard等工具做了代码混淆,请保留以下配置:

    -keepclasseswithmembernames class ** {
        native <methods>;
    }
    -keepattributes Signature
    -keep class sun.misc.Unsafe { *; }
    -keep class com.taobao.** {*;}
    -keep class com.alibaba.** {*;}
    -keep class com.alipay.** {*;}
    -keep class com.ut.** {*;}
    -keep class com.ta.** {*;}
    -keep class anet.**{*;}
    -keep class anetwork.**{*;}
    -keep class org.android.spdy.**{*;}
    -keep class org.android.agoo.**{*;}
    -keep class android.os.**{*;}
    -keep class org.json.**{*;}
    -dontwarn com.taobao.**
    -dontwarn com.alibaba.**
    -dontwarn com.alipay.**
    -dontwarn anet.**
    -dontwarn org.android.spdy.**
    -dontwarn org.android.agoo.**
    -dontwarn anetwork.**
    -dontwarn com.ut.**
    -dontwarn com.ta.**
  4. SDK初始化配置

    首先通过PushServiceFactory获取到CloudPushService,然后调用register()初始化并注册推送通道,并确保在Application上下文中进行初始化工作。

    请参照以下代码进行初始化:

    import android.app.Application;
    import android.content.Context;
    import android.util.Log;
    import com.alibaba.sdk.android.push.CloudPushService;
    import com.alibaba.sdk.android.push.CommonCallback;
    import com.alibaba.sdk.android.push.noonesdk.PushServiceFactory;
    public class MainApplication extends Application {
        private static final String TAG = "Init";
        @Override
        public void onCreate() {
            super.onCreate();
            initCloudChannel(this);
        }
        /**
         * 初始化云推送通道
         * @param applicationContext
         */
        private void initCloudChannel(Context applicationContext) {
            PushServiceFactory.init(applicationContext);
            CloudPushService pushService = PushServiceFactory.getCloudPushService();
            pushService.register(applicationContext, new CommonCallback() {
                @Override
                public void onSuccess(String response) {
                    Log.d(TAG, "init cloudchannel success");
                }
                @Override
                public void onFailed(String errorCode, String errorMessage) {
                    Log.d(TAG, "init cloudchannel failed -- errorcode:" + errorCode + " -- errorMessage:" + errorMessage);
                }
            });
        }
    }
    注意

    移动推送的初始化必须在Application主线程中,不能放到Activity中执行,也不能异步初始化。移动推送在初始化过程中将启动后台进程channel,必须保证应用进程和channel进程都执行到推送初始化代码。详情请参见Android SDK中CloudPushService应该怎样初始化?

  5. 初始化成功验证

    启动正常确认方法:

    • 回调方法callback.onSuccess()被调用。以上文中接入代码为例,logcat将会打印如下日志:

      11-24 12:55:51.096  15235-15535/com.alibaba.xxxx D/YourApp﹕ init cloudchannel success
    • 确认cloudchannel初始化正常,在logcat日志中,输入awcn关键字:

      11-24 12:53:51.036  15235-15556/com.alibaba.xxxx E/awcn﹕ |[seq:AWCN1_1] AUTH httpStatusCode: 200
      11-24 12:53:51.036  15235-15556/com.alibaba.xxxx E/awcn﹕ |[seq:AWCN1_1] status:AUTH_SUCC
    • 确认DeviceId获取正常:在初始化成功后使用cloudPushService.getDeviceId()可以唱功获取deviceId。

    • 如果注册服务器连接失败,则调用callback.onFailed方法,并且自动进行重新注册,直到onSuccess为止(重试规则会由网络切换等时机自动触发)。在onFailed方法中,会由相应的错误码返回,可参考错误处理

    说明

    市场上部分手机,对Log显示做了限制,比如华为手机,屏蔽了Debug和Verbose级别的日志;建议开发时使用Info级别日志。日志级别设置请参考Android SDK API介绍>设置日志等级

常见集成问题

  1. UTDID冲突,可参考:阿里云-移动云产品SDK UTDID冲突解决方案

  2. 集成Android SDK后运行App报java.lang.NoClassDefFoundError该如何解决?

  3. Android端SDK集成失败排查

  4. 初推送SDK在初始化时报错

  5. Android SDK初始化时报1105、10207报错

  6. 在Activity中初始化推送SDK,无法接收到推送通知