springBoot集成极光推送

最新推荐文章于 2023-08-09 09:44:09 发布
原创 最新推荐文章于 2023-08-09 09:44:09 发布 · 1.2k 阅读 · 3 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java

该博客详细介绍了如何配置并使用JPush API进行推送消息。首先，通过Maven引入JPush客户端和公共库依赖，然后配置JPushConfig类从YML文件获取AppKey和AppSecret。接着，定义了JPushType枚举以区分不同类型的推送消息。JPushUtil类作为核心组件，包含了多种推送方法，如按别名、标签或所有用户推送，并处理推送结果。示例代码展示了如何调用这些方法进行实际推送操作。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

pom:

        <dependency>
            <groupId>cn.jpush.api</groupId>
            <artifactId>jpush-client</artifactId>
            <version>3.4.8</version>
        </dependency>
        <dependency>
            <groupId>cn.jpush.api</groupId>
            <artifactId>jiguang-common</artifactId>
            <version>1.1.10</version>
        </dependency>
        <dependency>
            <groupId>com.deepoove</groupId>
            <artifactId>poi-tl</artifactId>
            <version>1.7.3</version>
        </dependency>

配置文件：

@Configuration
public class JPushConfig implements EnvironmentAware {
    private Environment environment;

    @Override
    public void setEnvironment(Environment environment) {
        this.environment = environment;
    }

    @Bean
    public JPushUtil jPushUtil() {
        String masterSecret = environment.getProperty("jpush.AppSecret");
        String appKey = environment.getProperty("jpush.AppKey");
        Boolean production = Boolean.valueOf(environment.getProperty("jpush.isProduction"));
        return new JPushUtil( masterSecret, appKey, production);
    }
}

yml:

jpush:
  AppKey: f54*******************92
  AppSecret: d6*****************055
  isProduction: true

类型定义：

public enum JPushType {
    Notification("通知"),
    Customize("自定义消息"),
    Both("两者");

    private String label;

    JPushType(String label) {
        this.label = label;
    }

    public String getLabel() {
        return label;
    }
}

调用组件封装：

public class JPushUtil {
    private static final Logger LOGGER = LoggerFactory.getLogger(JPushUtil.class);
    private Boolean ApnsProduction;
    private JPushClient jPushClient;

    public JPushUtil(String appSecret, String appKey, Boolean production) {
        this.ApnsProduction = production;
        jPushClient = new JPushClient(appSecret, appKey);
    }

//    public static void main(String[] args) {
//        JPushUtil jPushUtil = new JPushUtil("2b3e77f579efcdb4fd430610",
//                "ac9dd6a81230a63e68abdf26",true);
//Notice
//        List<String> alias = new ArrayList<>();
//        alias.add("31e79470_598a_49ae_bae2_59cc355440f0");
//
//        Map<String, String> extrasParam = new HashMap();
//        extrasParam.put("companyId", "2");
//        for (int i = 0; i < 1; i++) {
//            jPushUtil.sendToAliasList(alias,"测试标题","测试内容",
//                    new HashMap(){{put("companyId","2");}},JPushType.Notification);
//        }
//    }


    /**
     * 指定多个别名(Alias)进行多个平台进行推送 (推送给设备标识参数的用户)
     *
     * @param aliasList          别名或别名组
     * @param msg_content        消息内容
     * @param extrasParam        扩展字段(额外参数)
     * @param notification_title 通知标题
     * @return 0推送失败，1推送成功
     */
    public int sendToAliasList(List<String> aliasList, String notification_title, String msg_content, Map<String, String> extrasParam, JPushType jPushType) {
        if (BaseUtil.isEmpty(aliasList)) return 0;
        int result = 0;
        try {
            PushPayload pushPayload = buildPushObject(Platform.all(), Audience.alias(aliasList), msg_content, extrasParam, notification_title, jPushType);
            LOGGER.info("推送给设备标识参数的用户" + pushPayload);
            PushResult pushResult = jPushClient.sendPush(pushPayload);
            LOGGER.info("推送结果" + pushResult);
            if (pushResult.getResponseCode() == 200) {
                result = 1;
            }
        } catch (APIConnectionException e) {
            e.printStackTrace();

        } catch (APIRequestException e) {
            e.printStackTrace();
        }
        return result;
    }

    /**
     * 指定多个别名(Alias)进行多个平台进行推送 (推送给设备标识参数的用户)
     *
     * @param aliasList          别名或别名组
     * @param msg_content        消息内容
     * @param notification_title 通知标题
     * @return 0推送失败，1推送成功
     */
    public int sendToAliasList(List<String> aliasList, String notification_title, String msg_content, JPushType jPushType) {
        if (BaseUtil.isEmpty(aliasList)) return 0;
        int result = 0;
        try {
            PushPayload pushPayload = buildPushObject(Platform.all(), Audience.alias(aliasList), msg_content, new HashMap<String, String>(), notification_title, jPushType);
            LOGGER.info("推送给设备标识参数的用户" + pushPayload);
            PushResult pushResult = jPushClient.sendPush(pushPayload);
            LOGGER.info("推送结果" + pushResult);
            if (pushResult.getResponseCode() == 200) {
                result = 1;
            }
        } catch (APIConnectionException e) {
            e.printStackTrace();

        } catch (APIRequestException e) {
            e.printStackTrace();
        }
        return result;
    }

    /**
     * 指定别名(Alias)进行多个平台进行推送 (推送给设备标识参数的用户)
     *
     * @param alias              别名
     * @param msg_content        消息内容
     * @param extrasParam        扩展参数
     * @param notification_title 通知标题
     * @return 0推送失败，1推送成功
     */
    public int sendToAlias(String alias, String notification_title, String msg_content, Map<String, String> extrasParam, JPushType jPushType) {
        System.err.println("------");
        if (BaseUtil.isEmpty(alias)) return 0;
        int result = 0;
        try {
            PushPayload pushPayload = buildPushObject(Platform.all(), Audience.alias(alias), msg_content, extrasParam, notification_title, jPushType);
            LOGGER.info("推送给设备标识参数的用户" + pushPayload);
            PushResult pushResult = jPushClient.sendPush(pushPayload);
            LOGGER.info("推送结果" + pushResult);
            if (pushResult.getResponseCode() == 200) {
                result = 1;
            }
        } catch (APIConnectionException e) {
            e.printStackTrace();

        } catch (APIRequestException e) {
            e.printStackTrace();
        }
        return result;
    }

    /**
     * 指定别名(Alias)进行多个平台进行推送 (推送给设备标识参数的用户)
     *
     * @param alias              别名或别名组
     * @param msg_content        消息内容
     * @param notification_title 通知标题
     * @return 0推送失败，1推送成功
     */
    public int sendToAlias(String alias, String notification_title, String msg_content, JPushType jPushType) {
        System.err.println(jPushClient);
        if (BaseUtil.isEmpty(alias)) return 0;
        int result = 0;
        try {
            PushPayload pushPayload = buildPushObject(Platform.all(), Audience.alias(alias), msg_content, new HashMap<String, String>(), notification_title, jPushType);
            LOGGER.info("推送给设备标识参数的用户" + pushPayload);
            PushResult pushResult = jPushClient.sendPush(pushPayload);
            LOGGER.info("推送结果" + pushResult);
            if (pushResult.getResponseCode() == 200) {
                result = 1;
            }
        } catch (APIConnectionException e) {
            e.printStackTrace();
        } catch (APIRequestException e) {
            e.printStackTrace();
        }
        return result;
    }

    /**
     * 指定多个标签（Tag）进行多个平台进行推送
     *
     * @param tagsList     Tag或Tag组
     * @param msg_content  消息内容
     * @param extrasParams 扩展字段
     * @return 0推送失败，1推送成功
     */
    public int sendToTagList(List<String> tagsList, String notification_title, String msg_content, Map<String, String> extrasParams, JPushType jPushType) {
        if (BaseUtil.isEmpty(tagsList)) return 0;
        int result = 0;
        try {
            PushPayload pushPayload = buildPushObject(Platform.all(), Audience.tag(tagsList), msg_content, extrasParams, notification_title, jPushType);
            LOGGER.info("" + pushPayload);
            PushResult pushResult = jPushClient.sendPush(pushPayload);
            LOGGER.info("" + pushResult);
            if (pushResult.getResponseCode() == 200) {
                result = 1;
            }
        } catch (APIConnectionException e) {
            e.printStackTrace();

        } catch (APIRequestException e) {
            e.printStackTrace();
        }
        return result;
    }

    /**
     * 指定多个标签（Tag）进行多个平台进行推送
     *
     * @param tagsList    Tag或Tag组
     * @param msg_content 消息内容
     * @return 0推送失败，1推送成功
     */
    public int sendToTagList(List<String> tagsList, String notification_title, String msg_content, JPushType jPushType) {
        if (BaseUtil.isEmpty(tagsList)) return 0;
        int result = 0;
        try {
            PushPayload pushPayload = buildPushObject(Platform.all(), Audience.tag(tagsList), msg_content, new HashMap<String, String>(), notification_title, jPushType);
            LOGGER.info("" + pushPayload);
            PushResult pushResult = jPushClient.sendPush(pushPayload);
            LOGGER.info("" + pushResult);
            if (pushResult.getResponseCode() == 200) {
                result = 1;
            }
        } catch (APIConnectionException e) {
            e.printStackTrace();

        } catch (APIRequestException e) {
            e.printStackTrace();
        }
        return result;
    }

    /**
     * 指定标签（Tag）进行多个平台进行推送
     *
     * @param tag          Tag或Tag组
     * @param msg_content  消息内容
     * @param extrasParams 扩展字段
     * @return 0推送失败，1推送成功
     */
    public int sendToTag(String tag, String notification_title, String msg_content, Map<String, String> extrasParams, JPushType jPushType) {
        if (BaseUtil.isEmpty(tag)) return 0;
        int result = 0;
        try {
            PushPayload pushPayload = buildPushObject(Platform.all(), Audience.tag(tag), msg_content, extrasParams, notification_title, jPushType);
            LOGGER.info("" + pushPayload);
            PushResult pushResult = jPushClient.sendPush(pushPayload);
            LOGGER.info("" + pushResult);
            if (pushResult.getResponseCode() == 200) {
                result = 1;
            }
        } catch (APIConnectionException e) {
            e.printStackTrace();

        } catch (APIRequestException e) {
            e.printStackTrace();
        }
        return result;
    }

    /**
     * 指定标签（Tag）进行多个平台进行推送
     *
     * @param tag         Tag或Tag组
     * @param msg_content 消息内容
     * @return 0推送失败，1推送成功
     */
    public int sendToTag(String tag, String notification_title, String msg_content, JPushType jPushType) {
        if (BaseUtil.isEmpty(tag)) return 0;
        int result = 0;
        try {
            PushPayload pushPayload = buildPushObject(Platform.all(), Audience.tag(tag), msg_content, new HashMap<String, String>(), notification_title, jPushType);
            LOGGER.info("" + pushPayload);
            PushResult pushResult = jPushClient.sendPush(pushPayload);
            LOGGER.info("" + pushResult);
            if (pushResult.getResponseCode() == 200) {
                result = 1;
            }
        } catch (APIConnectionException e) {
            e.printStackTrace();

        } catch (APIRequestException e) {
            e.printStackTrace();
        }
        return result;
    }

    /**
     * 发送给所有用户
     *
     * @param msg_content        消息内容
     * @param extrasParam        扩展字段
     * @param notification_title 通知标题
     * @return 0推送失败，1推送成功
     */
    public int sendToAll(String msg_content, String notification_title, Map<String, String> extrasParam, JPushType jPushType) {
        int result = 0;
        try {
            PushPayload pushPayload = buildPushObject(Platform.android_ios(), Audience.all(), msg_content, extrasParam, notification_title, jPushType);
            LOGGER.info("" + pushPayload);
            PushResult pushResult = jPushClient.sendPush(pushPayload);
            LOGGER.info("" + pushResult);
            if (pushResult.getResponseCode() == 200) {
                result = 1;
            }
        } catch (Exception e) {

            e.printStackTrace();
        }
        return result;
    }

    /**
     * 发送给所有用户
     *
     * @param msg_content        消息内容
     * @param notification_title 通知标题
     * @return 0推送失败，1推送成功
     */
    public int sendToAll(String msg_content, String notification_title, JPushType jPushType) {
        int result = 0;
        try {
            PushPayload pushPayload = buildPushObject(Platform.android_ios(), Audience.all(), msg_content, new HashMap<String, String>(), notification_title, jPushType);
            LOGGER.info("" + pushPayload);
            PushResult pushResult = jPushClient.sendPush(pushPayload);
            LOGGER.info("" + pushResult);
            if (pushResult.getResponseCode() == 200) {
                result = 1;
            }
        } catch (Exception e) {

            e.printStackTrace();
        }

        return result;
    }

    /**
     * 发送给所有安卓用户
     *
     * @param notification_title 通知内容标题
     * @param msg_content        消息内容
     * @param extrasParam        扩展字段
     * @return 0推送失败，1推送成功
     */
    public int sendToAllAndroid(String notification_title, String msg_content, Map<String, String> extrasParam, JPushType jPushType) {
        int result = 0;
        try {
            PushPayload pushPayload = buildPushObject(Platform.android(), Audience.all(), msg_content, extrasParam, notification_title, jPushType);
            LOGGER.info("" + pushPayload);
            PushResult pushResult = jPushClient.sendPush(pushPayload);
            LOGGER.info("" + pushResult);
            if (pushResult.getResponseCode() == 200) {
                result = 1;
            }
        } catch (Exception e) {

            e.printStackTrace();
        }
        return result;
    }

    /**
     * 发送给所有IOS用户
     *
     * @param notification_title 通知内容标题
     * @param msg_content        消息内容
     * @param extrasParam        扩展字段
     * @return 0推送失败，1推送成功
     */
    public int sendToAllIos(String notification_title, String msg_content, Map<String, String> extrasParam, JPushType jPushType) {
        int result = 0;
        try {
            PushPayload pushPayload = buildPushObject(Platform.ios(), Audience.all(), msg_content, extrasParam, notification_title, jPushType);
            LOGGER.info("" + pushPayload);
            PushResult pushResult = jPushClient.sendPush(pushPayload);
            LOGGER.info("" + pushResult);
            if (pushResult.getResponseCode() == 200) {
                result = 1;
            }
        } catch (Exception e) {

            e.printStackTrace();
        }
        return result;
    }

    /**
     * 推送消息
     *
     * @param audience
     * @param msg_content
     * @param extrasParam
     * @param notification_title 通知标题
     * @return
     */
    private PushPayload buildPushObject(Platform platform, Audience audience, String msg_content, Map<String, String> extrasParam, String notification_title, JPushType jPushType) {
        LOGGER.info("----------推送消息中......");
        PushPayload.Builder builder = PushPayload.newBuilder().setPlatform(platform).setAudience(audience);
        if (JPushType.Both.equals(jPushType) || JPushType.Notification.equals(jPushType)) {
            builder = builder
                    .setNotification(Notification.newBuilder()
                            .addPlatformNotification(AndroidNotification.newBuilder()
                                    .setAlert(msg_content)
                                    .setTitle(notification_title)
                                    .addExtras(extrasParam)
                                    .build())
                            .addPlatformNotification(IosNotification.newBuilder()
                                    .setAlert(IosAlert.newBuilder().
                                            setTitleAndBody(notification_title, null, msg_content)
                                            .build()
                                    )
                                    .incrBadge(1)
                                    .setSound("default")
                                    .addExtras(extrasParam)
                                    .build())
                            .build());
        }
        if (JPushType.Both.equals(jPushType) || JPushType.Customize.equals(jPushType)) {
            builder = builder.setMessage(Message.newBuilder()
                    .setMsgContent(msg_content)
                    .setTitle(notification_title)
                    .addExtras(extrasParam)
                    .build());
        }
        builder = builder.setOptions(Options.newBuilder()
                .setApnsProduction(ApnsProduction)
                .setSendno(1)
                .setTimeToLive(86400)
                .build());
        return builder.build();
    }
}

service调用：

@Resource
private JPushUtil jPushUtil;


jPushUtil.sendToAliasList(aliasList, "title" , "content", extrasParam, JPushType.Notification);
Spring Boot入门教程(五十三): 极光推送Java-SDK
人不风流枉少年
04-02 2538
pom.xml <!-- 极光推送 begin --> <dependency> <groupId>cn.jpush.api</groupId> <artifactId>jpush-client</artifactId> <version>3.3.10</version> &...
SpringBoot服务端集成极光推送
AbyssskyLin的博客
11-22 1776
1. 添加依赖 <!-- 极光推送 --> <dependency> <groupId>cn.jpush.api</groupId> <artifactId>jpush-client</artifactId> <version>3.4.6</version> </dependency> <!--<dependency>--> &lt
springboot项目实现极光推送
08-18
springboot项目实现极光推送的，实现APP端的消息推送的工具，集成了，单个推送，群发推送，安卓机或苹果机各种推送方式。
springboot整合极光推送
weixin_38727482的博客
11-09 746
package com.owl.tcc.go.open.Jpush.entity; import lombok.Data; import java.util.Map; /** *@description *@author tyy *@date 2020/11/03 17:01 *@version 1.0 **/ @Data public class PushBean { // 必填, 通知内容, 内容可以为空字符串，则表示不展示到通知栏。 private String ale
【SpringBoot】在SpringBoot中如何使用 极光推送
peng_YuJun的博客
04-14 1790
简单记录一下在SpringBoot中实现极光推送的步骤和程序代码。
Springboot集成极光推送
LC的博客
12-01 792
极光链接： 官网：https://www.jiguang.cn 文档：https://docs.jiguang.cn//jpush/guideline/intro/ java示例git地址：https://github.com/jpush/jpush-api-java-client #1.pom.xml导入依赖 <!-- 极光推送 --> <dependency> <groupId>cn.jpush.api</
springboot 集成极光推送
Yweir的博客
11-10 860
在 Spring Boot 应用中集成极光推送（JPush）可以让开发者轻松地向用户设备发送推送通知。
springboot集成极光推送
07-29
在IT行业中，Spring Boot是一个非常流行的...通过以上步骤，你可以成功地在Spring Boot应用中集成极光推送服务，实现高效、精准的消息推送功能。在实际开发过程中，可以根据项目需求进行调整，以满足特定的业务场景。
Spring boot 集成 极光推送
weixin_42553198的博客
11-09 871
Spring boot 集成 极光推送 1. 注册极光推送账号 在官网首页注册登录 在我的图标下面，点击 服务中心 进入 找到开发者平台 进入 进入开发者应用运营平台 2. 创建应用 填写应用名称 点击确认 点击下一步 设置应用包名，并点击下一步 点击下载推送demo，安装在手机上 3. 获取应用的AppKey 和 Master Secret 在设置里面，找到对应app的 appkey 和 Master Secret 4. 创建springboot应用 在idea中创建Springboo
SpringBoot整合极光推送
qq_39252591的博客
05-13 725
展开 一. 极光推送代码 maven依赖 cn.jpush.api jpush-client 3.2.9 2. 极光配置类 package com.jinzhi.jpush.config; import cn.jpush.api.JPushClient; import org.springframework.beans.factory.annotation.Val...
SpringBoot集成极光推送(第三方)
m0_55841258的博客
05-08 1113
推送消息
SpringBoot集成极光推送完整实现代码（建议收藏）
最新发布
weixin_39255905的博客
08-09 2495
工作中经常会遇到服务器向App推送消息的需求，一般企业中选择用极光推送的比较多，在集成极光时发现极光的文档并不完整，网上的文章也很多不能直接使用，这里列出我在工作中集成极光的全部代码，只需要按照如下代码保证一次性实现。
spring boot 极光推送
YiWait的专栏
11-28 855
spring boot 极光推送
Spring Boot集成极光推送并且使用
yaochangliang的博客
02-03 670
极光推送 SpringBoot
springBoot集成极光 app消息推送
qq_29766917的博客
04-07 1931
极光推送一直以来提供了“广播”、“标签（tag）”、“别名（alias）”和“registration_id”等多种推送方式，这几种推送方式正确使用场景如下： 如果您希望一条推送能发给您 App 下的全量用户，建议您使用“广播”；参考：怎么样广播推送？ 如果您希望一条推送能批量推送给具有相同属性的一群用户，建议您使用“标签（tag）”推送；参考：怎么样向指定的一群用户推送消息？ 如果您希望一条推送只针对指定的某一个用户推送，则您可以选择“别名（alias）”或者“registration_id”推送.
Springboot整合极光推送
Mrz_woDeMeng的博客
03-26 686
java后端实现极光推送 1.需要的maven依赖 // 极光推送 <dependency> <groupId>cn.jpush.api</groupId> <artifactId>jpush-client</artifactId> <version>3.3.11</version> </d...
SpringBoot集成极光推送
weixin_54846521的博客
04-18 248
SpringBoot集成极光推送 1.添加pom依赖,注意依赖版本问题 <dependency> <groupId>cn.jpush.api</groupId> <artifactId>jpush-client</artifactId> <version>3.4.8</version> </dependency>
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值