laravel框架使用極光推送訊息操作示例

阿新 • • 發佈：2020-02-17

本文例項講述了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',//表示離線訊息保留時長(秒)
        '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,'type' => JPushService::PUSH_TYPE_ALIAS,]);

更多關於Laravel相關內容感興趣的讀者可檢視本站專題：《Laravel框架入門與進階教程》、《php優秀開發框架總結》、《php面向物件程式設計入門教程》、《php+mysql資料庫操作入門教程》及《php常見資料庫操作技巧彙總》

希望本文所述對大家基於Laravel框架的PHP程式設計有所幫助。