基于FCM的消息推送功能

需求背景

我方项目需要支持客户端消息推送，iOS终端可以借由苹果本身的apns很方便的实现，但是对于Android来说，必须集成第三方的SDK来处理。考虑到项目需要以及成本，我们选择使用谷歌的FCM框架来实现，因为我们项目针对消息的可到达率要求并不高，而且推送消息的性质是业务低关注度的，重点是我们的项目还是海外项目，所以一番评估之后发现FCM完全能够满足我们的需求。

文档分析

1、Firebase云消息传递服务器简介

2、FCM服务器协议

3、使用旧版HTTP协议发送

4、使用HTTP方式构建服务器

5、请求授权说明

6、向旧版协议发送请求提供授权

7、使用HTTP旧版协议模式发送请求

8、举例

项目运用

Capation&D的这个项目基于SpringBoot，JDK1.8进行开发。

1、Maven依赖

 <dependency>
     <groupId>com.google.api-client</groupId>
     <artifactId>google-api-client</artifactId>
     <version>1.24.1</version>
 </dependency>

2、编写工具类

 /**
  * @Project:captainad-supply-chain
  * @PackageName:com.captainad.supply-chain.common.push
  * @Author:Captainad
  * @blogsite:https://www.cnblogs.com/captainad/
  * @DateTime:2018/8/9 15:52.
  * @Description: 基于Google Firebase框架实现的实时消息推送功能，目前仅支持Android设备
  */
 @Slf4j
 @Component
 public class FcmPushService {

     @Autowired
     private GetSetCacheService getSetCacheService;

     @Autowired
     private HttpAskInterface httpAskInterface;

     /**
      * 消息推送，推送的消息用于提示，并且点击提示消息将会跳转链接至指定页面
      * A: Captain&D
      * W: https://www.cnblogs.com/captainad/
      * @param deviceToken
      * @param title
      * @param body
      * @param route
      * @throws Exception
      */
     @Async
     public void push(final String deviceToken, final String title, final String body,
                      final String route, final Integer dataType, final String dataMsg)
             throws Exception {
         log.info("[START]开始推送FCM消息");
         // 请求标头
         Map<String, String> requestHeader = new HashMap<>();
         requestHeader.put("Content-Type", "application/json; UTF-8");
         requestHeader.put("Authorization", "Bearer " + getAccessToken());

         // 请求体
         JSONObject json = new JSONObject();

         JSONObject message = new JSONObject();
         message.put("token", deviceToken);
         JSONObject data = new JSONObject();

         // 发送弹窗提示信息
         if(!StringUtils.isEmpty(title) && !StringUtils.isEmpty(body)) {
             JSONObject notification = new JSONObject();
             notification.put("title", title);
             notification.put("body", body);
             message.put("notification", notification);

             data.put("route", route);
             // flag: 0-无需跳转，1-需要跳转
             data.put("routeFlag", StringUtils.isEmpty(route) ? "0" : "1");
         }

         // 发送数据
         if(!StringUtils.isEmpty(dataMsg)) {
             data.put("dataType", String.valueOf(dataType));
             data.put("params", dataMsg);
         }

         message.put("data", data);
         json.put("message", message);

         log.info("请求json内容===> {}", json.toString());
         // https://fcm.googleapis.com/v1/projects/bluepay-tesla/messages:send
         String fcmApiUrl = getSetCacheService.getConfigValue("fcm_api_path");
         HttpResponse httpResponse = httpAskInterface.synSendPost(fcmApiUrl, json.toString(), requestHeader);
         log.info("fcm响应内容===> {}", httpResponse);
         log.info("[END]推送FCM消息结束");
     }

     /**
      * 获取定时刷新的令牌
      * A: Captain&D
      * W: https://www.cnblogs.com/captainad/
      * @return
      * @throws IOException
      */
     private String getAccessToken() throws Exception {
         String jsonPath = getSetCacheService.getConfigValue("fcm_access_token_json");
         URL url = new URL(jsonPath);
         HttpURLConnection conn = (HttpURLConnection)url.openConnection();
         InputStream inputStream = conn.getInputStream();

         GoogleCredential googleCredential = GoogleCredential
                 .fromStream(inputStream)
                 .createScoped(Arrays.asList("https://www.googleapis.com/auth/firebase.messaging"));
         googleCredential.refreshToken();
         if(inputStream != null) {
             inputStream.close();
         }
         return googleCredential.getAccessToken();
     }

 }

使用总结

我们只需要申请一个Google开发者账号以及自身企业的一些相关信息，就能够很方便的使用Firebase云消息传递(FCM)提供的众多消息传递选项和功能，上面基于项目的需要实现了Android支持的版本，值得提及的时候，给特定设备推送消息时，需要提前获取到设备的deviceToken，因为它指代了一台唯一特定的设备。另外，如果想批量发送消息的，可以自行扩展出来。

参考资料

1、https://firebase.google.cn/docs/cloud-messaging/concept-options?hl=zh-cn