在 Laravel 中使用極光推送

一個人的江湖發表於2019-07-13

最近在專案中需要用到推送，抽出時間看了看極光推送，記錄一下
Github地址：https://github.com/jpush/jpush-api-php-cli...
極光推送官方文件地址：https://docs.jiguang.cn/jpush/server/push/...

PHP 7.1.29

Laravel 5.6

在 composer.json 檔案中的 require 下新增 "jpush/jpush": "^3.6"

"require": {
    "jpush/jpush": "^3.6",
},

執行命令：composer install

在 config 目錄下新建檔案 Jpush.php 並進行如下配置：

return [
    'android_app_key' => env('JPUSH_APP_KEY'),
    'android_master_secret' => env('JPUSH_APP_MASTER_SECRET'),

    'ios_app_key' => env('JPUSH_IOS_KEY'),
    'ios_master_secret' => env('JPUSH_IOS_MASTER_SECRET'),

    // 環境 true-生產 false-開發
    'environment' => env('JPUSH_APNS_PRODUCTION', false),
];

.env 檔案進行如下配置：

JPUSH_APP_KEY=極光推送的app_key
JPUSH_APP_MASTER_SECRET=極光推送的master_secret
JPUSH_IOS_KEY=
JPUSH_IOS_MASTER_SECRET=
JPUSH_APNS_PRODUCTION=true

在 Support 目錄下新建目錄 Jpush，然後在 Jpush 目錄下新建檔案 Jpush.php 內容如下：

<?php

namespace App\Support\Jpush;

use JPush\Client;

class Jpush
{
    private $androidAppKey;
    private $androidMasterSecret;

    public function __construct()
    {
        $this->androidAppKey = config('Jpush.android_app_key');
        $this->androidMasterSecret = config('Jpush.android_master_secret');
    }

    /**
     * 初始化 JPushClient
     * @return Client
     */
    public function newJpushClient()
    {
        $client = new Client($this->androidAppKey, $this->androidMasterSecret);
        return $client;
    }

    /**
     * android 通過 註冊ID 給單個裝置或多個裝置推送訊息(已測可用)
     * @param $platform
     * @param $registrationId
     * @param $title
     * @param $content
     * @param $builder
     * @param $extras
     * @return array
     */
    public function androidPushByRegistrationId($platform, $registrationId, $title, $content, $builder, $extras)
    {
        $response = $this->newJpushClient()
            ->push()
            ->setPlatform($platform)
            ->addRegistrationId($registrationId)
            ->androidNotification($content, [
                "title" => $title,
                "builder_id" => $builder,
                "extras" => $extras
            ])->send();
        return $response;
    }

    /**
     * ios 通過 註冊ID 給單個裝置或多個裝置推送訊息（未測）
     * @param $platform
     * @param $registrationId
     * @param $title
     * @param $content
     * @param $builder
     * @param $extras
     * @return array
     */
    public function iosPushByRegistrationId($platform, $registrationId, $title, $content, $builder, $extras)
    {
        $response = $this->newJpushClient()
            ->push()
            ->setPlatform($platform)
            ->addRegistrationId($registrationId)
            ->androidNotification($content, [
                "title" => $title,
                "builder_id" => $builder,
                "extras" => $extras
            ])->send();
        return $response;
    }

    /**
     * android 通過 別名 給單個裝置或多個裝置推送訊息（已測可用）
     * @param $platform
     * @param $alias
     * @param $title
     * @param $content
     * @param $builder
     * @param $extras
     * @return array
     */
    public function androidPushByAlias($platform, $alias, $title, $content, $builder, $extras)
    {
        $response = $this->newJpushClient()
            ->push()
            ->setPlatform($platform)
            ->addAlias($alias)
            ->androidNotification($content, [
                "title" => $title,
                "builder_id" => $builder,
                "extras" => $extras
            ])->send();
        return $response;
    }

    /**
     * ios 通過 別名 給單個裝置或多個裝置推送訊息（未測）
     * @param $platform
     * @param $alias
     * @param $title
     * @param $content
     * @param $builder
     * @param $extras
     * @return array
     */
    public function iosPushByAlias($platform, $alias, $title, $content, $builder, $extras)
    {
        $response = $this->newJpushClient()
            ->push()
            ->setPlatform($platform)
            ->addAlias($alias)
            ->androidNotification($content, [
                "title" => $title,
                "builder_id" => $builder,
                "extras" => $extras
            ])->send();
        return $response;
    }

    /**
     * 推送所有 android裝置 或者 ios裝置（android 已測可用）
     * @param $platform
     * @param $title
     * @param $content
     * @param $builder
     * @param $extras
     * @return array
     */
    public function AndroidOrIosPushAll($platform, $title, $content, $builder, $extras)
    {
        $response = $this->newJpushClient()
            ->push()
            ->setPlatform($platform)
            ->addAllAudience()
            ->androidNotification($content, [
                "title" => $title,
                "builder_id" => $builder,
                "extras" => $extras
            ])->send();
        return $response;
    }

    /**
     * 推送所有裝置（android 已測可用）
     * @param $platform
     * @param $title
     * @param $content
     * @param $builder
     * @param $extras
     * @return array
     */
    public function pushAll($title, $content, $builder, $extras)
    {
        $response = $this->newJpushClient()
            ->push()
            ->setPlatform('all')
            ->addAllAudience()
            ->androidNotification($content, [
                "title" => $title,
                "builder_id" => $builder,
                "extras" => $extras
            ])->send();
        return $response;
    }
}

在 Modules 目錄下新建目錄 Jpush，然後在 Jpush 目錄下新建檔案 JpushService.php 內容如下：

<?php
namespace App\Modules\Jpush;

use App\BaseService;
use App\Exceptions\BaseResponseException;
use App\Support\Jpush\Jpush;
use Log;

class JpushService extends BaseService
{

    /**
     * 通過 註冊id 推送
     * @param $platform
     * @param $registrationId
     * @param $title
     * @param $content
     * @param $builder
     * @param $extras
     * @return array
     */
    public static function pushByRegistrationId($platform, $registrationId, $title, $content, $builder, $extras)
    {
        $jpush = new Jpush();
        if ($platform == 'android') {
            $response = $jpush->androidPushByRegistrationId($platform, $registrationId, $title, $content, $builder, $extras);
        } elseif ($platform == 'ios') {
            $response = $jpush->iosPushByRegistrationId($platform, $registrationId, $title, $content, $builder, $extras);
        } else {
            throw new BaseResponseException('推送平臺型別錯誤');
        }

        if ($response['http_code'] != 200) {
            Log::info('推送失敗 by registrationId', compact('response', 'platform', 'registrationId', 'title', 'content'));
        } else {
            Log::info('推送成功 by registrationId', compact('response', 'platform', 'registrationId', 'title', 'content'));
        }

        return $response;
    }

    /**
     * 通過 別名 推送
     * @param $platform
     * @param $alias
     * @param $title
     * @param $content
     * @param $builder
     * @param $extras
     * @return array
     */
    public static function pushByAlias($platform, $alias, $title, $content, $builder, $extras)
    {
        $jpush = new Jpush();
        if ($platform == 'android') {
            $response = $jpush->androidPushByAlias($platform, $alias, $title, $content, $builder, $extras);
        } elseif ($platform == 'ios') {
            $response = $jpush->iosPushByAlias($platform, $alias, $title, $content, $builder, $extras);
        } else {
            throw new BaseResponseException('推送平臺型別錯誤');
        }

        if ($response['http_code'] != 200) {
            Log::info('推送失敗 by alias', compact('response', 'platform', 'alias', 'title', 'content'));
        } else {
            Log::info('推送成功 by alias', compact('response', 'platform', 'alias', 'title', 'content'));
        }

        return $response;
    }

    /**
     * 推送全部 android裝置 或 ios裝置
     * @param $platform
     * @param $title
     * @param $content
     * @param $builder
     * @param $extras
     * @return array
     */
    public static function pushAllAndroidOrIos($platform, $title, $content, $builder, $extras)
    {
        $jpush = new Jpush();
        $response = $jpush->AndroidOrIosPushAll($platform, $title, $content, $builder, $extras);
        if ($response['http_code'] != 200) {
            Log::info('推送失敗 by all', compact('response', 'platform', 'title', 'content'));
        } else {
            Log::info('推送成功 by all', compact('response', 'platform', 'title', 'content'));
        }
        return $response;
    }

    /**
     * 推送全部
     * @param $title
     * @param $content
     * @param $builder
     * @param $extras
     * @return array
     */
    public static function pushAll($title, $content, $builder, $extras)
    {
        $jpush = new Jpush();
        $response = $jpush->pushAll($title, $content, $builder, $extras);
        if ($response['http_code'] != 200) {
            Log::info('推送失敗 by all', compact('response', 'title', 'content'));
        } else {
            Log::info('推送成功 by all', compact('response', 'title', 'content'));
        }
        return $response;
    }
}

新建路由：

// 手動推送測試（極光推送）
Route::post('message/jpush', 'MessageController@testJpush');

新建控制器並新增方法如下：

   /**
     * 手動測試推送（極光推送）
     */
    public function testJpush()
    {
        // 推送平臺 android 或 ios
        $platform = 'android';

        // 通過id推送，支援單個（字串）或多個（陣列）
        // $registrationId = '170976fa8afac898f28443';
        // $registrationId = [
        //     '170976fa8afac898f2822',
        //     '100d8559093c40254b03'
        // ];

        // 通過別名推送，支援單個（字串）或多個（陣列），下面的 * 號只是為了隱藏手機號
        // $alias = '188****2730';
        // $alias = [
        //     '188****2730',
        //     '176****4994',
        // ];

        $title = '恭喜您中獎了！';
        $content = '恭喜您中獎了！500萬元大獎哦！';
        // 通知欄樣式 ID
        $builder = 1;
        // 返回給客戶端的引數，用於其他需求，比如點選通知跳轉到詳情
        $extras = [
            'orderid' => 13545,
        ];

        // 通過id推送
        // $data = JpushService::pushByRegistrationId($platform, $registrationId, $title, $content, $builder, $extras);

        // 通過別名推送
        // $data = JpushService::pushByAlias($platform, $alias, $title, $content, $builder, $extras);

        // 推送所有android裝置或者ios裝置
        // $data = JpushService::pushAllAndroidOrIos($platform, $title, $content, $builder, $extras);

        // 推送所有裝置
        $data = JpushService::pushAll($title, $content, $builder, $extras);
        dd($data);
    }

最後，請求該測試方法，得到返回結果如下：

在 Laravel 中使用極光推送

本文只用到了最常用的通知欄推送，如需其他方式請參考官方文件。

為了能夠看的清楚些，寫的有點囉嗦，很多地方都可以優化，大家多多擔待，以上方法都在 android demo 下測試過，可用，等 IOS 小哥哥整合 IOS 包後，我測過 iOS 後重新補充整理一下，Thanks♪(･ω･)ﾉ。

乾坤未定，你我皆是黑馬

Laravel 極光推送驅動，使用極光不再那麼麻煩！
2019-02-27
Laravel
極光筆記｜極光推送在APICloud平臺的使用教程
2022-03-24
筆記APICloud
快捷地整合極光推送（JPush）到 Laravel 專案中
2019-01-30
Laravel
iOS —— 極光推送和極光IM
2019-03-04
iOS
極光推送demo在android studio中無法執行
2018-06-29
Android
Flutter應用整合極光推送
2020-02-27
Flutter
APP訊息推送極光推送示例程式碼
2020-11-25
APP
.NET對接極光訊息推送
2022-01-08
在Android裝置上使用極光推送id重複的原因分析和解決辦法
2019-12-23
Android
.NET快速對接極光訊息推送
2023-11-13
極光筆記丨iOS 15推送新特性
2021-10-20
筆記iOS
極光推送申請iOS推送證書p12及配置流程
2019-09-04
iOS
極光推送申請iOS推送證書p12及配置教程
2019-11-06
iOS
[外掛擴充套件]APP極光推送外掛！
2020-04-04
套件APP
在Laravel中整合騰訊雲移動(APP)推送（TPNS）
2020-07-20
LaravelAPP
極光筆記丨Spark SQL 在極光的建設實踐
2021-11-09
筆記SparkSQL
聊聊 Interface 在 Laravel 開發中的使用
2022-05-12
Laravel
在 Laravel 中不用 Node / npm 使用 Tailwind CSS
2022-02-10
LaravelNPMAICSS
Laravel + Laravel Echo + Pusher 網頁推送
2021-02-20
Laravel網頁
Laravel 使用阿里雲郵件推送的設定
2018-11-24
Laravel阿里
Redis 哨兵使用以及在 Laravel 中的配置
2019-06-28
RedisLaravel
使用Cloud Toolkit在IDEA中極速建立dubbo工程
2019-11-18
CloudIdea
在 laravel 中使用 elaticsearch
2021-10-14
Laravel
極光筆記 | 極光服務的信創改造實踐
2023-09-18
筆記
『技術分享』-- 使用極光 IM 構建聊天功能
2019-01-20
極光筆記 | 如何在Shopify中使用EngageLab （下）
2023-04-10
筆記
極光筆記 | 如何在Shopify中使用Engagelab（上）
2023-03-29
筆記
PHP trait 特性在 Laravel 中的使用個人心得
2019-02-26
PHPAILaravel
極光筆記 | 極光PUSH服務助力企業提升搶單速度
2023-03-04
筆記
在非 laravel 專案中使用 laravel 的特性
2021-02-23
Laravel
在 Laravel 中是用 Graphql
2020-04-27
Laravel
極光筆記|百億級KV儲存在極光的運維實踐之路
2021-12-02
筆記運維
極光：手機遊戲流失使用者研究報告
2020-01-06
遊戲
Laravel使用command在Linux系統中跑定時任務
2021-05-28
LaravelLinux
淺談在 Laravel 中使用 Materialize
2018-11-21
Laravel
在Laravel專案中使用Elasticsearch
2020-08-10
LaravelElasticsearch
Elasticsearch 7.2 在 Laravel 中實踐
2019-09-03
ElasticsearchLaravel
在Laravel 中如何自定義services
2021-05-17
Laravel

在 Laravel 中使用 極光推送

相關文章

在 Laravel 中使用極光推送