devbox
我家自动化
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

个推消息推送SDK快速Springboot项目集成案例_个推java sdk使用

作者：我家自动化 | 2024-03-20 15:22:19

赞

踩

个推java sdk使用

这些步骤仅提供了一个基本的集成个推的框架，具体的实现和细节可能因个推的版本和需求而有所不同。因此，建议根据个推的官方文档进行详细的配置和使用说明，并参考相关示例代码来完成集成。

官网：个推消息推送—Android和iOS推送SDK快速集成，免费使用

文档：开发前必读-个推文档中心

案例：https://github.com/GetuiLaboratory/getui-pushapi-java-client-v2

  1. 用户登陆手机 将clientid和用户id绑定 
    1. @Autowired
    2. private ClientInfoService clientInfoService;
    3.  
    4. @ApiOperation(value = "用户绑定")
    5. @PostMapping("/bind")
    6. public ApiResult submit(@RequestBody ClientInfoBindDTO bindDTO) {
    7.     this.clientInfoService.bind(bindDTO);
    8.     return R.success("操作成功");
    9. }
    10.  
    11.  
    12. @Service
    13. public class ClientInfoServiceImpl extends ServiceImpl<ClientInfoMapper, ClientInfo> implements ClientInfoService{
    14.  
    15.     @Override
    16.     public void bind(ClientInfoBindDTO bindDTO) {
    17.         ClientInfo one = this.getOne(new LambdaQueryWrapper<ClientInfo>().eq(ClientInfo::getUserId, bindDTO.getUserId()).eq(ClientInfo::getPlatform, bindDTO.getPlatform()));
    18.         ClientInfo clientInfo = ModelMapper.map(bindDTO, ClientInfo.class);
    19.         if (one == null) {
    20.             this.save(clientInfo);
    21.         } else {
    22.             if (!one.getCid().equals(bindDTO.getCid())) {
    23.                 // 更新CID
    24.                 clientInfo.setId(one.getId());
    25.                 this.updateById(clientInfo);
    26.             }
    27.         }
    28.     }
    29. }
    30.  
    31.  
    32. /**
    33.  * app消息推送表
    34.  * @TableName spang_client_info
    35.  */
    36. @TableName(value ="spang_client_info")
    37. @Data
    38. public class ClientInfo implements Serializable {
    39.  
    40.     private static final long serialVersionUID = 1L;
    41.  
    42.     /**
    43.      * 主键
    44.      */
    45.     @JsonSerialize(using = ToStringSerializer.class)
    46.     @ApiModelProperty(value = "主键id")
    47.     @TableId(value = "id", type = IdType.ASSIGN_ID)
    48.     private Long id;
    49.  
    50.     /**
    51.      * 用户主键ID
    52.      */
    53.     @TableField(value = "user_id")
    54.     private Long userId;
    55.  
    56.     /**
    57.      * 推送使用的clientId
    58.      */
    59.     @TableField(value = "cid")
    60.     private String cid;
    61.  
    62.     /**
    63.      * 所属平台
    64.      */
    65.     @TableField(value = "platform")
    66.     private String platform;
    67.  
    68.     /**
    69.      * 别名
    70.      */
    71.     @TableField(value = "alias")
    72.     private String alias;
    73.  
    74.     /**
    75.      * 城市
    76.      */
    77.     @TableField(value = "city")
    78.     private String city;
    79.  
    80. }
    81.  
    82. @Data
    83. @ApiModel(description = "绑定系统用户与个推用户的clientId")
    84. public class ClientInfoBindDTO implements Serializable {
    85.     private static final long serialVersionUID = 1L;
    86.  
    87.     @ApiModelProperty(value = "用户主键ID")
    88.     private Long userId;
    89.  
    90.     @ApiModelProperty(value = "个推对应的用户客户端ID")
    91.     private String cid;
    92.  
    93.     @ApiModelProperty(value = "个推对应的用户客户端平台类型")
    94.     private String platform;
    95. }
    96.  
    97.  
    98. DROP TABLE IF EXISTS `spang_client_info`;
    99. CREATE TABLE `spang_client_info`  (
    100.   `id` bigint(20) NOT NULL COMMENT '主键',
    101.   `user_id` bigint(20) NOT NULL COMMENT '用户主键ID',
    102.   `cid` varchar(100) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT '推送使用的clientId',
    103.   `platform` varchar(20) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL COMMENT '所属平台',
    104.   `alias` varchar(150) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '别名',
    105.   `city` varchar(30) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL COMMENT '城市',
    106.   PRIMARY KEY (`id`) USING BTREE
    107. ) ENGINE = InnoDB CHARACTER SET = utf8 COLLATE = utf8_general_ci COMMENT = 'app消息推送表' ROW_FORMAT = Dynamic;

  2. 导入个推的 Java SDK 包：在 Maven 或 Gradle 中添加个推的 Java SDK 依赖项。例如，在 Maven 中的 pom.xml 文件中添加以下依赖项： 
    1. <!--个推-->
    2.  <dependency>
    3.    <groupId>com.getui.push</groupId>
    4.    <artifactId>restful-sdk</artifactId>
    5.    <version>1.0.0.1</version>
    6. </dependency>

  3. 配置个推的参数：根据个推的配置，创建一个配置文件（例如 getui.properties）来存储个推的相关参数，如 AppID、AppKey、MasterSecret 等。在 Spring Boot 的配置文件（如 application.yml 或 application.properties）中，设置个推参数的值。

    1. /**
    2. app:
    3.   appId: xxxxx
    4.   appKey: xxxxx
    5.   masterSecret: xxxxxx
    6.   packageName: xxxxxxx
    7. **/
    8.  
    9. @Data
    10. @Configuration
    11. @ConfigurationProperties(prefix = "app")
    12. public class PushConfig {
    13.     public String appId;
    14.     public String appKey;
    15.     public String masterSecret;
    16.     public String packageName;
    17.  
    18.     private PushProvider pushProvider;
    19.  
    20.     /**
    21.      * 个推获取初始化信息
    22.      *
    23.      * @param
    24.      * @return com.spang.emergency.service.PushProvider
    25.      */
    26.     public PushProvider getPushProvider() {
    27.         if (this.pushProvider == null) {
    28.             pushProvider = new PushProvider(appId, appKey, masterSecret, packageName);
    29.         } else {
    30.             pushProvider.refreshApi();
    31.         }
    32.         return pushProvider;
    33.     }
    34.  
    35.     public PushProvider readySendMsg() {
    36.         return pushProvider;
    37.     }
    38. }

  4. 创建个推的服务类：创建一个 Java 类，用于封装个推相关的操作。在该类中，注入配置文件中的参数，并实现推送消息、绑定用户等个推功能的方法。

    1. import cn.hutool.core.util.StrUtil;
    2. import cn.hutool.json.JSONObject;
    3. import cn.hutool.json.JSONUtil;
    4. import com.getui.push.v2.sdk.ApiHelper;
    5. import com.getui.push.v2.sdk.GtApiConfiguration;
    6. import com.getui.push.v2.sdk.api.PushApi;
    7. import com.getui.push.v2.sdk.api.UserApi;
    8. import com.getui.push.v2.sdk.common.ApiResult;
    9. import com.getui.push.v2.sdk.dto.req.*;
    10. import com.getui.push.v2.sdk.dto.req.message.PushBatchDTO;
    11. import com.getui.push.v2.sdk.dto.req.message.PushChannel;
    12. import com.getui.push.v2.sdk.dto.req.message.PushDTO;
    13. import com.getui.push.v2.sdk.dto.req.message.PushMessage;
    14. import com.getui.push.v2.sdk.dto.req.message.android.AndroidDTO;
    15. import com.getui.push.v2.sdk.dto.req.message.android.ThirdNotification;
    16. import com.getui.push.v2.sdk.dto.req.message.android.Ups;
    17. import com.getui.push.v2.sdk.dto.req.message.ios.Alert;
    18. import com.getui.push.v2.sdk.dto.req.message.ios.Aps;
    19. import com.getui.push.v2.sdk.dto.req.message.ios.IosDTO;
    20. import com.google.common.collect.Maps;
    21. import lombok.extern.slf4j.Slf4j;
    22. import org.apache.commons.lang.StringUtils;
    23. import org.springframework.util.CollectionUtils;
    24.  
    25. import java.util.*;
    26.  
    27. @Slf4j
    28. public class PushProvider {
    29.     private String appId;
    30.     private String appKey;
    31.     private String masterSecret;
    32.     private String packageName;
    33.     private ApiHelper apiHelper;
    34.     private static PushApi pushApi;
    35.     private static UserApi userApi;
    36.  
    37.     public PushProvider(String appId, String appKey, String masterSecret, String packageName) {
    38.         this.appId = appId;
    39.         this.appKey = appKey;
    40.         this.masterSecret = masterSecret;
    41.         this.packageName = packageName;
    42.         GtApiConfiguration apiConfiguration = new GtApiConfiguration();
    43.         //填写应用配置
    44.         apiConfiguration.setAppId(appId);
    45.         apiConfiguration.setAppKey(appKey);
    46.         apiConfiguration.setMasterSecret(masterSecret);
    47.         // 实例化ApiHelper对象，用于创建接口对象
    48.         apiHelper = ApiHelper.build(apiConfiguration);
    49.         pushApi = apiHelper.creatApi(PushApi.class);
    50.         userApi = apiHelper.creatApi(UserApi.class);
    51.     }
    52.  
    53.     /**
    54.      * 配置数据有变化,则刷新个推api认证信息
    55.      */
    56.     public void refreshApi() {
    57.         GtApiConfiguration apiConfiguration = new GtApiConfiguration();
    58.         //填写应用配置
    59.         apiConfiguration.setAppId(appId);
    60.         apiConfiguration.setAppKey(appKey);
    61.         apiConfiguration.setMasterSecret(masterSecret);
    62.         // 实例化ApiHelper对象，用于创建接口对象
    63.         apiHelper = ApiHelper.build(apiConfiguration);
    64.         pushApi = apiHelper.creatApi(PushApi.class);
    65.         userApi = apiHelper.creatApi(UserApi.class);
    66.     }
    67.  
    68.     /**
    69.      * 个推批量推送
    70.      */
    71.     public void pushBatchByCid(List<String> clientIds, Message message) {
    72.         try {
    73.             if (CollectionUtils.isEmpty(clientIds)) {
    74.                 return;
    75.             }
    76.             PushBatchDTO pushBatchDTO = new PushBatchDTO();
    77.             List<PushDTO<Audience>> msgList = new ArrayList<>(clientIds.size());
    78.             for (String clientId : clientIds) {
    79.                 PushDTO<Audience> pushDTO = buildPushDTO(message);
    80.                 pushDTO.setAudience(buildAudienceByCid(clientId));
    81.                 msgList.add(pushDTO);
    82.             }
    83.             pushBatchDTO.setAsync(true);
    84.             pushBatchDTO.setMsgList(msgList);
    85.             ApiResult<Map<String, Map<String, String>>> apiResult = pushApi.pushBatchByCid(pushBatchDTO);
    86.             judgeResult(apiResult);
    87.         } catch (Exception e) {
    88.             // 个推是否成功不关心,此处异常不处理
    89.         }
    90.     }
    91.  
    92.     /**
    93.      * 个推单人推送
    94.      * @param clientId
    95.      * @param message
    96.      * @return java.lang.Boolean
    97.      */
    98.     public void pushToSingleByCid(String clientId, Message message) {
    99.         try {
    100.             PushDTO<Audience> pushDTO = buildPushDTO(message);
    101.             Audience audience = buildAudienceByCid(clientId);
    102.             pushDTO.setAudience(audience);
    103.             ApiResult<Map<String, Map<String, String>>> apiResult = pushApi.pushToSingleByCid(pushDTO);
    104.             judgeResult(apiResult);
    105.         } catch (Exception e) {
    106.             // 个推是否成功不关心,此处异常不处理
    107.         }
    108.     }
    109.  
    110.     private PushDTO buildPushDTO(Message message) {
    111.         if (Objects.isNull(message) || StringUtils.isEmpty(message.getTitle()) || StrUtil.isEmpty(message.getContent()) || Objects.isNull(message.getPayload())) {
    112.             throw new IllegalArgumentException("消息不能为空!");
    113.         }
    114.         PushDTO pushDTO = new PushDTO();
    115.         // 推送消息设置
    116.         pushDTO.setRequestId(System.currentTimeMillis() + "");//requestid需要每次变化唯一
    117.         //配置推送条件
    118.         // 1: 表示该消息在用户在线时推送个推通道，用户离线时推送厂商通道;
    119.         // 2: 表示该消息只通过厂商通道策略下发，不考虑用户是否在线;
    120.         // 3: 表示该消息只通过个推通道下发，不考虑用户是否在线；
    121.         // 4: 表示该消息优先从厂商通道下发，若消息内容在厂商通道代发失败后会从个推通道下发。
    122.         Strategy strategy = new Strategy();
    123.         strategy.setDef(1);
    124.         Settings settings = new Settings();
    125.         settings.setStrategy(strategy);
    126.         pushDTO.setSettings(settings);
    127.         settings.setTtl(3600000 * 12);//消息有效期，走厂商消息需要设置该值,默认12小时
    128.         //推送苹果离线通知标题内容
    129.         Alert alert = new Alert();
    130.         alert.setTitle(message.getTitle());
    131.         alert.setBody(message.getContent());
    132.         Aps aps = new Aps();
    133.         //1表示静默推送(无通知栏消息)，静默推送时不需要填写其他参数。
    134.         //苹果建议1小时最多推送3条静默消息
    135.         aps.setContentAvailable(0);
    136.         aps.setSound("default");
    137.         aps.setAlert(alert);
    138.         IosDTO iosDTO = new IosDTO();
    139.         iosDTO.setAps(aps);
    140.         iosDTO.setType("notify");
    141.         iosDTO.setAutoBadge("+1");
    142.         JSONObject jsonObject1 = JSONUtil.parseObj(message.getPayload());
    143.         jsonObject1.put("alive", false);
    144.         String s1 = jsonObject1.toString();
    145.         iosDTO.setPayload(s1);
    146.         PushChannel pushChannel = new PushChannel();
    147.         pushChannel.setIos(iosDTO);
    148.         //安卓离线厂商通道推送消息体
    149.         AndroidDTO androidDTO = new AndroidDTO();
    150.         Ups ups = new Ups();
    151.         ThirdNotification notification1 = new ThirdNotification();
    152.         ups.setNotification(notification1);
    153.         notification1.setTitle(message.getTitle());
    154.         notification1.setBody(message.getContent());
    155.         notification1.setClickType("intent");
    156.         JSONObject jsonObject = JSONUtil.parseObj(message.getPayload());
    157.         jsonObject.put("alive", false);
    158.         String s = jsonObject.toString();
    159.  
    160.  
    161.         notification1.setIntent("intent:" +
    162.                 "#Intent;" +
    163.                 "launchFlags=0x04000000;" +
    164.                 "action=android.intent.action.oppopush;" +
    165.                 "component=" + packageName + "/io.dcloud.PandoraEntry;" +
    166.                 "S.UP-OL-SU=true;" +
    167.                 "S.title=" + message.getTitle() + ";" +
    168.                 "S.content=" + message.getContent() + ";" +
    169.                 "S.payload=" + s + ";" +
    170.                 "end");
    171.         //各厂商自有功能单项设置
    172.         //ups.addOption("HW", "/message/android/notification/badge/class", "io.dcloud.PandoraEntry ");
    173.         //ups.addOption("HW", "/message/android/notification/badge/add_num", 1);
    174.         //ups.addOption("HW", "/message/android/notification/importance", "HIGH");
    175.         //ups.addOption("VV","classification",1);
    176.         androidDTO.setUps(ups);
    177.         pushChannel.setAndroid(androidDTO);
    178.         pushDTO.setPushChannel(pushChannel);
    179.  
    180.         // PushMessage在线走个推通道才会起作用的消息体
    181.         PushMessage pushMessage = new PushMessage();
    182.         pushDTO.setPushMessage(pushMessage);
    183.         HashMap<String, String> transmission = Maps.newHashMap();
    184.         transmission.put("title", message.getTitle());
    185.         transmission.put("content", message.getContent());
    186.         transmission.put("payload", message.getPayload());
    187.         pushMessage.setTransmission(JSONUtil.toJsonStr(transmission));
    188.         return pushDTO;
    189.     }
    190.  
    191.     private Audience buildAudienceByCid(String clientId) {
    192.         if (StringUtils.isBlank(clientId)) {
    193.             throw new IllegalArgumentException("参数不合法!");
    194.         }
    195.         Audience audience = new Audience();
    196.         audience.addCid(clientId);
    197.         return audience;
    198.     }
    199.  
    200.     private Boolean judgeResult(ApiResult<Map<String, Map<String, String>>> result) {
    201.         if (Objects.isNull(result)) {
    202.             log.error("推送结果为空!");
    203.             return Boolean.FALSE;
    204.         }
    205.         if (CollectionUtils.isEmpty(result.getData())) {
    206.             log.error("推送结果异常,code:{}, msg:{}", result.getCode(), result.getMsg());
    207.             return Boolean.FALSE;
    208.         }
    209.         if (result.isSuccess()) {
    210.             log.info("消息推送成功,code:" + result.getCode() + ", msg:" + result.getMsg());
    211.             return Boolean.TRUE;
    212.         } else {
    213.             log.info("消息推送失败,code:" + result.getCode() + ", msg:" + result.getMsg());
    214.             return Boolean.FALSE;
    215.         }
    216.     }
    217. }
    1. @Data
    2. public class Message {
    3.     private String title;
    4.     private String content;
    5.     private String payload;
    6. }

  5. 在需要使用个推的地方调用相关方法：在需要使用个推功能的地方，通过依赖注入的方式引入个推的服务类，并调用相应的方法来完成推送消息、绑定用户等操作。

    1.  PushProvider pushProvider = pushConfig.readySendMsg();
    2.  String msg = "要推送的消息xxxx"
    3.  // 推送APP
    4.  Message message = new Message();
    5.  message.setTitle("标题");
    6.  message.setContent(msg);
    7.  pushProvider.pushBatchByCid(cids, message);

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/我家自动化/article/detail/274561
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号