仅需三步即可集成极光推送--指南

本文就极光推送集成做了一个简化，仅需三步就可以快速集成极光推送。不用去看繁琐的极光推送的说明文档，仅仅看本文的说明步骤，三步即可集成极光推送功能。

  

1 仅需三步集成

  

第一步：配置build.gradle

在项目的app的主工程的build.gradle文件中添加如下内容：

android {
    compileSdkVersion 28
    defaultConfig {
        applicationId "Your App Id"
        ...........

        ndk {
            abiFilters 'armeabi', 'armeabi-v7a', 'arm64-v8a', 'x86', 'x86_64', 'mips', 'mips64'
        }

        manifestPlaceholders = [
                JPUSH_PKGNAME : defaultConfig.applicationId,
                JPUSH_APPKEY : "Your Key", //JPush 上注册的包名对应的 Appkey.
                JPUSH_CHANNEL : "developer-default", //暂时填写默认值即可.
        ]
    }
}

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

  

第二步：引入jpushlib模块

引入jpushlib module即可
jpushlib module下载地址：请点击这里

  

第三步：添加两行代码

class JGApplication: Application() {
    private val TAG = "JGApplication"

    override fun onCreate() {
        super.onCreate()
        JPushHelper.setJPushListener(absJPushListener)	//这一行代码设置Jpush回调监听
        JPushHelper.init(this, BuildConfig.DEBUG)		// 这一行代码初始化Jpush
    }

	// 重写抽象类AbstractJPushListener的相关方法即可，按需重载方法即可
	private val absJPushListener = object : AbstractJPushListener() {
       override fun onNotificationSettingsCheck(context: Context?, isOn: Boolean, i: Int) {
            super.onNotificationSettingsCheck(context, isOn, i)
            Log.i(TAG, "手机APP通知开关的回调-》  isOn:$isOn, i:$i")
        }
  
        override fun onConnected(context: Context?, b: Boolean) {
            super.onConnected(context, b)
            Log.i(TAG, "长连接状态回调:$b")
        }
    }
}

这一步仅需在application类的onCreate方法中设置JPushHelper类的初始化工作。
以上两行代码即可。

这两行代码顺序不要变动。先设置监听回调接口，再初始化即可通过监听获取回调状态通知。当然监听回调非必须的，可不设置或设置为空。

通过以上三步即可完成极光推送的集成。

  

2 检验集成是否成功

经过上面三步集成指南之后，启动APP，查看日志：

如果日志显示这样的状态，即表明JPush集成成功，并且长连接已经建立，可接收发送的推送通知

  

3 Demo效果

 
经过上面三步的操作之后，即可调用JPushHelper类的相关方法设置JPush推送相关的方法。

以上三步的集成效果，我做了一个Demo，具体地址： 请点击这里

Demo效果如下：

  

UI界面中使用到的方法均是JPushHelper类提供的方法，直接使用即可。

点击按钮，日志打印如下：

用户别名API日志：

用户标签API日志：

 

4 jpushlib模块JPushHelper类说明

 
该类是jpushlib模块的核心，是app中使用极光推送库的桥梁，通过该类即可设置极光推送的所有相关方法。

具体该类提供的方法接口如下：

//初始化
public static void init(Context context, boolean isDebug)
//清理
public static void cleanJPushListener()

// ===========================================极光推送API
//停止推送
public static void stopPush()
//恢复推送服务
public static void resumePush()
//用来检查 Push Service 是否已经被停止
public static boolean isPushStoped()
// 获取当前连接状态
public static boolean getConnectionState()
//动态配置 channel，优先级比 AndroidManifest 里配置的高
public static void setChannel(String channel)
//允许推送的开始时间与结束时间
public static void setPushTime(Set<Integer> weekDays, int startHour, int endHour)
//调用此 API 来设置静音时段。如果在该时间段内收到消息，则：不会有铃声和震动
public static void setSilenceTime(int startHour, int startMinute,
									 int endHour, int endMinute)
//在 Android 6.0 及以上的系统上，需要去请求一些用到的权限，
//JPush SDK 用到的一些需要请求如下权限
public static void requestPermission(Activity activity)
//JPush SDK 开启和关闭省电模式，默认为关闭
public static void setPowerSaveMode(Activity activity, boolean enable)
//调用此 API 设置手机号码
public static void setMobileNumber(int sequence, String mobileNumber)
//调用此 API 来取得应用程序对应的 RegistrationID。
public static String getRegistrationID()

// ===========================================别名相关API
//调用此 API 来设置别名。
public static void setAlias(int sequence, String alias)
//调用此 API 来删除别名。
public static void deleteAlias(int sequence) 
//调用此 API 来查询别名
public static void getAlias(int sequence)


// ===========================================标签相关API
//设置 tags 时，如果其中一个 tag 无效，则整个设置过程失败,可过滤无效的tag
public static Set<String> filterValidTags(Set<String> tags)
//调用此 API 来设置标签 
//需要理解的是，这个接口是覆盖逻辑，而不是增量逻辑。即新的调用会覆盖之前的设置
public static void setTags(int sequence, Set<String> tags)
//调用此 API 来新增标签
public static void addTags(int sequence, Set<String> tags)
//调用此 API 来删除指定标签
public static void deleteTags(int sequence, Set<String> tags)
//调用此 API 来清除所有标签
public static void cleanTags(int sequence)
//调用此 API 来查询所有标签
public static void getAllTags(int sequence) 
//调用此 API 来查询指定 tag 与当前用户绑定的状态
public static void checkTagBindState(int sequence, String tag)


// ===========================================通知相关API
//此 API 提供清除通知的功能，包括：清除所有 JPush 展现的通知（不包括非 JPush SDK 展现的）
public static void clearAllNotifications()
//清除指定某个通知
public static void clearNotificationById(int notificationId)
//当用户需要定制默认的通知栏样式时，则可调用此方法
public static void setDefaultPushNotificationBuilder(DefaultPushNotificationBuilder builder)
//当开发者需要为不同的通知，指定不同的通知栏样式（行为）时，则需要调用此方法设置多个通知栏构建类
public static void setPushNotificationBuilder(Integer notificationBuilderId,
                                                  BasicPushNotificationBuilder builder)
//限制保留的通知条数。默认为保留最近 5 条通知
public static void setLatestNotificationNumber(int maxNum)


// ===========================================崩溃API
//关闭 CrashLog 上报
public static void stopCrashHandler()
//开启 CrashLog 上报
public static void initCrashHandler()

// ===========================================本地通知API
//本地通知 API 不依赖于网络，无网条件下依旧可以触发
public static void addLocalNotification(JPushLocalNotification notification)
//移除指定的本地通知
public static void removeLocalNotification(long notificationId)
//移除所有的本地通知，注意notificationId为0或者负数时通知无法移除
public static void clearLocalNotifications()

// ===========================================地理围栏功能API
//设置地理围栏监控周期，最小3分钟，最大1天。默认为15分钟，
public static void setGeofenceInterval(long interval) 
//设置最多允许保存的地理围栏数量，超过最大限制后，
//如果继续创建先删除最早创建的地理围栏。默认数量为10个，允许设置最小1个，最大100个。
public static void setMaxGeofenceNumber(int maxNumber)
//删除指定id的地理围栏
public static void deleteGeofence(String geofenceid)


//设置角标数字(目前仅支持华为手机)
public static void setBadgeNumber(int num)


// ===========================================手机APP通知开关API
//检查当前应用的通知开关是否开启
//返回结果：1表示开启，0表示关闭，-1表示检测失败
public static int isNotificationEnabled()
//跳转手机的应用通知设置页，可由用户操作开启通知开关
public static void goToAppNotificationSettings() 

// ===========================================统计分析API
public static void onResume(final Activity activity) 
public static void onPause(final Activity activity)

// ===========================================设置监听器
public static void setJPushListener(AbstractJPushListener listener)
public static void cleanJPushListener()

以上JPushHelper接口完全可以满足开发者引入极光推送的全部功能。无需再去看Jpush极光推送的文档，仅仅引入我这里提供的jpushlib模块即可。

 

5 jpushlib模块AbstractJPushListener类回调监听说明

 

public abstract class AbstractJPushListener {

    public Notification getNotification(Context context,
    					 NotificationMessage notificationMessage,
    					 Notification notification) {
        return notification;
    }

    /**
     * 收到自定义消息回调
     *
     * @param context Context
     * @param customMessage 接收自定义消息内容
     */
    public void onMessage(Context context, CustomMessage customMessage) {

    }

    /**
     * 点击通知回调
     *
     * @param context Context
     * @param notificationMessage 点击的通知内容
     */
    public void onNotifyMessageOpened(Context context,
    				NotificationMessage notificationMessage) {

    }

    /**
     * 收到通知回调
     *
     * @param context Context
     * @param notificationMessage 接收到的通知内容
     */
    public void onNotifyMessageArrived(Context context,
    							NotificationMessage notificationMessage) {

    }

    /**
     * 清除通知回调
     *
     * 说明:
     *
     * 1.同时删除多条通知，可能不会多次触发清除通知的回调
     *
     * 2.只有用户手动清除才有回调，调接口清除不会有回调
     *
     * @param context Context
     * @param notificationMessage 清除的通知内容
     */
    public void onNotifyMessageDismiss(Context context,
    					NotificationMessage notificationMessage) {

    }

    /**
     * 注册成功回调
     *
     * @param context Context
     * @param s  注册id
     */
    public void onRegister(Context context, String s) {

    }

    /**
     * 长连接状态回调
     *
     * @param context Context
     * @param b 长连接状态
     */
    public void onConnected(Context context, boolean b) {

    }

    /**
     * 注册失败回调
     *
     * @param context Context
     * @param cmdMessage 错误信息
     */
    public void onCommandResult(Context context, CmdMessage cmdMessage) {

    }

    /**
     * 通知的MultiAction回调
     *
     * @param context Context
     * @param intent 点击后触发的Intent
     *
     *  说明 注意这个方法里面禁止再调super.onMultiActionClicked,因为会导致逻辑混乱
     */
    public void onMultiActionClicked(Context context, Intent intent) {

    }

    /**
     * 通知开关的回调
     *
     * 该方法会在以下情况触发时回调。
     *
     * 1.sdk每次启动后都会检查通知开关状态并通过该方法回调给开发者。
     *
     * 2.当sdk检查到通知状态变更时会通过该方法回调给开发者。
     *
     * @param context Context
     * @param isOn 通知开关状态
     * @param i 触发场景，0为sdk启动，1为检测到通知开关状态变更
     */
    public void onNotificationSettingsCheck(Context context, boolean isOn, int i) {

    }

    /**
     * tag 增删查改的操作会在此方法中回调结果
     *
     * @param context Context
     * @param jPushMessage tag 相关操作返回的消息结果体
     */
    public void onTagOperatorResult(Context context, JPushMessage jPushMessage) {

    }

    /**
     * 查询某个 tag 与当前用户的绑定状态的操作会在此方法中回调结果
     *
     * @param context Context
     * @param jPushMessage check tag 与当前用户绑定状态的操作返回的消息结果体，
     * 具体参考 JPushMessage 类的说明
     */
    public void onCheckTagOperatorResult(Context context, JPushMessage jPushMessage) {

    }

    /**
     * alias 相关的操作会在此方法中回调结果
     *
     * @param context Context
     * @param jPushMessage alias 相关操作返回的消息结果体
     */
    public void onAliasOperatorResult(Context context, JPushMessage jPushMessage) {

    }

    /**
     * 设置手机号码会在此方法中回调结果
     *
     * @param context Context
     * @param jPushMessage 设置手机号码返回的消息结果体
     */
    public void onMobileNumberOperatorResult(Context context, JPushMessage jPushMessage) {

    }

    /**
     * 应用被拉起时回调 onWake(Context context, int wakeType) 方法，
     * context 是上下文，wakeType 是拉起的类型，其取值对应的拉起方式如下：
     * wakeType值	拉起方式
     * 1	START_SERVICE
     * 2	BIND_SERVICE
     * 4	CONTENTPROVIDER
     */
    public void onWake(Context context, int wakeType) {

    }
}

该类是一个抽象类，在文章开始位置，重写了其部分方法，通过回调监听部分方法，按需要重载其方法即可。

 

6 源码下载

源代码地址，请点击这里

---

欢迎关注公众号：技术印象