NestJS：基础掌握从了解到使用

柔情只为你懂 2024-03-26 10:47 31阅读 0赞

**一、官网**

一定要认真学习官网内容！

[NestJS 简介 | NestJS 中文文档 | NestJS 中文网][NestJS _ _ NestJS _ _ NestJS]

[NestJS - A progressive Node.js framework][]

**二、理解NestJS（内容来自官网）**

**2.1、理解NestJS**

Nest (NestJS) 是一个用于构建高效、可扩展的 [Node.js][] 服务器端应用程序的开发框架。它利用 JavaScript 的渐进增强的能力，使用并完全支持 [TypeScript][] （仍然允许开发者使用纯 JavaScript 进行开发），并结合了 OOP （面向对象编程）、FP （函数式编程）和 FRP （函数响应式编程）。

在底层，Nest 构建在强大的 HTTP 服务器框架上，例如 [Express][] （默认），并且还可以通过配置从而使用 [Fastify][] ！

Nest 在这些常见的 Node.js 框架 (Express/Fastify) 之上提高了一个抽象级别，但仍然向开发者直接暴露了底层框架的 API。这使得开发者可以自由地使用适用于底层平台的无数的第三方模块。

**2.2、NestJS哲学**

近年来，由于 Node.js、JavaScript 已经成为 web 前端和后端应用程序的“通用开发语言”。这促成了诸如 [Angular][]、[React][] 和 [Vue][] 等优秀项目的出现，他们提高了开发者的工作效率，并能够创建快速、可测试和可扩展的前端应用程序。然而，尽管 Node （和服务器端 JavaScript）拥有大量优秀的软件库、辅助程序和工具，但没有一个能够有效地解决我们所面对的主要问题，即 **架构**。这样也是本人很长时间以来期望的。

Nest 提供了一个开箱即用的应用程序体系结构，允许开发者及其团队创建高度可测试、可扩展、松散耦合且易于维护的应用程序。这种架构深受 Angular 的启发。

**2.3、NestJS能力**

1、后端开发。

2、其他。

[node.js可以做什么 • Worktile社区][node.js_ _ Worktile]

**2.4、NestJS对比Egg.js：**

[eggjs 停止更新 - OSCHINA - 中文开源技术交流社区][eggjs _ - OSCHINA -]

[NestJS和Egg.js的区别以及对比][NestJS_Egg.js]  
[egg.js和nest.js的对比\_程序员 小明的博客-CSDN博客\_nestjs和eggjs哪个好][egg.js_nest.js_ _-CSDN_nestjs_eggjs]

**三、安装、启动NestJS项目**

[NestJS 简介 | NestJS 中文文档 | NestJS 中文网][NestJS _ _ NestJS _ _ NestJS]

3.1、创建一个新的项目目录，并使用核心的 Nest 文件和支撑模块填充该目录，从而**为项目创建一个传统的基本结构**。建议初学者使用 **Nest CLI** 创建新项目。

npm i -g @nestjs/cli
    cnpm i -g @nestjs/cli // 如速度慢可使用cnpm
    nest new project-name

![824ef615be744ccaa1a197b3aab39d20.png][]![49371ca7d14b4f4e882a34e962fead45.png][]

![7482604a2123426cb82d60e963587335.png][]

3.2、启动项目

> pnpm run start

启动成功

![51273c405f374ebea7ee01dd6840e9c4.png][]

3.3、从src/main.ts文件，我们看到项目监听的是3000端口

我们访问本地项目 [http://localhost:3000/][http_localhost_3000]

访问成功

![5c78b7ca984e48dcb7f5b45a1fe6b4c6.png][]

**四、NestJS项目目录介绍**

引用自[技术胖-NestJS 快速入门教程][-NestJS]

+-- dist[目录]                      // 编译后的目录，用于预览项目
    +-- node_modules[目录]              // 项目使用的包目录，开发使用和上线使用的都在里边
    +-- src[目录]                       // 源文件/代码，程序员主要编写的目录
    |  +-- app.controller.spec.ts      // 对于基本控制器的单元测试样例
    |  +-- app.controller.ts           // 控制器文件，可以简单理解为路由文件
    |  +-- app.module.ts               // 模块文件，在NestJS世界里主要操作的就是模块
    |  +-- app.service.ts              // 服务文件，提供的服务文件，业务逻辑编写在这里
    |  +-- app.main.ts                 // 项目的入口文件，里边包括项目的主模块和监听端口号
    +-- test[目录]                      // 测试文件目录，对项目测试时使用的目录，比如单元测试...
    |  +-- app.e2e-spec.ts             // e2e测试，端对端测试文件，测试流程和功能使用
    |  +-- jest-e2e.json               // jest测试文件，jset是一款简介的JavaScript测试框架
    +-- .eslintrc.js                   // ESlint的配置文件
    +-- .gitignore                     // git的配置文件，用于控制哪些文件不受Git管理
    +-- .prettierrc                    // prettier配置文件，用于美化/格式化代码的
    +-- nest-cli.json                  // 整个项目的配置文件，这个需要根据项目进行不同的配置
    +-- package-lock.json              // 防止由于包不同，导致项目无法启动的配置文件，固定包版本
    +-- package.json                   // 项目依赖包管理文件和Script文件，比如如何启动项目的命令
    +-- README.md                      // 对项目的描述文件，markdown语法
    +-- tsconfig.build.json            // TypeScript语法构建时的配置文件
    +-- tsconfig.json                  // TypeScript的配置文件，控制TypeScript编译器的一些行为

**五、Controller控制器-路由的创建**

**5.1、创建请求地址**

创建 http://localhost:3000/name 的请求地址（接口地址）

src/service.ts

// 服务文件，提供的服务文件，业务逻辑编写在这里
    import { Injectable } from '@nestjs/common';
    
    @Injectable()
    export class AppService {
      getHello(): string {
        return 'Hello World Snow!';
      }
      getName(): string {
        return 'SNOW!';
      }
    }

src/controller.ts

// 控制器--编写路由
    import { Controller, Get } from '@nestjs/common';
    import { AppService } from './app.service';
    
    @Controller('api') // 添加顶层路径 api
    export class AppController {
      constructor(private readonly appService: AppService) {}
      @Get()
      getHello(): string {
        return this.appService.getHello();
      }
      @Get('name')
      getName(): string {
        return this.appService.getName();
      }
    }

访问成功。

![5d9a8dca5a8044a188b6bc4090a7abdc.png][]

**5.2、添加顶层路径 api**

![f0981981584e49debf4690e60107fdfc.png][]

访问成功 api/name

![1b2cddfc6e0244f7bb6f39a5d2935bb5.png][]

**5.3、src下创建product模块**

5.3.1、删除以下文件

![46871672bd9b4bf7a4f5fe5955598905.png][]

5.3.2、app.module.ts删除对应的使用

![7c3c8f90b31446e1a83e98bd3dfbd8ef.png][]

5.3.3、新建module

> **nest g module products**

5.3.4、创建controller

> **nest g controller products --no-spec**

src/products/products.controller.ts

import { Controller, Get } from '@nestjs/common';
    
    @Controller('products')
    export class ProductsController {
        @Get()
        getProductsList(): any{
            return {
                code: 0,
                data: ['huawei', 'changcheng', 'biyadi'],
                msg: '请求产品列表成功'
            }
        }
    }

**5.4、src/main.ts 设置默认前缀 api/**

> app.setGlobalPrefix('api/')

![bb29252e05d34da0a1c35b98391e5d45.png][]

![d347978d8e5d415ba6b75cb4a356ad59.png][]

**六、Controller控制器-使用products.service.ts写业务逻辑**

6.1、把业务逻辑放在products`.service.ts`这个文件中。nestjs规范。

> **nest g service products --no-spec**

![68127beaa51f4cac8f9fb6545fc6afc4.png][]

6.2、src/products/products.controller.ts 引入 service

import { ProductsService } from './products.service';

import { Controller, Get } from '@nestjs/common';
    import { ProductsService } from './products.service';
    
    @Controller('products')
    export class ProductsController {
        // this.productsService = new ProductsService() 等价于 constructor 方式
        constructor(private productsService: ProductsService){}
        @Get()
        getProductsList(): any{
            return this.productsService.getProductsList()
        }
    }

6.3、src/products/products.service.ts

import { Injectable } from '@nestjs/common';
    
    @Injectable()
    export class ProductsService {
        getProductsList(){
            return {
                code: 0,
                data: ['huawei', 'changcheng', 'biyadi'],
                msg: '请求产品列表成功'
            }
        }
    }

![3a909e3187f14a6882c2e4d157126381.png][]

**七、Controller控制器 Get 请求**

**7.1、get请求 -- 带参数**

src/products/products.controller.ts

@Get('/getProductsById')
    // @Request()装饰器
    // getProductsById(@Request() req):any{
    //     let id:number = parseInt(req.query.id)
    //     return this.productsService.getProductsById(id)
    // }
    // @Query()装饰器
    getProductsById(@Query() query):any{
       let id:number = parseInt(query.id)
       return this.productsService.getProductsById(id)
    }

src/products/products.service.ts

getProductsById(id:number){
            let resJson:any = {}
            switch (id) {
                case 1:
                    resJson = {id:1, name: 'huawei', type: 'shouji'}
                break;
                case 2:
                    resJson = {id:2, name: 'changcheng', type: 'qiche'}
                break;
                case 3:
                    resJson = {id:3, name: 'biyadi', type: 'qiche'}
                break;
            }
            return resJson;
        }

RESTClient/demo.http

![b4471f9a08504e2885b4d73df734b2f5.png][]

**7.2、Get请求-@Request()装饰器-动态参数id**

src/products/products.controller.ts

// Get请求-@Request()装饰器-动态参数id
        @Get('/getProductsByIdRouter/:id')
        getProductsByIdRouter(@Request() req):any{
            console.log()
            let id:number = parseInt(req.params.id)
            return this.productsService.getProductsByIdRouter(id)
        }

src/products/products.service.ts

getProductsByIdRouter(id:number){
            let resJson:any = {}
            switch (id) {
                case 1:
                    resJson = {id:1, name: 'huawei', type: 'shouji'}
                break;
                case 2:
                    resJson = {id:2, name: 'changcheng', type: 'qiche'}
                break;
                case 3:
                    resJson = {id:3, name: 'biyadi', type: 'qiche'}
                break;
            }
            return resJson;
        }

RESTClient/demo.http

http://localhost:3000/api/products/getProductsByIdRouter/1 HTTP/1.1

![6253cc0268604f469a0cfd0bdb81ff7d.png][]

**7.3、Get请求-@Param()装饰器-动态参数id，name**

src/products/products.controller.ts

// Get请求-@Param()装饰器-动态参数id，name
        @Get('/getProductsByIdRouter/:id/:name')
        getProductsByIdRouter2(@Param() Params):any{
            console.log()
            let id:number = parseInt(Params.id)
            let name:string = Params.name
            return this.productsService.getProductsByIdRouter2(id, name)
        }

src/products/products.service.ts

getProductsByIdRouter2(id:number, name:string = "huawei"){
            let resJson:any = {}
            switch (id) {
                case 1:
                    resJson = {id:1, name: name, type: 'shouji'}
                break;
                case 2:
                    resJson = {id:2, name: name, type: 'qiche'}
                break;
                case 3:
                    resJson = {id:3, name: name, type: 'qiche'}
                break;
            }
            return resJson;
        }

RESTClient/demo.http

http://localhost:3000/api/products/getProductsByIdRouter/1/huawei-mate-60 HTTP/1.1

![bb1ed5a5bc5241cbb0b46a6859289ff5.png][]

**八、Controller控制器 Post 请求**

**8.1、post请求**

src/products/products.controller.ts

@Post('/addProducts')
    addProducts(): any{
        return this.productsService.addProducts()
    }

src/products/products.service.ts

addProducts(){
            return {
                code: 200,
                data: ['huawei', 'changcheng', 'biyadi'],
                msg: '增加产品成功'
            }
        }

![60804082594c4d4e9c0a2049f5640315.png][]

**8.2、post请求 -- 带参数**

src/products/products.controller.ts

// @Query()装饰器
        getProductsById(@Query() query):any{
            let id:number = parseInt(query.id)
            return this.productsService.getProductsById(id)
        }

src/products/products.service.ts

addProducts2(id: any){
            console.log(id)
            let resJson:any = {
                code: 200,
                data: ['huawei', 'changcheng', 'biyadi'],
                msg: '增加产品成功'
            }
            switch (id) {
                case 1:
                    resJson.data = ['huawei']
                break;
                case 2:
                    resJson.data = ['changcheng']
                break;
                case 3:
                    resJson.data = ['biyadi']
                break;
            }
            return resJson
        }

RESTClient/demo.http

POST http://localhost:3000/api/products/addProducts2
    Content-Type: application/json
    
    {
        "id": 1
    }

![0852addedc9043db800a4e7c2b170780.png][]

**九、TypeORM 连接mysql数据库，增删改查**

[NestJS：TypeORM 连接mysql数据库，增删改查\_snow@li的博客-CSDN博客][NestJS_TypeORM _mysql_snow_li_-CSDN]

**十、其他内容待更新**

**过程记录：**

**记录一、nestjs热更新**

nestjs自带nodemon可以热更新，启动方式npm run start:dev(package.json里)

记录二、使用VsCode插件 REST Client

![d0a4152a710e499c97e9e6d3d397f329.png][]

项目根目录创建RESTClient目录，demo.http文件

![f30ea7070c0640d18263dc52833b84f2.png][]

POST 接口地址 HTTP/1.1 点击Send Request 请求结果如右图

![60804082594c4d4e9c0a2049f5640315.png][]

记录三、

![ff27bb42cbe244f9961b47c4417a5f43.png][]

*Content-Type 和 json字符串中间必须有一个空行 url和conten-type之间不能有空行*

*增加空行后即可*

![3c56879876604b5180687aefc30ecc31.png][]

**相关内容：**

express、koa、egg、Fastify

**参考链接：**

[Nest.js笔记(持续更新...) - 码农教程][Nest.js_..._ -]

[01.NestJS简介和优势介绍 | NestJS快速入门教程\_哔哩哔哩\_bilibili][01.NestJS_ _ NestJS_bilibili]

[技术胖-NestJS 快速入门教程][-NestJS]

[js后端框架nestjs的简单使用\_獨孤殤的博客-CSDN博客\_nestjs][js_nestjs_-CSDN_nestjs]

[NestJS 及其对后端开发人员的优势 - 知乎][NestJS _ -]

[NestJS _ _ NestJS _ _ NestJS]: https://www.nestjs.com.cn/
[NestJS - A progressive Node.js framework]: https://nestjs.com/
[Node.js]: https://nodejs.org/
[TypeScript]: http://www.typescriptlang.org/
[Express]: https://expressjs.com/
[Fastify]: https://github.com/fastify/fastify
[Angular]: https://angular.io/
[React]: https://github.com/facebook/react
[Vue]: https://github.com/vuejs/vue
[node.js_ _ Worktile]: https://worktile.com/kb/ask/18305.html
[eggjs _ - OSCHINA -]: https://www.oschina.net/informat/eggjs+%E5%81%9C%E6%AD%A2%E6%9B%B4%E6%96%B0?page=399&size=20&type=DEFAULT_ALL
[NestJS_Egg.js]: http://bbs.itying.com/topic/5d8ffe789e631c1318091be4
[egg.js_nest.js_ _-CSDN_nestjs_eggjs]: https://blog.csdn.net/weixin_42304193/article/details/104869170
[824ef615be744ccaa1a197b3aab39d20.png]: https://img-blog.csdnimg.cn/824ef615be744ccaa1a197b3aab39d20.png
[49371ca7d14b4f4e882a34e962fead45.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/bf560d27893a45d1b7cc7a03de44efcc.png
[7482604a2123426cb82d60e963587335.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/77303c7e5f1e47348e7b0e6deac0dee8.png
[51273c405f374ebea7ee01dd6840e9c4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/cf3b9a88963841ddbea8dc886bc45697.png
[http_localhost_3000]: http://localhost:3000/
[5c78b7ca984e48dcb7f5b45a1fe6b4c6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/a7c6e7c3d4e04c2f9ea1e57e1714b318.png
[-NestJS]: https://jspang.com/article/87
[5d9a8dca5a8044a188b6bc4090a7abdc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/3dc60e07ef8d4789951cef3ae6ce04d3.png
[f0981981584e49debf4690e60107fdfc.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/4542efaf7f754f6c9f2d72251456af88.png
[1b2cddfc6e0244f7bb6f39a5d2935bb5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/247246a3939e4a7e90460ec0ab854137.png
[46871672bd9b4bf7a4f5fe5955598905.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/d79b33d4246f4631813f116a913d0494.png
[7c3c8f90b31446e1a83e98bd3dfbd8ef.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/0c2ae21e1b8645ef96edcec1c94140ea.png
[bb29252e05d34da0a1c35b98391e5d45.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/3f7ed2b24e9a4256ac769f2c5bdfa4b0.png
[d347978d8e5d415ba6b75cb4a356ad59.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/647fceb10f914495a68d5753f95ab1c9.png
[68127beaa51f4cac8f9fb6545fc6afc4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/4613ea33682f402aa90a842cabeb3b99.png
[3a909e3187f14a6882c2e4d157126381.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/695881e18f0849979e3f6cc3342e58e7.png
[b4471f9a08504e2885b4d73df734b2f5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/94f78bac018b449c890586bdd9304b80.png
[6253cc0268604f469a0cfd0bdb81ff7d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/fc60f891aa8d46cebf3bbf0b76b77076.png
[bb1ed5a5bc5241cbb0b46a6859289ff5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/bbb1a017886149efaec6fd62e7350bd9.png
[60804082594c4d4e9c0a2049f5640315.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/1300435ca07a4fff95e253b4cd0f7a21.png
[0852addedc9043db800a4e7c2b170780.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/b6fecf9c3f8243aebbc3d52e687b0934.png
[NestJS_TypeORM _mysql_snow_li_-CSDN]: https://blog.csdn.net/snowball_li/article/details/130186984
[d0a4152a710e499c97e9e6d3d397f329.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/6b61b9226de348378642161848439574.png
[f30ea7070c0640d18263dc52833b84f2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/e74cfd7e9370498984af368b28feb47a.png
[ff27bb42cbe244f9961b47c4417a5f43.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/b1ecb17dae6f4418abd839763f084c48.png
[3c56879876604b5180687aefc30ecc31.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/ae3bb7960d8a49c38696d28994486845.png
[Nest.js_..._ -]: http://www.manongjc.com/detail/54-gsjfdhtgiapyudc.html
[01.NestJS_ _ NestJS_bilibili]: https://www.bilibili.com/video/BV1QP411M7d7/?spm_id_from=333.999.0.0&vd_source=704e2597123fc066b03283e82eb866c0
[js_nestjs_-CSDN_nestjs]: https://blog.csdn.net/qq_40015826/article/details/112277058
[NestJS _ -]: https://zhuanlan.zhihu.com/p/480181580