README

简介

Laravel-FCM是一个易于使用的包，可以与Laravel和Lumen一起使用，用于发送Firebase云消息（FCM）的推送通知。

目前仅支持HTTP协议用于

向一个或多个设备发送下行消息
管理分组并发送分组消息
发送主题消息

注意：目前不支持XMPP协议。

安装

要将Laravel-FCM的最新版本添加到您的项目中，请从"composer"中引入它

$ composer require brozot/laravel-fcm

或者您可以直接在composer.json文件中添加它

{
    "require": {
        "brozot/laravel-fcm": "1.3.*"
    }
}

Laravel

直接在您的app配置文件config/app.php中注册提供者config/app.php

Laravel >= 5.5提供了包自动发现功能，归功于rasmuscnielsen和luiztessadri，他们帮助实现了Laravel-FCM中的此功能，因此提供者和外观的注册可能不再需要。

'providers' => [
	// ...

	LaravelFCM\FCMServiceProvider::class,
]

在相同文件中添加外观别名

'aliases' => [
	...
	'FCM'      => LaravelFCM\Facades\FCM::class,
	'FCMGroup' => LaravelFCM\Facades\FCMGroup::class, // Optional
]

注意：如果要在应用程序中管理分组消息，则需要FCMGroup外观。

使用以下命令发布包配置文件

$ php artisan vendor:publish --provider="LaravelFCM\FCMServiceProvider"

Lumen

在您的bootstrap/app.php启动文件中注册提供者

在文件的"注册服务提供者"部分底部添加以下行。

$app->register(LaravelFCM\FCMServiceProvider::class);

对于外观，在"创建应用程序"部分中添加以下行。如果要在应用程序中使用分组消息，则需要FCMGroup外观。

class_alias(\LaravelFCM\Facades\FCM::class, 'FCM');
class_alias(\LaravelFCM\Facades\FCMGroup::class, 'FCMGroup');

将配置文件fcm.php从目录/vendor/brozot/laravel-fcm/config手动复制到目录/config （您可能需要创建此目录）。

包配置

在您的.env文件中，添加Firebase云消息的服务器密钥和密钥

FCM_SERVER_KEY=my_secret_server_key
FCM_SENDER_ID=my_secret_sender_id

要获取这些密钥，您必须在Firebase云消息控制台中创建一个新应用程序。

在Firebase上创建您的应用程序后，您可以在项目设置 -> 云消息中找到密钥。

基本用法

可以使用Laravel-FCM发送两种类型的消息

通知消息，有时被称为“显示消息”
数据消息，由客户端应用程序处理

有关更多信息，请参阅官方文档。

下行消息

下行消息是您使用其registration_Ids向目标设备或多个目标设备发送的通知消息、数据消息或两者的组合。

以下示例需要以下使用语句

use LaravelFCM\Message\OptionsBuilder;
use LaravelFCM\Message\PayloadDataBuilder;
use LaravelFCM\Message\PayloadNotificationBuilder;
use FCM;

向设备发送下行消息

$optionBuilder = new OptionsBuilder();
$optionBuilder->setTimeToLive(60*20);

$notificationBuilder = new PayloadNotificationBuilder('my title');
$notificationBuilder->setBody('Hello world')
				    ->setSound('default');

$dataBuilder = new PayloadDataBuilder();
$dataBuilder->addData(['a_data' => 'my_data']);

$option = $optionBuilder->build();
$notification = $notificationBuilder->build();
$data = $dataBuilder->build();

$token = "a_registration_from_your_database";

$downstreamResponse = FCM::sendTo($token, $option, $notification, $data);

$downstreamResponse->numberSuccess();
$downstreamResponse->numberFailure();
$downstreamResponse->numberModification();

// return Array - you must remove all this tokens in your database
$downstreamResponse->tokensToDelete();

// return Array (key : oldToken, value : new token - you must change the token in your database)
$downstreamResponse->tokensToModify();

// return Array - you should try to resend the message to the tokens in the array
$downstreamResponse->tokensToRetry();

// return Array (key:token, value:error) - in production you should remove from your database the tokens
$downstreamResponse->tokensWithError();

向多个设备发送下行消息

$optionBuilder = new OptionsBuilder();
$optionBuilder->setTimeToLive(60*20);

$notificationBuilder = new PayloadNotificationBuilder('my title');
$notificationBuilder->setBody('Hello world')
				    ->setSound('default');

$dataBuilder = new PayloadDataBuilder();
$dataBuilder->addData(['a_data' => 'my_data']);

$option = $optionBuilder->build();
$notification = $notificationBuilder->build();
$data = $dataBuilder->build();

// You must change it to get your tokens
$tokens = MYDATABASE::pluck('fcm_token')->toArray();

$downstreamResponse = FCM::sendTo($tokens, $option, $notification, $data);

$downstreamResponse->numberSuccess();
$downstreamResponse->numberFailure();
$downstreamResponse->numberModification();

// return Array - you must remove all this tokens in your database
$downstreamResponse->tokensToDelete();

// return Array (key : oldToken, value : new token - you must change the token in your database)
$downstreamResponse->tokensToModify();

// return Array - you should try to resend the message to the tokens in the array
$downstreamResponse->tokensToRetry();

// return Array (key:token, value:error) - in production you should remove from your database the tokens present in this array
$downstreamResponse->tokensWithError();

请参阅下行消息错误响应代码文档以获取更多信息。

主题消息

主题消息是您发送到注册到此主题的所有设备的通知消息、数据消息或两者的组合。

注意：主题名称必须由您的应用程序管理并由您的服务器知道。Laravel-FCM包或fcm不提供轻松实现此功能的简单方法。

以下示例需要以下使用语句

use LaravelFCM\Message\Topics;

向主题发送消息

$notificationBuilder = new PayloadNotificationBuilder('my title');
$notificationBuilder->setBody('Hello world')
				    ->setSound('default');

$notification = $notificationBuilder->build();

$topic = new Topics();
$topic->topic('news');

$topicResponse = FCM::sendToTopic($topic, null, $notification, null);

$topicResponse->isSuccess();
$topicResponse->shouldRetry();
$topicResponse->error();

向多个主题发送消息

它将通知发送到以下主题注册的设备

新闻和经济
新闻和文化

注意：主题支持每个表达式两个操作符

$notificationBuilder = new PayloadNotificationBuilder('my title');
$notificationBuilder->setBody('Hello world')
				    ->setSound('default');

$notification = $notificationBuilder->build();

$topic = new Topics();
$topic->topic('news')->andTopic(function($condition) {

	$condition->topic('economic')->orTopic('cultural');

});

$topicResponse = FCM::sendToTopic($topic, null, $notification, null);

$topicResponse->isSuccess();
$topicResponse->shouldRetry();
$topicResponse->error());

群组消息

向群组发送通知

$notificationKey = ['a_notification_key'];


$notificationBuilder = new PayloadNotificationBuilder('my title');
$notificationBuilder->setBody('Hello world')
                        ->setSound('default');

$notification = $notificationBuilder->build();


$groupResponse = FCM::sendToGroup($notificationKey, null, $notification, null);

$groupResponse->numberSuccess();
$groupResponse->numberFailure();
$groupResponse->tokensFailed();

创建群组

$tokens = ['a_registration_id_at_add_to_group'];
$groupName = "a_group";
$notificationKey

// Save notification key in your database you must use it to send messages or for managing this group
$notification_key = FCMGroup::createGroup($groupName, $tokens);

将设备添加到群组

$tokens = ['a_registration_id_at_add_to_the_new_group'];
$groupName = "a_group";
$notificationKey = "notification_key_received_when_group_was_created";

$key = FCMGroup::addToGroup($groupName, $notificationKey, $tokens);

从群组中删除设备

注意：如果从群组中删除所有设备，则群组将自动在 "fcm" 中删除。

$tokens = ['a_registration_id_at_remove_from_the_group'];
$groupName = "a_group";
$notificationKey = "notification_key_received_when_group_was_created";

$key = FCMGroup::removeFromGroup($groupName, $notificationKey, $tokens);

选项

Laravel-FCM 支持基于 Firebase Cloud Messaging 选项的选项。这些选项可以帮助您定义通知的特定性。

您可以按照以下方式构建一个选项

$optionsBuilder = new OptionsBuilder();

$optionsBuilder->setTimeToLive(42*60)
                ->setCollapseKey('a_collapse_key');

$options = $optionsBuilder->build();

通知消息

通知有效负载用于发送通知，其行为由接收设备的 App 状态和操作系统定义。

当应用处于后台时，通知消息将传递到通知栏。对于前台应用，消息由以下回调处理

didReceiveRemoteNotification：在 iOS 上
onMessageReceived() 在 Android 上。数据包中的通知键包含通知。

请参阅官方文档。

$notificationBuilder = new PayloadNotificationBuilder();
$notificationBuilder->setTitle('title')
            		->setBody('body')
            		->setSound('sound')
            		->setBadge('badge');

$notification = $notificationBuilder->build();

数据消息

使用您自定义的键值对设置数据键，向客户端应用发送数据有效负载。数据消息的有效负载最大为 4KB。

iOS，FCM 存储消息，并且只有在应用处于前台并且建立了 FCM 连接时才传递。
Android，客户端应用在 onMessageReceived() 中接收到数据消息，并可以相应地处理键值对。

请参阅官方文档。

$dataBuilder = new PayloadDataBuilder();
$dataBuilder->addData([
	'data_1' => 'first_data'
]);

$data = $dataBuilder->build();

通知 & 数据消息

当收到包含通知和数据有效负载的消息时，应用的行为取决于应用是否处于后台或前台——基本上，是否在接收时处于活动状态（来源）。

后台，应用在通知栏接收通知有效负载，并且只有在用户点击通知时才处理数据有效负载。
前台，您的应用接收一个包含两个有效负载的消息对象。

主题

对于主题消息，Laravel-FCM 提供了一个易于使用的 API，用于抽象 Firebase 条件。为了制作例如 Firebase 官方文档中给出的条件，必须像以下 Laravel-FCM 一样进行

官方文档条件

'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)

$topics = new Topics();

$topics->topic('TopicA')
       ->andTopic(function($condition) {
	       $condition->topic('TopicB')->orTopic('TopicC');
       });

测试

对于集成测试，您可以使用 mockery 和包提供的 Mocks 模拟响应。

该包提供了 3 种类型的 "MockResponse"

MockDownstreamResponse
MockGroupResponse
MockTopicResponse

您可以像以下示例一样模拟 FCM 调用

$numberSucess = 2;
$mockResponse = new \LaravelFCM\Mocks\MockDownstreamResponse(numberSucess);

$mockResponse->addTokenToDelete('token_to_delete');
$mockResponse->addTokenToModify('token_to_modify', 'token_modified');
$mockResponse->setMissingToken(true);

$sender = Mockery::mock(\LaravelFCM\Sender\FCMSender::class);
$sender->shouldReceive('sendTo')->once()->andReturn($mockResponse);

$this->app->singleton('fcm.sender', function($app) use($sender) {
	return $sender;
});

API 文档

您可以在 API 参考中找到更多关于 API 的文档。

许可

此库是开源软件，根据MIT 许可证授权。

本文档的一些内容来自官方文档。您可以在Firebase Cloud Messaging 网站上找到完整的文档。

fikom-team / laravel-fcm

维护者

详情