laravel框架使用极光推送消息操作示例

本文实例讲述了laravel框架使用极光推送消息。分享给大家供大家参考，具体如下：

最近需要使用极光推送往客户端推消息，所以这里记录下使用过程。

极光推送的服务端文档：

https://docs.jiguang.cn/jpush/server/push/server_overview/

极光推送服务端php代码：

https://github.com/jpush/jpush-api-php-client

在laravel项目下安装极光推送

composer require jpush/jpush

我们在config目录下创建一个jpush.php文件，用于获取key和secret

<?php
return [
  'app_key' => env('jpush_app_key', ''),
  'master_secret' => env('jpush_master_secret', ''),
  'apns_production' => env('jpush_apns_production', true),
];

然后在 .env 文件中配置相应参数

jpush_app_key=
jpush_master_secret=
jpush_apns_production=true

然后我们在app目录下，创建一个 services目录，并创建jpushservice.php

<?php
namespace app\services;
use jpush\client as jpush;
use log;
class jpushservice
{
  protected static $client = null;
  //推送类型
  const push_type_all = 1;
  const push_type_tag = 2;
  const push_type_alias = 3;
  const push_type_reg_id = 4;
  private function __construct()
  {
  }
  private function __clone()
  {
  }
  /**
   * 获取实例
   */
  public static function getinstance()
  {
    if (!self::$client) {
      self::$client = new jpush(config('jpush.app_key'), config('jpush.master_secret'), null);
    }
    return self::$client;
  }
  /**
   * 给android或ios推送消息
   */
  public static function pushnotify($params)
  {
    //推送平台
    $platform = $params['platform'] ?? 'all';
    //推送标题
    $title = $params['title'] ?? '';
    //推送内容
    $content = $params['content'] ?? '';
    //通知栏样式id
    $builder_id = $params['builder_id'] ?? 0;
    //附加字段
    $extras = $params['extras'] ?? '';
    //推送类型
    $type = $params['type'] ?? '';
    //推送目标(注册id)
    $reg_id = $params['reg_id'] ?? '';
    //推送目标(标签)
    $tag = $params['tag'] ?? '';
    //推送目标(别名)
    $alias = $params['alias'] ?? '';
    try {
      $push = self::getinstance()->push();
      //设置平台
      $push->setplatform($platform);
      switch ($type) {
        case self::push_type_all:
          $push->addallaudience();
          break;
        case self::push_type_tag:
          $push->addtag($tag);
          break;
        case self::push_type_alias:
          $push->addalias($alias);
          break;
        case self::push_type_reg_id:
          $push->addregistrationid($reg_id);
          break;
      }
      $push->androidnotification($content, [
        'title' => $title,
        'builder_id' => $builder_id,
        'extras' => $extras,
      ])->iosnotification($content, [
        'sound' => 'sound',
        'badge' => '+1',
        'extras' => $extras
      ])->options([
        'apns_production' => config('jpush.apns_production', true),
        //表示离线消息保留时长(秒)
        'time_to_live' => 86400,
      ]);
      $response = $push->send();
      if ($response['http_code'] != 200) {
        log::channel('jpush')->error(json_encode($response, json_unescaped_unicode));
      }
      return $response;
    } catch (\throwable $e) {
      log::channel('jpush')->error(json_encode([
        'file' => $e->getfile(),
        'line' => $e->getline(),
        'message' => $e->getmessage(),
        'params' => $params,
      ], json_unescaped_unicode));
    }
  }
  /**
   * 获取指定设备的别名和标签
   */
  public static function getdevices($reg_id)
  {
    $response = self::getinstance()->device()->getdevices($reg_id);
    if ($response['http_code'] == 200) {
      return $response['body'];
    }
    return [];
  }
  /**
   * 给指定设备添加标签
   */
  public static function addtags($reg_id, $tags = [])
  {
    $response = self::getinstance()->device()->addtags($reg_id, $tags);
    if ($response['http_code'] == 200) {
      return true;
    }
    return false;
  }
  /**
   * 清空指定设备的标签
   */
  public static function cleartags($reg_id)
  {
    $response = self::getinstance()->device()->cleartags($reg_id);
    if ($response['http_code'] == 200) {
      return true;
    }
    return false;
  }
  /**
   * 清空指定设备的标签
   */
  public static function removetags($reg_id, $tags = [])
  {
    $response = self::getinstance()->device()->removetags($reg_id, $tags);
    if ($response['http_code'] == 200) {
      return true;
    }
    return false;
  }
  /**
   * 更新指定设备的别名
   */
  public static function updatealias($reg_id, $alias)
  {
    $response = self::getinstance()->device()->updatealias($reg_id, $alias);
    if ($response['http_code'] == 200) {
      return true;
    }
    return false;
  }
}

创建完后，我们就可以在项目中调用 jpushservice::pushnotify() 来推消息了。

jpushservice::pushnotify([
  //标题
  'title' => '测试',
  //内容
  'content' => '测试',
  //设备标识，跟设备相关
  'reg_id' => 'xxxxxxxxxxx',
  //扩展字段
  'extras' => [
    'key' => 'value',
  ],
  //推送类型
  'type' => jpushservice::push_type_reg_id,
]);

reg_id是前端安卓或ios获取到后，传给php后端，然后跟用户关联，存起来。

注意，reg_id是跟设备相关的，同一个设备上的app，当不同用户登陆时，reg_id是一样的，这样会导致一个问题。

a用户登app后，又切换到b用户，那b用户会收到发送给a用户的消息，这会造成消息错乱。

解决方法：

通过别名来发送消息，因为一个设备只能绑定一个别名，当a用户登陆时，把 reg_id 绑定到别名 user_a，切换用户或退出时，就把别名置空。

然后b用户登陆，就把 reg_id 绑定到 user_b 上。推消息时，就通过别名来推送消息。

绑定别名(推荐使用用户id来区分不同的别名)：

jpushservice::updatealias($user->jpush_reg_id, 'user_id_' . $user->id);

置空别名：

jpushservice::updatealias($user->jpush_reg_id, '');

通过别名发送：

jpushservice::pushnotify([
  'title' => '测试',
  'content' => '测试',
  'alias' => 'user_id_' . $message->receive_id,
  'extras' => $extras,
  'type' => jpushservice::push_type_alias,
]);