Laravel 極光推送驅動，使用極光不再那麼麻煩！

medz發表於2019-02-27
Laravel

我們在開發針對國內運營的時候進行需要使用過程的幾家推送，極光推送則是其中之一。這個包就可以讓你方便的在你構件的 Laravel 應用中進行極光推送的使用。

GitHub: https://github.com/medz/laravel-jpush-noti...

前提

  • PHP >= 7
  • Laravel >= 5.5

安裝

在 Laravel 應用目錄使用 Composer 進行依賴：

composer require medz/laravel-jpush-notification-channel

包中依賴了匹配的 jpush/jpush 依賴版本為 ^3.6，你已經依賴了更低版本的不相容版本包，使用的時候要小心了！

配置

在 config/services.php 中進行如下配置：

return [
    'jpush' => [
        'app_key' => env('JPUSH_APP_KEY', ''),
        'master_secret' => env('JPUSH_MASTER_SECRET', ''),
        'apns_production' => env('JPUSH_APNS_PRODUCTION', false),
    ],
]

然後在 .env 檔案中進行配置：

JPUSH_APP_KEY=
JPUSH_MASTER_SECRET=
JPUSH_APNS_PRODUCTION=

使用

首先，要在資料模型上新增一個 routeNotificationForJpush 方法：

use Illuminate\Foundation\Auth\User as Authenticatable;
use Medz\Laravel\Notifications\JPush\Sender as JPushSender;

class User extends Authenticatable
{
    /**
     * Get Notification for JPush sender.
     * @return \Medz\Laravel\Notifications\JPush\Sender
     */
    protected function routeNotificationForJpush()
    {
        return new JPushSender([
            'platform' => 'all',
            'audience' => [
                'alias' => sprintf('user_%d', $this->id),
            ],
        ]);
    }
}

這裡我們返回一個 Medz\Laravel\Notifications\JPush\Sender 例項，可以使用構造引數快速配置，如同上面一樣，也可以使用鏈式呼叫進行配置。鏈式呼叫的 API 如下：

  • setPlatform 設定平臺，值有 all、winphone、android 和 ios
  • setAudience 推送目標進行設定

setAudience 方法或者構造引數中的 audience 設定參考：推送目標文件。

然後開啟通知類，新增一個 toJpush 方法，這裡我們已 app/Notifications/CommentNotification.php 為例：

<?php

namespace App\Notifications;

use Illuminate\Notifications\Notification;
use Medz\Laravel\Notifications\JPush\Message as JPushMessage;

class CommentNotification extends Notification
{
    public function toJpush($notifiable)
    {
        $message = new JPushMessage();
        // TODO

        /*
            ====== 把所有的配置都進行配置 ===
            $message->setAlert('Alert.'); // 簡單地給所有平臺推送相同的 alert 訊息

            // 自定義訊息
            $message->setMessage('Message', [
                'title' => '', // 通知標題，會填充到 toast 型別 text1 欄位上
                '_open_page' => '', 點選開啟的頁面名稱
                'extras' => [], // 自定義的資料內容
            ]);

            // iOS 通知
            $message->setNotification(JPushMessage::IOS, 'Alert 內容', [
                'alert' => '', // 覆蓋第二個引數的 Alert 內，推薦不傳,
                'sound' => '', // 表示通知提示聲音，預設填充為空字串
                'badge' => '', // 表示應用角標，把角標數字改為指定的數字；為 0 表示清除，支援 '+1','-1' 這樣的字串，表示在原有的 badge 基礎上進行增減，預設填充為 '+1'
                /// ...
            ])

            // 更多通知請參考 https://docs.jiguang.cn/jpush/server/push/rest_api_v3_push/#notification 官方文件
            // 使用 `setNotification` 方法第一個常量有三個： IOS/ANDROID/WP

            // 可選引數
            $message->setOptions([]); // 參考 https://docs.jiguang.cn/jpush/server/push/rest_api_v3_push/#options
        */

        return $message
    }
}

toJpush 方法需要返回一個 Medz\Laravel\Notifications\JPush\Message 物件例項！

完成上面的配置後，就可以推送了，記得在 via 方法中返回 jpush 這個值哈，例如：

public function via()
{
    return ['database', 'jpush'];
}

Seven 的程式碼太渣，歡迎關注我的新擴充包 medz/cors 解決 PHP 專案程式設定跨域需求。

相關文章