Android Studio标准集成-个推文档中心

当前位置：个推文档 > 客户端 > OTT > Android Studio标准集成

Android Studio标准集成

关于Android Studio

Android Studio是Google力推的Android开发环境，在IntelliJ IDEA基础上进行了大量功能完善和优化，包括：

基于Gradle的构建支持
Android 专属的重构工具和Instant Run快速修复技术
功能强大的布局编辑器，可以让你拖拉 UI 控件并进行效果预览
全新的 Android 模拟器大约比之前的模拟器快 3 倍，同时由于 ADB 的增强，传输应用和数据到模拟器上的速度比到物理设备上快 10 倍。
提供性能分析工具以捕获性能、可用性、版本兼容性等问题

因此我们强烈推荐Android开发者将现有项目迁移到Android Studio环境，并在Android Studio下更快地实现个推SDK的集成工作。

前言

**本文档介绍Android Studio开发环境下手动方式导入SDK资源进行集成的步骤，配置相对复杂，需要仔细阅读文档和Demo工程。
请参考Getui_SDK_Demo_AS_officialDemo工程

1. 创建个推应用

进入“开发者中心-应用管理”，点击“创建应用”

dev-center-add-app

填写信息

dev-center-add-app

点击应用配置，获取到相应的AppID、AppKey、AppSecret信息：

dev-center-add-app

2. 打开项目工程

启动Android Studio, 打开您之前创建的Android项目工程：

img_as_open

如果需要从原有的Eclipse项目导入，请选择Import project (Eclipse ADT, Gradle, etc.)：

img_as_import

3. 添加个推SDK及相关配置

一、为兼容Android9.0，务必在application节点添加android:usesCleartextTraffic="true"

3.1 个推Android SDK资料包结构

GETUI_ANDROID_SDK/
  |- readme.txt （SDK资料包说明）
  |- 接入文档/ (Android SDK相关集成文档PDF版本)
  |- 资源文件/
  |    |- res/
  |    |    |- layout/
  |    |    |    |- getui_notification.xml (个推SDK所需的布局文件)
  |    |    |- raw
  |    |    |    |- keep.xml （用于资源保留的描述文件）
  |    |- so/ （各 CPU 架构so库）
  |    |   |- arm64-v8a/
  |    |   |- armeabi/
  |    |   |- armeabi-v7a/
  |    |   |- mips/
  |    |   |- mips64/
  |    |   |- x86/
  |    |   |- x86_64/
  |    |- GTSDK-OTT-1.0.0.jar
  | - Demo工程/
  |    |- Getui_SDK_Demo_AS_official/ （AndroidStudio标准集成Demo工程）

3.2 导入个推SDK

以下集成步骤假设项目主模块名为app

将SDK资料包GETUI_ANDROID_SDK/资源文件目录下的GTSDK-OTT-xxx.jar复制到app模块目录下的libs文件夹中，如下图所示：

img_as_jar

打开app/build.gradle，在dependencies中添加相应的jar包的引用：

dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
}

3.3 导入个推so库

目前个推SDK支持armeabi、armeabi-v7a、arm64-v8a、mips、mips64、x86、x86_64这几种 CPU 架构，请根据项目情况指定所需的架构。

如果项目中包含的其他 so 库只支持其中某几种 cpu 架构，那么应该根据其他 so 库所支持的 CPU 架构的最小集来配置。否则如果在特定架构上未能支持所有 so 库，则很可能导致程序运行异常。切记！

将SDK资料包中GETUI_ANDROID_SDK/资源文件/so目录下所需CPU架构的目录拷贝到app/src/main/jniLibs目录下，如图所示：

img_as_so

如果将 so 库放置在app/src/main/jniLibs以外的其他目录，请在app/build.gradle文件中的android段内正确设置 so 路径。假设 so 路径为app/libs，则需添加如下配置代码：

sourceSets {
    main {
      jniLibs.srcDirs = ['libs']
    }
}

3.4 导入布局文件

为了支持最新的展开式样式和浮动通知，必须使用最新的getui_notification.xml布局文件

将SDK资料包中GETUI_ANDROID_SDK/资源文件/layout目录下的getui_notification.xml布局文件复制到app/src/main/res/layout目录下，如下图所示：

img_as_layout

3.5 配置个推应用参数

为了进一步降低个推SDK集成难度、减少错误发生几率,我们推荐应用开发者采用manifestPlaceholders来配置Manifest文件，避免手动替换参数可能导致的问题。

在app/build.gradle文件中的android.defaultConfig下添加manifestPlaceholders，配置个推相关的应用参数（参见【步骤1】），如下图所示：

img_as_param

manifestPlaceholders = [
    GETUI_APP_ID : "APP_ID",
    GETUI_APP_KEY : "APP_KEY",
    GETUI_APP_SECRET : "APP_SECRET"
]

请根据【步骤1】获取到的应用参数进行相应替换APP_ID、APP_KEY、APP_SECRET的值

3.6 在Manifest中配置个推SDK组件

在AndroidManifest.xml中需要正确配置个推SDK所需的Service、Activity、以及BroadcastReceiver等组件。请在<application>标签内增加以下组件配置（由于使用了manifestPlaceholders来做参数替换，因此以下配置无需手工修改，直接复制粘贴即可）：

<!-- 个推SDK配置开始 -->
<!-- Android9.0以上默认不支持http通信，为保证SDK正常使用，请在application节点下新增该属性 -->
<application android:usesCleartextTraffic="true">

<!-- 配置的第三方参数属性 -->
<meta-data
    android:name="PUSH_APPID"
    android:value="${GETUI_APP_ID}" />
<meta-data
    android:name="PUSH_APPKEY"
    android:value="${GETUI_APP_KEY}" />
<meta-data
    android:name="PUSH_APPSECRET"
    android:value="${GETUI_APP_SECRET}" />

<!-- 配置SDK核心服务 -->
<service
    android:name="com.igexin.sdk.PushCoreService"
    android:permission="android.permission.BIND_JOB_SERVICE"
    android:exported="false"
    android:label="NotificationCenter"
    android:process=":pushservice">
    <intent-filter>
        <action android:name="com.igexin.sdk.action.service.message"/>
    </intent-filter>
</service>

<receiver android:name="com.igexin.sdk.PushReceiver" >
    <intent-filter>
        <action android:name="android.intent.action.BOOT_COMPLETED" />
        <action android:name="android.net.conn.CONNECTIVITY_CHANGE" />
        <action android:name="android.intent.action.USER_PRESENT" />
        <!-- 以下三项为可选的action声明，可大大提高service存活率和消息到达速度 -->
        <action android:name="android.intent.action.MEDIA_MOUNTED" />
        <action android:name="android.intent.action.ACTION_POWER_CONNECTED" />
        <action android:name="android.intent.action.ACTION_POWER_DISCONNECTED" />
    </intent-filter>
</receiver>

<!-- 个推SDK配置结束 -->

3.7 添加权限声明

请在<manifest>根标签下加入个推SDK所必需的权限，配置如下（由于使用了manifestPlaceholders来做参数替换，因此以下配置无需手工修改，直接复制粘贴即可）：


<!-- 个推SDK权限配置开始 -->
<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.CHANGE_WIFI_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.VIBRATE" />
<uses-permission android:name="android.permission.GET_TASKS" />
<!-- 支持iBeancon 需要蓝牙权限 -->
<uses-permission android:name="android.permission.BLUETOOTH" />
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
<!-- 支持个推3.0 电子围栏功能 -->
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<!-- 浮动通知权限 -->
<uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" />

<!-- 自定义权限 -->
<uses-permission android:name="getui.permission.GetuiService.${applicationId}" />

<permission
    android:name="getui.permission.GetuiService.${applicationId}"
    android:protectionLevel="normal"></permission>
<!-- 个推SDK权限配置结束 -->

3.8 配置可选权限

上述接入方式已包含个推服务所需的所有必备权限。在此之外，您还可以配置以下可选权限，以便使用个推3.0提供的电子围栏功能。请在AndroidManifest.xml的<manifest>根标签下添加如下配置：

<!-- iBeancon功能所需权限 -->;
<uses-permission android:name="android.permission.BLUETOOTH"/>
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN"/>
<!-- 个推3.0电子围栏功能所需权限 -->
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />

3.9 导入通知栏图标

为了修改默认的通知图标以及通知栏顶部提示小图标，请在资源目录的res/drawable-ldpi/、res/drawable-mdpi/、res/drawable-hdpi/、res/drawable-xhdpi/、res/drawable-xxhdpi/等各分辨率目录下，放置相应尺寸的文件名为push.png和push_small.png图片，如图所示：

建议的push.png图片尺寸如下：

ldpi:    48*48
mdpi:    64*64
hdpi:    96*96
xhdpi:   128*128
xxhdpi:  192*192

该图标push.png将会作为通知图标，如下所示：

img_asmv_pushicon

建议的push_small.png图片尺寸如下：

ldpi:    18*18
mdpi:    24*24
hdpi:    36*36
xhdpi:   48*48
xxhdpi:  72*72
xxxhdpi:  96*96

该图标push_small.png将会作为通知图标展示在通知栏顶部，如下所示：
push_small.png设计规范请参考状态栏图标设计规范

img_as_small_icon

3.10 Proguard混淆配置

如果您的工程启用了Proguard混淆，即如果在app/build.gradle的android.buildTypes.release下配置了minifyEnabled true，为了避免个推SDK被错误混淆导致功能异常，需要在app/proguard-rules.pro混淆配置文件中添加如下配置：

-dontwarn com.igexin.**
-keep class com.igexin.** { *; }
-keep class org.json.** { *; }

img_as_proguard

3.11 资源精简配置

如果您的工程启用了资源精简，即如果在app/build.gradle的android.buildTypes.release下配置了shrinkResources true，为了避免个推SDK所需资源被错误精简导致功能异常，需要在项目资源目录res/raw中添加keep.xml文件，内容如下：

img_as_keep

在SDK资料包中GETUI_ANDROID_SDK/资源文件/raw目录下有keep.xml示例文件，完整内容如下：

<?xml version="1.0" encoding="utf-8"?>
<resources
    xmlns:tools="http://schemas.android.com/tools"
    tools:keep="@layout/getui_notification,
    @drawable/push,
    @drawable/push_small"/>
    <!-- 若您需要使用其他自定义推送图标，也需要在此处添加 -->

如果你的项目工程已经使用了keep.xml，则只需在tools:keep中增加对@layout/getui_notification的声明，例如：

<?xml version="1.0" encoding="utf-8"?>
<resources
    xmlns:tools="http://schemas.android.com/tools"
    tools:keep="@layout/other_res,...,
    @layout/getui_notification,
    @drawable/push,
    @drawable/push_small"/>
    <!-- 若您需要使用其他自定义推送图标，也需要在此处添加 -->

如果您的工程使用了AndResGuard进行资源精简，为了避免个推SDK所需资源被错误精简导致功能异常，需要为个推添加白名单配置。

gradle集成AndResGuard的方式，需要您在andResGuard的whiteList节点下添加如下代码:

andResGuard {
    ...
    whiteList = [
           ...
           // for getui
           "R.drawable.push",        
           "R.drawable.push_small",
           "R.layout.getui_notification",
           "R.id.getui_*"
           // 若您需要使用其他自定义推送图标，也需要在此处添加
    ]
    ...
}

命令行使用AndResGuard的方式，需要您在config.xml文件中的<issue id=whitelist>节点下添加如下代码

<issue id="whitelist" isactive="true">
    <path value="<your_package_name>.R.drawable.push"/>
    <path value="<your_package_name>.R.drawable.push_small"/>
    <path value="<your_package_name>.R.layout.getui_notification"/>
    <path value="<your_package_name>.R.id.getui_*"/>
    <!-- 若您需要使用其他自定义推送图标，也需要在此处添加 -->
</issue>

4. 编写集成代码

4.1 初始化SDK

我们建议应用开发者在Activity或Service类中调用个推SDK的初始化方法，确保SDK在各种情况下都能正常运行。一般情况下可以在主Activity的onCreate()或者onResume()方法中调用，也可以在多个主要界面Activity的onCreate()或onResume()方法中调用。反复调用SDK初始化并不会有什么副作用。

在应用的 Activity 里导入PushManager类，如下所示：

import com.igexin.sdk.PushManager;

然后在 Activity 的onCreate()或者onResume()方法中调用个推SDK初始化方法。如果使用了自定义推送服务，初始化方法还需要传入新的自定义推送服务名：

// com.getui.demo.DemoPushService 为第三方自定义推送服务
PushManager.getInstance().initialize(getApplicationContext());

4.2 接收推送服务事件

为了解决小概率发生的Android广播丢失问题，我们推荐应用开发者使用新的IntentService方式来接收推送服务事件（包括CID获取通知、透传消息通知等）

在项目源码中添加一个继承自com.igexin.sdk.GTIntentService的类，用于接收CID、透传消息以及其他推送服务事件。请参考下列代码实现各个事件回调方法：

package com.getui.demo;

import android.content.Context;
import android.os.Message;
import android.util.Log;

import com.igexin.sdk.GTIntentService;
import com.igexin.sdk.PushConsts;
import com.igexin.sdk.PushManager;
import com.igexin.sdk.message.FeedbackCmdMessage;
import com.igexin.sdk.message.GTCmdMessage;
import com.igexin.sdk.message.GTTransmitMessage;
import com.igexin.sdk.message.SetTagCmdMessage;

/**
 * 继承 GTIntentService 接收来自个推的消息, 所有消息在线程中回调, 如果注册了该服务, 则务必要在 AndroidManifest中声明, 否则无法接受消息<br>
 * onReceiveMessageData 处理透传消息<br>
 * onReceiveClientId 接收 cid <br>
 * onReceiveOnlineState cid 离线上线通知 <br>
 * onReceiveCommandResult 各种事件处理回执 <br>
 */
public class DemoIntentService extends GTIntentService {

    public DemoIntentService() {

    }

    @Override
    public void onReceiveServicePid(Context context, int pid) {
    }

    @Override
    public void onReceiveMessageData(Context context, GTTransmitMessage msg) {
        // 透传消息的处理，详看SDK demo
    }

    @Override
    public void onReceiveClientId(Context context, String clientid) {
        Log.e(TAG, "onReceiveClientId -> " + "clientid = " + clientid);
    }

    @Override
    public void onReceiveOnlineState(Context context, boolean online) {
    }

    @Override
    public void onReceiveCommandResult(Context context, GTCmdMessage cmdMessage) {
    }

    @Override
    public void onNotificationMessageArrived(Context context, GTNotificationMessage msg) {
    }

    @Override
    public void onNotificationMessageClicked(Context context, GTNotificationMessage msg) {   
    }
}

在AndroidManifest.xml中配置上述 IntentService 类：

<service 
    android:name="com.getui.demo.DemoIntentService"
    android:permission="android.permission.BIND_JOB_SERVICE"/>

在个推SDK初始化后，注册上述 IntentService 类：

// com.getui.demo.DemoIntentService 为第三方自定义的推送服务事件接收类
PushManager.getInstance().registerPushIntentService(getApplicationContext(), com.getui.demo.DemoIntentService.class);

关于原有广播方式和新的IntentService方式兼容性说明：

如果调用了registerPushIntentService方法注册自定义IntentService，则SDK仅通过IntentService回调推送服务事件；
如果未调用registerPushIntentService方法进行注册，则原有的广播接收器仍然可以继续使用。

5. 测试

连接手机或启动Android模拟器，编译运行你的工程，查看logcat信息。在搜索框中输入clientid，如果能显示clientid is xxx日志，则说明个推SDK已经成功运行起来了：

img_as_logcat

登录个推，点击【创建推送】，进入待测试应用的推送通知界面：

img_as_conlose

依次填写通知标题和通知内容，点击发送按钮即可向该推送应用名下所有CID推送通知消息。具体推送操作方法详见：创建推送通知
如果手机或模拟器收到消息，显示下图所示通知，那么恭喜您，个推SDK接入测试已经成功完成！

img_as_success

以上文档对您是否有帮助？

当前位置：个推文档 > 客户端 > OTT > Android Studio标准集成