如何在 Vue 项目中实现 laravel-echo 客户端

Question

我正在开发一个以 Vuetify (Vue.js) 作为前端的应用程序，它通过 api 与 laravel 后端服务器通信。

我正在尝试使用 laravel-echo-server 与 socket.io 一起制作一个通知系统。并在客户端中使用 laravel-echo。

我在客户端组件中用于测试连接是否有效的代码是：

// Needed by laravel-echo
window.io = require('socket.io-client')

let token = this.$store.getters.token

let echo = new Echo({
  broadcaster: 'socket.io',
  host: 'http://localhost:6001',
  auth: {
    headers: {
      authorization: 'Bearer ' + token,
      'X-CSRF-TOKEN': 'too_long_csrf_token_hardcoded'
    }
  }
})

echo.private('Prova').listen('Prova', () => {
  console.log('IT WORKS!')
})

这是laravel-echo-server.json的代码

{
    "authHost": "http://gac-backend.test",
    "authEndpoint": "/broadcasting/auth",
    "clients": [],
    "database": "redis",
    "databaseConfig": {
        "redis": {},
        "sqlite": {
            "databasePath": "/database/laravel-echo-server.sqlite"
        }
    },
    "devMode": true,
    "host": null,
    "port": "6001",
    "protocol": "http",
    "socketio": {},
    "sslCertPath": "",
    "sslKeyPath": "",
    "sslCertChainPath": "",
    "sslPassphrase": "",
    "apiOriginAllow": {
        "allowCors": false,
        "allowOrigin": "",
        "allowMethods": "",
        "allowHeaders": ""
    }
}

我尝试修改 apiOriginsAllow 没有成功。 事件已发送，我可以在 laravel-echo-server 日志中看到它：

Channel: Prova
Event: App\Events\Prova

但在那之后，当我访问包含连接代码的客户端组件时，我可以在 laravel-echo-server 日志中看到长错误跟踪和下一个错误：

The client cannot be authenticated, got HTTP status 419

如您所见，我在 laravel echo 客户端的 headers 中指定了 csrf 令牌和授权令牌。但它不起作用。

这是routes/channels.php的代码：

Broadcast::channel('Prova', function ($user) {
    return true;
});

我只想监听一个事件，它是私有的还是公共的并不重要，因为当它工作时，我想把它放到 service worker 中。那么，我想如果它是公开的会更好。

• 如何在 laravel 项目中使用 laravel echo 客户端？
• 如果我制作私人事件并尝试将其监听到服务人员中会有问题吗？

Answer 1

您好，我正在向您介绍如何使用 Laravel 和 Echo 功能配置 VUE

Step1先安装laravel

composer create-project laravel/laravel your-project-name 5.4.*

步骤 2 设置变量更改 Broadcastserviceprovider

我们首先需要注册App\Providers\BroadcastServiceProvider。打开 config/app.php 并取消注释 providers 数组中的以下行。

// App\Providers\BroadcastServiceProvider

我们需要告诉 Laravel 我们正在使用 .env 文件中的 Pusher 驱动程序：

BROADCAST_DRIVER=pusher

在 config/app.php 中添加 pusher 类

'Pusher' => Pusher\Pusher::class,

第三步在你的 laravel 项目中添加一个 Pusher

composer require pusher/pusher-php-server

步骤 4 将以下内容添加到 config/broadcasting.php

'options' => [
          'cluster' => env('PUSHER_CLUSTER'),
          'encrypted' => true,
      ],

第五步设置推送变量

PUSHER_APP_ID=xxxxxx
PUSHER_APP_KEY=xxxxxxxxxxxxxxxxxxxx
PUSHER_APP_SECRET=xxxxxxxxxxxxxxxxxxxx
PUSHER_CLUSTER=xx

步骤 6 安装节点

npm install

步骤 7 安装 Pusher js

npm install --save laravel-echo pusher-js 

第 8 步取消关注

// resources/assets/js/bootstrap.js

import Echo from "laravel-echo"

window.Echo = new Echo({
    broadcaster: 'pusher',
    key: 'xxxxxxxxxxxxxxxxxxxx',
    cluster: 'eu',
    encrypted: true
});

第 9 步创建迁移之前

// app/Providers/AppServiceProvider.php
// remember to use
Illuminate\Support\Facades\Schema;

public function boot()
{
  Schema::defaultStringLength(191);
}

Answer 2

为了启动客户端监听器，我使用了 Vuex。然后，当我的应用程序启动时，我调度操作 INIT_CHANNEL_LISTENERS 来启动侦听器。

频道 MODULE vuex 的 index.js

import actions from './actions'
import Echo from 'laravel-echo'
import getters from './getters'
import mutations from './mutations'

window.io = require('socket.io-client')

export default {
  state: {
    channel_listening: false,
    echo: new Echo({
      broadcaster: 'socket.io',
      // host: 'http://localhost:6001'
      host: process.env.CHANNEL_URL
    }),
    notifiable_public_channels: [
      {
        channel: 'Notificacio',
        event: 'Notificacio'
      },
      {
        channel: 'EstatRepetidor',
        event: 'BroadcastEstatRepetidor'
      }
    ]
  },
  actions,
  getters,
  mutations
}

频道 MODULE vuex 的 action.js

import * as actions from '../action-types'
import { notifyMe } from '../../helpers'
// import { notifyMe } from '../../helpers'

export default {
  /*
  * S'entent com a notifiable un event que té "títol" i "message" (Per introduir-los a la notificació)
  * */
  /**
   * Inicialitza tots els listeners per als canals. Creat de forma que es pugui ampliar.
   * En cas de voler afegir més canals "Notifiables" s'ha de afegir un registre al state del index.js d'aquest modul.
   * @param context
   */
  [ actions.INIT_CHANNEL_LISTENERS ] (context) {
    console.log('Initializing channel listeners...')
    context.commit('SET_CHANNEL_LISTENING', true)

    context.getters.notifiable_public_channels.forEach(listener => {
      context.dispatch(actions.INIT_PUBLIC_NOTIFIABLE_CHANNEL_LISTENER, listener)
    })
    // }
  },

  /**
   * Inicialitza un event notificable a través d'un canal.
   * Per anar bé hauria de tenir un titol i un missatge.
   * @param context
   * @param listener
   */
  [ actions.INIT_PUBLIC_NOTIFIABLE_CHANNEL_LISTENER ] (context, listener) {
    context.getters.echo.channel(listener.channel).listen(listener.event, payload => {
      notifyMe(payload.message, payload.title)
    })
  }
}

助手中的notifyMe函数 该函数在浏览器上调度通知

export function notifyMe (message, titol = 'TITLE', icon = icon) {
  if (!('Notification' in window)) {
    console.error('This browser does not support desktop notification')
  } else if (Notification.permission === 'granted') {
    let notification = new Notification(titol, {
      icon: icon,
      body: message,
      vibrate: [100, 50, 100],
      data: {
        dateOfArrival: Date.now(),
        primaryKey: 1
      }
    })
  }

然后后端像问题一样使用 laravel-echo-server。使用 redis 对事件进行排队，并使用 supervisor 在服务器启动时启动 laravel-echo-server。

Answer 3

对于socket io

npm install socket.io --save

如果你的帧头无效，请在 bootstrap.js 中设置身份验证端点，如下所示

window.Echo = new Echo({ authEndpoint : 'http://project/broadcasting/auth', broadcaster: 'pusher', key: '63882dbaf334b78ff949', cluster: 'ap2', encrypted: true });