极光推送之自定义消息推送

一、引入Maven jar 包

官网地址：https://docs.jiguang.cn/ 

版本非实时更新，故可取官网或Maven仓库寻找最新地址

https://mvnrepository.com/artifact/cn.jpush.api/jpush-client

<!-- 极光推送 -->
<dependency>
    <groupId>cn.jpush.api</groupId>
    <artifactId>jpush-client</artifactId>
    <version>3.3.9</version>
</dependency>

二、配置yml文件

#极光推送服务
jpush:
  appKey: fff8c1798d4dawdaw8a1fc7d #（示例，不可用）
  masterSecret: d223479342347d4610a342427 #(示例，不可用)

三、参数封装实体类

@Setter 
@Getter
@ToString
/**
 * 漂流瓶推送自定义消息接收参数实体类
 * 加入了Lombok set、get、tostring注解 若无该插件请手动添加set、get、tostring方法
 */
public class CustomMessageDomain {

    /** 设备标识 用户ID 别名 */
    private String alias;
    /** 通知内容标题 */
    private String notificationTitle;
    /** 消息内容标题 */
    private String msgTitle;
    /** 消息内容 */
    private String msgContent;
    /** 扩展字段（通常传跳转的链接）*/
    private String extrasParam;
}

四、接口方法

APPResponseDate为封装的方法返回值实体类。 可以选择无返回的方法

@PostMapping("sendCustomMessage")
--Swagger注解可选可不选
@ApiOperation(value = "根据别名推送自定义消息 （别名为手机号）", httpMethod = "POST")
@ApiImplicitParams({
        @ApiImplicitParam(name = "alias", value = "设备标识 用户ID 别名", required = true, paramType = "query", dataType = "String"),
        @ApiImplicitParam(name = "notificationTitle", value = "通知内容标题", required = true, paramType = "query", dataType = "String"),
        @ApiImplicitParam(name = "msgTitle", value = "消息内容标题", required = true, paramType = "query", dataType = "String"),
        @ApiImplicitParam(name = "msgContent", value = "消息内容", required = true, paramType = "query", dataType = "String"),
        @ApiImplicitParam(name = "extrasParam", value = "扩展字段（通常传跳转的链接）非必传", required = false, paramType = "query", dataType = "String")
})
--Swagger注解可选可不选
public AppResponseData sendCustomMessage(@RequestBody CustomMessageDomain customMessageDomain) {
    //给指定别名的用户推送一条自定义消息
    PushUtil.getInstance().sendToRegistrationId(customMessageDomain.getAlias(),
            customMessageDomain.getNotificationTitle(),
            customMessageDomain.getMsgTitle(),
            customMessageDomain.getMsgContent(),
            customMessageDomain.getExtrasParam());
    return new AppResponseData(ResultCode.SUCCESS, "推送成功！");
}

五、PushUtil 工具类

public class PushUtil {

    private static PushUtil instance;
    private JPushClient jpushClient;
    //日志记录
    private static Logger logger = LoggerFactory.getLogger(PushUtil.class);

    /**
     * 极光账户初始化
     */
    private PushUtil() {
        //这里是账户 key 与masterSecret 建议从配置文件中读取
        String appKey = "*************";
        String masterSecret = "*************";

        if (appKey == null || masterSecret == null) {
            throw new JPushException("极光推送账户初始化失败");
        }
        jpushClient = new JPushClient(masterSecret, appKey);
    }

    public static PushUtil getInstance() {
        if (null == instance) {
            synchronized (PushUtil.class) {
                if (null == instance) {
                    instance = new PushUtil();
                }
            }
        }
        return instance;
    }
//    Device===================================================

    /**
     * 推送给指定设备标识参数的用户（自定义消息通知）
     * @param alias 设备标识 用户ID 别名
     * @param notification_title 通知内容标题
     * @param msg_title 消息内容标题
     * @param msg_content 消息内容
     * @param extrasparam 扩展字段（通常传跳转的链接）
     * @return 0推送失败，1推送成功
     */
    public int sendToRegistrationId(String alias, String notification_title, String msg_title, String msg_content, String extrasparam) {
        int result = 0;
        try {
            PushPayload pushPayload= this.buildPushObject_all_alias_alertWithTitle(alias, notification_title, msg_title, msg_content, extrasparam);
            PushResult pushResult = jpushClient.sendPush(pushPayload);
            if(pushResult.getResponseCode() == 200){
                result=1;
            }
            logger.info("[极光推送]PushResult result is " + pushResult);
        } catch (APIConnectionException e) {
            logger.error("[极光推送]Connection error. Should retry later. ", e);
        } catch (APIRequestException e) {
            logger.error("[极光推送]Error response from JPush server. Should review and fix it. ", e);
            logger.info("[极光推送]HTTP Status: " + e.getStatus());
            logger.info("[极光推送]Error Code: " + e.getErrorCode());
            logger.info("[极光推送]Error Message: " + e.getErrorMessage());
        }
        return result;
    }

    /**
     * 推送自定义消息 指定别名推送
     * @param alias
     * @param notification_title
     * @param msg_title
     * @param msg_content
     * @param extrasparam
     * @return
     */
    private PushPayload buildPushObject_all_alias_alertWithTitle(String alias, String notification_title, String msg_title, String msg_content, String extrasparam) {
        //创建一个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.alias(alias))
                //.setAudience(Audience.all()) //所有人
                //.setAudience(Audience.registrationId(registrationId)) //注册ID
                //jpush的通知，android的由jpush直接下发，iOS的由apns服务器下发，Winphone的由mpns下发
                .setNotification(Notification.newBuilder()
                        //指定当前推送的android通知
                        .addPlatformNotification(AndroidNotification.newBuilder()
                                .setAlert(msg_content)
                                .setTitle(notification_title)
                                //此字段为透传字段，不会显示在通知栏。用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value）
                                .addExtra("url", extrasparam)
                                .build())
                        //指定当前推送的iOS通知
                        .addPlatformNotification(IosNotification.newBuilder()
                                //传一个IosAlert对象，指定apns title、title、subtitle等
                                .setAlert(msg_content)
                                //直接传alert
                                //此项是指定此推送的badge自动加1
                                .incrBadge(1)
                                //此字段的值default表示系统默认声音；传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒，
                                // 如果系统没有此音频则以系统默认声音提醒；此字段如果传空字符串，iOS9及以上的系统是无声音提醒，以下的系统是默认声音
                                .setSound("sound.caf")
                                //此字段为透传字段，不会显示在通知栏。用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value）
                                .addExtra("url", extrasparam)
                                //此项说明此推送是一个background推送，想了解background看：http://docs.jpush.io/client/ios_tutorials/#ios-7-background-remote-notification
                                //取消此注释，消息推送时ios将无法在锁屏情况接收
                                // .setContentAvailable(true)
                                .build())
                        .build())
                //Platform指定了哪些平台就会像指定平台中符合推送条件的设备进行推送。 jpush的自定义消息，
                // sdk默认不做任何处理，不会有通知提示。建议看文档http://docs.jpush.io/guideline/faq/的
                // [通知与自定义消息有什么区别？]了解通知和自定义消息的区别
                .setMessage(Message.newBuilder()
                        .setMsgContent(msg_content)
                        .setTitle(msg_title)
                        //.addExtra("url", extrasparam) //释放该字段会发送两次消息，第二次消息内容是扩展字段
                        .build())
                .setOptions(Options.newBuilder()
                        //此字段的值是用来指定本推送要推送的apns环境，false表示开发，true表示生产；对android和自定义消息无意义
                        .setApnsProduction(true)
                        //此字段是给开发者自己给推送编号，方便推送者分辨推送记录
                        .setSendno(1)
                        //此字段的值是用来指定本推送的离线保存时长，如果不传此字段则默认保存一天，最多指定保留十天； 秒为单位
                        .setTimeToLive(1 * 60 * 60 * 24)
                        .build())
                .build();

    }

}

六、完成

调用该接口，Android或者IOS端即可收到一条自定义消息。