CakePHP middleware: Integrate push notifications and message reminders to achieve real-time notifications

CakePHP middleware: Integrate push notifications and message reminders to achieve real-time notifications

[Introduction]
In modern Internet applications, real-time notifications are a very important function. In order to achieve real-time notifications, we usually use push notifications and message reminders. This article will introduce how to integrate push notifications and message reminders in CakePHP applications to achieve real-time notification functions.

[Push Notification]
Push notifications are mainly used to send important real-time information to users, such as new messages, order status updates, etc. In CakePHP, we can use third-party push services, such as Firebase Cloud Messaging (FCM) or Aurora Push, to send push notifications.

First, we need to configure the push service key and other necessary parameters in the CakePHP application. You can add the following configuration in the config/app.php file:

'PushNotification' => [
    'fcm' => [
        'server_key' => 'YOUR_SERVER_KEY',
        'sender_id' => 'YOUR_SENDER_ID',
    ],
    'jpush' => [
        'app_key' => 'YOUR_APP_KEY',
        'master_secret' => 'YOUR_MASTER_SECRET',
    ],
],

Then, we need to create a push notification middleware to handle the logic of sending push notifications. You can create the following middleware in the src/Middleware/PushNotificationMiddleware.php file:

<?php
namespace AppMiddleware;

use CakeCoreConfigure;
use CakeHttpResponse;
use CakeHttpServerRequest;
use CakeORMTableRegistry;
use JPushClient as JPushClient;
use PsrHttpMessageResponseInterface;
use PsrHttpMessageServerRequestInterface;
use RuntimeException;

class PushNotificationMiddleware
{
    public function __invoke(ServerRequestInterface $request, ResponseInterface $response, $next)
    {
        // 获取请求参数
        $data = $request->getParsedBody();
        
        // 获取需要发送的推送通知内容
        $message = $data['message'];
        $userId = $data['user_id'];
        
        // 获取用户deviceId
        $table = TableRegistry::getTableLocator()->get('Devices');
        $device = $table->find()->where(['user_id' => $userId])->first();
        $deviceId = $device->device_id;
        
        // 发送推送通知
        $this->sendPushNotification($message, $deviceId);
        
        return $next($request, $response);
    }
    
    private function sendPushNotification($message, $deviceId)
    {
        // 获取推送服务配置
        $pushConfig = Configure::read('PushNotification');
        
        // 使用极光推送发送推送通知
        $jpush = new JPushClient($pushConfig['jpush']['app_key'], $pushConfig['jpush']['master_secret']);
        $jpush->push()
            ->setPlatform('all')
            ->addAlias($deviceId)
            ->message($message)
            ->send();
    }
}

Finally, we need to register the middleware in the src/Application.php file . You can add the following code in the bootstrap() method:

$this->addMiddleware(new AppMiddlewarePushNotificationMiddleware());

At this time, when our application receives the request, the push notification middleware will automatically send a push notification to the corresponding user.

[Message Reminder]
In addition to push notifications, we usually also need to display message reminders inside the application, such as popping up a message prompt box or displaying the number of unread messages on the page.

In CakePHP, we can use the Session component to store the number of unread messages from users. When the user receives the notification, we increase the number of unread messages by 1 and store it in the Session. When a user views a message, we reset the unread message count to zero.

For ease of use, we can create a message reminder component. The following component can be created in the src/Controller/Component/NotificationComponent.php file:

<?php
namespace AppControllerComponent;

use CakeControllerComponent;
use CakeControllerComponentRegistry;
use CakeORMTableRegistry;

class NotificationComponent extends Component
{
    protected $_defaultConfig = [];
    
    public function notify($userId, $message)
    {
        // 获取用户的未读消息数
        $table = TableRegistry::getTableLocator()->get('Notifications');
        $notification = $table->find()->where(['user_id' => $userId])->first();
        
        // 更新未读消息数
        if (!$notification) {
            $notification = $table->newEntity(['user_id' => $userId]);
        }
        
        $notification->unread_count++;
        $table->save($notification);
        
        // 发送消息通知
        $this->Flash->success($message);
    }
    
    public function markAsRead($userId)
    {
        $table = TableRegistry::getTableLocator()->get('Notifications');
        $notification = $table->find()->where(['user_id' => $userId])->first();
        
        // 标记所有消息为已读
        $notification->unread_count = 0;
        $table->save($notification);
    }
}

Then, we need to load the component in the controller and use notify() and markAsRead() methods send messages and mark messages as read:

public function index()
{
    // 加载Notification组件
    $this->loadComponent('Notification');
    
    // 发送消息通知
    $this->Notification->notify($userId, '您有一条新消息！');
    
    // 标记所有消息为已读
    $this->Notification->markAsRead($userId);
}

At this point, we have successfully integrated push notifications and message reminders to implement real-time notification functions. Users will be able to receive important real-time information in a timely manner and view and manage unread messages within the app.

[Summary]
This article introduces how to integrate push notifications and message reminders in CakePHP applications to achieve real-time notification functions. By integrating third-party push services and using Session components, we can easily implement real-time notifications and message reminders for users in our applications. This is a very important function for modern Internet applications, which can improve user experience and increase user stickiness. Hope this article is helpful to everyone!

The above is the detailed content of CakePHP middleware: Integrate push notifications and message reminders to achieve real-time notifications. For more information, please follow other related articles on the PHP Chinese website!