Spring boot 集成消息推送个推 unipush消息推送

梦里梦外; 2023-10-04 12:51 65阅读 0赞

#### 集成uniPush消息推送 ####

*  1. 安装依赖
 *  2.在项目的yml文件里增加配置
 *  3.创建配置类
 *  4.编写工具类

## 1. 安装依赖 ##

推荐通过Maven来管理项目依赖，您只需在项目的pom.xml文件中声明如下依赖

<dependency>
            <groupId>com.getui.push</groupId>
            <artifactId>restful-sdk</artifactId>
            <version>1.0.0.1</version>
        </dependency>

## 2.在项目的yml文件里增加配置 ##

# 个推
    getui:
      # Url前缀
      baseUrl: https://restapi.getui.com/v2/
      # appId、appKey、appSecret、masterSecret 需要去HBuilderX打包配置里拿
      appId: appId
      appKey: appKey
      appSecret: appSecret
      masterSecret: masterSecret

## 3.创建配置类 ##

import com.getui.push.v2.sdk.ApiHelper;
    import com.getui.push.v2.sdk.GtApiConfiguration;
    import com.getui.push.v2.sdk.api.PushApi;
    import com.getui.push.v2.sdk.api.StatisticApi;
    import com.getui.push.v2.sdk.api.UserApi;
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    /**
     * @program: dashen-api
     * @description 个推配置
     * @author: fanzhen
     * @create: 2021-05-08 17:46
     **/
    @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() {
        
            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
            PushApi pushApi = apiHelper.creatApi(PushApi.class);
            return pushApi;
        }
    
    //    @Bean(name = "myStatisticApi")
    //    public StatisticApi statisticApi() {
        
    //        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
    //        StatisticApi pushApi = apiHelper.creatApi(StatisticApi.class);
    //        return pushApi;
    //    }
    //
    //    @Bean(name = "myUserApi ")
    //    public UserApi userApi() {
        
    //        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
    //        UserApi pushApi = apiHelper.creatApi(UserApi.class);
    //        return pushApi;
    //    }
    
    
    }

## 4.编写工具类 ##

这里可以自己设置点击消息跳转的url

import com.getui.push.v2.sdk.ApiHelper;
    import com.getui.push.v2.sdk.GtApiConfiguration;
    import com.getui.push.v2.sdk.api.PushApi;
    import com.getui.push.v2.sdk.common.ApiResult;
    import com.getui.push.v2.sdk.dto.req.Audience;
    import com.getui.push.v2.sdk.dto.req.Settings;
    import com.getui.push.v2.sdk.dto.req.Strategy;
    import com.getui.push.v2.sdk.dto.req.message.PushChannel;
    import com.getui.push.v2.sdk.dto.req.message.PushDTO;
    import com.getui.push.v2.sdk.dto.req.message.PushMessage;
    import com.getui.push.v2.sdk.dto.req.message.android.AndroidDTO;
    import com.getui.push.v2.sdk.dto.req.message.android.GTNotification;
    import com.getui.push.v2.sdk.dto.req.message.android.ThirdNotification;
    import com.getui.push.v2.sdk.dto.req.message.android.Ups;
    import com.getui.push.v2.sdk.dto.req.message.ios.Alert;
    import com.getui.push.v2.sdk.dto.req.message.ios.Aps;
    import com.getui.push.v2.sdk.dto.req.message.ios.IosDTO;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.stereotype.Component;
    
    import javax.annotation.Resource;
    import java.util.Date;
    import java.util.Map;
    
    @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<Audience>();
            // 设置推送参数
            pushDTO.setRequestId(System.currentTimeMillis() + "");
            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(s -> {
        
                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(s);
                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 pushMsg1(String cid, String title, String content) {
        
            //根据cid进行单推
            PushDTO<Audience> pushDTO = new PushDTO<Audience>();
            // 设置推送参数
            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());
            }
        }
    }