Nest学习：入门到实践的简易教程

概述

本文介绍了Nest框架的基础知识，包括其特点和优势，适用场景以及如何安装和配置Nest框架。文章详细讲解了Nest框架中的基础概念，如控制器、服务、模块和提供者，并提供了实践教程和常见问题解答。通过阅读本文，读者可以全面了解和掌握nest学习的相关知识。

Nest框架简介 什么是Nest框架

Nest框架是一个基于Node.js和TypeScript的高性能服务器端框架，主要用于构建高效、可扩展的应用程序。它采用了现代的JavaScript工具链，特别是TypeScript，可以提供强类型支持，增强开发效率。Nest框架由Angular团队维护，它借鉴了Angular的设计理念，为开发者提供了一套模块化、可组合的架构模式。

Nest框架的特点和优势

1. 模块化和可组合性：Nest采用了模块化的设计方式，可以将应用程序划分为独立的模块。每个模块可以包含控制器、服务、提供者等。模块之间的解耦便于开发和维护。
2. 类型安全：Nest框架鼓励使用TypeScript，提供了强类型支持，可以减少运行时错误。
3. 中间件支持：Nest支持多种中间件，可以轻松地实现如身份验证、日志记录等功能。
4. 可测试性：Nest框架内置了单元测试和集成测试的支持，便于编写测试代码。
5. 可扩展性：Nest框架提供了灵活的插件和装饰器系统，可以方便地扩展功能。
6. 跨平台：Nest框架使用Node.js，因此可以在任何支持Node.js的平台上运行。

适用场景和应用案例

Nest框架适用于构建以下类型的Web应用程序：

• RESTful API：Nest非常适合构建RESTful API，可以通过控制器定义HTTP路由和处理请求。
• GraphQL服务器：Nest内置了GraphQL支持，可以轻松地构建GraphQL服务器。
• 企业级应用：Nest框架的模块化和可组合特性使其非常适合大型企业级应用。
• 微服务架构：Nest框架可以轻松地构建微服务架构，每个微服务可以独立部署。

安装配置Nest 安装Node.js

安装Nest框架前，首先需要安装Node.js。Node.js可以在其官方网站上下载安装，安装完成后需要验证安装是否成功：

node -v
npm -v

确保Node.js和npm版本符合Nest框架的要求。

安装Nest CLI

Nest CLI是一个命令行界面工具，用于创建和管理Nest项目。可以通过以下命令安装Nest CLI：

npm install -g @nestjs/cli

安装完成后，可以通过以下命令验证安装：

nest -v

创建第一个Nest项目

创建Nest项目需要遵循以下步骤：

1. 使用Nest CLI创建新项目：

nest new my-nest-app

1. 进入项目目录：

cd my-nest-app

1. 启动应用：

npm run start:dev

启动后，Nest会自动编译并启动应用，可以在浏览器中访问http://localhost:3000，默认会返回Hello World。

基础概念讲解 控制器（Controllers）

控制器是负责处理HTTP请求和响应的主要组件。每个控制器都有一个或多个装饰器，用于定义路由和HTTP方法。

示例代码

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

@Controller('users')
export class UsersController {
  @Get()
  findAll(): string {
    return 'This action returns all users';
  }
}

在这个例子中，@Controller('users')定义了控制器的路由前缀。@Get()装饰器定义了一个GET请求处理器，返回一条消息。

服务（Services）

服务是执行业务逻辑的组件，通常不直接处理HTTP请求。服务可以被多个控制器共享。

示例代码

import { Injectable } from '@nestjs/common';

@Injectable()
export class UserService {
  findAll(): string {
    return 'This action returns all users';
  }
}

在服务中使用@Injectable()装饰器标记为可注入的服务。

模块（Modules）

模块是Nest框架的基本组织单元，每个模块可以包含控制器、服务、提供者等。模块还定义了依赖关系。

示例代码

import { Module } from '@nestjs/common';
import { UsersController } from './users.controller';
import { UserService } from './users.service';

@Module({
  controllers: [UsersController],
  providers: [UserService],
})
export class UsersModule {}

在该模块中，定义了控制器和提供者。

提供者（Providers）

提供者是Nest框架中的可注入对象，例如服务、装饰器和中间件。它们可以被模块内的其他组件共享。

示例代码

import { Injectable } from '@nestjs/common';

@Injectable()
export class UserService {
  findAll(): string {
    return 'This action returns all users';
  }
}

UserService就是一个提供者，可以被控制器或其他服务共享。

实践教程 创建RESTful API

创建一个简单的RESTful API需要以下步骤：

1. 创建控制器和路由：

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

@Controller('users')
export class UsersController {
  @Get()
  findAll(): string {
    return 'This action returns all users';
  }
}

1. 创建服务并实现业务逻辑：

import { Injectable } from '@nestjs/common';

@Injectable()
export class UserService {
  findAll(): string {
    return 'This action returns all users';
  }
}

1. 在模块中定义控制器和服务：

import { Module } from '@nestjs/common';
import { UsersController } from './users.controller';
import { UserService } from './users.service';

@Module({
  controllers: [UsersController],
  providers: [UserService],
})
export class UsersModule {}

1. 在控制器中注入服务：

import { Controller, Get, Inject } from '@nestjs/common';
import { UserService } from '../services/user.service';

@Controller('users')
export class UsersController {
  constructor(private readonly userService: UserService) {}

  @Get()
  async findAll(): Promise<string> {
    return this.userService.findAll();
  }
}

使用中间件

中间件可以用来执行一些特定的任务，例如日志记录、身份验证等。

定义中间件

import { Injectable } from '@nestjs/common';

@Injectable()
export class LoggingMiddleware {
  use(req, res, next) {
    console.log('Request received:', req.path);
    next();
  }
}

在模块中使用中间件

import { Module } from '@nestjs/common';
import { LoggingMiddleware } from './logging.middleware';

@Module({
  providers: [LoggingMiddleware],
})
export class AppModule {}

在控制器中使用中间件

import { Controller, UseMiddleware } from '@nestjs/common';
import { LoggingMiddleware } from './logging.middleware';

@Controller('users')
export class UsersController {
  @UseMiddleware(LoggingMiddleware)
  @Get()
  findAll(): string {
    return 'This action returns all users';
  }
}

模板渲染

Nest框架支持使用模板引擎渲染HTML页面。常用的模板引擎包括EJS、Pug等。

1. 安装模板引擎：

npm install @nestjs/core @nestjs/platform-express ejs

1. 在模块中配置模板引擎：

import { Module } from '@nestjs/common';
import { HttpModule } from '@nestjs/axios';
import { ServeStaticModule } from '@nestjs/serve-static';
import { EjsAdapter, TemplateService } from '@nestjs-modules/core';

@Module({
  imports: [
    HttpModule,
    ServeStaticModule.forRoot({
      rootPath: 'public',
    }),
  ],
  providers: [
    TemplateService,
    {
      provide: TemplateService,
      useClass: EjsAdapter,
    },
  ],
})
export class AppModule {}

1. 创建模板文件：

在dist/src/templates目录下创建index.ejs文件：

<!DOCTYPE html>
<html>
<head>
  <title>My Nest App</title>
</head>
<body>
  <h1>Welcome to My Nest App</h1>
</body>
</html>

1. 在控制器中使用模板：

import { Controller, Get } from '@nestjs/common';
import { TemplateService } from '@nestjs-modules/core';

@Controller('home')
export class HomeController {
  constructor(private readonly templateService: TemplateService) {}

  @Get()
  async index(): Promise<string> {
    return this.templateService.render('index');
  }
}

数据库集成

Nest框架支持多种数据库，例如MySQL、MongoDB等。这里以MongoDB为例。

1. 安装MongoDB驱动：

npm install @nestjs/microservices @nestjs/mongoose mongoose

1. 配置MongoDB连接：

import { MongooseModule } from '@nestjs/mongoose';
import { Module } from '@nestjs/common';

@Module({
  imports: [
    MongooseModule.forRoot('mongodb://localhost:27017/mydatabase'),
  ],
})
export class AppModule {}

1. 定义数据模型：

import { Document, Schema } from 'mongoose';

export interface User extends Document {
  name: string;
  email: string;
}

export const UserSchema = new Schema({
  name: String,
  email: String,
});

1. 创建服务并操作数据库：

import { Injectable } from '@nestjs/common';
import { Model } from 'mongoose';
import { InjectModel } from '@nestjs/mongoose';
import { UserSchema }.