八、使用 Vue 3、Laravel 和 Socket.IO 构建聊天应用

在前面的章节中，我们创建了仅通过 HTTP 进行通信的前端项目或完整堆栈项目。前端和后端之间没有实时通信。如果我们需要将数据从服务器端传送到客户端，或者从客户端传送到服务器端，那么实时通信有时是必要的。如果没有一些实时通信机制，没有客户端发起请求，就无法从服务器端通信到客户端。这是我们可以通过 Laravel 框架和 Socket.io 轻松添加的内容。

在本章中，我们将了解以下主题：

• 使用 Laravel 创建 API 端点
• 设置 JWT 身份验证
• 创建前端让用户聊天

Laravel 是一个用 PHP 编写的后端 web 框架。它是一个全面的后端框架，包括处理 HTTP 请求、数据库操作和实时通信。

在本章中，我们将了解如何使所有这些部分协同工作，以便我们可以创建一个与 Vue 3、Laravel、Laravel Echo Server 和 Redis 协同工作的聊天应用。

技术要求

要完全理解本章，需要以下内容：

• 对 PHP 的基本理解
• 使用 Vue 组件创建基本应用的能力
• 使用 Axios HTTP 客户端发送和接收 HTTP 请求的能力

本章项目代码见https://github.com/PacktPublishing/-Vue.js-3-By-Example/tree/master/Chapter08 。

使用 Laravel 创建 API 端点

创建聊天应用的第一步是使用 Laravel 创建后端应用。使用 Laravel 创建 API 是本章我们必须学习的主要内容。这是我们以前没有做过的事情。这也意味着我们必须用 PHP 编写代码，因为 Laravel 是一个基于 PHP 的 web 框架。因此，在阅读此代码之前，您应该学习一些基本的 PHP 语法。与 JavaScript 和其他面向对象语言一样，它们共享类似的概念，例如使用对象、数组、字典、循环、类和其他基本的面向对象编程概念。因此，就学习难度而言，它不应该与 JavaScript 有太大区别。

安装所需的库

要使用 Laravel 创建我们的 API，我们不必自己创建所有文件，我们只需运行一些命令，这将自动为我们创建所有文件和配置设置。在创建 API 之前，我们必须运行 PHP。在 Windows 中，将 PHP 添加到 Windows 安装中最简单的方法是使用 XAMPP。我们可以通过下载并安装 https://www.apachefriends.org/download.html 。它也可用于 macOS 和 Linux。

一旦我们安装了它，我们就可以用Composer创建我们的 Laravel API。Composer 是一个用于 PHP 的包管理器，我们稍后将使用它安装更多库。创建项目的最简单方法是创建项目文件夹，然后在转到文件夹后运行命令创建 Laravel 项目：

1. 首先，我们创建一个名为vue-example-ch8-chat-app的项目文件夹，它将前端和后端都保存在各自独立的文件夹中。
2. 然后，在这个文件夹中，我们创建后端文件夹来存放我们的 Laravel 项目代码文件。
3. 现在我们进入命令行，然后进入vue-example-ch8-chat-app，然后运行composer global require laravel/installer。

这将安装 Laravel 安装程序，让我们创建 Laravel 项目。全球图书馆的位置如下：

• 所以这和 MacOS 是一样的。
• 窗口：%USERPROFILE%\AppData\Roaming\Composer\vendor\bin
• GNU/Linux 发行版：$HOME/.config/composer/vendor/bin或$HOME/.composer/vendor/bin

我们还可以运行composer global about查找库文件的位置。

完成后，我们使用所有文件创建 scaffold，还包括所有配置文件，并使用一个命令为我们安装所有必需的库。

我们通过命令行进入vue-example-ch8-chat-app文件夹，然后运行laravel new backend在后端文件夹中创建 Laravel 应用。Laravel 安装人员将运行并为我们的 Laravel 创建脚手架。此外，Composer 将安装运行 Laravel 所需的所有 PHP 库。一旦这一切完成，我们应该有一个完整的 Laravel 安装与所有文件和配置，我们需要运行我们的应用。

创建数据库和迁移文件

现在，随着 Laravel 应用的创建和所有相关库的安装，我们可以在 Laravel 应用上创建 API。首先，我们通过创建一些迁移文件来创建数据库。我们需要他们创建chats和messages表。chats表中有聊天室数据。messages表中有与聊天室相关的聊天信息。它还将引用发送消息的用户。

我们不必创建users表，因为它是在创建 Laravel 应用时自动创建的。几乎每个应用都需要保存用户数据，因此这是自动包含的。使用 Laravel scaffold，我们可以使用用户名、电子邮件和密码创建用户，并使用我们刚刚创建的用户的用户名和密码登录。Laravel 还能够发送电子邮件供用户验证，而无需添加任何代码。

要创建迁移，我们运行以下命令：

php artisan make:migration create_chats_table
php artisan make:migration create_messages_table

前面的命令将为我们创建迁移文件，并在迁移文件的文件名前添加日期和时间。所有迁移文件都在database/migrations文件夹中。所以我们可以进入这个文件夹并打开文件。在以create_chats_table作为文件名的文件中，我们添加了以下代码：

<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
class CreateChatsTable extends Migration
{
    public function up()
    {
        Schema::create('chats', function (Blueprint $table)
        {
            $table->id();
            $table->string('name');
            $table->timestamp('created_at')->useCurrent();
            $table->timestamp('updated_at')->useCurrent();
        });
    }
    public function down()
    {
        Schema::dropIfExists('chats');
    }
}

前面的代码将创建chats表。up()方法包含我们在运行迁移时想要运行的代码。down()方法具有我们想要反转迁移时运行的方法。

在up()方法中，我们调用Schema::create来创建表。::符号表示方法为静态方法。第一个参数是表名，第二个参数是回调函数，我们添加代码来创建表。$table对象使用id()方法创建id列。string()方法使用参数中的列名创建一个string列。timestamp()方法允许我们使用给定的列名创建一个timestamp列。useCurrent()方法允许我们将时间戳的默认值设置为当前日期和时间。

在down()方法中，我们使用Schema::dropIfExists()方法删除参数中具有给定名称的表，如果该表存在，则删除该表。

迁移文件必须具有继承自Migration类的类，才能用作迁移。

同样地，在文件名中有create_message_table名称的迁移文件中，我们编写以下内容：

<?php
use Illuminate\Database\Migrations\Migration;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Support\Facades\Schema;
class CreateMessagesTable extends Migration
{
    public function up()
    {
        Schema::create('messages', function (Blueprint 
         $table) {
            $table->id();
            $table->unsignedBigInteger('user_id');
            $table->unsignedBigInteger('chat_id');
            $table->string('message');
            $table->timestamp('created_at')->useCurrent();
            $table->timestamp('updated_at')->useCurrent();
            $table->foreign('user_id')->references('id')-
              >on('users');
            $table->foreign('chat_id')->references('id')-
              >on('chats');
        });
    }
    public function down()
    {
        Schema::dropIfExists('messages');
    }
}

前面的文件有创建messages表的代码。此表有更多列。我们有与chats表中相同的id和timestamp列，但我们还有user_id未签名integer列用于引用发布消息的用户的 ID，chat_id未签名integer列用于引用chats中的条目表将消息与创建该消息的聊天会话相关联。

foreign()方法允许我们分别指定user_id和chat_id列在用户和chats表中引用的内容。

配置我们的数据库

在我们可以运行迁移之前，我们必须配置我们的数据库，用于存储后端的数据。为此，我们在项目的root文件夹中创建.env文件，方法是复制.env.example文件，然后将其重命名为.env。

.env文件有许多设置，我们需要这些设置来运行 Laravel 应用。要配置要使用的数据库，请运行以下命令以连接到 SQLite 数据库：

DB_CONNECTION=sqlite
DB_DATABASE=C:\vue-example-ch8-chat-app\backend\db.sqlite

完整的配置文件位于https://github.com/PacktPublishing/-Vue.js-3-By-Example/blob/master/Chapter08/backend/.env.example 。我们只需将其内容复制到同一文件夹中的.env文件中即可使用配置。

为了简单起见，我们在本章中使用 SQLite，这样我们就可以专注于使用 Vue 3 创建聊天应用。然而，如果我们正在构建一个生产应用，我们应该使用一个具有更好安全性和管理能力的生产质量数据库。DB_CONNECTION环境变量具有我们想要使用的数据库类型，即 SQLite。在DB_DATABASE设置中，我们指定数据库文件的绝对路径。Laravel 不会自动为我们创建此文件，因此我们必须自己创建它。为了创建 SQLite 文件，我们可以使用 SQLite 程序的 DB 浏览器。它支持 Windows、macOS 和 Linux，因此我们可以在所有流行的平台上运行它。您可以从下载程序 https://sqlitebrowser.org/dl/ 。安装完成后，只需点击左上角的新建数据库，点击文件菜单，点击保存即可保存数据库文件。

配置到 Redis 的连接

除了使用 SQLite 作为我们应用的主数据库外，我们还需要配置与 Redis 的连接，以便我们可以使用 Laravel 的排队功能将我们的数据广播到 Redis 服务器，然后由 Laravel Echo 服务器拾取，以便将事件发送到 Vue 3 前端。Redis 配置的环境变量如下所示：

BROADCAST_DRIVER=redis
QUEUE_CONNECTION=redis
QUEUE_DRIVER=sync

我们添加了 Redis 配置，包括以下内容：

REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379

第一组环境变量配置队列将数据定向到的位置。BROADCAST_DRIVER设置被设置为redis，以便我们将事件定向到 Redis。出于同样的原因，QUEUE_CONNECTION也必须设置为redis。QUEUE_DRIVER设置为sync，以便事件在广播后立即发送到队列。

运行迁移文件

现在我们已经创建了迁移并配置了要使用的数据库，我们运行php artisan migrate来运行迁移。运行迁移将把表添加到我们的 SQLite 数据库中。在添加表之后，我们可以添加种子数据，这样当我们想要重置数据库或有空数据库时，就不必自己重新创建数据。为了创建种子数据，我们在database/seeders/DatabaseSeeder.php文件中添加了一些代码。在该文件中，我们编写以下代码为数据库添加文件：

<?php
namespace Database\Seeders;
use Illuminate\Database\Seeder;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Hash;
use Illuminate\Support\Str;
use App\Models\User;
use App\Models\Chat;
class DatabaseSeeder extends Seeder
{
    public function run()
    {
        $this->addUsers();
        $this->addChats();
        $this->addMessages();
    }
    private function addUsers()
    {
        for ($x = 0; $x <= 1; $x++) {
            DB::table('users')->insert([
                'name' => 'user'.$x,
                'email' => 'user'.$x.'@gmail.com',
                'password' => Hash::make('password'),
            ]);
        }
    }
  ...
}

我们有addUsers()方法将一些用户添加到users表中。我们创建一个循环，调用DB::table('users')->insert将一些条目插入users表。->符号与 JavaScript 中的句点相同。它允许我们访问对象属性或方法。

在insert()方法中，我们传入一个关联数组或字典，其中包含要插入的键和值：

    ...
    private function addChats()
    {
        for ($x = 0; $x <= 1; $x++) {
            DB::table('chats')->insert([
                'name' => 'chat '.$x,
            ]);
        }
    }
    ...

addChats()方法允许我们添加聊天室条目。我们只需插入名称。在addMessages()方法中，我们插入messages表的条目。我们从users表中的现有条目中获取要设置为值的用户条目的id值。同样地，我们通过从chats表中获取一个条目来对chat_id执行相同的操作，并使用该条目的id值，并将其设置为chat_id的值：

...
    private function addMessages()
    {
        for ($x = 0; $x <= 1; $x++) {
            DB::table('messages')->insert([
                'message' => 'hello',
                'user_id' => User::all()->get(0)->id,
                'chat_id' => Chat::all()->get($x)->id
            ]);
            DB::table('messages')->insert([
                'message' => 'how are you',
                'user_id' => User::all()->get(1)->id,
                'chat_id' => Chat::all()->get($x)->id
            ]);
        }
    }
...

一旦我们编写了播种机，我们可能需要重新生成 Composer 的自动加载器，以使用我们拥有的依赖项更新自动加载器。我们可以通过运行composer dump-autoload来实现这一点。如果对任何依赖项的引用已过时，并且我们希望刷新引用，以便它们不会过时，那么这将非常方便。然后我们运行php artisan db:seed运行播种器，将所有数据填充到表中。

要将数据重置为原始状态，我们可以通过运行php artisan migrate:refresh –seed同时运行迁移和播种机。我们也可以通过运行php artisan migrate:refresh清空数据库并重新运行所有迁移。

创建我们的应用逻辑

现在我们已经了解了数据库结构和种子数据，我们可以继续创建应用逻辑了。我们创建了一些控制器，以便从前端接收请求。Laravel 控制器应位于app/Http/Controllers文件夹中。我们创建一个用于接收请求或操纵chats表，另一个用于接收请求以操纵messages表。Laravel 附带了一个用于创建控制器的命令。首先，我们通过运行以下代码创建ChatController.php文件：

php artisan make:controller Chat

然后我们应该将app/Http/Controllers/ChatController.php文件添加到我们的项目中。完整代码位于https://github.com/PacktPublishing/-Vue.js-3-By-Example/blob/master/Chapter08/backend/app/Http/Controllers/ChatController.php 。

Laravel 控制器有一个从Controller类继承的类。在这个类中，我们有一些稍后将映射到 URL 的方法，这样我们就可以运行这些方法并做我们想做的事情。每个方法都获取一个包含请求数据的请求对象，包括头、URL 参数和主体。

get()方法查找单个Chat条目。Chat是chats表的模型类。在 Laravel 中，约定是通过移除末尾的s来转换表名，然后将第一个字母转换为大写，从而使类名与表名相对应。因此，Chat模型类用于操作chats表中的条目。Laravel 自动进行映射，因此我们不必自己做任何事情。我们只要记住这个惯例，就不会被它弄糊涂了。find()方法是一种static方法，我们使用它通过 ID 获取单个条目。

在所有控制器函数中，我们只需返回字符串、关联数组、响应对象或从query()方法返回的结果即可将其作为响应返回。因此，当我们发出请求并调用get方法时，Chat::find方法的返回值将作为响应返回。

getAll()方法用于从chats表中获取所有条目。all()方法是一个静态方法，返回所有条目。

create()方法用于根据请求数据创建条目。我们调用Validate::make静态方法为请求数据创建验证器。第一个参数是$request->all()，它是一个返回请求对象中所有项的方法。第二个参数是一个关联数组，其中包含要验证的请求主体的键。它的值是一个带有验证规则的字符串。所需规则确保已填写名称。字符串规则检查作为名称键的值设置的值是否为字符串。max:255规则是name值中可以包含的最大字符数：

...
    public function create(Request $request)
    {
        $validator = Validator::make($request->all(), [
            'name' => 'required|string|max:255',
        ]);
        if($validator->fails()){
            return response()->json($validator->errors()-
              >toJson(), 400);
        }
        $chat = Chat::create([
            'name' => $request->get('name'),
        ]);
        return response()->json($chat, 201);
    }
...

我们使用$validator->fails()方法检查验证是否失败。$validator是Validator::make方法返回的对象。在if块中，我们调用response()->json()将错误返回给具有 400 状态码的用户。

否则，我们调用Chat::create来创建chats表项。我们使用$request->get方法从请求主体获取name字段的值，该方法使用我们想要获取的键。然后我们将其设置为关联数组中'name'键的值，我们将其传递到create方法中。

我们做了一些与update()方法类似的事情，除了调用Chat::find以通过id值查找项目。然后我们将请求主体中的name字段的值分配给返回的聊天对象的name属性。然后调用$chat->save()保存最新的值。然后我们通过调用response()->json($chat)返回转换为 JSON 的最新聊天条目来返回响应：

...
    public function update(Request $request)
    {
        $validator = Validator::make($request->all(), [
            'name' => 'required|string|max:255',
        ]);
        if($validator->fails()){
            return response()->json($validator->errors()-
              >toJson(), 400);
        }
        $chat = Chat::find($request->id);
        $chat->name =  $request->get('name');
        $chat->save();
        return response()->json($chat);
    }
...

当我们向 API 发出删除请求以删除聊天室条目时，调用delete()方法。我们再次调用Chat::find从chats表中找到具有给定 ID 的条目，然后调用$chat->delete()删除返回的条目。然后我们返回一个空响应：

...
    public function delete(Request $request)
    {
        $chat = Chat::find($request->id);
        $chat->delete();
        return response(null, 200);
    }
...

对于MessageController.php我们有类似的逻辑来保存聊天信息。我们有带代码的UserController.php文件，以便在注册用户帐户时保存用户数据。

重要：

这些文件可在找到 https://github.com/PacktPublishing/-Vue.js-3-By-Example/blob/master/Chapter08/backend/app/Http/Controllers/MessageController.php 和https://github.com/PacktPublishing/-Vue.js-3-By-Example/blob/master/Chapter08/backend/app/Http/Controllers/UserController.php 分别。

暴露端点的控制器方法

接下来，我们必须将控制器方法映射到我们将发出调用请求的 URL。我们通过在routes/api.php文件中添加一些代码来实现这一点。为此，我们用以下代码替换文件中的内容：

<?php
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;
use App\Http\Controllers\AuthController;
use App\Http\Controllers\UserController;
use App\Http\Controllers\ChatController;
use App\Http\Controllers\MessageController;
Route::post('register', [UserController::class, 'register']);
Route::group([
    'middleware' => 'api',
    'prefix' => 'auth'
], function () {
    Route::post('login', [AuthController::class, 'login']);
    Route::post('logout', [AuthController::class, 
     'logout']);
    Route::post('refresh', [AuthController::class, 
     'refresh']);
    Route::post('me', [AuthController::class, 'me']);
     });
...
    Route::get('{chat_id}', [MessageController::class, 
     'getAll']);
    Route::post('create', [MessageController::class, 
     'create']);
});

我们将控制器方法公开为 POST，并通过分别调用Route::post和Route::get方法向客户端获取端点。

jwt.verify中间件是我们在为路由运行controller方法之前检查 JSON web 令牌的工具。这样，controller()方法将仅在令牌有效时运行。

然后我们必须创建AuthController让我们进行 JSON web 令牌身份验证。

首先，我们运行以下命令：

php artisan make:controller AuthController

然后在app/Http/Controllers/AuthController.php文件中，我们为端点添加方法，以便获取当前用户的数据、登录和注销。此文件的代码位于https://github.com/PacktPublishing/-Vue.js-3-By-Example/blob/master/Chapter08/backend/app/Http/Controllers/AuthController.php 。

如果您没有app/Http/Middleware/JwtMiddleware.php文件，则此文件的完整代码位于https://github.com/PacktPublishing/-Vue.js-3-By-Example/blob/master/Chapter08/backend/app/Http/Middleware/JwtMiddleware.php 。

它允许我们在 Vue 客户端和此应用之间使用 JSON web 令牌启用身份验证。

设置 JWT 认证

现在，我们必须使用我们的 Laravel 应用设置 JSON web 令牌身份验证，这样我们就可以独立于后端托管前端。为此，我们使用 tymon/jwt-auth库。要安装它，我们运行以下命令：

composer require tymon/jwt-auth

接下来，我们运行以下命令来发布包配置文件：

php artisan vendor:publish --provider="Tymon\JWTAuth\Providers\LaravelServiceProvider"

前面的命令将为我们添加所有必需的配置。我们现在应该将[T0]添加到我们的应用中。然后，我们通过运行以下命令生成密钥，对 JSON web 令牌进行签名：

php artisan jwt:secret

[T0]键将被添加到具有[T2]键的[T1]文件中。

配置我们的身份验证

接下来，我们必须配置我们的身份验证，以便在成功请求需要身份验证的路由之前验证 JSON web 令牌。在config/auth.php中，我们有以下代码：

<?php
return [
    'defaults' => [
        'guard' => 'api',
        'passwords' => 'users',
    ],
    'guards' => [
        'web' => [
            'driver' => 'session',
            'provider' => 'users',
        ],
        'api' => [
            'driver' => 'jwt',
            'provider' => 'users',
        ],
    ],
    'providers' => [
        'users' => [
            'driver' => 'eloquent',
            'model' => App\Models\User::class,
        ],
    ],
    'passwords' => [
        'users' => [
            'provider' => 'users',
            'table' => 'password_resets',
            'expire' => 60,
            'throttle' => 60,
        ],
    ],
    'password_timeout' => 10800,
];

在guards部分，我们有一个api密钥，该密钥的值是一个关联数组，驱动密钥设置为'jwt'，提供者设置为'users'，让我们使用jwt-auth库发布的 JSON web 令牌对用户进行身份验证。

接下来，我们添加代码以启用 CORS，以便我们的 Vue.js 3 应用可以与之通信。

启用跨域通信

为了使我们能够在前端和后端之间进行跨域通信，我们安装了fruitcake/laravel-cors包。为此，我们运行以下命令：

composer require fruitcake/laravel-cors

那么，在app/Http/Kernel.php中，我们应该有以下内容：

<?php
namespace App\Http;
use Illuminate\Foundation\Http\Kernel as HttpKernel;
class Kernel extends HttpKernel
{
    protected $middleware = [
        \App\Http\Middleware\TrustProxies::class,
        \Fruitcake\Cors\HandleCors::class,
        \App\Http\Middleware\
           PreventRequestsDuringMaintenance::class,
        \Illuminate\Foundation\Http\Middleware\
           ValidatePostSize::class,
        \App\Http\Middleware\TrimStrings::class,
        \Illuminate\Foundation\Http\Middleware\
           ConvertEmptyStringsToNull::class,
        \Fruitcake\Cors\HandleCors::class,
    ];
...
        'password.confirm' =>  \Illuminate\Auth\Middleware\
           RequirePassword::class,
        'signed' => \Illuminate\Routing\Middleware\
           ValidateSignature::class,
        'throttle' => \Illuminate\Routing\Middleware\
           ThrottleRequests::class,
        'verified' => \Illuminate\Auth\Middleware\
           EnsureEmailIsVerified::class,
        'jwt.verify' => \App\Http\Middleware\
           JwtMiddleware::class,
    ];
}

我们注册laravel-cors包附带的HandleCors中间件，在$routesMiddleware关联数组中写入以下代码，在$routeMiddleware关联数组中注册jwt.verify中间件：

'jwt.verify' => \App\Http\Middleware\JwtMiddleware::class,

这样，我们就可以使用jwt.verify中间件来验证令牌。

完整代码位于https://github.com/PacktPublishing/-Vue.js-3-By-Example/blob/master/Chapter08/backend/app/Http/Kernel.php 。

此外，我们还安装了predis软件包，以便更轻松地与 Redis 数据库进行通信。要安装predis包，我们运行以下命令：

composer require predis/predis

然后，在config/database.php中，我们编写以下代码：

<?php
use Illuminate\Support\Str;
return [
    ...    'redis' => [
        'client' => env('REDIS_CLIENT', 'predis'),
        'options' => [
            'cluster' => env('REDIS_CLUSTER', 'redis'),
            'prefix' => env('REDIS_PREFIX', Str::slug(   
            env('APP_NAME', 'laravel'), '_').'_database_'),
        ],
        ...
        'cache' => [
            'url' => env('REDIS_URL'),
            'host' => env('REDIS_HOST', '127.0.0.1'),
            'password' => env('REDIS_PASSWORD', null),
            'port' => env('REDIS_PORT', '6379'),
            'database' => env('REDIS_CACHE_DB', '1'),
        ],
    ],
];

我们在为'redis'设置的关联数组中配置我们的 Redis 数据库连接，以便我们可以连接到 Redis。

完整文件位于https://github.com/PacktPublishing/-Vue.js-3-By-Example/blob/master/Chapter08/backend/config/database.php 。

现在我们已经创建了用于存储用户数据和聊天信息的 API，接下来我们将向 Laravel 应用添加实时通信功能，以便用户可以实时保存和获取聊天信息。

增加实时通信

现在我们已经添加了路由、身份验证、数据库配置和操作代码，我们准备添加代码，让我们在前端和后端之间实时通信。首先，我们需要在 Laravel 后端创建一个event类，这样我们就可以像在MessageController中一样调用event函数来广播事件。

为此，我们运行php artisan make:event MessageSent命令来创建MessageSent事件类。该类现在应该位于backend/app/Events/MessageSent.php文件中。创建文件后，我们将用以下代码替换文件中的内容：

<?php
namespace App\Events;
...
class MessageSent implements ShouldBroadcast
{
    use InteractsWithSockets, SerializesModels;
    public $user;
    public $message;
    public function __construct(User $user, Message 
      $message)
    {
        $this->user = $user;
        $this->message = $message;
    }
    public function broadcastOn()
    {
        return new Channel('chat');
    }
    public function broadcastAs()
    {
        return 'MessageSent';
    }
}

__constructor()方法为构造函数；我们获取$user和$message对象，然后将它们分配给具有相同名称的类变量。broadcastOn()方法返回Channel对象，它创建了一个我们可以在前端收听的频道。broadCastAs()方法返回我们在聊天频道中收听的事件名称。我们将在前端使用它来收听广播事件。一个event类应该实现ShouldBroadcast接口，以便可以从中广播事件。

MessageSent.php的完整代码位于https://github.com/PacktPublishing/-Vue.js-3-By-Example/blob/master/Chapter08/backend/app/Events/MessageSent.php 。

在backend/routes/channels.php文件中，我们应该有以下代码，以便所有用户都可以收听聊天频道：

<?php
use Illuminate\Support\Facades\Broadcast;
Broadcast::channel('chat', function () {
    return true;
});

我们要订阅的第一个参数的名称是。回调函数是一个返回true的函数，如果用户可以监听事件，则返回false，否则返回。一个可选参数是user对象，这样我们就可以检查用户是否可以监听给定的事件。

此文件的完整代码位于https://github.com/PacktPublishing/-Vue.js-3-By-Example/blob/master/Chapter08/backend/routes/channels.php 。

通信流程为，如下图所示：

图 8.1–聊天应用架构图

Vue 3 前端向 Laravel 应用发出 HTTP 请求，其中包含我们要发送的消息。Laravel 应用使用聊天会话和用户的 ID 将消息保存到messages表中。它还通过队列向 Redis 服务器广播事件。然后，Laravel Echo 服务器监视 Redis，查看是否有任何内容保存到 Redis 数据库中。如果保存了任何新内容，则 Laravel Echo 服务器会将其推送到 Vue 3 前端。Vue 3 前端通过收听 Laravel Echo 服务器与 Laravel Echo 客户端和 Socket.IO 客户端的事件来获取这些信息。

与 Socket.IO 的通信

为了使我们的后端应用通过 Socket.IO 与前端通信，我们需要 Laravel Echo 服务器。为此，我们首先需要在全球范围内安装 Laravel Echo Servernpm包。我们通过运行npm install –g laravel-echo-server来安装它。然后，我们将运行这个包来创建用于设置通信的配置文件。

为此，我们创建一个新文件夹，然后运行laravel-echo-server init运行命令行向导，在文件夹中创建 Laravel Echo 服务器配置文件。此时，我们可以使用默认设置回答所有问题。这是因为我们将编辑此向导完成后创建的配置文件。

向导完成后，我们将看到文件夹中的laraval-echo-server.json文件。现在，我们打开它并用以下代码替换其中的任何内容：

{
 "authHost": "http://localhost:8000",
 "authEndpoint": "/broadcasting/auth",
 "clients": [
  {
   "appId": "APP_ID",
   "key": "c84077a4dabd8ab2a60e51b051c9d0ea"
  }
 ...
  },
  "sqlite": {
   "databasePath": "/database/laravel-echo-server.sqlite"
  },
  "publishPresence": true
 },
 "devMode": true,
 "host": "127.0.0.1",
 ...
 "http": true,
  "redis": true
 },
 "apiOriginAllow": {
  "allowCors": true,
  "allowOrigin": "*",
  "allowMethods": "GET, POST",
  "allowHeaders": "Origin, Content-Type, X-Auth-Token,     X-Requested-With, Accept, Authorization, X-CSRF-TOKEN,     X-Socket-Id"
 }
}

在前面的代码中，我们有用于配置的 JSON 代码，这样 Laravel Echo 服务器可以监听保存在 Redis 中的项目，然后通过 Socket.IO 客户端将 Redis 数据库中的任何内容发送到前端。devMode属性设置为true，这样我们就可以看到发送的所有事件。主机具有 Laravel Echo 服务器的主机 IP 地址。port属性设置为6001，因此此服务器将侦听端口 6001。该文件的另一个重要部分是apiOriginAllow属性。它被设置为一个对象，allowCors被设置为true，这样我们就可以与前端进行跨域通信。

allowOrigin属性允许我们设置允许侦听发出事件的域。allowMethods属性具有允许从前端接收的 HTTP 方法。allowHeaders属性具有允许从前端发送到 Laravel Echo 服务器的 HTTP 请求头列表。

authHost具有 Laravel 应用的基本 URL，因此可以收听 Laravel 应用广播的事件。authEndpoint具有身份验证端点，用于检查用户是否已通过身份验证以侦听需要身份验证的事件。

此配置文件的另一个重要部分是数据库配置属性。数据库属性设置为"redis"，以便它将侦听 Redis 服务器上保存的项目。databaseConfig属性具有允许我们连接到 Redis 服务器的设置。"redis"属性设置为对象，而"port"属性设置为 Redis 服务器侦听的port。Redis 的默认端口为6379。host属性是 Redis 服务器的位置。publishPresence属性设置为true，以便 Redis 发布保存在其数据库中的项目。

完整配置位于https://github.com/PacktPublishing/-Vue.js-3-By-Example/blob/master/Chapter08/laravel-echo-server/laravel-echo-server.json 。

Redis 的最新版本仅适用于 Linux 或 macOS。要在 Ubuntu Linux 上安装 Redis，请运行以下命令安装 Redis 服务器：

sudo apt update
sudo apt install redis-server

如果您正在运行 Windows 10，您可以使用 Windows Linux 子系统安装 Ubuntu Linux 的副本，以便运行最新版本的 Redis。要在 Windows 10 上安装 Ubuntu，请执行以下操作：

1. Type in Turn Windows Features on and Off in the Start menu.

   然后我们滚动到底部，点击Windows Subsystem for Linux安装它。它会要求您重新启动，您应该在继续之前重新启动。

2. 电脑重启后，进入Windows 应用商店搜索Ubuntu，点击获取。

3. 安装完成后，您可以在开始菜单中输入Ubuntu并启动。现在只需按照说明完成安装。

然后可以运行前面的两个命令来安装 Redis。

安装 Redis 后，我们运行以下命令来运行 Redis 服务器：

redis-server

现在，我们项目的后端部分已经完成。现在我们运行php artisan serve和php artisan queue:listen来运行 Laravel 应用和队列工作者。我们还必须通过运行laravel-echo-server start来启动 Laravel Echo 服务器，从而运行 Laravel Echo 服务器。

如果您遇到任何问题，那么您可能必须清除缓存以确保最新的代码正在实际运行。为此，可以运行以下命令清除所有缓存：

php artisan config:cache
php artisan config:clear
php artisan route:cache
php artisan route:clear

如果缓存被清除，并且代码仍然不工作，那么您可以返回检查代码。

现在，我们已经在 Laravel 应用中添加了实时通信，我们准备继续创建前端，让用户注册帐户、登录并开始在聊天室聊天。

创建前端让用户聊天

现在我们已经完成并运行了后端代码，我们可以在前端工作了。前端与前面几章中的内容没有太大区别。我们使用 Vue CLI 在vue-example-ch8-chat-app文件夹的frontend文件夹中创建项目，然后开始编写代码。

在vue-example-ch8-chat-app/frontend文件夹中，我们运行vue create，然后选择选择版本，然后在启用Vue 路由选项的情况下选择Vue 3选项。一旦 Vue CLI 向导完成运行，我们就可以开始构建前端了。

安装 Vue 依赖项

除了 Vue 依赖项外，我们还需要安装 Axios HTTP 客户端、Socket.IO 客户端和 Laravel Echo 客户端包，分别通过 Laravel Echo 服务器发出 HTTP 请求和监听服务器端发出的事件。要安装这些，我们运行以下命令：

npm install axios socket.io-client laravel-echo

首先，在src文件夹中，我们创建constants.js文件并添加以下代码：

export const APIURL = 'http://localhost:8000';

我们添加了APIURL常量，当我们向 API 端点发出请求时将使用该常量。在src/main.js中，我们将现有代码替换为以下代码：

...
axios.interceptors.request.use((config) => {
  if (config.url.includes('login') || 
   config.url.includes('register')) {
    return config;
  }
  return {
    ...config, headers: {
      Authorization: `Bearer ${localStorage.getItem('token')}`,
    }
  }
}, (error) => {
  return Promise.reject(error);
});
axios.interceptors.response.use((response) => {
  const { data: { status } } = response;
  if (status === 'Token is Expired') {
    router.push('/login');
  }
  return response;
}, (error) => {
  return Promise.reject(error);
});
createApp(App).use(router).mount('#app')

我们在这个文件中有两件新的东西。我们有 Axios 请求和响应拦截器，因此我们可以对所有请求应用相同的设置，而无需在发出每个请求时重复相同的代码。axios.interceptors.request.use()方法接受回调，让我们根据需要返回一个新的config对象。

如果请求 URL 不包含login或register，那么我们需要将令牌添加到Authorization头中。这就是我们在传入use()方法的回调中所做的。我们将令牌添加到需要它们的端点的请求配置中。第二个回调是一个错误处理程序，我们只返回一个被拒绝的承诺，以便在发出请求时处理它们。

类似地，我们有axios.interceptor.response.use()方法来检查第一个参数中带有回调的每个响应。我们检查响应主体是否将status属性设置为"Token is expired"字符串，以便在收到此消息并返回响应时重定向到登录页面。否则，我们只返回原样的响应。第二个参数中的错误处理程序与请求拦截器相同。

创建我们的组件

接下来，我们创建组件。我们从表单开始设置或编辑聊天室名称。为此，我们进入src/components文件夹并创建ChatroomForm.vue文件。然后，在该文件中，我们编写以下代码：

<template>
  <div>
    <h1>{{ edit ? "Edit" : "Add" }} Chatroom</h1>
    <form @submit.prevent="submit">
      <div class="form-field">
        <label for="name">Name</label>
        <br />
        <input v-model="form.name" type="text" name="name" 
          />
      </div>
      <div>
        <input type="submit" />
      </div>
    </form>
  </div>
</template>
...

此组件采用具有布尔类型的edit属性和具有字符串类型的id属性。它有一个反应性质，即form性质。它用于将输入值绑定到被动属性。我们有submit()方法来检查名称是否已填写。如果是，那么我们继续提交。如果edit属性为 true，则我们发出 PUT 请求，以使用给定 ID 更新chats表中的现有条目。否则，我们将使用给定的名称值在同一个表中创建一个新条目。完成后，我们重定向到主页，其中有聊天室列表。

在created钩子中，我们检查edit反应性属性是否正确。如果是，则我们在chats表中获得具有给定 ID 的条目，并将其设置为form无功属性的值，以便我们可以在输入框中看到form.name属性的值：

<script>
import axios from "axios";
import { APIURL } from "../constants";
export default {
  name: "ChatroomForm",
  ...
  async created() {
    if (this.edit) {
      const { data } = await 
       axios.get(`${APIURL}/api/chat/${this.id}`);
      this.form = data;
    }
  },
 };
</script>

接下来，在src/components文件夹中，我们创建NavBar.vue来创建一个组件来渲染导航栏。在该文件中，我们编写以下代码：

<template>
  <div>
    <ul>
      <li>
        <router-link to="/">Chatrooms</router-link>
      </li>
      <li><a href="#" @click="logOut">Logout</a></li>
    </ul>
  </div>
</template>
<script>
import axios from "axios";
import { APIURL } from "../constants";
export default {
  name: "NavBar",
  methods: {
    async logOut() {
      await axios.post(`${APIURL}/api/auth/logout`);
      localStorage.clear();
      this.$router.push("/login");
    },
  },
};
</script>
...

我们有一个router-link组件，可以进入聊天室页面。这是通过将to道具设置为/路线来实现的。当我们点击logout()方法时，我们还有一个链接来调用它。logout()方法向/api/auth/logOut端点发出 POST 请求，以使 JSON web 令牌无效。然后我们调用localStorage.clear()方法来清除本地存储。然后我们调用this.$router.push重定向到登录页面。

在样式部分，我们有一些用于ul和li元素的样式，因此li水平显示，它们之间有一些空白。我们还将list-style-type属性设置为none，以便从列表中删除项目符号：

<style scoped>
ul {
  list-style-type: none;
}
ul li {
  display: inline;
  margin-right: 10px;
}
</style>

在src/views文件夹中，我们将页面的组件映射到 Vue 路由的 URL，以便我们可以从浏览器访问这些组件。首先，我们在src/views文件夹中创建AddChatroomForm.vue组件文件，并添加以下代码：

<template>
  <div>
    <NavBar></NavBar>
    <ChatroomForm></ChatroomForm>
  </div>
</template>
<script>
import ChatroomForm from "@/components/ChatroomForm";
import NavBar from "@/components/NavBar";
export default {
  components: {
    ChatroomForm,
    NavBar
  },
};
</script>

我们只需在components属性中注册NavBar和ChatroomForm组件，然后将它们添加到模板中。

接下来，我们创建ChatRoom.vue组件来显示我们的聊天信息，并将代码添加到收听laravel_database_chat频道的MessageSent事件，我们通过 Redis 数据库和该文件中的 Laravel Echo 服务器从 Laravel 应用发出该事件。在此文件中，我们编写以下代码：

...
<script>
import axios from "axios";
import { APIURL } from "../constants";
import NavBar from "@/components/NavBar";
export default {
  name: "Chatroom",
  components: {
    NavBar,
  },
  beforeMount() {
    this.getChatMessages();
    this.addChatListener();
  },
  data() {
    return {
      chatMessages: [],
      message: "",
    };
  },
  ...};
</script>

然后我们将这些方法添加到同一个文件中，通过编写以下代码来获取和发送聊天信息：

...
<script>
...
export default {
  ...
  methods: {
    async getChatMessages() {
      const { id } = this.$route.params;
      const { data } = await 
        axios.get(`${APIURL}/api/message/${id}`);
      this.chatMessages = data;
      this.$nextTick(() => {
        const container = this.$refs.container;
        container.scrollTop = container.scrollHeight;
      });
    },
    async sendChatMessage() {
      const { message } = this;
      if (!message) {
        return;
      }
      const { id: chat_id } = this.$route.params;
        ...
        () => {
          this.getChatMessages();
        }
      );
    },
  },
</script>

getChatMessages方法从 API 获取聊天室的聊天消息，sendChatMessage方法通过 HTTP 请求向 API 提交聊天消息，向聊天室发送消息。然后，API 端点将通过 Laravel Echo 服务器向队列发送一条消息，并返回到此应用中使用的 Socket.IO 聊天客户端。我们调用addChatListener来监听来自服务器的laravel_database_chat事件，服务器调用getChatMessages来获取最新消息。

组件模板仅使用v-for指令呈现chatMessages反应性属性的每个条目并呈现它们。下面代码中的form元素用于让我们输入一条消息，然后通过发出 HTTP 请求将其提交给 Laravel。端点将消息保存到messages表中，并发出我们监听的事件，该事件通过 Redis 数据库和 Laravel Echo 服务器发送。前端仅从实时通信的角度了解 Laravel Echo 服务器：

<template>
  <div>
    <NavBar></NavBar>
    <h1>Chatroom</h1>
    <div id="chat-messages" ref="container">
      <div class="row" v-for="m of chatMessages" 
        :key="m.id">
        <div>
          <b>{{ m.user.name }} - {{ m.created_at }}</b>
        </div>
        <div>{{ m.message }}</div>
      </div>
    </div>
    <form @submit.prevent="sendChatMessage">
      <div class="form-field">
        <label for="message">Message</label>
        <br />
        <input v-model="message" type="text" name="message"
           />
      </div>
      <div>
        <input type="submit" />
      </div>
    </form>
  </div>
</template>

在component对象中，我们有beforeMount钩子来调用getChatMessage方法来获取聊天信息。addChatListener()方法使用 Socket.IO 客户端创建一个事件侦听器，让我们侦听从 Laravel Echo 服务器发出的事件。在getChatMessage()方法中，我们通过回调调用this.$nextTick()方法，以便在获得消息后始终滚动到保存消息的div标记的底部。我们在$nextTick回调中运行了该代码，因为我们需要确保在呈现所有消息之后运行滚动代码。

this.$nextTick()方法允许我们在回调中运行代码之前，在更新反应性属性之后等待组件重新呈现。

在addChatListener()方法中，我们订阅laravel_database_chat频道，这与我们在 Laravel 应用中定义的聊天频道相同。通过观察 Laravel Echo 服务器的输出，我们可以确保订阅了正确的频道。.MessageSent事件与我们在后端应用中定义的事件相同。事件名称前的点是必需的，以便它侦听正确命名空间中的正确事件。在我们传入的用于侦听的回调中，我们调用this.getChatMessages()以获取最新消息。

聊天信息容器的高度设置为 300px，这样当我们有太多的信息时，它就不会太高。当我们有足够的消息溢出容器时，它还允许我们滚动到底部：

<style scoped>
#chat-messages {
  height: 300px;
  overflow-y: scroll;
}
.row {
  display: flex;
  flex-wrap: wrap;
}
.row div:first-child {
  width: 30%;
}
</style>

接下来，在src/views文件夹中，我们通过编写以下代码创建Chatrooms.vue组件文件：

<template>
  <div>
    <NavBar></NavBar>
    <h1>Chatrooms</h1>
    <button @click="createChatRoom">Create Chatroom
      </button>
    <table id="table">
      <thead>
        <tr>
          <th>Name</th>
          <th>Go</th>
          <th>Edit</th>
          <th>Delete</th>
...
  beforeMount() {
    this.getChatRooms();
  },
};
</script>
<style scoped>
#table {
  width: 100%;
...
</style>

我们呈现一个带有聊天室列表的表，我们可以访问、编辑聊天室的名称或删除聊天室。该方法仅获取聊天室数据，然后分别转到使用给定 ID 编辑聊天室、添加聊天室、重定向到使用给定 ID 的聊天室页面和删除聊天室的路径。当我们删除聊天室时，我们会使用getChatRooms()方法再次获取最新的条目，以便获取最新的数据。

我们在beforeMount钩子中获得聊天室列表，以便在页面加载时看到表条目。接下来，在同一个文件夹中，我们创建EditChatroomForm.vue文件并添加以下代码：

<template>
  <div>
    <NavBar></NavBar>
    <ChatroomForm edit :id="$route.params.id">
      </ChatroomForm>
  </div>
</template>
<script>
import ChatroomForm from "@/components/ChatroomForm";
import NavBar from "@/components/NavBar";
export default {
  components: {
    ChatroomForm,
    NavBar,
  },
};
</script>

它的内容与AddChatroomForm.vue文件相同，但ChatroomForm上的edit属性设置为true，而id属性设置为我们从 Vue 路由获得的 URL 中的idURL 参数。

创建登录页面

接下来，我们通过创建src/views/Login.vue并添加以下代码来创建登录页面：

<template>
  <div>
    <h1>Login</h1>
    <form @submit.prevent="login">
      <div class="form-field">
        <label for="email">Email</label>
        <br />
        <input v-model="form.email" type="email" name="email" />
      </div>
      <div class="form-field">
        <label for="password">Password</label>
        <br />
        <input v-model="form.password" type="password"            name="password" />
      </div>
      <div>
        <input type="submit" value="Log in" />
        <button type="button" @click="goToRegister">Register</            button>
      </div>
    </form>
  </div>
</template>
<script>
import axios from "axios";
import { APIURL } from "../constants";
export default {
  name: "Login",
  data() {
    return {
      form: {
        email: "",
        password: "",
      },
    };
  },
  methods: {
    async login() {
      const { email, password } = this.form;
      if (!email || !password) {
        alert("Email and password are required");
        return;
      }
      try {
        const {
          data: { access_token },
        } = await axios.post(`${APIURL}/api/auth/login`, {
          email,
          password,
        });
        localStorage.setItem("token", access_token);
        this.$router.push("/");
      } catch (error) {
        alert("Invalid username or password");
      }
    },
    goToRegister() {
      this.$router.push("/register");
    },
  },
};
</script>

该模板只是有一个登录表单，它接受电子邮件和密码，让我们登录。提交表单时，调用login()方法。它首先检查所有字段是否正确填写，然后使用凭据向/api/auth/login路由发出 HTTP 请求，以查看我们是否可以登录。

该表单还有一个Register.vue文件，可以转到注册页面，这样我们就可以注册帐户并加入聊天室。

我们必须创建的最后一页是用于放置注册表的页面。要创建它，我们编写以下代码：

<template>
  <div>
    <h1>Register</h1>
    <form @submit.prevent="register">
      <div class="form-field">
        <label for="email">Name</label>
        <br />
        <input v-model="form.name" type="text" name="name"
          />
      </div>
      <div class="form-field">
        <label for="email">Email</label>
        <br />
        <input v-model="form.email" type="email" 
          name="email" />
      </div>
      <div class="form-field">
        <label for="password">Password</label>
        <br />
          …
          name,
          email,
          password,
          password_confirmation: confirmPassword,
        });
        this.$router.push("/login");
      } catch (error) {
        alert("Invalid username or password");
      }
    },
  },
};
</script>

该表单包含名称、电子邮件、密码和确认密码字段，这些字段都是注册帐户所必需的。当我们提交表单时，我们称之为register()方法。我们对字段进行检查，看它们是否填写正确。对[T2]正则表达式调用[T1]方法以检查有效的电子邮件地址。如果有效，test()方法返回true。否则返回false。我们还检查密码是否与confirmPassword变量相同。如果所有内容都有效，那么我们会发出 POST 请求以注册用户帐户。

在src/App.vue中，我们用以下代码替换中的内容，添加router-view组件，以便我们可以从src/views文件夹中看到路由组件：

<template>
  <div>
    <router-view />
  </div>
</template>
<style scoped>
div {
  width: 70vw;
  margin: 0 auto;
}
</style>
<style>
.form-field input {
  width: 100%;
}
</style>

然后，在src/router/index.js文件中，我们用以下代码替换那里的内容，以注册所有路由，并创建Socket.io事件以使用 LaravelEcho 库进行监听：

...
window.io = require('socket.io-client');
const beforeEnter = (to, from, next) => {
  const hasToken = Boolean(localStorage.getItem('token'));
  if (!hasToken) {
    return next({ path: 'login' });
  }
  next();
}
const routes = [
  {
...
    path: '/edit-chatroom/:id',
    name: 'edit-chatroom/:id',
    component: EditChatroomForm,
    beforeEnter
  },
]
...
export default router

Laravel Echo 客户端与 Socket.IO 客户端一起使用，以便我们可以收听从 Laravel Echo 服务器广播的事件。broadcaster属性被设置为'socket.io'，以便我们可以监听来自 Laravel Echo 服务器的事件。host属性设置为 Laravel Echo 服务器的 URL。

此外，我们有beforeEnter导航保护，我们在前面的章节中已经看到，当我们需要限制一条路径只有在认证成功后才可用时。我们只是检查令牌是否存在。如果存在，我们会呼叫next继续下一条路线。否则，我们重定向到登录页面。

现在我们可以通过运行npm run serve来运行前端，就像在所有其他项目中一样。现在我们应该看到如下截图。以下屏幕截图具有聊天室用户界面：

图 8.2–聊天室的屏幕截图

下面的屏幕截图是 Laravel Echo 服务器正在工作。我们应该看到所广播事件的名称及其发送的频道：

图 8.3–聊天事件发送到前端时 Redis 的输出

下面的截图是队列事件的日志：

图 8.4–Laravel 事件的输出

我们早些时候通过在backend文件夹中运行php artisan queue:listen启动了队列，该文件夹包含 Laravel 项目。

现在聊天应用的前端工作正常了，我们用 Laravel 和 Vue 创建了一个简单的聊天系统。

总结

在本章中，我们介绍了如何使用 Laravel 和 Vue 构建聊天应用。我们用 Laravel 构建了后端，并添加了控制器来接收请求。我们使用内置在 Laravel 中的队列系统将数据发送到前端。我们还在 Laravel 应用中添加了 JSON web 令牌身份验证。

在前端，我们使用 Socket.IO 客户端监听从 Laravel Echo 服务器发送的事件，该服务器通过 Redis 从 Laravel 获取数据。

现在，我们已经经历了不同难度的 Vue 3 项目，我们可以根据实际情况调整我们在这里学到的内容。现实生活中的 Vue 应用几乎总是向服务器发出 HTTP 请求。Axios 库使这变得简单。一些应用还与服务器实时通信，如本章中的聊天应用。

唯一的区别是，在现实生活中的应用中，会进行检查，以查看用户是否经过身份验证并有权将数据发送到服务器。

---

版权属于：月萌API www.moonapi.com，转载请注明出处

本文链接：https://moonapi.com/news/14337.html