使用提示
本文是 Android SDK 标准的集成指南文档。
匹配的 SDK 版本为:r1.8.0及以后版本。
本文随SDK压缩包分发。在你看到本文时,可能当前的版本与本文已经不是很适配。所以建议关注在线文档:
- 3 分钟快速 Demo(Android):如果您想要快速地测试、感受下极光推送的效果,请参考本文在几分钟内跑通Demo。
- 极光推送文档网站上,有极光推送相关的所有指南、API、教程等全部的文档。包括本文档的更新版本,都会及时地发布到该网站上。
- 极光推送问答网站:大家除了文档之外,还有问题与疑问,会到这里来提问题,以及时地得到解答。
- 如果您看到本文档,但还未下载Android SDK,请访问SDK下载页面下载。
产品功能说明
极光推送(JPush)是一个端到端的消息推送服务,使得服务器端消息能够及时地推送到终端用户手机上,让开发者积极地保持与用户的连接,从而提高用户活跃度、提高应用的留存率。极光推送客户端支持 Android, iOS 两个平台。
本 Android SDK 方便开发者基于 JPush 来快捷地为 Android App 增加推送功能。
主要功能
- 保持与服务器的长连接,以便消息能够即时推送到达客户端
- 接收通知与自定义消息,并向开发者App 传递相关信息
主要特点
- 客户端维持连接占用资源少、耗电低
- SDK丰富的接口,可定制通知栏提示样式
- 服务器大容量、稳定
jpush-sdk_v1.x.y.zip 集成压缩包内容
- AndoridManifest.xml
- 客户端嵌入SDK参考的配置文件
- libs/jpush-sdk-release1.x.y.jar
- SDK Java 开发包
- libs/armeabi/libjpush.so
- SDK native 开发包
- res
- 集成SDK必须添加的资源文件
- example
- 是一个完整的 Android 项目,通过这个演示了 JPush SDK 的基本用法,可以用来做参考。
Android SDK 版本
目前SDK只支持Android 2.1或以上版本的手机系统。富媒体信息流功能则需Android3.0或以上版本的系统。
SDK集成步骤
1、导入 SDK 开发包到你自己的应用程序项目
- 解压缩 jpush-sdk_v1.x.y.zip 集成压缩包
- 复制 libs/jpush-sdk-release1.x.y.jar 到工程 libs/ 目录下
- 复制 libs/armeabi/libjpush1xy.so 到工程 libs/armeabi 目录下
- 复制 libs/armeabi-v7a/libjpush.so 到工程 libs/armeabi-v7a 目录下
如果您的项目有 libs/armeabi-v7a 这个目录,请把 libs/armeabi-v7a下的so文件 也复制一份到这个目录。
- 复制 res/drawable-hdpi 中的资源文件到工程的 res/drawable-hdpi/ 目录下
- 复制 res/layout 中的布局文件到工程的 res/layout/ 目录下
2、配置 AndroidManifest.xml
根据 SDK 压缩包里的 AndroidManifest.xml 样例文件,来配置应用程序项目的 AndroidManifest.xml 。
主要步骤为:
- 复制备注为 "Required" 的部分
- 将备注为替换包名的部分,替换为当前应用程序的包名
- 将AppKey替换为在Portal上注册该应用的的Key,例如(9fed5bcb7b9b87413678c407)
AndroidManifest.xml权限配置:
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="Your Package"
android:versionCode="100"
android:versionName="1.0.0"
>
<uses-sdk android:minSdkVersion="11" android:targetSdkVersion="17" />
<!-- Required -->
<permission android:name="Your Package.permission.JPUSH_MESSAGE" android:protectionLevel="signature" />
<!-- Required -->
<uses-permission android:name="You Package.permission.JPUSH_MESSAGE" />
<uses-permission android:name="android.permission.RECEIVE_USER_PRESENT" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WAKE_LOCK" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-