小米辅助推送集成-个推文档中心

当前位置：厂商推送文档 > 客户端接入文档 > XM集成文档

小米辅助推送集成

目录
    前言
    1. 准备阶段
        1.1 创建小米应用
        1.2 开通权限和应用配置
            1.2.1 基础配置
            1.2.2 高级配置
    2. 添加辅助 SDK 及相关配置  
        2.1 Maven 自动导入  
            2.1.1 添加 Maven 库地址  
            2.1.2 配置相关依赖  
        2.2 手动导入  
            2.2.1 导入辅助 SDK  
            2.2.2 配置辅助 SDK 相关参数  
    3. Proguard 混淆配置

前言

本文档介绍 Android Studio 开发环境下手动方式导入 SDK 资源和 Maven 自动导入 SDK 资源进行多厂商推送 SDK 集成的步骤，配置相对复杂，需要仔细阅读文档和 Demo 工程

说明

辅助推送：个推推送针对小米设备管控较严的情况特意接入小米推送作为辅助通道以提高在小米设备上的到达率。个推推送优先选择个推通道进行消息下发，只有在个推通道断连时选择辅助通道下发消息。
辅助推送启用条件：小米 rom 且小米服务框架（包名：com.xiaomi.xmsf）版本号大于等于 105
功能接口对辅助 SDK 的差异处理

| API 接口 | 小米辅助 SDK |
| ------| ------ |
| stopService(Context context)| 不会停止小米辅助 SDK |
手动导入可参考 Getui_SDK_Demo_AS_manufacture Demo 工程
本文默认您已经完成了个推推送 SDK 的集成以及掌握了基本的 Android 基础知识

本文假设您的工程项目结构为

Getui_SDK_Demo_AS_manufacture/
|- app/ （项目主模块）
|    |- libs/ （第三方库）
|    |- src/ （代码目录）
|    |- build.gradle （模块级 gradle 文件）
|- gradle/
|- build.gradle （顶层 gradle 文件）
|- settings.gradle
| ......

注：其中 “......” 表示省略其他与本教程无关的配置内容，以下 “......” 表示相同意义，不再重复说明。

1. 准备阶段

说明：该阶段主要介绍了如何创建小米应用及开通相关的应用权限配置，如果您已经完成该阶段，可以直接进入下一阶段。

1.1 创建小米应用

登录小米开放平台申请开发者帐号：
进入管理控制台->消息推送：
选择创建手机/平板应用：
填写应用名称和应用包名创建应用
勾选我同意接受小米推送的接入合作协议复选框，点击启用按钮：
查看应用信息，获取小米 AppID、小米 AppKey、小米 AppSecret：

1.2 开通权限和应用配置

1.2.1 基础配置

联系个推客服开通多厂商推送功能
在开发者中心中填写小米 AppID、小米 AppSecret：

1.2.2 高级配置

如果当前用户是集成个推客户端 SDK 并且配置了静默时间的用户，在基础配置信息填写完毕的同时需要配置高级设置
该高级设置是为了一些多厂商通道不支持客户端 SDK 静默而做的服务端配置

注意：

1、静默时间是统一设置，如用户开通其他厂商通道，将统一更新静默时间。
2、该时间必须同个推 SDK 配置静默时间一致。
3、在设定时间范围内，将不对用户进行消息下发。

2. 添加辅助 SDK 及相关配置

注：该步骤有俩种实现方式，可以使用 maven 库自动导入方式（推荐）或者手动导入方式，俩者选一即可。

2.1 Maven 自动导入

2.1.1 添加 Maven 库地址

在以项目名为命名的顶层 build.gradle 文件的 allprojects.repositories 中，添加个推 maven 库地址 http://mvn.gt.igexin.com/nexus/content/repositories/releases/ 如下所示：

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

allprojects {
    repositories {
        jcenter()
        //添加 Maven URL 地址
        maven {
            url "http://mvn.gt.igexin.com/nexus/content/repositories/releases/"
        }
    }
}

2.1.2 配置相关依赖

该步骤需要在模块级别 app/build.gradle 中配置个推辅助推送应用参数以及对应的 SDK 依赖库，主要分为俩步骤：

在 app/build.gradle文件中的 dependencies 块中引用个推辅助 SDK 依赖库 com.getui:xmp:${version} ，此处的 ${version} 对应您当前获取到相应的 SDK 版本号，如下所示：


......

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation 'com.getui:xmp:${version}'  //请将此处的 ${version} 替换成您当前相应的 SDK 版本号
    ......
}

在 app/build.gradle 文件中的 android.defaultConfig 块中添加 manifestPlaceholders 块，配置个推辅助推送相关的应用参数（参见【步骤 1】准备阶段），如下 manifestPlaceholders 中的内容所示：

......

android {

    defaultConfig {
        ......

        manifestPlaceholders = [

                //小米相关应用参数，请填写您获取到的 XIAOMI_APP_ID，XIAOMI_APP_KEY 值
                XIAOMI_APP_ID : "",  
                XIAOMI_APP_KEY : "", 

                ......

        ]
        ......
    }

}

......

请根据【步骤 1】获取到的应用参数填写相应 XIAOMI_APP_ID、XIAOMI_APP_KEY 的值，最终的 app/build.gradle 文件的大致结构如下：

......

android {

    defaultConfig {
        ......

        manifestPlaceholders = [
                //个推应用参数，请填写您获取到的应用参数值
                GETUI_APP_ID : "", 
                GETUI_APP_KEY : "",
                GETUI_APP_SECRET : "",

                //小米相关应用参数，请填写您获取到的 XIAOMI_APP_ID，XIAOMI_APP_KEY 值
                XIAOMI_APP_ID : "",  
                XIAOMI_APP_KEY : "", 

                ......

        ]

        ndk {
            abiFilters "armeabi", "armeabi-v7a", "x86_64", "x86"
        }

    }

    packagingOptions {
        exclude 'META-INF/LICENSE.txt'
        exclude 'META-INF/NOTICE.txt'
    }

}

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation 'com.getui:xmp:${version}'  //请将此处的 ${version} 替换成您当前相应的 SDK 版本号
    ......
}

2.2 手动导入

手动导入主要分为导入辅助 SDK 和配置辅助 SDK 参数俩步骤，详细步骤见下文：

2.2.1 导入辅助 SDK

下载辅助 SDK 资料包，辅助 SDK 资料包结构如下：

GETUI_ANDROID_XM_SUPPORT/
  |- readme.txt （SDK 资料包说明）
  |- 接入文档/ (Android SDK 相关集成文档 PDF 版本）
  |- 资源文件/
  |    |- GetuiSDK-support-XMP-<version>.jar （其中<version> 代表对应的版本号）
  | - Demo 工程/
  |    |- Getui_SDK_Demo_AS_manufacture/ （AndroidStudio 多厂商推送集成 Demo 工程）

导入辅助 SDK

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

将 SDK 资料包 GETUI_ANDROID_XM_SUPPORT/ 资源文件目录下的 GetuiSDK-support-XMP-<version>.jar 复制到 app 模块目录下的 libs 文件夹中，结构如下所示：
```
Getui_SDK_Demo_AS_manufacture/
  |- app/
  |    |- libs/
  |       |- GetuiSDK-support-XMP-<version>.jar 
  | ......
```
打开 app/build.gradle，在 dependencies 块中添加 implementation fileTree(dir: 'libs', include: ['*.jar']) 引用相应的 jar 包：
```
 ......

dependencies {
    // 该行配置将会编译 libs 目录下的所有 jar 文件
    implementation fileTree(dir: 'libs', include: ['*.jar'])

    ......
}
```

2.2.2 配置辅助 SDK 相关参数

配置应用参数

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

android {

    defaultConfig {
        ......

        manifestPlaceholders = [

                ......

                //小米相关应用参数，请填写您获取到的 XIAOMI_APP_ID，XIAOMI_APP_KEY 值
                XIAOMI_APP_ID : "",  
                XIAOMI_APP_KEY : "", 

        ]
    }

    ......
}
......

请根据【步骤 1】获取到的应用参数填写相应 XIAOMI_APP_ID、XIAOMI_APP_KEY 的值，最终的 app/build.gradle 文件的大致结构如下：

android {

    defaultConfig {
        ......

        manifestPlaceholders = [
                //个推应用参数，请填写您获取到的应用参数值
                GETUI_APP_ID : "", 
                GETUI_APP_KEY : "",
                GETUI_APP_SECRET : "",

                //小米相关应用参数，请填写您获取到的 XIAOMI_APP_ID，XIAOMI_APP_KEY 值
                XIAOMI_APP_ID : "",  
                XIAOMI_APP_KEY : "", 

                ......

        ]

        ndk {
            abiFilters "armeabi", "armeabi-v7a", "x86_64", "x86"
        }

    }

    buildTypes {
        release {
            minifyEnabled true
            shrinkResources true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        }
    }

}

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

在 Manifest 中配置辅助 SDK 组件

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

<!-- 小米辅助 SDK -->
<meta-data
    android:name="MIPUSH_APPID"
    android:value="XM_${XIAOMI_APP_ID}" />
<meta-data
    android:name="MIPUSH_APPKEY"
    android:value="XM_${XIAOMI_APP_KEY}" />

<service
    android:name="com.xiaomi.mipush.sdk.PushMessageHandler"
    android:enabled="true"
    android:exported="true"
    android:process=":pushservice" />

<service
    android:name="com.xiaomi.mipush.sdk.MessageHandleService"
    android:enabled="true"
    android:process=":pushservice" />

<receiver
    android:name="com.igexin.sdk.MiuiPushReceiver"
    android:exported="true"
    android:process=":pushservice">
    <intent-filter>
        <action android:name="com.xiaomi.mipush.RECEIVE_MESSAGE" />
    </intent-filter>
    <intent-filter>
        <action android:name="com.xiaomi.mipush.MESSAGE_ARRIVED" />
    </intent-filter>
    <intent-filter>
        <action android:name="com.xiaomi.mipush.ERROR" />
    </intent-filter>
</receiver>

添加权限声明

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

<!-- 小米辅助 SDK -->
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.GET_TASKS" />
<uses-permission android:name="android.permission.VIBRATE" />

<permission
    android:name="${applicationId}.permission.MIPUSH_RECEIVE"
    android:protectionLevel="signature" />

<uses-permission android:name="${applicationId}.permission.MIPUSH_RECEIVE" />

3. Proguard 混淆配置

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

-dontwarn com.xiaomi.**
-keep class com.xiaomi.** { *; }

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

当前位置：厂商推送文档 > 客户端接入文档 > XM集成文档