简介
官网:https://www.jpush.cn/
极光推送(JPush)是一个端到端的推送服务,使得服务器端消息能够及时地推送到终端用户手机上,让开发者积极地保持与用户的连接,从而提高用户活跃度、提高应用的留存率。
主要功能
- 保持与服务器的长连接,以便消息能够即时推送到达客户端
- 接收通知与自定义消息,并向开发者App传递相关信息
主要特点
- 客户端维持连接占用资源少、耗电低
- SDK丰富的接口,可定制通知栏提示样式
- 服务器大容量、稳定
原理
- JPush Android SDK 是作为 Android Service 长期运行在后台的,从而创建并保持长连接,保持永远在线的能力。
包青天备注
- 客户端推送服务进程必须开启才能接收到推送消息,如果使用助手类的工具把进程杀死了,那就收不到了
- 客户如果设置不显示通知或消息,也是收不到的
压缩包中的内容
- AndroidManifest.xml
- 客户端嵌入SDK参考的配置文件
- libs/jpush-sdk-release1.x.y.jar
- SDK Java 开发包
- libs/armeabi/libjpush.so
- SDK native 开发包
- res
- 集成SDK必须添加的资源文件
- example
- 是一个完整的 Android 项目,通过这个演示了 JPush SDK 的基本用法,可以用来做参考。
客户端启动步骤:
- 检查 metadata 的 appKey 和 channel ,如果不存在,则启动失败
- 初始化 JPush SDK,检查 JNI 等库文件的有效性,如果库文件无效,则启动失败
- 检查 Androidmanifest.xml,如果有 Required 的权限不存在,则启动失败
- 连接服务器登录,如果存在网络问题,则登陆失败
集成步骤
官方文档:http://docs.jpush.io/guideline/android_guide/
详细教程: http://docs.jpush.io/client/android_tutorials/
1、导入SDK
- 解压缩后,复制 libs、res 中的文件到工程的相应目录下
2、集成 SDK 的混淆
- 在proguard-android.txt中配置:
-dontoptimize-dontpreverify-dontwarn cn.jpush.**-keep class cn.jpush.** { *; }#v2.0.5 及以上的版本由于引入了protobuf ,在上面基础之上增加排出混淆的配置。#==================gson==========================-dontwarn com.google.**-keep class com.google.gson.** {*;}#==================protobuf======================-dontwarn com.google.**-keep class com.google.protobuf.** {*;}3、配置清单文件
- 详见官方文档
4、添加代码
- 在应用启动时初始化 JPush。
JPushInterface.init(getApplicationContext()); //只需要在应用程序启动时调用一次该 API 即可
- 定制一个本应用程序 Application 类
public class ExampleApplication extends Application {private static final String TAG = "JPush";@Overridepublic void onCreate() {Log.d(TAG, "[ExampleApplication] onCreate");super.onCreate();JPushInterface.setDebugMode(true); // 设置开启日志,发布时请关闭日志JPushInterface.init(this); // 一般建议在自定义 Application 类里初始化。也可以在主 Activity 里。}}
清单文件配置实例
步骤
- 复制备注为 "Required" 的部分
- 将备注为替换包名的部分,替换为当前应用程序的包名
- 将AppKey替换为在Portal上注册该应用的的Key
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"package="com.example.test"android:versionCode="1"android:versionName="1.0.0" ><uses-sdkandroid:minSdkVersion="11"android:targetSdkVersion="17" /><!-- Required --><permissionandroid:name="com.example.test.permission.JPUSH_MESSAGE"android:protectionLevel="signature" /><!-- Required --><!-- 官方定义的权限,允许应用接收JPUSH内部代码发送的广播消息。 --><uses-permission android:name="com.example.test.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.WRITE_SETTINGS" /><!-- 允许应用震动。 --><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" /><!-- 允许应用显示系统窗口,位于显示的顶层。 --><uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" /><!-- Optional. Required for location feature --><uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" /><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" /><applicationandroid:name="com.example.test.ExampleApplication"android:allowBackup="true"android:icon="@drawable/ic_launcher"android:label="@string/app_name" ><!-- For test only 测试的主程序 --><activityandroid:name="com.example.test.MainActivity"android:label="@string/app_name" ><intent-filter><action android:name="android.intent.action.MAIN" /><category android:name="android.intent.category.LAUNCHER" /></intent-filter></activity><!-- For test only 测试高级功能 --><activityandroid:name="com.example.test.PushSetActivity"android:label="@string/app_name" ></activity><!-- For test only 测试设置 --><activityandroid:name="com.example.test.SettingActivity"android:label="@string/app_name" ></activity><!-- For test only 测试状态通知栏,需要打开的Activity --><activityandroid:name="com.example.test.TestActivity"android:exported="false" ><intent-filter><action android:name="jpush.testAction" /><category android:name="jpush.testCategory" /></intent-filter></activity><!-- Rich push 核心功能 since 2.0.6 --><activityandroid:name="cn.jpush.android.ui.PopWinActivity"android:exported="false"android:theme="@style/MyDialogStyle" ></activity><!-- Required SDK核心功能 --><activityandroid:name="cn.jpush.android.ui.PushActivity"android:configChanges="orientation|keyboardHidden"android:exported="false"android:theme="@android:style/Theme.NoTitleBar" ><intent-filter><action android:name="cn.jpush.android.ui.PushActivity" /><category android:name="android.intent.category.DEFAULT" /><category android:name="com.example.test" /></intent-filter></activity><!-- Required SDK核心功能 --><serviceandroid:name="cn.jpush.android.service.DownloadService"android:enabled="true"android:exported="false" /><!-- option since 2.0.5 可配置PushService,DaemonService,PushReceiver,AlarmReceiver的android:process参数 --><!-- 将JPush相关组件设置为一个独立进程。如:android:process=":remote" --><serviceandroid: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><!-- since 1.8.0 option 可选项。用于同一设备中不同应用的JPush服务相互拉起的功能。 --><!-- 若不启用该功能可删除该组件,将不拉起其他应用也不能被其他应用拉起 --><serviceandroid:name="cn.jpush.android.service.DaemonService"android:enabled="true"android:exported="true" ><intent-filter><action android:name="cn.jpush.android.intent.DaemonService" /><category android:name="com.example.test" /></intent-filter></service><!-- Required --><receiverandroid:name="cn.jpush.android.service.PushReceiver"android:enabled="true" ><intent-filter android:priority="1000" ><action android:name="cn.jpush.android.intent.NOTIFICATION_RECEIVED_PROXY" /><!-- Required 显示通知栏 --><category android:name="com.example.test" /></intent-filter><intent-filter><action android:name="android.intent.action.USER_PRESENT" /><action android:name="android.net.conn.CONNECTIVITY_CHANGE" /></intent-filter><!-- Optional --><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核心功能 --><receiver android:name="cn.jpush.android.service.AlarmReceiver" /><!-- User defined. 用户自定义的广播接收器 --><receiverandroid:name="com.example.test.MyReceiver"android:enabled="true"android:exported="false" ><intent-filter><action android:name="cn.jpush.android.intent.REGISTRATION" /> <!-- Required 用户注册SDK的intent --><action android:name="cn.jpush.android.intent.UNREGISTRATION" /><action android:name="cn.jpush.android.intent.MESSAGE_RECEIVED" /> <!-- Required 用户接收SDK消息的intent --><action android:name="cn.jpush.android.intent.NOTIFICATION_RECEIVED" /> <!-- Required 用户接收SDK通知栏信息的intent --><action android:name="cn.jpush.android.intent.NOTIFICATION_OPENED" /> <!-- Required 用户打开自定义通知栏的intent --><action android:name="cn.jpush.android.intent.ACTION_RICHPUSH_CALLBACK" /> <!-- Optional 用户接受Rich Push Javascript 回调函数的intent --><action android:name="cn.jpush.android.intent.CONNECTION" /> <!-- 接收网络变化 连接/断开 since 1.6.3 --><category android:name="com.example.test" /></intent-filter></receiver><!-- Required. For publish channel feature --><!-- JPUSH_CHANNEL 是为了方便开发者统计APK分发渠道。 --><!-- 例如:发到 Google Play 的APK可以设置为 google-play; 发到其他市场的 APK 可以设置为 xxx-market。 --><!-- 目前这个渠道统计功能的报表还未开放。 --><meta-dataandroid:name="JPUSH_CHANNEL"android:value="developer-default" /><!-- 值来自开发者平台取得的AppKey --><meta-dataandroid:name="JPUSH_APPKEY"android:value="2310ef7d8dac10ff69973eb2" /></application></manifest>