JAVA 整合 极光推送

java 整合极光推送

1. maven依赖

		<!--jPush-->
        <dependency>
            <groupId>cn.jpush.api</groupId>
            <artifactId>jpush-client</artifactId>
            <version>3.2.17</version>
        </dependency>

        <dependency>
            <groupId>cn.jpush.api</groupId>
            <artifactId>jiguang-common</artifactId>
            <version>1.0.3</version>
        </dependency>
        <!--jPush 极光推送 end -->

2. 工具类

package com.laituo.juyou.app.utils;

import cn.jiguang.common.resp.APIConnectionException;
import cn.jiguang.common.resp.APIRequestException;
import cn.jpush.api.JPushClient;
import cn.jpush.api.push.PushResult;
import cn.jpush.api.push.model.Message;
import cn.jpush.api.push.model.Options;
import cn.jpush.api.push.model.Platform;
import cn.jpush.api.push.model.PushPayload;
import cn.jpush.api.push.model.audience.Audience;
import cn.jpush.api.push.model.notification.AndroidNotification;
import cn.jpush.api.push.model.notification.IosAlert;
import cn.jpush.api.push.model.notification.IosNotification;
import cn.jpush.api.push.model.notification.Notification;
import org.springframework.beans.factory.annotation.Value;

import java.util.List;

/**
 * 极光推送工具类
 * @auth ywh
 * @Date 2021/4/12
 */
public class JPushUtils {

    /**
     * 极光平台申请的 appKey 和 masterSecret
     */
    @Value("${com.jpush.appKey}")
    private String APP_KEY;

    @Value("${com.jpush.masterSecrt}")
    private String MASTER_SECRET;

    //创建JPushClient(极光推送的实例)
    private final JPushClient jPushClient = new JPushClient(this.MASTER_SECRET,this.APP_KEY);


    public static void main(String[] args) {
        try {
            //别名推送示例
            JPushClient jcTest = new JPushClient("你的MASTER_SECRET","你的APP_KEY");
            JPushVo jv = new JPushVo();
            jv.setExtraParam("隐藏参数");
            jv.setMsgContent("消息内容测试");
            jv.setMsgTitle("=====消息标题=====");
            jv.setNotificationTitle("通知头");
            jv.setAlias("4960");//别名-对应平台userId

            PushPayload pushPayload = buildPushAliasAlertTitle(jv);
            System.out.println("构建消息通知打印："+pushPayload);
            PushResult pushResult = jcTest.sendPush(pushPayload);
            System.out.println("通知返回结果打印："+pushResult);
            if (pushResult.getResponseCode() == 200) {
                System.out.println("=================SUCCESS=================");
            }
        } catch(Exception e){
            e.printStackTrace();
            System.out.println("=================ERROR=================");
        }
        System.out.println("=================结束=================");

    }

    /**
     * 极光推送
     * @param JPushVo 发送信息自定义对象
     * @return 发送是否成功 boolean
     */
    public boolean sendToMessage(JPushVo JPushVo) {
        boolean result = false;
        try {
            PushPayload pushPayload = buildPushAllRegistrationIdAlertTitle(JPushVo);
            System.out.println(pushPayload);
            PushResult pushResult = this.jPushClient.sendPush(pushPayload);
            System.out.println(pushResult);
            if (pushResult.getResponseCode() == 200) {
                result = true;
            }
        } catch (APIConnectionException | APIRequestException e) {
            e.printStackTrace();
        }

        return result;
    }


    /**
     * 构建发送消息
     * @param JPushVo 发送信息
     */
    private static PushPayload buildPushAllRegistrationIdAlertTitle(JPushVo JPushVo) {
        List<String> registrationIds = JPushVo.getRegistrationIds();
        String notificationTitle = JPushVo.getNotificationTitle();
        String msgTitle = JPushVo.getMsgTitle();
        String msgContent = JPushVo.getMsgContent();
        String extraParam = JPushVo.getExtraParam();
        //ios标题、二级标题、内容区分
        IosAlert iosAlert = IosAlert.newBuilder()
                .setTitleAndBody(msgTitle, "subTitle测试",msgContent)
                .build();

        // 创建一个IosAlert对象，可指定APNs的alert、title等字段
        // IosAlert iosAlert = IosAlert.newBuilder().setTitleAndBody("title",
        // "alert body").build();
        return PushPayload.newBuilder()
                // 指定要推送的平台，all代表当前应用配置了的所有平台，也可以传android等具体平台
                .setPlatform(Platform.all())
                // 指定推送的接收对象，all代表所有人，也可以指定已经设置成功的tag或alias或该应应用客户端调用接口获取到的registration
                // id
                //.setAudience(Audience.all()) //代表所有人 1
                //.setAudience(Audience.alias(alias)) //别名推送 2 
                .setAudience(Audience.registrationId(registrationIds))//指定registrationId集合 3
                // jpush的通知，android的由jpush直接下发，iOS的由apns服务器下发，Winphone的由mpns下发
                .setNotification(Notification.newBuilder()
                        // 指定当前推送的android通知
                        .addPlatformNotification(AndroidNotification.newBuilder()
                                .setAlert(msgContent)
                                .setTitle(notificationTitle)
                                // 此字段为透传字段，不会显示在通知栏。用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value）
                                .addExtra("extraParam", extraParam)
                                .build())
                        // 指定当前推送的iOS通知
                        .addPlatformNotification(IosNotification.newBuilder()
                                // 传一个IosAlert对象，指定title、subTitle、content等
                                .setAlert(iosAlert)
                                // 直接传alert
                                // 此项是指定此推送的badge自动加1
//            .incrBadge(1)
                                // 此字段的值default表示系统默认声音；传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒，
                                // 如果系统没有此音频则以系统默认声音提醒；此字段如果传空字符串，iOS9及以上的系统是无声音提醒，以下的系统是默认声音
//            .setSound("sound.caf")
                                // 此字段为透传字段，不会显示在通知栏。用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value）
                                //.addExtras()//可传多个值，键值对方式 Map<String,String>
                                .addExtra("extraParam", extraParam)
                                .build())
                        // 此项说明此推送是一个background推送，想了解background看：http://docs.jpush.io/client/ios_tutorials/#ios-7-background-remote-notification
                        // 取消此注释，消息推送时ios将无法在锁屏情况接收
                        // .setContentAvailable(true)
                        .build())
                // Platform指定了哪些平台就会像指定平台中符合推送条件的设备进行推送。 jpush的自定义消息，
                // sdk默认不做任何处理，不会有通知提示。建议看文档http://docs.jpush.io/guideline/faq/的
                // [通知与自定义消息有什么区别？]了解通知和自定义消息的区别
                .setMessage(Message.newBuilder()
                        .setMsgContent(msgContent)
                        .setTitle(msgTitle)
                        .addExtra("extraParam", extraParam)
                        .build())
                .setOptions(Options.newBuilder()
                        // 此字段的值是用来指定本推送要推送的apns环境，false表示开发，true表示生产；对android和自定义消息无意义
                        .setApnsProduction(false)
                        // 此字段是给开发者自己给推送编号，方便推送者分辨推送记录
                        .setSendno(100001)
                        // 此字段的值是用来指定本推送的离线保存时长，如果不传此字段则默认保存一天，最多指定保留十天；
                        .setTimeToLive(86400)
                        .build())

                .build();

    }

}

JPushVo 为自定义实体

import lombok.Data;
import java.util.List;

/**
 * @auth ywh
 * @Date 2021/4/12
 */
@Data
public class JPushVo {

    //发送方式1：发送人员集合  registrationId
    private List<String> registrationIds;

    //发送方式2：别名 - 用userId做别名 （方便使用）
    private String alias;

    //发送方式3：标签 - 暂时不用
    private String tag;

    //通知标题
    private String notificationTitle;

    //消息标题
    private String msgTitle;

    //消息内容
    private String msgContent;

    //隐藏参数、不面向用户
    private String extraParam;

}

参考链接（点我）