MVC Model-View-Controller

导读

Nest 默认使用 Express 库。因此，在 Express 中使用 MVC（模型-视图-控制器）模式的每种技术也适用于 Nest。

首先，让我们使用 CLI 工具搭建一个简单的 Nest 应用程序：

bash

$ npm i -g @nestjs/cli
$ nest new project

为了创建 MVC 应用程序，我们还需要一个模板引擎来呈现我们的 HTML 视图：

bash

$ npm install --save hbs

我们使用了 hbs (Handlebars) 引擎，但您可以使用任何符合您要求的引擎。安装过程完成后，我们需要使用以下代码配置快速实例：

main

import { join } from 'node:path'
import { NestFactory } from '@nestjs/core'
import { NestExpressApplication } from '@nestjs/platform-express'
import { AppModule } from './app.module'

async function bootstrap() {
  const app = await NestFactory.create<NestExpressApplication>(
    AppModule,
  )

  app.useStaticAssets(join(__dirname, '..', 'public'))
  app.setBaseViewsDir(join(__dirname, '..', 'views'))
  app.setViewEngine('hbs')

  await app.listen(3000)
}
bootstrap()

我们告诉 Express public 目录将用于存储静态资产，views 将包含模板，hbs 模板引擎将用于呈现 HTML 输出。

模板渲染

现在，让我们创建一个 views 目录和其中的 index.hbs 模板。在模板中，我们将打印从控制器传递的 message：

html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <title>App</title>
  </head>
  <body>
    {{ "{{ message }\}" }}
  </body>
</html>

接下来，打开 app.controller 文件并用以下代码替换 root() 方法：

app.controller

import { Controller, Get, Render } from '@nestjs/common'

@Controller()
export class AppController {
  @Get()
  @Render('index')
  root() {
    return { message: 'Hello world!' }
  }
}

在此代码中，我们在 @Render() 装饰器中指定要使用的模板，并将路由处理程序方法的返回值传递给模板进行渲染。请注意，返回值是一个具有属性 message 的对象，与我们在模板中创建的 message 占位符匹配。

在应用程序运行时，打开浏览器并导航到 http://localhost:3000。您应该会看到 Hello world! 消息。

动态模板渲染

如果应用程序逻辑必须动态决定要渲染哪个模板，那么我们应该使用 @Res() 装饰器，并在路由处理程序中提供视图名称，而不是在 @Render() 装饰器中：

提示

当 Nest 检测到 @Res() 装饰器时，它会注入特定于库的 response 对象。我们可以使用此对象动态渲染模板。了解有关 response 对象 API 的更多信息，请点击此处。

app.controller

import { Controller, Get, Render, Res } from '@nestjs/common'
import { Response } from 'express'
import { AppService } from './app.service'

@Controller()
export class AppController {
  constructor(private appService: AppService) {}

  @Get()
  root(@Res() res: Response) {
    return res.render(
      this.appService.getViewName(),
      { message: 'Hello world!' },
    )
  }
}

示例

此处提供了一个工作示例。

Fastify

正如本章节中所述，我们可以将任何兼容的 HTTP 提供程序与 Nest 一起使用。其中一个库是 Fastify。为了使用 Fastify 创建 MVC 应用程序，我们必须安装以下软件包：

bash

$ npm i --save @fastify/static @fastify/view handlebars

接下来的步骤几乎与 Express 使用的流程相同，但平台略有不同。安装过程完成后，打开main.ts文件并更新其内容：

main

import { join } from 'node:path'
import { NestFactory } from '@nestjs/core'
import { FastifyAdapter, NestFastifyApplication } from '@nestjs/platform-fastify'
import { AppModule } from './app.module'

async function bootstrap() {
  const app = await NestFactory.create<NestFastifyApplication>(
    AppModule,
    new FastifyAdapter(),
  )
  app.useStaticAssets({
    root: join(__dirname, '..', 'public'),
    prefix: '/public/',
  })
  app.setViewEngine({
    engine: {
      handlebars: require('handlebars'),
    },
    templates: join(__dirname, '..', 'views'),
  })
  await app.listen(3000)
}
bootstrap()

Fastify API 略有不同，但这些方法调用的最终结果保持不变。Fastify 的一个不同之处在于，传递给 @Render() 装饰器的模板名称必须包含文件扩展名。

app.controller

import { Controller, Get, Render } from '@nestjs/common'

@Controller()
export class AppController {
  @Get()
  @Render('index.hbs')
  root() {
    return { message: 'Hello world!' }
  }
}

当应用程序运行时，打开浏览器并导航到 http://localhost:3000。您应该会看到 Hello world! 消息。

示例

此处提供了一个可用的示例。