Nest.js MVC 介绍
Nest 默认使用底层的 Express 库。 因此,在 Express 中使用 MVC(模型-视图-控制器)模式的每种技术也适用于 Nest。
首先,让我们使用 CLI 工具搭建一个简单的 Nest 应用程序:
$ npm i -g @nestjs/cli
$ nest new project
为了创建一个 MVC 应用程序,我们还需要一个模板引擎来渲染我们的 HTML 视图:
$ npm install --save hbs
我们使用了 hbs(Handlebars)引擎,但你可以使用任何适合自己要求的引擎。 安装过程完成后,我们需要使用以下代码配置 express 实例:
import { NestFactory } from '@nestjs/core';
import { NestExpressApplication } from '@nestjs/platform-express';
import { join } from 'path';
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 目录将用于存储静态资源,视图将包含模板,并且应该使用 hbs 模板引擎来呈现 HTML 输出。
模板渲染
现在,让我们在其中创建一个 views 目录和 index.hbs 模板。 在模板中,我们将打印从控制器传递的消息:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<title>App</title>
</head>
<body>
{{ message }}
</body>
</html>
接下来,打开 app.controller
文件并将 root()
方法替换为以下代码:
import { Get, Controller, Render } from '@nestjs/common';
@Controller()
export class AppController {
@Get()
@Render('index')
root() {
return { message: 'Hello world!' };
}
}
在这段代码中,我们在 @Render()
装饰器中指定了要使用的模板,并将路由处理程序方法的返回值传递给模板进行渲染。 请注意,返回值是一个带有属性消息的对象,与我们在模板中创建的消息占位符匹配。
在应用程序运行时,打开浏览器并导航到 http://localhost:3000
。 我们应该看到 Hello world! 信息。
动态模板渲染
如果应用程序逻辑必须动态决定要渲染哪个模板,那么我们应该使用 @Res()
装饰器,并在我们的路由处理程序中提供视图名称,而不是在 @Render()
装饰器中:
提示
当 Nest 检测到 @Res() 装饰器时,它会注入特定于库的响应对象。 我们可以使用这个对象来动态渲染模板。
import { Get, Controller, Res, Render } 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 应用程序,我们必须安装以下软件包:
$ npm i --save fastify-static point-of-view handlebars
接下来的步骤涵盖了与 Express 使用的几乎相同的过程,只是特定于平台的细微差别。 安装过程完成后,打开 main.ts 文件并更新其内容:
import { NestFactory } from '@nestjs/core';
import { NestFastifyApplication, FastifyAdapter } from '@nestjs/platform-fastify';
import { AppModule } from './app.module';
import { join } from 'path';
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()
装饰器的模板名称必须包含文件扩展名。
import { Get, Controller, Render } from '@nestjs/common';
@Controller()
export class AppController {
@Get()
@Render('index.hbs')
root() {
return { message: 'Hello world!' };
}
}
在应用程序运行时,打开浏览器并导航到 http://localhost:3000
。 您应该看到 Hello world! 信息。