极光推送零基础极速上手开发指南，快速搭建后台推送服务

水深无声 2024-03-29 14:51 38阅读 0赞

## 一、基础配置 ##

### 1.依赖配置 ###

<dependency>
       <groupId>cn.jpush.api</groupId>
       <artifactId>jiguang-common</artifactId>
       <version>1.1.4</version>
    </dependency>
    <dependency>
       <groupId>io.netty</groupId>
       <artifactId>netty-all</artifactId>
       <version>4.1.6.Final</version>
       <scope>compile</scope>
    </dependency>
    <dependency>
       <groupId>com.google.code.gson</groupId>
       <artifactId>gson</artifactId>
       <version>2.3</version>
    </dependency>
    <dependency>
       <groupId>cn.jpush.api</groupId>
       <artifactId>jpush-client</artifactId>
       <version>3.3.10</version>
    </dependency>

### 2、极光推送配置类 JpsuhConfig.java ###

package com.service.msg.config.jpush;
    
    import org.springframework.beans.factory.annotation.Value;
    import org.springframework.context.annotation.Configuration;
    
    import cn.jiguang.common.ClientConfig;
    import cn.jpush.api.JPushClient;
    
    /**
     * 极光推送配置类
     * @author: huang ******
     * @date:   2023年1月12日 上午10:28:53
     */
    
    @Configuration
    public class JpsuhConfig {
    
    	@Value("${jpush.appKey}")
    	private String appKey;
    	
    	@Value("${jpush.masterSecret}")
    	private String masterSecret;
    	
    	public JPushClient createClient() {
    		 JPushClient jpushClient = new JPushClient("b671d2c5dcb1b6a72e1bde53", "aabbb7684426998689f16a02", null, ClientConfig.getInstance());
    		 return jpushClient;
    	}
    }

### 3、全局变量 AppKey 和 Master Secret 变量配置 ###

#### 3.1.两种配置方式 ####

>  *  application.yml 配置文件配置
>  *  jpush.properties 配置文件配置
>  *  AppKey：移动端APP应用的唯一标识key
>  *  Master Secret：极光推送secret

#### 3.2.本文是采用 yml格式配置 ####

jpush:
      appKey: aabb******26998689f16a02
      masterSecret: b671d2c5dcb1b6*****de53
      apnsProduction: false

apnsProduction: false 开发环境是FALSE；生产环境是TRUE；

### 4.封装极光推送工具类 JpushUtil.java ###

package com.service.msg.utils;
    
    import cn.jiguang.common.resp.APIConnectionException;
    import cn.jiguang.common.resp.APIRequestException;
    import cn.jpush.api.JPushClient;
    import cn.jpush.api.push.PushResult;
    import cn.jpush.api.push.model.Message;
    import cn.jpush.api.push.model.Options;
    import cn.jpush.api.push.model.Platform;
    import cn.jpush.api.push.model.PushPayload;
    import cn.jpush.api.push.model.audience.Audience;
    import cn.jpush.api.push.model.notification.AndroidNotification;
    import cn.jpush.api.push.model.notification.IosNotification;
    import cn.jpush.api.push.model.notification.Notification;
    import com.alibaba.fastjson.JSONArray;
    import java.util.List;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Value;
    
    /**
     * 极光推送工具包
     *
     * @author: huang ******
     * @date: 2023年1月12日 上午10:28:53
     */
    public class JpushUtil {
    
      private static final Logger log = LoggerFactory.getLogger(JpushUtil.class);
    
      /** 上线之后要改为true */
      @Value("${jpush.apnsProduction}")
      private static final Boolean APNS_PRODUCTION = false;
    
      /** 上线之后要改为true */
      private static final int SUCCESS_CODE = 200;
    
      /**
       * 推送给别名的用户 @Description:
       *
       * @param jPushClient
       * @param aliasList
       * @param notificationTitle
       * @param msgTitle
       * @param msgContent
       * @param extraKey
       * @param extrasparam
       * @return
       * @throws
       */
      public static int sendToAliasList(
    			JPushClient jPushClient,
    			List<String> aliasList,
    			String notificationTitle,
    			String msgTitle,
    			String msgContent,
          String extraKey,
          String extrasparam) {
        int result = 0;
        try {
          PushPayload pushPayload =
              buildPushObjectAllAliasList(
                  aliasList, notificationTitle, msgTitle, msgContent, extraKey, extrasparam);
          log.info("推送给设备标识参数的用户" + pushPayload);
          PushResult pushResult = jPushClient.sendPush(pushPayload);
          log.info("推送结果" + pushResult);
          if (pushResult.getResponseCode() == SUCCESS_CODE) {
            result = 1;
          }
        } catch (APIConnectionException e) {
          e.printStackTrace();
    
        } catch (APIRequestException e) {
          e.printStackTrace();
        }
    
        return result;
      }
      /**
       * 推送给别名的用户（加入未读消息数量统计） @Description:
       *
       * @param jPushClient
       * @param aliasList
       * @param notificationTitle
       * @param msgTitle
       * @param msgContent
       * @param extraKey
       * @param extrasparam
       * @oaram countParam
       * @return
       * @throws
       */
      public static int sendToAliasList1(
          JPushClient jPushClient,
          List<String> aliasList,
          String notificationTitle,
          String msgTitle,
          String msgContent,
          String extraKey,
          String extrasparam,
          String countKey,
          String countParam) {
        int result = 0;
        try {
          PushPayload pushPayload =
              buildPushObjectAllAliasList1(
                  aliasList,
                  notificationTitle,
                  msgTitle,
                  msgContent,
                  extraKey,
                  extrasparam,
                  countKey,
                  countParam);
          log.info("推送给设备标识参数的用户" + pushPayload);
          PushResult pushResult = jPushClient.sendPush(pushPayload);
          log.info("推送结果" + pushResult);
          if (pushResult.getResponseCode() == SUCCESS_CODE) {
            result = 1;
          }
        } catch (APIConnectionException e) {
          e.printStackTrace();
    
        } catch (APIRequestException e) {
          e.printStackTrace();
        }
    
        return result;
      }
      /**
       * 发送给所有用户 @Description:
       *
       * @param jPushClient
       * @param notificationTitle
       * @param msgTitle
       * @param msgContent
       * @param extraKey
       * @param extrasparam
       * @return
       * @throws
       */
      public static int sendToAll(
          JPushClient jPushClient,
          String notificationTitle,
          String msgTitle,
          String msgContent,
          String extraKey,
          String extrasparam) {
        int result = 0;
        try {
          PushPayload pushPayload =
              buildPushObject(notificationTitle, msgTitle, msgContent, extraKey, extrasparam);
          log.info("" + pushPayload);
          PushResult pushResult = jPushClient.sendPush(pushPayload);
          log.info("" + pushResult);
          if (pushResult.getResponseCode() == SUCCESS_CODE) {
            result = 1;
          }
        } catch (Exception e) {
    
          e.printStackTrace();
        }
    
        return result;
      }
    
      /**
       * 推送给Tag参数的用户
       *
       * @param tagsList Tag或Tag组
       * @param msgContent 消息内容
       * @param extrasparam 扩展字段
       * @return 0推送失败，1推送成功
       */
      public static int sendToTagList(
          JPushClient jPushClient,
          List<String> tagsList,
          String notificationTitle,
          String msgTitle,
          String msgContent,
          String extraKey,
          String extrasparam) {
        int result = 0;
        try {
          PushPayload pushPayload =
              buildPushObjectAllTagList(
                  tagsList, notificationTitle, msgTitle, msgContent, extraKey, extrasparam);
          log.info("" + pushPayload);
          PushResult pushResult = jPushClient.sendPush(pushPayload);
          log.info("" + pushResult);
          if (pushResult.getResponseCode() == SUCCESS_CODE) {
            result = 1;
          }
        } catch (APIConnectionException e) {
          e.printStackTrace();
    
        } catch (APIRequestException e) {
          e.printStackTrace();
        }
    
        return result;
      }
    
      /**
       * 发送给所有安卓用户 @Description:
       *
       * @param jPushClient
       * @param title
       * @param alert
       * @return
       * @throws
       */
      public static PushResult sendToAllAndroid(JPushClient jPushClient, String title, String alert) {
        int result = 0;
        PushResult pushResult = null;
        try {
          PushPayload pushPayload = buildPushObjectAndroid(title, alert);
          log.info("" + pushPayload);
          pushResult = jPushClient.sendPush(pushPayload);
          log.info("" + pushResult);
          if (pushResult.getResponseCode() == SUCCESS_CODE) {
            result = 1;
          }
        } catch (Exception e) {
    
          e.printStackTrace();
        }
    
        return pushResult;
      }
    
      /**
       * 发送给所有IOS用户
       *
       * @param msgContent 消息内容
       * @param extrasparam 扩展字段
       * @return 0推送失败，1推送成功
       */
      public static int sendToAllIos(
          JPushClient jPushClient,
          String notificationTitle,
          String msgTitle,
          String msgContent,
          String extraKey,
          String extrasparam) {
        int result = 0;
        try {
          PushPayload pushPayload =
              buildPushObjectIos(notificationTitle, msgTitle, msgContent, extraKey, extrasparam);
          log.info("" + pushPayload);
          PushResult pushResult = jPushClient.sendPush(pushPayload);
          log.info("" + pushResult);
          if (pushResult.getResponseCode() == SUCCESS_CODE) {
            result = 1;
          }
        } catch (Exception e) {
    
          e.printStackTrace();
        }
    
        return result;
      }
    
      /**
       * 推送给设备标识参数的用户 @Description:
       *
       * @param jPushClient
       * @param registrationId
       * @param notificationTitle
       * @param msgTitle
       * @param msgContent
       * @param extraKey
       * @param extrasparam
       * @return
       * @throws
       */
      public static int sendToRegistrationId(
          JPushClient jPushClient,
          String registrationId,
          String notificationTitle,
          String msgTitle,
          String msgContent,
          String extraKey,
          String extrasparam) {
        int result = 0;
        try {
          PushPayload pushPayload =
              buildPushRegistrationId(
                  registrationId, notificationTitle, msgTitle, msgContent, extraKey, extrasparam);
          log.info("" + pushPayload);
          PushResult pushResult = jPushClient.sendPush(pushPayload);
          log.info("" + pushResult);
          if (pushResult.getResponseCode() == SUCCESS_CODE) {
            result = 1;
          }
        } catch (Exception e) {
    
          e.printStackTrace();
        }
    
        return result;
      }
    
      /**
       * 推送给设备标识参数的用户 @Description:
       *
       * @param registrationId
       * @param notificationTitle
       * @param msgTitle
       * @param msgContent
       * @param extraKey
       * @param extrasparam
       * @return
       * @throws
       */
      private static PushPayload buildPushRegistrationId(
          String registrationId,
          String notificationTitle,
          String msgTitle,
          String msgContent,
          String extraKey,
          String extrasparam) {
        log.info("----------向所有平台单个或多个指定别名用户推送消息中......");
        // 创建一个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.registrationId(registrationId))
            // jpush的通知，android的由jpush直接下发，iOS的由apns服务器下发，Winphone的由mpns下发
            .setNotification(
                Notification.newBuilder()
                    // 指定当前推送的android通知
                    .addPlatformNotification(
                        AndroidNotification.newBuilder()
                            .setAlert(notificationTitle)
                            .setTitle(notificationTitle)
                            // 此字段为透传字段，不会显示在通知栏。用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value）
                            .addExtra(extraKey, extrasparam)
                            .build())
                    // 指定当前推送的iOS通知
                    .addPlatformNotification(
                        IosNotification.newBuilder()
                            // 传一个IosAlert对象，指定apns
                            // title、title、subtitle等
                            .setAlert(notificationTitle)
                            // 直接传alert
                            // 此项是指定此推送的badge自动加1
                            .incrBadge(1)
                            // 此字段的值default表示系统默认声音；传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒，
                            // 如果系统没有此音频则以系统默认声音提醒；此字段如果传空字符串，iOS9及以上的系统是无声音提醒，以下的系统是默认声音
                            .setSound("default")
                            // 此字段为透传字段，不会显示在通知栏。用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value）
                            .addExtra(extraKey, 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(msgContent)
                    .setTitle(msgTitle)
                    .addExtra(extraKey, extrasparam)
                    .build())
            .setOptions(
                Options.newBuilder()
                    // 此字段的值是用来指定本推送要推送的apns环境，false表示开发，true表示生产；对android和自定义消息无意义
                    .setApnsProduction(APNS_PRODUCTION)
                    // 此字段是给开发者自己给推送编号，方便推送者分辨推送记录
                    .setSendno(1)
                    // 此字段的值是用来指定本推送的离线保存时长，如果不传此字段则默认保存一天，最多指定保留十天；
                    .setTimeToLive(86400)
                    .build())
            .build();
      }
    
      /**
       * 向所有平台单个或多个指定别名用户推送消息
       * 消息体封装
       *
       * @param aliasList
       * @param notificationTitle
       * @param msgTitle
       * @param msgContent
       * @param extraKey
       * @param extrasparam
       * @return
       * @throws
       */
      private static PushPayload buildPushObjectAllAliasList(
          List<String> aliasList,
          String notificationTitle,
          String msgTitle,
          String msgContent,
          String extraKey,
          String extrasparam) {
        log.info("----------向所有平台单个或多个指定别名用户推送消息中......");
        // 创建一个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(aliasList))
            // jpush的通知，android的由jpush直接下发，iOS的由apns服务器下发，Winphone的由mpns下发
            .setNotification(
                Notification.newBuilder()
                    // 指定当前推送的android通知
                    .addPlatformNotification(
                        AndroidNotification.newBuilder()
                            .setAlert(notificationTitle)
                            .setTitle(msgTitle)
                            // 此字段为透传字段，不会显示在通知栏。用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value）
                            .addExtra(extraKey, extrasparam)
                            .build())
                    // 指定当前推送的iOS通知
                    .addPlatformNotification(
                        IosNotification.newBuilder()
                            // 传一个IosAlert对象，指定apns
                            // title、title、subtitle等
                            .setAlert(notificationTitle)
                            // 直接传alert
                            // 此项是指定此推送的badge自动加1
                            .incrBadge(1)
                            // 此字段的值default表示系统默认声音；传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒，
                            // 如果系统没有此音频则以系统默认声音提醒；此字段如果传空字符串，iOS9及以上的系统是无声音提醒，以下的系统是默认声音
                            .setSound("default")
                            // 此字段为透传字段，不会显示在通知栏。用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value）
                            .addExtra(extraKey, 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(msgContent)
                    .setTitle(msgTitle)
                    .addExtra(extraKey, extrasparam)
                    .build())
            .setOptions(
                Options.newBuilder()
                    // 此字段的值是用来指定本推送要推送的apns环境，false表示开发，true表示生产；对android和自定义消息无意义
                    .setApnsProduction(APNS_PRODUCTION)
                    // 此字段是给开发者自己给推送编号，方便推送者分辨推送记录
                    .setSendno(1)
                    // 此字段的值是用来指定本推送的离线保存时长，如果不传此字段则默认保存一天，最多指定保留十天；
                    .setTimeToLive(86400)
                    .build())
            .build();
      }
      /**
       * 向所有平台单个或多个指定别名用户推送消息
       * 消息体封装
       *
       * @param aliasList
       * @param notificationTitle
       * @param msgTitle
       * @param msgContent
       * @param extraKey
       * @param extrasparam
       * @param countParam
       * @return
       * @throws
       */
      private static PushPayload buildPushObjectAllAliasList1(
          List<String> aliasList,
          String notificationTitle,
          String msgTitle,
          String msgContent,
          String extraKey,
          String extrasparam,
          String countKey,
          String countParam) {
        log.info("----------向所有平台单个或多个指定别名用户推送消息中......");
        // 创建一个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(aliasList))
            // jpush的通知，android的由jpush直接下发，iOS的由apns服务器下发，Winphone的由mpns下发
            .setNotification(
                Notification.newBuilder()
                    // 指定当前推送的android通知
                    .addPlatformNotification(
                        AndroidNotification.newBuilder()
                            .setAlert(notificationTitle)
                            .setTitle(msgTitle)
                            // 此字段为透传字段，不会显示在通知栏。用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value）
                            .addExtra(extraKey, extrasparam)
                            .addExtra(countKey, countParam)
                            .build())
                    // 指定当前推送的iOS通知
                    .addPlatformNotification(
                        IosNotification.newBuilder()
                            // 传一个IosAlert对象，指定apns
                            // title、title、subtitle等
                            .setAlert(notificationTitle)
                            // 直接传alert
                            // 此项是指定此推送的badge自动加1
                            .incrBadge(1)
                            // 此字段的值default表示系统默认声音；传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒，
                            // 如果系统没有此音频则以系统默认声音提醒；此字段如果传空字符串，iOS9及以上的系统是无声音提醒，以下的系统是默认声音
                            .setSound("default")
                            // 此字段为透传字段，不会显示在通知栏。用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value）
                            .addExtra(extraKey, extrasparam)
                            .addExtra(countKey, countParam)
                            // 此项说明此推送是一个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(msgContent)
                    .setTitle(msgTitle)
                    .addExtra(extraKey, extrasparam)
                    .addExtra(countKey, countParam)
                    .build())
            .setOptions(
                Options.newBuilder()
                    // 此字段的值是用来指定本推送要推送的apns环境，false表示开发，true表示生产；对android和自定义消息无意义
                    .setApnsProduction(APNS_PRODUCTION)
                    // 此字段是给开发者自己给推送编号，方便推送者分辨推送记录
                    .setSendno(1)
                    // 此字段的值是用来指定本推送的离线保存时长，如果不传此字段则默认保存一天，最多指定保留十天；
                    .setTimeToLive(86400)
                    .build())
            .build();
      }
      /**
       * 向所有平台所有用户推送消息
       * 消息体封装
       *
       * @param notificationTitle
       * @param msgTitle
       * @param msgContent
       * @param extraKey
       * @param extrasparam
       * @return
       * @throws
       */
      public static PushPayload buildPushObject(
          String notificationTitle,
          String msgTitle,
          String msgContent,
          String extraKey,
          String extrasparam) {
        log.info("----------向所有平台所有用户推送消息中......");
        return PushPayload.newBuilder()
            .setPlatform(Platform.android_ios())
            .setAudience(Audience.all())
            .setNotification(
                Notification.newBuilder()
                    .addPlatformNotification(
                        AndroidNotification.newBuilder()
                            .setAlert(notificationTitle)
                            .setTitle(notificationTitle)
                            // 此字段为透传字段，不会显示在通知栏。用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value）
                            .addExtra(extraKey, extrasparam)
                            .build())
                    .addPlatformNotification(
                        IosNotification.newBuilder()
                            // //传一个IosAlert对象，指定apns
                            // title、title、subtitle等
                            .setAlert(notificationTitle)
                            // 直接传alert
                            // 此项是指定此推送的badge自动加1
                            .incrBadge(1)
                            // 此字段的值default表示系统默认声音；传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒，
                            // 如果系统没有此音频则以系统默认声音提醒；此字段如果传空字符串，iOS9及以上的系统是无声音提醒，以下的系统是默认声音
                            .setSound("default")
                            // 此字段为透传字段，不会显示在通知栏。用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value）
                            .addExtra(extraKey, extrasparam)
                            // 此项说明此推送是一个background推送，想了解background看：http://docs.jpush.io/client/ios_tutorials/#ios-7-background-remote-notification
                            // .setContentAvailable(true)
    
                            .build())
                    .build())
            // Platform指定了哪些平台就会像指定平台中符合推送条件的设备进行推送。 jpush的自定义消息，
            // sdk默认不做任何处理，不会有通知提示。建议看文档http://docs.jpush.io/guideline/faq/的
            // [通知与自定义消息有什么区别？]了解通知和自定义消息的区别
            .setMessage(
                Message.newBuilder()
                    .setMsgContent(msgContent)
                    .setTitle(msgTitle)
                    .addExtra(extraKey, extrasparam)
                    .build())
            .setOptions(
                Options.newBuilder()
                    // 此字段的值是用来指定本推送要推送的apns环境，false表示开发，true表示生产；对android和自定义消息无意义
                    .setApnsProduction(APNS_PRODUCTION)
                    // 此字段是给开发者自己给推送编号，方便推送者分辨推送记录
                    .setSendno(1)
                    // 此字段的值是用来指定本推送的离线保存时长，如果不传此字段则默认保存一天，最多指定保留十天，单位为秒
                    .setTimeToLive(86400)
                    .build())
            .build();
      }
    
      /**
       * 向所有平台单个或多个指定Tag用户推送消息
       * 消息体封装
       *
       * @param tagsList
       * @param notificationTitle
       * @param msgTitle
       * @param msgContent
       * @param extraKey
       * @param extrasparam
       * @return
       * @throws
       */
      private static PushPayload buildPushObjectAllTagList(
          List<String> tagsList,
          String notificationTitle,
          String msgTitle,
          String msgContent,
          String extraKey,
          String extrasparam) {
    
        log.info("----------向所有平台单个或多个指定Tag用户推送消息中.......");
        // 创建一个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.tag(tagsList))
            // jpush的通知，android的由jpush直接下发，iOS的由apns服务器下发，Winphone的由mpns下发
            .setNotification(
                Notification.newBuilder()
                    // 指定当前推送的android通知
                    .addPlatformNotification(
                        AndroidNotification.newBuilder()
                            .setAlert(notificationTitle)
                            .setTitle(notificationTitle)
                            // 此字段为透传字段，不会显示在通知栏。用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value）
                            .addExtra(extraKey, extrasparam)
                            .build())
                    // 指定当前推送的iOS通知
                    .addPlatformNotification(
                        IosNotification.newBuilder()
                            // 传一个IosAlert对象，指定apns title、title、subtitle等
                            .setAlert(notificationTitle)
                            // 直接传alert
                            // 此项是指定此推送的badge自动加1
                            .incrBadge(1)
                            // 此字段的值default表示系统默认声音；传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒，
                            // 如果系统没有此音频则以系统默认声音提醒；此字段如果传空字符串，iOS9及以上的系统是无声音提醒，以下的系统是默认声音
                            .setSound("default")
                            // 此字段为透传字段，不会显示在通知栏。用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value）
                            .addExtra(extraKey, 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(msgContent)
                    .setTitle(msgTitle)
                    .addExtra(extraKey, extrasparam)
                    .build())
            .setOptions(
                Options.newBuilder()
                    // 此字段的值是用来指定本推送要推送的apns环境，false表示开发，true表示生产；对android和自定义消息无意义
                    .setApnsProduction(APNS_PRODUCTION)
                    // 此字段是给开发者自己给推送编号，方便推送者分辨推送记录
                    .setSendno(1)
                    // 此字段的值是用来指定本推送的离线保存时长，如果不传此字段则默认保存一天，最多指定保留十天；
                    .setTimeToLive(86400)
                    .build())
            .build();
      }
    
      /**
       * 向android平台所有用户推送
       * 消息体封装
       *
       * @param title 通知标题
       * @param alert 通知内容
       * @return
       */
      private static PushPayload buildPushObjectAndroid(String title, String alert) {
        log.info("----------向android平台所有用户推送消息中......");
        JSONArray array = new JSONArray();
        array.add("西安");
        return PushPayload.newBuilder()
            // 指定要推送的平台，all代表当前应用配置了的所有平台，也可以传android等具体平台
            .setPlatform(Platform.android())
            // 指定推送的接收对象，all代表所有人，也可以指定已经设置成功的tag或alias或该应应用客户端调用接口获取到的registration
            // id
            .setAudience(Audience.all())
            // jpush的通知，android的由jpush直接下发，iOS的由apns服务器下发，Winphone的由mpns下发
            .setNotification(
                Notification.newBuilder()
                    // 指定当前推送的android通知
                    .addPlatformNotification(
                        AndroidNotification.newBuilder()
                            .setAlert(title)
                            .setTitle(title)
                            .setAlert(alert)
                            // 此字段为透传字段，不会显示在通知栏。用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value）
                            //										.addExtra(extraKey, extrasparam)
                            .build())
                    .build())
            // Platform指定了哪些平台就会像指定平台中符合推送条件的设备进行推送。 jpush的自定义消息，
            // sdk默认不做任何处理，不会有通知提示。建议看文档http://docs.jpush.io/guideline/faq/的
            // [通知与自定义消息有什么区别？]了解通知和自定义消息的区别
            //				.setMessage(Message.newBuilder().setMsgContent(msgContent).setTitle(msgTitle)
            //						.addExtra(extraKey, extrasparam).build())
    
            .setOptions(
                Options.newBuilder()
                    // 此字段的值是用来指定本推送要推送的apns环境，false表示开发，true表示生产；对android和自定义消息无意义
                    .setApnsProduction(APNS_PRODUCTION)
                    // 此字段是给开发者自己给推送编号，方便推送者分辨推送记录
                    .setSendno(1)
                    // 此字段的值是用来指定本推送的离线保存时长，如果不传此字段则默认保存一天，最多指定保留十天，单位为秒
                    .setTimeToLive(86400)
                    .build())
            .build();
      }
    
      /**
       * 向ios平台所有用户推送消息 @Description:
       *
       * @param notificationTitle
       * @param msgTitle
       * @param msgContent
       * @param extraKey
       * @param extrasparam
       * @return
       * @throws
       */
      private static PushPayload buildPushObjectIos(
          String notificationTitle,
          String msgTitle,
          String msgContent,
          String extraKey,
          String extrasparam) {
        log.info("----------向ios平台所有用户推送消息中.......");
        return PushPayload.newBuilder()
            // 指定要推送的平台，all代表当前应用配置了的所有平台，也可以传android等具体平台
            .setPlatform(Platform.ios())
            // 指定推送的接收对象，all代表所有人，也可以指定已经设置成功的tag或alias或该应应用客户端调用接口获取到的registration
            // id
            .setAudience(Audience.all())
            // jpush的通知，android的由jpush直接下发，iOS的由apns服务器下发，Winphone的由mpns下发
            .setNotification(
                Notification.newBuilder()
                    // 指定当前推送的android通知
                    .addPlatformNotification(
                        IosNotification.newBuilder()
                            // 传一个IosAlert对象，指定apns title、title、subtitle等
                            .setAlert(notificationTitle)
                            // 直接传alert
                            // 此项是指定此推送的badge自动加1
                            .incrBadge(1)
                            // 此字段的值default表示系统默认声音；传sound.caf表示此推送以项目里面打包的sound.caf声音来提醒，
                            // 如果系统没有此音频则以系统默认声音提醒；此字段如果传空字符串，iOS9及以上的系统是无声音提醒，以下的系统是默认声音
                            .setSound("default")
                            // 此字段为透传字段，不会显示在通知栏。用户可以通过此字段来做一些定制需求，如特定的key传要指定跳转的页面（value）
                            .addExtra(extraKey, extrasparam)
                            // 此项说明此推送是一个background推送，想了解background看：http://docs.jpush.io/client/ios_tutorials/#ios-7-background-remote-notification
                            // .setContentAvailable(true)
    
                            .build())
                    .build())
            // Platform指定了哪些平台就会像指定平台中符合推送条件的设备进行推送。 jpush的自定义消息，
            // sdk默认不做任何处理，不会有通知提示。建议看文档http://docs.jpush.io/guideline/faq/的
            // [通知与自定义消息有什么区别？]了解通知和自定义消息的区别
            .setMessage(
                Message.newBuilder()
                    .setMsgContent(msgContent)
                    .setTitle(msgTitle)
                    .addExtra(extraKey, extrasparam)
                    .build())
            .setOptions(
                Options.newBuilder()
                    // 此字段的值是用来指定本推送要推送的apns环境，false表示开发，true表示生产；对android和自定义消息无意义
                    .setApnsProduction(APNS_PRODUCTION)
                    // 此字段是给开发者自己给推送编号，方便推送者分辨推送记录
                    .setSendno(1)
                    // 此字段的值是用来指定本推送的离线保存时长，如果不传此字段则默认保存一天，最多指定保留十天，单位为秒
                    .setTimeToLive(86400)
                    .build())
            .build();
      }
    }

工具类封装总结：

> 所有的封装都是围绕 极光推送 入参对象 PushPayload 来进行的，根据不同的推送业务封装不同的应用场景，最终都是调用同一个接口进行推送的：
> 
>     jPushClient.sendPush(pushPayload);
> 
> 具体的PushPayload 对象的结构文档URL如下：
> 
> [极光文档 (jiguang.cn)][_jiguang.cn]

#### 5、业务从应用 ####

package com.service.msg.biz.jiguang.service.impl;
    
    import cn.jpush.api.push.PushResult;
    import javax.annotation.Resource;
    import jsh.mg.msg.service.msg.biz.jiguang.dto.NotificationVo;
    import jsh.mg.msg.service.msg.biz.jiguang.dto.ReverseBandingParamsDto;
    import jsh.mg.msg.service.msg.biz.jiguang.dto.UploadBandingParamsDto;
    import jsh.mg.msg.service.msg.biz.jiguang.service.JiguangService;
    import jsh.mg.msg.service.msg.config.jpush.JpsuhConfig;
    import jsh.mg.msg.service.msg.utils.JpushUtil;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.stereotype.Service;
    
    /**
     * 极光推送service实现.
     *
     * @author ****
     * @since 2023/01/12 17:16
     */
    @Service
    public class JiguangServiceImpl implements JiguangService {
    
      private static final Logger log = LoggerFactory.getLogger(JiguangServiceImpl.class);
    
      @Resource private JpsuhConfig jpsuhConfig;
    
      @Override
      public PushResult sendMsg(NotificationVo notificationVo) {
        PushResult pushResult =
            JpushUtil.sendToAllAndroid(
                jpsuhConfig.createClient(), notificationVo.getTitle(), notificationVo.getAlert());
        if (pushResult.getResponseCode() == 200) {
          log.info("推送成功{}" + notificationVo.getTitle() + notificationVo.getAlert());
        }
        return pushResult;
      }
    
    }

通过 main 方法调用触发接口即可完成推送，注意入参格式

以上是极光推送后台基本推送环境搭建完成

## 二、移动端APP应用的创建 ##

### 1、在极光推送官网创建新的APP应用 ###

URL：[极光开发者服务 (jiguang.cn)][_jiguang.cn 1]

第一步：进入创建应用![ec62a77ae18045218beb00d9d86ee7f6.png][]

第二步：基本信息维护

![d87318e1d63a4b7b8bd3648a5526d22e.png][]

第三步：服务集成

![f3941e09d5134acba0fafeb0ae9b6d15.png][]

第四步：维护应用的包名

![732de49be68b4ba5bb7dd459ff058b6e.png][]

第四步：下载应用到手机

![d09477216ad54af1b0f736745dd39b4a.png][]

第五步：把生成的应用的 AppKey 和 Master Secret 维护到后台的配置文件中即可

![939e005e190740608a01db8b6e49e0bd.png][]

以上是安卓手机应用的创建

### 2、创建苹果手机应用 ###

第一步：创建集成服务应用

![4d1b3b4edc2b459e8a748eda1cb61069.png][]

![e783543723c240d6806fd386edfce411.png][]

![e6fb37658f4d4b8d88f174c4f86da76a.png][]

到这里，就要在苹果电脑生成文件，辅助操作，咱不是做苹果应用开发的，就说到这里

辅助文档URL：[Apple iOS推送证书配置和生成教程 - 简书 (jianshu.com)][Apple iOS_ - _ _jianshu.com]

参照以上文档操作，需要有iOS开发者账号才行的

截止现在，调用后台服务接口，就可以可以给安全应用推送消息了

分享到这里就结束了，希望可以帮到你

[_jiguang.cn]: https://docs.jiguang.cn/jpush/server/push/rest_api_v3_push#%E6%8E%A8%E9%80%81%E5%AF%B9%E8%B1%A1
[_jiguang.cn 1]: https://www.jiguang.cn/portal/#/dev/overview/appCardList
[ec62a77ae18045218beb00d9d86ee7f6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/e7050266f9f343d2901fb254b163731f.png
[d87318e1d63a4b7b8bd3648a5526d22e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/3972d43372ac430db3258f3d4d339d20.png
[f3941e09d5134acba0fafeb0ae9b6d15.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/5aa5d831a5804ed7b5b85fb3e7c53f9e.png
[732de49be68b4ba5bb7dd459ff058b6e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/b37797bb249a412f9b4fc58fe138853a.png
[d09477216ad54af1b0f736745dd39b4a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/d3fd825c5c994fb58ad4adfd7e9e6412.png
[939e005e190740608a01db8b6e49e0bd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/d799b63916dc44638ff5482fa0a94264.png
[4d1b3b4edc2b459e8a748eda1cb61069.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/ff90749e35f14b819bb7fb60c04c3971.png
[e783543723c240d6806fd386edfce411.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/08741ea1a64f4060ae490d1571ed18fc.png
[e6fb37658f4d4b8d88f174c4f86da76a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/28/6cbc247a6c104da898e20b69ed4d655a.png
[Apple iOS_ - _ _jianshu.com]: https://www.jianshu.com/p/fb180965ff76