如何用Nestjs和PostgreSQL建立一个实时的聊天应用程序？（附教程）

方石剑
1,024 阅读8分钟

用Nestjs和PostgreSQL建立一个实时的聊天应用程序

了解如何使用WebSockets为你的Nestjs网络应用程序添加实时聊天功能。

本教程的代码可以在我的GitHub仓库中找到。在你按照步骤进行操作时，可以自由地克隆它。让我们开始吧!

什么是NestJS？

NestJS是一个Node.js框架，用于创建快速、可测试、可扩展、松散耦合的服务器端应用程序，使用TypeScript。它利用了强大的HTTP服务器框架的优势，如Express或Fastify。Nest为Node.js框架增加了一层抽象，并将其API暴露给开发者。它支持PostgreSQL和MySQL等数据库管理系统。NestJS还提供了依赖性注入的Websockets和APIGetaways。

什么是WebSocket？

WebSocket是一种计算机通信协议，通过单一的TCP连接提供全双工通信通道。IETF在2011年将WebSocket协议标准化为RFC 6455。目前的规范被称为 "HTML生活标准"。与HTTP/HTTPS不同，WebSocket是有状态的协议，这意味着服务器和客户端之间建立的连接将是活的，除非服务器或客户端终止；一旦WebSocket连接被一端关闭，它将延伸到另一端。

前提条件

本教程是一个实战演示。要跟上进度，请确保你已经安装了以下内容。

项目设置

在开始编码之前，让我们来设置我们的NestJS项目和项目结构。我们将从创建项目文件夹开始。然后，打开你的终端，运行以下命令。

mkdir chatapp && cd chatapp

创建项目文件夹

然后用下面的命令安装NestJS CLI。

Shell

npm i -g @nestjs/cli

当安装完成后，运行下面的命令来搭建一个NestJS项目的支架。

Shell

nest new chat

选择你喜欢的npm软件包管理器。在这个教程中，我们将使用npm，并等待必要的包被安装。一旦安装完成，用下面的命令安装WebSocket和Socket.io。

Shell

npm i --save @nestjs/websockets @nestjs/platform-socket.io

然后，用下面的命令创建一个网关应用程序。

Shell

nest g gateway app

现在，让我们通过运行下面的命令启动我们的服务器。

Shell

npm run start:dev

设置一个Postgres数据库

现在我们可以设置我们的Postgres数据库来存储我们的用户记录和服务器设置。首先，我们将使用TypeORM（Object Relational Mapper）来连接我们的数据库和我们的应用程序。首先，我们需要创建一个数据库，步骤如下。首先，切换到系统的Postgres用户账户。

Shell

sudo su - postgres

然后，用下面的命令创建一个新的用户账户。

Shell

createuser --interactive

接下来，创建一个新的数据库。你可以用下面的命令来做。

Shell

createdb chat

现在，我们将连接到我们刚刚创建的数据库。首先，打开app.module.ts文件，在**import[]**数组中添加下面的代码片段。

Shell

...
import { TypeOrmModule } from '@nestjs/typeorm';
import { Chat } from './chat.entity';
imports: [
   TypeOrmModule.forRoot({
     type: 'postgres',
     host: 'localhost',
     username: '<USERNAME>',
     password: '<PASSWORD>',
     database: 'chat',
     entities: [Chat],
     synchronize: true,
   }),
   TypeOrmModule.forFeature([Chat]),
 ],
...

在上面的代码片断中，我们使用TypeOrmModule forRoot方法将我们的应用程序连接到PostgresSQL数据库，并传入我们的数据库凭证。将和替换为您为聊天数据库创建的用户和密码。

创建我们的聊天实体

现在我们已经将应用程序连接到您的数据库，创建一个聊天实体来保存用户的消息。要做到这一点，在src文件夹中创建一个chat.entity.ts文件，并添加下面的代码片段。

TypeScript

import {
 Entity,
 Column,
 PrimaryGeneratedColumn,
 CreateDateColumn,
} from 'typeorm';
 
@Entity()
export class Chat {
 @PrimaryGeneratedColumn('uuid')
 id: number;
 
 @Column()
 email: string;
 
 @Column({ unique: true })
 text: string;
 
 @CreateDateColumn()
 createdAt: Date;
}

在上面的代码片段中，我们使用TypeOrm提供的Entity、Column、CreatedDateColumn和PrimaryGenerateColumn 装饰器为我们的聊天创建了列。

设置一个WebSocket

让我们在服务器中设置一个WebSocket连接来发送实时信息。首先，我们将通过下面的代码片段导入我们所需的模块。

TypeScript

import {
 SubscribeMessage,
 WebSocketGateway,
 OnGatewayInit,
 WebSocketServer,
 OnGatewayConnection,
 OnGatewayDisconnect,
} from '@nestjs/websockets';
import { Socket, Server } from 'socket.io';
import { AppService } from './app.service';
import { Chat } from './chat.entity';

在上面的代码片段中，我们导入了SubscribeMessage()，以监听来自客户端的事件；导入了WebSocketGateway()，这将使我们能够访问socket.io；我们还导入了OnGatewayInit、OnGatewayConnection和OnGatewayDisconnect实例。这个WebSocket实例使你能够知道你的应用程序的状态。例如，我们可以让我们的服务器在服务器加入或断开聊天时做一些事情。然后，我们导入了聊天实体和AppService，它暴露了我们需要保存用户信息的方法。

TypeScript

@WebSocketGateway({
 cors: {
   origin: '*',
 },
})

为了使我们的客户端能够与服务器通信，我们通过初始化WebSocketGateway来启用CORS**。**

TypeScript

export class AppGateway
 implements OnGatewayInit, OnGatewayConnection, OnGatewayDisconnect
{
 constructor(private appService: AppService) {}
 
 @WebSocketServer() server: Server;
 
 @SubscribeMessage('sendMessage')
 async handleSendMessage(client: Socket, payload: Chat): Promise<void> {
   await this.appService.createMessage(payload);
   this.server.emit('recMessage', payload);
 }
 
 afterInit(server: Server) {
   console.log(server);
   //Do stuffs
 }
 
 handleDisconnect(client: Socket) {
   console.log(`Disconnected: ${client.id}`);
   //Do stuffs
 }
 
 handleConnection(client: Socket, ...args: any[]) {
   console.log(`Connected ${client.id}`);
   //Do stuffs
 }
}

接下来，在我们的AppGateWay 类中，我们实现了上述导入的WebSocket实例。我们创建了一个构造方法，并绑定了我们的AppService以访问其方法。我们从WebSocketServer装饰器中创建了一个服务器实例。

然后我们创建一个handleSendMessage ，使用 ***@SubscribeMessage()***实例和handleMessage()方法来发送数据到我们的客户端。

当消息从客户端发送到该函数时，我们将其保存在我们的数据库中，并将该消息反馈给我们客户端的所有连接用户。我们还有许多其他的方法，你可以进行实验，比如afterInit， 在客户端连接后被触发， handleDisconnect， 在用户断开连接时被触发。handleConnection方法在用户加入连接时启动。

创建一个控制器/服务

现在让我们创建我们的服务和控制器，以保存聊天内容并渲染我们的静态页面。打开app.service.ts文件，用下面的代码片断更新内容。

TypeScript

import { Injectable } from '@nestjs/common';
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';
import { Chat } from './chat.entity';
 
@Injectable()
export class AppService {
 constructor(
   @InjectRepository(Chat) private chatRepository: Repository<Chat>,
 ) {}
 async createMessage(chat: Chat): Promise<Chat> {
   return await this.chatRepository.save(chat);
 }
 
 async getMessages(): Promise<Chat[]> {
   return await this.chatRepository.find();
 }
}

然后用下面的代码片断更新app.controller.ts 文件。

TypeScript

import { Controller, Render, Get, Res } from '@nestjs/common';
import { AppService } from './app.service';
import { Chat } from './chat.entity';
 
@Controller()
export class AppController {
 constructor(private readonly appService: AppService) {}
 
 @Get('/chat')
 @Render('index')
 Home() {
   return;
 }
 
 @Get('/api/chat')
 async Chat(@Res() res) {
   const messages = await this.appService.getMessages();
   res.json(messages);
 }
}

在上面的代码片段中，我们创建了两条路由来渲染我们的静态页面和用户的信息。

服务我们的静态页面

现在让我们配置应用程序来渲染静态文件和我们的页面。为了做到这一点，我们将实现服务器端的渲染。首先，在你的main.ts文件中，用下面的命令将应用程序配置为静态服务器文件。

TypeScript

async function bootstrap() {
 ...
 app.useStaticAssets(join(__dirname, '..', 'static'));
 app.setBaseViewsDir(join(__dirname, '..', 'views'));
 app.setViewEngine('ejs');
 ...
}

接下来，在你的src 目录下创建一个静态和一个视图文件夹。在views文件夹中，创建一个index.ejs文件并添加下面的代码片段。

HTML

<!DOCTYPE html>
<html lang="en">
 
<head>
 <!-- Required meta tags -->
 <meta charset="utf-8" />
 <meta name="viewport" content="width=device-width, initial-scale=1" />
 
 <!-- Bootstrap CSS -->
 <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" rel="stylesheet"
   integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous" />
 
 <title>Let Chat</title>
</head>
 
<body>
 <nav class="navbar navbar-light bg-light">
   <div class="container-fluid">
     <a class="navbar-brand">Lets Chat</a>
   </div>
 </nav>
 <div class="container">
   <div class="mb-3 mt-3">
     <ul style="list-style: none" id="data-container"></ul>
   </div>
   <div class="mb-3 mt-4">
     <input class="form-control" id="email" rows="3" placeholder="Your Email" />
   </div>
   <div class="mb-3 mt-4">
     <input class="form-control" id="exampleFormControlTextarea1" rows="3" placeholder="Say something..." />
   </div>
 </div>
 <script src="https://cdn.socket.io/4.3.2/socket.io.min.js"
   integrity="sha384-KAZ4DtjNhLChOB/hxXuKqhMLYvx3b5MlT55xPEiNmREKRzeEm+RVPlTnAn0ajQNs"
   crossorigin="anonymous"></script>
 <script src="app.js"></script>
 <!-- Option 1: Bootstrap Bundle with Popper -->
 <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js"
   integrity="sha384-MrcW6ZMFYlzcLA8Nl+NtUVF0sA7MsXsP1UyJoMp4YLEuNSfAP+JcXn/tWtIaxVXM"
   crossorigin="anonymous"></script>
</body>
</html>

为了加快模板的速度，我们使用Bootstrap来添加一些样式。然后我们添加了两个输入字段和一个无序列表来显示用户的信息。我们还包括了我们的app.js文件，我们将在本节的后面创建这个文件，以及一个指向socket.io客户端的链接。

现在创建一个app.js文件并添加下面的代码片段。

JavaScript

const socket = io('http://localhost:3002');
const msgBox = document.getElementById('exampleFormControlTextarea1');
const msgCont = document.getElementById('data-container');
const email = document.getElementById('email');
 
//get old messages from the server
const messages = [];
function getMessages() {
 fetch('http://localhost:3002/api/chat')
   .then((response) => response.json())
   .then((data) => {
     loadDate(data);
     data.forEach((el) => {
       messages.push(el);
     });
   })
   .catch((err) => console.error(err));
}
getMessages();
 
//When a user press the enter key,send message.
msgBox.addEventListener('keydown', (e) => {
 if (e.keyCode === 13) {
   sendMessage({ email: email.value, text: e.target.value });
   e.target.value = '';
 }
});
 
//Display messages to the users
function loadDate(data) {
 let messages = '';
 data.map((message) => {
   messages += ` <li class="bg-primary p-2 rounded mb-2 text-light">
      <span class="fw-bolder">${message.email}</span>
      ${message.text}
    </li>`;
 });
 msgCont.innerHTML = messages;
}
 
//socket.io
//emit sendMessage event to send message
function sendMessage(message) {
 socket.emit('sendMessage', message);
}
//Listen to recMessage event to get the messages sent by users
socket.on('recMessage', (message) => {
 messages.push(message);
 loadDate(messages);
})

在上面的代码片段中，我们创建了一个socket.io实例，并监听了我们服务器上的事件，以发送和接收来自服务器的信息。我们希望当用户加入聊天时，旧的聊天记录默认是可用的。

现在我们已经成功创建了我们的聊天应用程序。首先，让我们用Arctype查看一下用户的数据。首先，启动Arctype，点击MySQL标签，并输入以下MySQL凭证.然后，点击chattable，显示用户的聊天信息

测试应用程序

现在在两个不同的标签或窗口中打开该应用程序，并尝试用不同的电子邮件地址发送消息，如下图所示。

另外，当你看你的控制台时，你会看到用户加入和断开服务器时的日志，这是由handleDisconnect和handleConnection方法处理的。

总结

在本教程中，我们探讨了如何使用Nestjs和PostgreSQL创建一个实时聊天应用程序。我们首先简要介绍了Nestjs和WebSockets。然后，我们创建了一个演示应用程序来演示实现。希望你能得到你所寻求的知识。

avatar
文章
阅读
粉丝