使⽤用提⽰示
本⽂文是 Android SDK 标准的集成指南⽂文档。匹配的 SDK 版本为：v2.0.5 及以后版本。
本⽂文随SDK压缩包分发。在你看到本⽂文时，可能当前的版本的集成⽂文档已有更新，所以请关注在线⽂文档：
3 分钟快速 Demo（Android）：如果您想要快速地测试、感受下极光推送的效果，请参考本⽂文在⼏几分钟内跑通Demo。
极光推送⽂文档⺴⽹网站上，有极光推送相关的所有指南、API、教程等全部的⽂文档。包括本⽂文档的更新版本，都会及JPUSH_CHANNEL时地发布到该⺴⽹网站上。
极光推送问答⺴⽹网站：⼤大家除了⽂文档之外，还有问题与疑问，会到这⾥里来提问题，以及时地得到解答。如果您看到本⽂文档，但还未下载Android SDK，请访问SDK下载⻚页⾯面下载。
产品功能说明
极光推送（JPush）是⼀一个端到端的推送服务，使得服务器端消息能够及时地推送到终端⽤用户⼿手机上，让开发者积极地保持与⽤用户的连接，从⽽而提⾼高⽤用户活跃度、提⾼高应⽤用的留存率。极光推送客户端⽀支持 Android, iOS 两个平台。本 Android SDK ⽅方便开发者基于 JPush 来快捷地为 Android App 增加推送功能。
主要功能
保持与服务器的⻓长连接，以便消息能够即时推送到达客户端接收通知与⾃自定义消息，并向开发者App 传递相关信息
主要特点
客户端维持连接占⽤用资源少、耗电低
SDK丰富的接⼝口，可定制通知栏提⽰示样式服务器⼤大容量、稳定
jpush-sdk_v2.x.y.zip 集成压缩包内容
AndroidManifest_AS_Example.xml / AndroidManifest_Eclipse_Example.xml
客户端嵌⼊入SDK参考的配置⽂文件。分别对应AndroidStudio 和 Eclipse
libs/jpush-sdk-release2.x.y.jar
SDK Java 开发包
libs/armeabi（或 armeabi-v7a/arm64-v8a）/libjpush2xy.so
SDK native 开发包。分别对应arm, armv7a,armv8a(64位) 的.so⽂文件。
res/
集成SDK 必须添加的资源⽂文件
example
是⼀一个完整的 Android 项⺫⽬目，通过这个演⽰示了 JPush SDK 的基本⽤用法，可以⽤用来做参考。
Android SDK 版本
⺫⽬目前SDK只⽀支持Android 2.3 及以上版本的⼿手机系统。
富媒体信息流功能则需Android3.0或以上版本的系统。
SDK集成步骤
1、导⼊入 SDK 开发包到你⾃自⼰己的应⽤用程序项⺫⽬目
解压缩 jpush-sdk_v2.x.y.zip 集成压缩包
复制 libs/jpush-sdk-release2.x.y.jar 到⼯工程 libs/ ⺫⽬目录下
复制 libs/armeabi(和 armeabi-v7a/arm64-v8a)/中so⽂文件 到⼯工程libs/下对应的CPU⺫⽬目录下
在AndroidStudio中使⽤用，在build.gradle的sourceSets.main节点下指定jniLibs的路径。sourceSets{main {
jniLibs.srcDirs = ['libs'] // <-- Set your folder here! }}
复制 res/drawable-hdpi 中的资源⽂文件到⼯工程的 res/drawable-hdpi/ ⺫⽬目录下复制 res/layout 中的布局⽂文件到⼯工程的 res/layout/ ⺫⽬目录下
2、配置 AndroidManifest.xml
根据 SDK 压缩包⾥里的 AndroidManifest.xml 样例⽂文件，来配置应⽤用程序项⺫⽬目的 AndroidManifest.xml 。主要步骤为：
1. 复制备注为 \"Required\" 的部分
2. Eclipse的AndroidManifest中将备注为\"您应⽤用的包名\"的部分，替换为当前应⽤用程序的包名; AndroidStudio的AndroidManifest中引⽤用的是所在Module的applicationId，需在build.gradle中配置。3. 将AppKey替换为在Portal上注册该应⽤用的的Key,例如（9fed5bcb7b9b87413678c407）
Eclipse中AndoridManifest ⽰示例：
android:configChanges=\"orientation|keyboardHidden\" android:theme=\"@android:style/Theme.NoTitleBar\" android:exported=\"false\"> android:exported=\"false\" >
AndroidStudio中AndroidManifest ⽰示例：
android:configChanges=\"orientation|keyboardHidden\" android:theme=\"@android:style/Theme.NoTitleBar\" android:exported=\"false\"> android:exported=\"false\" >
其中applicationId为 build.gradle配置中 defaultConfig节点下配置，如：
defaultConfig {
applicationId \"cn.jpush.example\" // <--Your package name }
3、添加代码
JPush SDK 提供的 API 接⼝口，都主要集中在 cn.jpush.android.api.JPushInterface 类⾥里。
基础 API
init 初始化SDK
public static void init(Context context)
setDebugMode 设置调试模式
// You can enable debug mode in developing state. You should close debug mode when release.
public static void setDebugMode(boolean debugEnalbed)
添加统计代码
参考⽂文档： 统计分析 API调⽤用⽰示例代码（参考 example 项⺫⽬目）
init 只需要在应⽤用程序启动时调⽤用⼀一次该 API 即可。
以下代码定制⼀一个本应⽤用程序 Application 类。需要在 AndoridManifest.xml ⾥里配置。请参考上⾯面AndroidManifest.xml ⽚片断，或者 example 项⺫⽬目。
public class ExampleApplication extends Application { @Override
public void onCreate() { super.onCreate();
JPushInterface.setDebugMode(true); JPushInterface.init(this); }}
4、测试确认
1. 确认所需的权限都已经添加。如果必须的权限未添加，⽇日志会提⽰示错误。2. 确认 AppKey（在Portal上⽣生成的）已经正确的写⼊入 Androidmanifest.xml 。3. 确认在程序启动时候调⽤用了init(context) 接⼝口4. 确认测试⼿手机（或者模拟器）已成功连⼊入⺴⽹网络
客户端调⽤用 init 后不久，如果⼀一切正常，应有登录成功的⽇日志信息
5. 启动应⽤用程序，在 Portal 上向应⽤用程序发送⾃自定义消息或者通知栏提⽰示。详情请参考管理Portal。
在⼏几秒内，客户端应可收到下发的通知或者正定义消息如果 SDK ⼯工作正常，则⽇日志信息会如下图所⽰示：
如图所⽰示，客户端启动分为 4 步：
1. 检查 metadata 的 appKey 和 channel ，如果不存在，则启动失败，并有相应打印提⽰示。
2. 初始化 JPush SDK，检查 JNI 等库⽂文件的有效性，如果库⽂文件⽆无效，则启动失败，并有找不到so的相关打印。3. 检查 Androidmanifest.xml，如果有 Required 的权限不存在，则启动失败，并有相应打印提⽰示。4. 连接服务器登录，如果存在⺴⽹网络问题，则登陆失败,或者前⾯面三步有问题，不会启动JPush SDK。注：在检测AndroidManifest中权限和组件时，已有定义却提⽰示没有找到，很有可能是包名没有对应造成的。
⾼高级功能
请参考： 统计分析 API标签与别名API获取 RegistrationID API停⽌止与恢复推送服务 API设置允许推送时间 API通知栏样式定制API接收推送消息 Receiver设置通知静默时间 API获取推送连接状态本地通知API获取推送连接状态
富⽂文本⻚页⾯面 Javascript 回调API设置保留最近通知条数 API客户端错误码定义
技术⽀支持
邮件联系： support@jpush.cn问答社区：http://www.jpush.cn/qa/
因篇幅问题不能全部显示，请点此查看更多更全内容