Développement Laravel : Comment utiliser Laravel Broadcasting pour mettre en œuvre la diffusion d'événements ?

Dans les applications web en temps réel, la diffusion d'événements est l'une des fonctions les plus importantes. Le framework Laravel fournit des fonctionnalités de diffusion d'événements prêtes à l'emploi, et la diffusion et la surveillance d'événements peuvent être facilement mises en œuvre via Laravel Broadcasting. Cet article explique comment utiliser Laravel Broadcasting pour implémenter la diffusion d'événements.

1. Comprendre la diffusion d'événements

Dans les applications Web, lorsqu'un événement se produit, tel que la réussite de l'enregistrement d'un utilisateur, la publication d'un article, etc., nous espérons que d'autres utilisateurs pourront le recevoir dans le temps Informations connexes. À l'heure actuelle, si vous utilisez la méthode traditionnelle d'actualisation de page ou d'interrogation Ajax, cela consommera beaucoup de bande passante et de ressources du serveur et ne pourra pas répondre à la demande en temps réel. La diffusion d’événements peut résoudre ce problème.

La diffusion d'événements consiste à émettre un événement sur une chaîne ou un groupe de diffusion spécifique, puis les utilisateurs surveillant la chaîne ou le groupe de diffusion spécifique peuvent recevoir immédiatement des informations pertinentes. Grâce à la diffusion d'événements, le nombre de communications entre le serveur et le client peut être considérablement réduit, la latence du réseau et la consommation de bande passante peuvent être réduites, et les performances et l'expérience utilisateur des applications Web peuvent être améliorées.

2. Installez Laravel Broadcasting

Avant d'utiliser Laravel Broadcasting, vous devez installer Laravel Echo et les pilotes de diffusion associés. Laravel Echo est la bibliothèque client Socket.io fournie avec le framework Laravel, utilisée pour la communication en temps réel avec les services de diffusion. Le pilote de diffusion fournit des API pour interagir avec différents services de diffusion, tels que Redis et Pusher. Dans cet article, nous utiliserons Pusher comme service de diffusion.

1. Installer le SDK Laravel Echo et Pusher

Installer le SDK Laravel Echo et Pusher via npm :

npm install --save laravel-echo pusher-js

#🎜 🎜#Modifier le fichier de configuration

Ouvrez le fichier config/app.php et décommentez le code suivant :

AppProvidersBroadcastServiceProvider::class,

Ensuite, ajoutez Pusher dans le fichier .env configuration :

BROADCAST_DRIVER=pusher

PUSHER_APP_ID=your-app-id
PUSHER_APP_KEY=your-app-key
PUSHER_APP_SECRET=your-app-secret

Parmi eux, votre-app-id, votre-app-key et votre-app-secret doivent être modifiés en fonction de la situation réelle.

3. Créez des événements et des chaînes

Dans Laravel, les événements sont implémentés via la classe Event. Nous pouvons créer une classe Event correspondante pour chaque événement qui doit être diffusé. Dans cet article, nous prenons comme exemple l’enregistrement réussi d’un utilisateur pour créer un événement UserRegistered. Tout d'abord, exécutez la commande suivante dans le terminal pour créer la classe d'événements UserRegistered :

php artisan make:event UserRegistered

Ensuite, ouvrez le fichier app/Events/UserRegistered.php et modifiez le code comme suit :

namespace AppEvents;

use AppUser;
use IlluminateQueueSerializesModels;
use IlluminateFoundationEventsDispatchable;

class UserRegistered
{
    use Dispatchable, SerializesModels;

    public $user;

    /**
     * Create a new event instance.
     *
     * @param  AppUser  $user
     * @return void
     */
    public function __construct(User $user)
    {
        $this->user = $user;
    }

    /**
     * Get the channels the event should broadcast on.
     *
     * @return IlluminateBroadcastingChannel|array
     */
    public function broadcastOn()
    {
        return new Channel('user.'.$this->user->id);
    }
}

#🎜 🎜# ci-dessus Dans le code, nous avons créé une classe d'événement UserRegistered et injecté le modèle User dans la méthode constructeur. Ensuite, dans la méthode BroadcastOn(), nous définissons le canal sur lequel l'événement doit être diffusé, où un canal privé est spécifié sous la forme « user.{user_id} ».

Ensuite, nous devons créer un canal UserChannel pour surveiller les utilisateurs du canal 'user.{user_id}'. Il existe deux manières de créer un canal UserChannel : l'enregistrement manuel et la découverte automatique.

Méthode d'enregistrement manuelle :

Enregistrez la chaîne UserChannel dans le fichier app/Providers/BroadcastServiceProvider.php :

use IlluminateSupportFacadesBroadcast;
use AppBroadcastingUserChannel;

Broadcast::channel('user.{userId}', UserChannel::class);

Méthode de découverte automatique : #🎜 🎜 #

Créez un fichier UserChannel.php dans le répertoire app/Broadcasting et modifiez le code en :

namespace AppBroadcasting;

use AppUser;

class UserChannel
{
    /**
     * Create a new channel instance.
     *
     * @param  AppUser  $user
     * @return void
     */
    public function __construct(User $user)
    {
        $this->user = $user;
    }

    /**
     * Authenticate the user's access to the channel.
     *
     * @return array|bool
     */
    public function join(User $user, $userId)
    {
        return $user->id === (int) $userId;
    }
}

Dans le code ci-dessus, nous avons créé une classe de canal UserChannel et l'avons ajoutée dans le constructeur méthode Le modèle User y est injecté. Vérifiez ensuite que l'utilisateur a accès au canal via la méthode join().

4. Diffusion d'événements

Après avoir créé des événements et des chaînes, nous pouvons utiliser la fonction Broadcast() pour diffuser des événements sur la chaîne spécifiée. Dans cet article, nous allons implémenter la diffusion de l'événement UserRegistered dans la classe UserController après une inscription réussie de l'utilisateur :

namespace AppHttpControllers;

use AppUser;
use AppEventsUserRegistered;
use IlluminateHttpRequest;

class UserController extends Controller
{
    /**
     * Register a new user.
     *
     * @param  IlluminateHttpRequest  $request
     * @return IlluminateHttpResponse
     */
    public function register(Request $request)
    {
        $user = new User([
            'name' => $request->input('name'),
            'email' => $request->input('email'),
            'password' => bcrypt($request->input('password')),
        ]);
        $user->save();

        event(new UserRegistered($user));

        return response()->json([
            'message' => 'User registered successfully!',
            'user' => $user,
        ]);
    }
}

Dans le code ci-dessus, nous créons d'abord un utilisateur et effectuons une opération de sauvegarde. Ensuite, utilisez la fonction event() pour diffuser l'événement UserRegistered afin d'informer les autres utilisateurs qu'un nouvel utilisateur s'est enregistré avec succès.

5. Surveillance des événements

Après avoir créé des événements et des chaînes, les autres utilisateurs peuvent recevoir des événements en écoutant les chaînes correspondantes. Ensuite, nous écouterons l'événement UserRegistered via Laravel Echo.

Modifier le fichier de configuration

1. Tout d'abord, ajoutez le code suivant au fichier resources/assets/js/bootstrap.js :

import Echo from 'laravel-echo';

window.Pusher = require('pusher-js');

window.Echo = new Echo({
    broadcaster: 'pusher',
    key: process.env.MIX_PUSHER_APP_KEY,
    cluster: process.env.MIX_PUSHER_APP_CLUSTER,
    encrypted: true
});

Dans le code ci-dessus, nous utilisons Laravel Echo et Pusher SDK pour nous connecter au service de diffusion Pusher. PUSHER_APP_KEY et PUSHER_APP_CLUSTER peuvent être définis dans le fichier .env.

Créer un écouteur

2. Ouvrez le fichier resources/assets/js/app.js et ajoutez-y le code suivant :

import Echo from 'laravel-echo';

window.Pusher = require('pusher-js');

window.Echo = new Echo({
    broadcaster: 'pusher',
    key: process.env.MIX_PUSHER_APP_KEY,
    cluster: process.env.MIX_PUSHER_APP_CLUSTER,
    encrypted: true
});

window.Echo.channel('user.' + userId)
    .listen('UserRegistered', (e) => {
        console.log(e);
    });

Dans le code ci-dessus, nous écoutons le canal 'user.{user_id}' via la méthode window.Echo.channel() et spécifions le type d'événement comme 'UserRegistered'. Ce code sera exécuté une fois l'utilisateur connecté pour garantir que chaque utilisateur n'écoute que sa propre chaîne.
6. Testez
Enregistrez un nouvel utilisateur dans l'application, puis vérifiez si un nouvel événement d'enregistrement d'utilisateur est reçu dans la console.
Grâce aux étapes ci-dessus, nous avons terminé le processus d'utilisation de Laravel Broadcasting pour mettre en œuvre la diffusion d'événements. La diffusion d'événements est l'une des fonctions importantes des applications Web en temps réel, qui peut considérablement améliorer les performances et l'expérience utilisateur des applications Web.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!