Spring Boot 集成个推和 UniPush 两种消息推送方式

Posted 2023-03-31 ℳ₯㎕ddzོꦿ࿐

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Spring Boot 集成个推和 UniPush 两种消息推送方式相关的知识，希望对你有一定的参考价值。

Spring Boot 集成个推和 UniPush 两种消息推送方式

一、集成个推
二、集成UniPush
三、总结

Spring Boot 是目前非常流行的Java Web框架之一，它提供了很多便捷的开发方式和功能，其中集成消息推送是比较常见的需求，本篇博客将介绍如何在 Spring Boot 中集成个推和 UniPush 两种消息推送方式。

一、集成个推

1. 注册个推账号

首先需要注册个推账号并创建应用，获取到AppID、AppKey和MasterSecret，这些参数在后续的开发中会用到；需要注意的是之前的老板本已经没有在维护了，现在需要引入最新的依赖包。

个推消息推送
 参考文档
 Demo地址

2. 引入个推SDK

在pom.xml中添加个推SDK的依赖：

<!-- https://mvnrepository.com/artifact/com.getui.push/restful-sdk -->
<dependency>
    <groupId>com.getui.push</groupId>
    <artifactId>restful-sdk</artifactId>
    <version>1.0.0.11</version>
</dependency>

3. 配置个推参数

在application.properties中配置个推相关参数：

# 个推相关配置
getui.appId=你的AppID
getui.appKey=你的AppKey
getui.appSecret=你的AppSecret
getui.masterSecret=你的MasterSecret
getui.baseUrl=https://restapi.getui.com/v2/

或

# 个推相关配置
getui:
	appId: 你的AppID
	appKey: 你的AppKey
	appSecret: 你的AppSecret
	masterSecret: 你的MasterSecret    
	# Url前缀
	baseUrl: https://restapi.getui.com/v2/

4. 编写个推配置类

/**
 * 个推配置类
 **/
@Configuration
public class GeTuiConfig 
    @Value("$getui.baseUrl")
    private String baseUrl;

    @Value("$getui.appId")
    private String appId;

    @Value("$getui.appKey")
    private String appKey;

    @Value("$getui.appSecret")
    private String appSecret;

    @Value("$getui.masterSecret")
    private String masterSecret;

    @Bean(name = "myPushApi")
    public PushApi pushApi() 
        // 设置httpClient最大连接数，当并发较大时建议调大此参数。或者启动参数加上 -Dhttp.maxConnections=200
        System.setProperty("http.maxConnections", "200");
        GtApiConfiguration apiConfiguration = new GtApiConfiguration();
        //填写应用配置
        apiConfiguration.setAppId(appId);
        apiConfiguration.setAppKey(appKey);
        apiConfiguration.setMasterSecret(masterSecret);
        // 接口调用前缀，请查看文档: 接口调用规范 -> 接口前缀, 可不填写appId
        apiConfiguration.setDomain(baseUrl);
        // 实例化ApiHelper对象，用于创建接口对象
        ApiHelper apiHelper = ApiHelper.build(apiConfiguration);
        // 创建对象，建议复用。目前有PushApi、StatisticApi、UserApi
        return apiHelper.creatApi(PushApi.class);

5. 编写个推推送工具类

推送工具的代码如下：

@Slf4j
@Component
public class GeTuiUtils 

    @Resource(name = "myPushApi")
    private PushApi myPushApi;

    /**
     * 单点推送（离线不推送）
     *
     * @param cid     目标
     * @param title   标题
     * @param content 内容
     */
    public void pushMsg(String cid, String title, String content) 
        //根据cid进行单推
        PushDTO<Audience> pushDTO = new PushDTO<>();
        // 设置推送参数
        pushDTO.setRequestId(IdUtil.fastSimpleUUID());
        // 个推推送消息参数
        PushMessage pushMessage = new PushMessage();
        pushDTO.setPushMessage(pushMessage);
        /** 带跳转url*/
//        GTNotification notification = new GTNotification();
//        pushMessage.setNotification(notification);
//        notification.setTitle(title + new Date());
//        notification.setBody(content);
//        notification.setClickType("url");
//        notification.setUrl("https://www.baidu.com");// 跳转地址
        /** 不带跳转url*/
        pushMessage.setTransmission(" title:\\"" + title + "\\",content:\\"" + content + "\\",payload:\\"自定义数据\\"");
        pushDTO.setPushMessage(pushMessage);
        // 设置接收人信息
        Audience audience = new Audience();
        pushDTO.setAudience(audience);
        audience.addCid(cid);
        // 进行cid单推
        ApiResult<Map<String, Map<String, String>>> apiResult = myPushApi.pushToSingleByCid(pushDTO);
        if (apiResult.isSuccess()) 
            // success
            System.out.println(apiResult.getData());
         else 
            // failed
            System.out.println("code:" + apiResult.getCode() + ", msg: " + apiResult.getMsg());
        
    

    /**
     * 推送给多个
     *
     * @param cids    目标集
     * @param title   标题
     * @param content 内容
     */
    public void pushMsg(List<String> cids, String title, String content) 
        List<PushDTO<Audience>> list = new ArrayList<>(cids.size());
        cids.forEach(cid -> 
            PushDTO<Audience> pushDTO = new PushDTO<>();
            // 唯一标识
            pushDTO.setRequestId(IdUtil.fastSimpleUUID());
            // 消息内容
            PushMessage pushMessage = new PushMessage();
            pushMessage.setNetworkType(0);
            // 透传消息内容
            pushMessage.setTransmission(" title:\\"" + title + "\\",content:\\"" + content + "\\",payload:\\"自定义数据\\"");
            pushDTO.setPushMessage(pushMessage);
            // 消息接受人
            Audience audience = new Audience();
            audience.addCid(cid);
            pushDTO.setAudience(audience);
            list.add(pushDTO);
        );
        PushBatchDTO pushBatchDTO = new PushBatchDTO();
        pushBatchDTO.setAsync(true);
        pushBatchDTO.setMsgList(list);
        ApiResult<Map<String, Map<String, String>>> mapApiResult = myPushApi.pushBatchByCid(pushBatchDTO);
        if (mapApiResult.isSuccess()) 
            // success
            System.out.println(mapApiResult.getData());
         else 
            // failed
            System.out.println("code:" + mapApiResult.getCode() + ", msg: " + mapApiResult.getMsg());
        
    

    /**
     * 消息推送（离线推送）
     *
     * @param cid     目标
     * @param title   标题
     * @param content 内容
     */
    public void offlinePushMsg(String cid, String title, String content) 
        //根据cid进行单推
        PushDTO<Audience> pushDTO = new PushDTO<>();
        // 设置推送参数
        pushDTO.setRequestId(System.currentTimeMillis() + "");//requestid需要每次变化唯一
        //配置推送条件
        // 1: 表示该消息在用户在线时推送个推通道，用户离线时推送厂商通道;
        // 2: 表示该消息只通过厂商通道策略下发，不考虑用户是否在线;
        // 3: 表示该消息只通过个推通道下发，不考虑用户是否在线；
        // 4: 表示该消息优先从厂商通道下发，若消息内容在厂商通道代发失败后会从个推通道下发。
        Strategy strategy = new Strategy();
        strategy.setDef(1);
        Settings settings = new Settings();
        settings.setStrategy(strategy);
        pushDTO.setSettings(settings);
        settings.setTtl(3600000);//消息有效期，走厂商消息需要设置该值
        //推送苹果离线通知标题内容
        Alert alert = new Alert();
        alert.setTitle(title);//苹果离线通知栏标题
        alert.setBody(content);//苹果离线通知栏内容
        Aps aps = new Aps();
        //1表示静默推送(无通知栏消息)，静默推送时不需要填写其他参数。
        //苹果建议1小时最多推送3条静默消息
        aps.setContentAvailable(0);
        aps.setSound("default");
        aps.setAlert(alert);
        iosDTO iosDTO = new IosDTO();
        iosDTO.setAps(aps);
        iosDTO.setType("notify");
        PushChannel pushChannel = new PushChannel();
        pushChannel.setIos(iosDTO);
        //安卓离线厂商通道推送消息体
        PushChannel pushChannel1 = new PushChannel();
        androidDTO androidDTO = new AndroidDTO();
        Ups ups = new Ups();
        ThirdNotification notification1 = new ThirdNotification();
        ups.setNotification(notification1);
        notification1.setTitle(title);//安卓离线展示的标题
        notification1.setBody(content);//安卓离线展示的内容
        notification1.setClickType("intent");
        notification1.setIntent("intent:#Intent;launchFlags=0x04000000;action=android.intent.action.oppopush;component=io.dcloud.HBuilder/io.dcloud.PandoraEntry;S.UP-OL-SU=true;S.title=测试标题;S.content=测试内容;S.payload=test;end");
        //各厂商自有功能单项设置
        //ups.addOption("HW", "/message/android/notification/badge/class", "io.dcloud.PandoraEntry ");
        //ups.addOption("HW", "/message/android/notification/badge/add_num", 1);
        //ups.addOption("HW", "/message/android/notification/importance", "HIGH");
        //ups.addOption("VV","classification",1);
        androidDTO.setUps(ups);
        pushChannel1.setAndroid(androidDTO);
        pushDTO.setPushChannel(pushChannel1);

        // PushMessage在线走个推通道才会起作用的消息体
        PushMessage pushMessage = new PushMessage();
        pushDTO.setPushMessage(pushMessage);
        pushMessage.setTransmission(" title:\\"" + title + "\\",content:\\"" + content + "\\",payload:\\"自定义数据\\"");
        // 设置接收人信息
        Audience audience = new Audience();
        pushDTO.setAudience(audience);
        audience.addCid(cid);// cid
        // 进行cid单推
        ApiResult<Map<String, Map<String, String>>> apiResult = myPushApi.pushToSingleByCid(pushDTO);
        if (apiResult.isSuccess()) 
            // success
            System.out.println(apiResult.getData());
         else 
            // failed
            System.out.println("code:" + apiResult.getCode() + ", msg: " + apiResult.getMsg());
        
    

    /**
     * 官方api案例
     */
    public void offlinePushMsg1() 
        //根据cid进行单推
        PushDTO<Audience> pushDTO = new PushDTO<Audience>();
        // 设置推送参数
        pushDTO.setRequestId(System.currentTimeMillis() + "");
        /**** 设置个推通道参数 *****/
        PushMessage pushMessage = new PushMessage();
        pushDTO.setPushMessage(pushMessage);
        GTNotification notification = new GTNotification();
        pushMessage.setNotification(notification);
        notification.setTitle("个title");
        notification.setBody("个body");
        notification.setClickType("url");
        notification.setUrl("https://www.getui.com");
        /**** 设置个推通道参数，更多参数请查看文档或对象源码 *****/

        /**** 设置厂商相关参数 ****/
        PushChannel pushChannel = new PushChannel();
        pushDTO.setPushChannel(pushChannel);
        /*配置安卓厂商参数*/
        AndroidDTO androidDTO = new AndroidDTO();
        pushChannel.setAndroid(androidDTO);
        Ups ups = new Ups();
        androidDTO.setUps(ups);
        ThirdNotification thirdNotification = new ThirdNotification();
        ups.setNotification(thirdNotification);
        thirdNotification.setTitle("厂商title");
        thirdNotification.setBody("厂商body");
        thirdNotification.setClickType("url");
        thirdNotification.setUrl("https://www.getui.com");
        // 两条消息的notify_id相同，新的消息会覆盖老的消息，取值范围：0-2147483647
        // thirdNotification.setNotifyId("11177");
        /*配置安卓厂商参数结束，更多参数请查看文档或对象源码*/

        /*设置ios厂商参数*/
        IosDTO iosDTO = new IosDTO();
        pushChannel.setIos(iosDTO);
        // 相同的collapseId会覆盖之前的消息
        iosDTO.setApnsCollapseId("xxx");
        Aps aps = new Aps();
        iosDTO.setAps(aps);
        Alert alert = new Alert();
        aps.setAlert(alert);
        alert.setTitle("通知消息标题");
        alert.setBody("通知消息内容");
        /*设置ios厂商参数结束，更多参数请查看文档或对象源码*/

        /*设置接收人信息*/
        Audience audience = new Audience();
        pushDTO.setAudience(audience);
        audience.addCid("xxx");
        /*设置接收人信息结束*/
        /**** 设置厂商相关参数，更多参数请查看文档或对象源码 ****/

        // 进行cid单推
        ApiResult<Map<String, Map<String, String>>> apiResult = myPushApi.pushToSingleByCid(pushDTO);
        if (apiResult.isSuccess()) 
            // success
            System.out.println(apiResult.getData());
         else 
            // failed
            System.out.println("code:" + apiResult.getCode() + ", msg: " + apiResult.getMsg());

调用推送代码：

    @Resource
    private GeTuiUtils geTuiUtils;

    public void pushOne(String cid, String title, String content) 
        geTuiUtils.pushMsg(cid, title, content);

二、集成UniPush

1. 注册UniPush账号

首先需要注册UniPush账号并创建应用，获取到AppKey和AppSecret，这些参数在后续的开发中会用到。

UniPush

2. 引入UniPush SDK

在pom.xml中添加UniPush SDK的依赖：

<dependency>
    <groupId>com.github.yunai</groupId>
    <artifactId>yunpian-unipush-sdk</artifactId>
    <version>2.2.2</version>
</dependency>

3. 配置UniPush参数

在application.properties中配置UniPush相关参数：

# UniPush相关配置
unipush.appkey=你的AppKey
unipush.appsecret=你的AppSecret
unipush.host=https://api.unipush.me/rest/

或

#
Spring Boot 和 Nginx 集成

【中文标题】Spring Boot 和 Nginx 集成【英文标题】：Spring Boot and Nginx integration   
            【发布时间】：2016-08-31 15:57:25 
            【问题描述】： 
            

                
在我的项目中，Web 应用程序是使用带有默认 tomcat 服务器的 Spring boot 开发的。
我使用 NGINX 作为负载平衡器，并在 NGINX 配置中配置了我的 spring-boot-web-app，如下所示：

location /spring-boot-web-app 
     proxy_pass http://spring-boot-web-app/


http 
    upstream /spring-boot-web-app 
        server <IP_of_spring_boot_app>:<Port_of_spring_boot_app>
    



现在让我们将 NGINX IP 和端口分别称为 nginx_ip 和 nginx_port。
我的网络应用程序的工作 URL 也为：http://web_app_ip:web_app_port/rest/echo/hi

上面的 URL 工作正常。但是当我尝试通过 NGINX 访问相同的 URI 时，它会抛出 404。通过 NGINX 使用的 URL 为：
http://nginx_ip:nginx_port/spring-boot-web-app/rest/echo/hi

我有什么遗漏吗？
    

        

    
    

        【问题讨论】：

            

        
        
            
                
                你检查过 nginx 日志吗？
                
              
                
            
        
    
    
        
        
            
                
                是的。即使我看到它拦截 URL 的应用程序日志。
                
              
                
            
        
    
    
        
        
            
                
                不知何故，我觉得它更多的是与 CORS 相关的问题。我需要设置任何标题值吗？
                
              
                
            
        
    
    
        
        
            
                
                您可能需要设置proxy_pass_reverse nginx.com/resources/wiki/start/topics/examples/likeapache, ***.com/questions/12847771/…
                
              
                
                        
            
        
    
    
        
        
            
                
                是 $remote_add 并且 $host 应该是我的网络应用的 IP？
                
              
                
            
        
    

            

 
             
            【参考方案1】： 
                

    
    
这对我有用。你可以试试这个吗？



运行tomcat

docker run -d -p 8080:8080 --name=tomcat tomcat:8 



运行 nginx 

docker run -d -p 80:80 --link tomcat:tomcat --name=nginx nginx



进入 nginx 容器并更新配置文件

docker exec -it nginx bash


/etc/nginx/nginx.conf：

server 
   listen 80 default_server;
  server_name subdomain.domain.com;
  location / 
      proxy_pass http://tomcat:8080;
      proxy_set_header Host      $host;
      proxy_set_header X-Real-IP $remote_addr;
  




重启nginx服务

nginx -s reload



从主机浏览器通过 nginx 访问 tomcat。您可能需要向 /etc/hosts 添加条目

http://subdomain.domain.com



完成 nginx 配置：nginx.conf
    
    
    





             
    
        【讨论】：
            

        
        
            
                
                非常感谢您的帮助“Gangaraju”。但是你提出的 docker 命令我不能使用。因为我正在使用 consul 来做这件事并定义依赖关系。
                
              
                
            
        
    
    
        
        
            
                
                它可能不适合您的环境。但是尝试通过与这些步骤进行比较来调试您的问题并检查您缺少的内容。我建议你在其他环境中运行这些容器来交叉验证 nginx 配置/以便更好地理解
                
              
                
            
        
    
    
        
        
            
                
                非常感谢 Gangaraju 的及时帮助。非常感谢！1
                
              
                
            
        
    
    
        
        
            
                
                接受了答案，因为它提供了一些调试途径。一旦我得到它会发布解决方案。以上是关于Spring Boot 集成 个推 和 UniPush 两种消息推送方式的主要内容，如果未能解决你的问题，请参考以下文章 
 Spring-boot 和 Keycloak 集成
 Spring Boot集成Spring Cache 和 Redis
 spring boot 和 mybatis集成
 Angular集成Spring Boot,Spring Security,JWT和CORS
 Flyway 和 Spring Boot 集成
 个推怎么管理亿级代码的质量？持续集成SonarQube 代码质量管理系统

Spring Boot 集成 个推 和 UniPush 两种消息推送方式

Spring Boot 集成 个推 和 UniPush 两种消息推送方式

一、集成个推

1. 注册个推账号

2. 引入个推SDK

3. 配置个推参数

4. 编写个推配置类

5. 编写个推推送工具类

二、集成UniPush

1. 注册UniPush账号

2. 引入UniPush SDK

3. 配置UniPush参数

Spring Boot 和 Nginx 集成

Spring Boot 集成个推和 UniPush 两种消息推送方式

Spring Boot 集成个推和 UniPush 两种消息推送方式