初识Nest JS

Nest 是一个渐进的 Node.js 框架，它可以在 TypeScript 和 JavaScript (ES6、ES7、ES8)之上构建高效、可伸缩的企业级服务器端应用程序.

Nest 基于 TypeScript 编写并且结合了 OOP（面向对象编程），FP（函数式编程）和 FRP （函数式响应编程）的相关理念。在设计上的很多灵感来自于 Angular，Angular 的很多模式又来自于 Java 中的 Spring 框架，依赖注入、面向切面编程等，所以我们也可以认为： Nest 是 Node.js 版的 Spring 框架 。

Nest 框架底层 HTTP 平台默认是基于 Express 实现的，所以无需担心第三方库的缺失.

NestJs 的核心思想：就是提供了一个层与层直接的耦合度极小,抽象化极高的一个架构体系.

脚手架 NestJS CLI

与其它框架一样，NestJS也有自己的脚手架，它可帮助我们快速初始化Nest项目以及开发和维护 Nest 应用程序.

安装

绝大多数人可能会选择全局安装，因为方便，但需要注意的是，全局安装 任何 npm 软件包都会将确保它们运行正确版本的责任留给我们开发者自身。这还意味着，如果你有不同的项目，每个项目都将运行 相同 版本的 CLI.

                        
                          npm install -g @nestjs/cli

                        
                      

⚠️这里需要注意Node版本，可能会遇到脚手架安装成功了但初始化项目时报错，这里建议使用高版本node，我这里用是node版本是 16.19.0 。

当然你也可以不选择全局安装， Nest 提供了 @nestjs/cli 包同样可以使用 nest 命令 。

                        
                          npx @nestjs/cli@latest

                        
                      

nest命令

安装完脚手架之后我们可以通过 nest --help 看看它都有哪些命令:

new|n

该命令是用来初始化一个 Nest 项目的 。

                        
                          nest new project-name

                        
                      

该命令表示初始化一个名为 project-name 的 Nest 项目，并且会帮你安装好所有必要的依赖，简直就是一步到位，非常棒~ 。

上图中我们可以看到 nest|n ， n 代表 nest 的别名，所以为了方便，你也可以这样使用:

                        
                          nest n project-name

                        
                      

generate|g

该命令可以为我们生成各种代码，其中包括：控制器Controller、服务service、模块module等.

                        
                          # 生成控制器
nest generate controller controller-name

# 生成服务
nest generate service service-name

# 生成模块
nest generate module module-name

                        
                      

当你觉得一个一个生成很麻烦时，可以使用下面这个命令 。

                        
                          nest g resource filename

                        
                      

当你执行这个命令时，它会让你选择生成那种类型的代码:

这里我们直接选择 REST API ，它会再问你是否需要生成CURD代码 。

我们选择是就好了，这个它就为我们生成了一个完整的CURD代码.

我们会发现生成的文件中可能会有一些测试文件，当我们不需要这些文件时，可以直接删除掉，或者在生成时加上 --no-spec 表示不生成测试文件 。

                        
                          nest g resource filename --no-spec

                        
                      

当然它还可以生成更多类型的代码，可以通过以下命令查看:

                        
                          nest g --help

                        
                      

start

该命令用于启动开发服务，支持 watch 和调试 。

                        
                          # 启动
nest start

# 启动并监听文件变动
nest start --watch

#启动并调试
nest start --debug --watch

                        
                      

这些命令可以在 package.json 文件中找到 。

所以我们本地开发一般使用 npm run start:dev 启动项目 。

build

该命令用于项目打包 。

                        
                          nest build

                        
                      

它有两种编译方式可选： --wepback 和 --tsc ，默认是 tsc 编译，也可以切换成 webpack.

区别在于 tsc 模式并不会将 node_modules 模块打包进去，而 webpack 模式则会将node模块打包成单文件 。

脚手架配置文件

Nest 脚手架与其它脚手架不同的是，它生成的项目下会有一个脚手架配置文件 nest-cli.json ，上面我们用的命令的很多选项都可以在这个文件中直接配置.

该文件的顶级属性如下:

• "collection" ：指向用于生成组件的原理图集合；（最好不要改）
• "sourceRoot" ：指向标准模式结构中单个项目的源代码根目录，或monorepo 模式结构中的 默认项目
• "compilerOptions" ：编译相关的配置选项
• "generateOptions" ：全局生成相关的配置选项
• "monorepo" ：（仅限 monorepo）对于 monorepo 模式结构，该值始终为 true
• "root" ：（仅限 monorepo）指向 默认项目的项目根目录

全局编译选项

这些属性指定要使用的编译器以及影响 任何 编译步骤的各种选项，无论是作为 nest build 或的一部分 nest start ，也不考虑编译器，无论 tsc 是还是 webpack.

名称	描述
webpack	如果是 true ，使用webpack编译。如果 false 存在或不存在，请使用 tsc . 在 monorepo 模式下，默认为 true (use webpack)，在标准模式下，默认为 false (use tsc )。
tsConfigPath	( 仅 monorepo ) 指向包含在不带选项的情况下调用或调用 tsconfig.json 时将使用的设置的文件（例如，当构建或启动默认项目时）。 nest build``nest start``project
webpackConfigPath	指向 webpack 选项文件。如果未指定，Nest 会查找文件 webpack.config.js . 请参阅下面的更多细节。
deleteOutDir	如果 true ，则每当调用编译器时，它都会首先删除编译输出目录（如 中配置 tsconfig.json ，默认为 ./dist ）。
assets	每当编译步骤开始时，启用自动分发非 TypeScript 资源（在增量编译模式下不会发生 资源 --watch 分发）。详情请参阅下文。
watchAssets	如果 true ，则以监视模式运行，监视 所有 非 TypeScript 资源。
manualRestart	如果，则启用手动重新启动服务器的 true 快捷方式。 rs 默认值为 false 。
builder	指示 CLI 使用什么 builder 来编译项目（ tsc 、 swc 或 webpack ）。要自定义构建器的行为，您可以传递包含两个属性的对象： type ( tsc 、 swc 或 webpack ) 和 options 。
typeCheck	如果 true ，则启用 SWC 驱动项目的类型检查（当 builder 为时 swc ）。默认值为 false 。

全局生成选项

这些属性指定命令使用的默认生成选项 nest generate .

名称	描述
spec	如果值为布尔值，则默认情况下 true 启用 spec 生成，值为 则 false 禁用生成。CLI 命令行上传递的标志会覆盖此设置，项目特定的 generateOptions 设置也会覆盖此设置（更多内容见下文）。如果该值是一个对象，则每个键代表一个原理图名称，并且布尔值确定是否为该特定原理图启用/禁用默认规范生成。
flat	如果为 true，则所有生成命令都将生成平面结构

本系列文章会持续更新哦，关注前端南玖，敬请期待吧~ 。

最后此篇关于【NestJS系列】从NestCLI开始入门的文章就讲到这里了,如果你想了解更多关于【NestJS系列】从NestCLI开始入门的内容请搜索CFSDN的文章或继续浏览相关文章，希望大家以后支持我的博客！ 。