JPush极光推送Java服务器端API

产品功能说明

极光推送（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 开发包
• example
  
  • 是一个完整的 Android 项目，通过这个演示了 JPush SDK 的基本用法，可以用来做参考。

Android SDK 版本

目前SDK只支持Android 2.1或以上版本的手机系统。

SDK集成步骤

1、导入 SDK 开发包到你自己的应用程序项目

• 解压缩 jpush-sdk_v1.x.y.zip 集成压缩包
• 复制 libs/jpush-sdk-release1.x.y.jar 到工程 libs/ 目录下

• 复制 libs/armeabi/libjpush.so 到工程 libs/armeabi 目录下

  如果您的项目有 libs/armeabi-v7a 这个目录，请把 libjpush.so 也复制一份到这个目录。

2、配置 AndroidManifest.xml

根据 SDK 压缩包里的 AndroidManifest.xml 样例文件，来配置应用程序项目的 AndroidManifest.xml 。

主要步骤为：

1. 复制备注为 "Required" 的部分
2. 将备注为替换包名的部分，替换为当前应用程序的包名
3. 将AppKey替换为在Portal上注册该应用的的Key,例如（9fed5bcb7b9b87413678c407）

<?xml version= "1.0" encoding= "utf-8" ?> <manifest xmlns:android= "<a href="http://schemas.android.com/apk/res/android" "="" style="border-top-left-radius: 0px !important; border-top-right-radius: 0px !important; border-bottom-right-radius: 0px !important; border-bottom-left-radius: 0px !important; background-image: none !important; border: 0px !important; bottom: auto !important; float: none !important; height: auto !important; left: auto !important; line-height: 1.2em !important; margin: 0px !important; outline: none; overflow: visible !important; padding: 0px !important; position: static !important; right: auto !important; top: auto !important; vertical-align: baseline !important; width: auto !important; box-sizing: content-box !important; font-size: 1em !important; min-height: inherit !important; color: rgb(0, 109, 175); ">http://schemas.android.com/apk/res/android"      package = "Your Package"      android:versionCode= "100"      android:versionName= "1.0.0"      >         <!-- 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-permission android:name= "android.permission.VIBRATE" />      <uses-permission android:name= "android.permission.MOUNT_UNMOUNT_FILESYSTEMS" />      <uses-permission android:name= "android.permission.ACCESS_NETWORK_STATE" />            <!-- Optional. Required for location feature -->      <uses-permission android:name= "android.permission.ACCESS_COARSE_LOCATION" />      <uses-permission android:name= "android.permission.ACCESS_COARSE_UPDATES" />      <uses-permission android:name= "android.permission.ACCESS_WIFI_STATE" />      <uses-permission android:name= "android.permission.CHANGE_WIFI_STATE" />      <uses-permission android:name= "android.permission.ACCESS_FINE_LOCATION" />      <uses-permission android:name= "android.permission.ACCESS_LOCATION_EXTRA_COMMANDS" />      <uses-permission android:name= "android.permission.CHANGE_NETWORK_STATE" />                  <application          android:icon= "@drawable/ic_launcher"          android:label= "@string/app_name"          android:name= "Your Application" >                    <!-- Required -->          <service              android:name= "cn.jpush.android.service.PushService"              android:enabled= "true"              android:exported= "false" >              <intent-filter>                  <action android:name= "cn.jpush.android.intent.REGISTER" />                  <action android:name= "cn.jpush.android.intent.REPORT" />                  <action android:name= "cn.jpush.android.intent.PushService" />                  <action android:name= "cn.jpush.android.intent.PUSH_TIME" />              </intent-filter>          </service>                    <!-- Required -->          <receiver              android:name= "cn.jpush.android.service.PushReceiver"              android:enabled= "true" >            <intent-filter android:priority= "1000" > <!--since 1.3 . 5 -->                  <action android:name= "cn.jpush.android.intent.NOTIFICATION_RECEIVED_PROXY" /> <!--since 1.3 . 5 -->                  <category android:name= "Your Package" /> <!--since 1.3 . 5 -->              </intent-filter> <!--since 1.3 . 5 -->              <intent-filter>                  <action android:name= "android.intent.action.USER_PRESENT" />                  <action android:name= "android.net.conn.CONNECTIVITY_CHANGE" />              </intent-filter>              <intent-filter>                  <action android:name= "android.intent.action.PACKAGE_ADDED" />                  <action android:name= "android.intent.action.PACKAGE_REMOVED" />                  <data android:scheme= "package" />              </intent-filter>          </receiver>       <!-- Required SDK核心功能-->          <activity              android:name= "cn.jpush.android.ui.PushActivity"              android:theme= "@android:style/Theme.Translucent.NoTitleBar"              android:configChanges= "orientation|keyboardHidden" >              <intent-filter>                  <action android:name= "cn.jpush.android.ui.PushActivity" />                  <category android:name= "android.intent.category.DEFAULT" />                  <category android:name= "Your Package" />              </intent-filter>          </activity>          <!-- Required SDK核心功能-->          <service              android:name= "cn.jpush.android.service.DownloadService"              android:enabled= "true"              android:exported= "false" >          </service>          <!-- Required SDK核心功能-->          <receiver android:name= "cn.jpush.android.service.AlarmReceiver" />                 <!-- Required. For publish channel feature -->          <!-- JPUSH_CHANNEL 是为了方便开发者统计APK分发渠道。-->          <!-- 例如: -->          <!-- 发到 Google Play 的APK可以设置为 google-play; -->          <!-- 发到其他市场的 APK 可以设置为 xxx-market。 -->          <!-- 目前这个渠道统计功能的报表还未开放。-->          <meta-data android:name= "JPUSH_CHANNEL" android:value= "developer-default" />          <!-- Required. AppKey copied from Portal -->          <meta-data android:name= "JPUSH_APPKEY" android:value= "Your AppKey" />      </application> </manifest>

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)

调用示例代码（参考 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 等库文件的有效性，如果库文件无效，则启动失败
3. 检查 Androidmanifest.xml，如果有 Required 的权限不存在，则启动失败
4. 连接服务器登录，如果存在网络问题，则登陆失败,或者前面三步有问题，不会启动JPush SD

AppKey的获取

进入极光的官方网站，登录注册，建立一个应用，创建成功后，点击该应用进入详情页面就可以获取appkey了

https://www.jpush.cn