NestJs框架快速入门(V6.5)

最新推荐文章于 2024-09-16 17:48:31 发布
最新推荐文章于 2024-09-16 17:48:31 发布
阅读量4k 收藏 9
点赞数 1
分类专栏： Nodejs 文章标签： Nestjs
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/cnwyt/article/details/91878111
版权

Nest是构建高效可扩展的 Node.js Web 应用程序的框架。
默认使用JavaScript的超集TypeScript进行开发。

环境准备

查看node和npm版本:

$ node --version
v10.16.0

$ npm --version
6.9.0

安装@nestjs/cli

使用 npm 全局安装 @nestjs/cli:

$ npm i -g @nestjs/cli
/usr/local/bin/nest -> /usr/local/lib/node_modules/@nestjs/cli/bin/nest.js
+ @nestjs/cli@6.5.0
removed 3 packages and updated 13 packages in 6.982s

使用 nest --version 命令查看 nest 当前版本:

$ nest --version
6.5.0

使用 nest new 命令创建一个名为 nest-app 的项目:

$ nest new nest-app    
⚡  We will scaffold your app in a few seconds..

CREATE /nest-app/.prettierrc (51 bytes)
CREATE /nest-app/README.md (3370 bytes)
CREATE /nest-app/nest-cli.json (84 bytes)
CREATE /nest-app/nodemon-debug.json (163 bytes)
CREATE /nest-app/nodemon.json (67 bytes)
CREATE /nest-app/package.json (1804 bytes)
CREATE /nest-app/tsconfig.build.json (97 bytes)
CREATE /nest-app/tsconfig.json (325 bytes)
CREATE /nest-app/tslint.json (426 bytes)
CREATE /nest-app/src/app.controller.spec.ts (617 bytes)
CREATE /nest-app/src/app.controller.ts (274 bytes)
CREATE /nest-app/src/app.module.ts (249 bytes)
CREATE /nest-app/src/app.service.ts (142 bytes)
CREATE /nest-app/src/main.ts (208 bytes)
CREATE /nest-app/test/app.e2e-spec.ts (561 bytes)
CREATE /nest-app/test/jest-e2e.json (183 bytes)

? Which package manager would you ❤️  to use? npm
▹▹▹▸▹ Installation in progress... ☕
?  Successfully created project nest-app
?  Get started with the following commands:

$ cd nest-app
$ npm run start

    Thanks for installing Nest ?
Please consider donating to our open collective
    to help us maintain this package.
                         
?  Donate: https://opencollective.com/nest

启动项目

进入项目，并启动项目

$ cd nest-app 
$ npm run start
> nest-app@0.0.1 start /Users/wangtom/development/node/nest-app
> ts-node -r tsconfig-paths/register src/main.ts
[Nest]3226-2019-06-13 [NestFactory] Starting Nest application...
[Nest]3226-2019-06-13 [InstanceLoader] AppModule dependencies initialized +87ms
[Nest]3226-2019-06-13 [RoutesResolver] AppController {/}: +41ms
[Nest]3226-2019-06-13 [RouterExplorer] Mapped {/, GET} route +16ms
[Nest]3226-2019-06-13 [NestApplication] Nest application successfully started +43ms

打开浏览器，访问 http://localhost:3000/ 就可以看到Hello World!页面输出了。

或者在终端使用 curl 请求:

$ curl -i localhost:3000
HTTP/1.1 200 OK
X-Powered-By: Express
Content-Type: text/html; charset=utf-8
Content-Length: 12
ETag: W/"c-Lve95gjOVATpfV8EL5X4nxwjKHE"
Date: Thu, 13 Jun 2019 08:16:42 GMT
Connection: keep-alive

Hello World!%

可以看到， 输出了 Hello World! 字符串。
使用 -i 参数，表示要输出 header 头信息。
在 header 头信息中，我们可以看到，X-Powered-By 值为 Express， 就是告诉我们这个网站或框架底层是 Expres 框架。

项目结构

查看一下项目结构:

$ ll nest-app 
total 640
-rw-r--r--    1 wangtom  staff   3.3K  6 13 16:13 README.md
-rw-r--r--    1 wangtom  staff    84B  6 13 16:13 nest-cli.json
drwxr-xr-x  585 wangtom  staff    18K  6 13 16:14 node_modules
-rw-r--r--    1 wangtom  staff   163B  6 13 16:13 nodemon-debug.json
-rw-r--r--    1 wangtom  staff    67B  6 13 16:13 nodemon.json
-rw-r--r--    1 wangtom  staff   287K  6 13 16:14 package-lock.json
-rw-r--r--    1 wangtom  staff   1.8K  6 13 16:14 package.json
drwxr-xr-x    7 wangtom  staff   224B  6 13 16:13 src
drwxr-xr-x    4 wangtom  staff   128B  6 13 16:13 test
-rw-r--r--    1 wangtom  staff    97B  6 13 16:13 tsconfig.build.json
-rw-r--r--    1 wangtom  staff   325B  6 13 16:13 tsconfig.json
-rw-r--r--    1 wangtom  staff   426B  6 13 16:13 tslint.json

可以使用 tree 命令查看nest-app的目录结构:

比如使用 tree ./nest-app -L 1, 查看1级目录结构。

./nest-app
├── README.md
├── nest-cli.json
├── node_modules/
├── nodemon-debug.json
├── nodemon.json
├── package-lock.json
├── package.json
├── src  # 源码目录
│   ├── app.controller.spec.ts
│   ├── app.controller.ts # 控制器类
│   ├── app.module.ts  # 模块
│   ├── app.service.ts # 服务类
│   └── main.ts   # 入口文件
├── test   # 测试目录
│   ├── app.e2e-spec.ts
│   └── jest-e2e.json
├── tsconfig.build.json
├── tsconfig.json
└── tslint.json

可以看到，和 Angular 的项目结构很相似。

src/main.ts 是项目的入口文件, 定义了一个异步方法(bootstrap)来启动应用，默认监听端口 3000:

// main.ts
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(3000);
}
bootstrap();

控制器: app.controller.ts

// app.controller.ts
import { Controller, Get } from '@nestjs/common';
import { AppService } from './app.service';

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

  @Get()
  getHello(): string {
    return this.appService.getHello();
  }
}

控制器中定义了一个名为 getHello() 的方法，使用 @Get 注解，表示可以通过 Get 方法访问。
控制器构造方法中引入了私有只读的服务类 AppService， 在 getHello() 方法中调动了服务类(AppService)中的 getHello() 方法。

服务类: app.service.ts

// app.service.ts
import { Injectable } from '@nestjs/common';

@Injectable()
export class AppService {
  getHello(): string {
    return 'Hello World!';
  }
}

在服务类AppService中，定义了getHello()方法，只返回了字符串 Hello World!。

小试牛刀

熟悉了项目目录结构与基本运行代码后，我们来增加一些自己的方法，感受一个这个框架。

自定义一个返回当前版本的接口，获取当前应用的版本:

// app.controller.ts
// 导入 Post
import { Controller, Get } from '@nestjs/common';
import { AppService } from './app.service';

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

  @Get()
  getHello(): string {
    return this.appService.getHello();
  }
  // 自定义 getVersion 方法: 
  @Get('/version')
  getVersion(): Object {
    return this.appService.getVersion();
  }
  // 自定义 postIndex 方法: 
  @Post('/api')
  postIndex(): Object {
    return this.appService.getVersion();
  }
}

在控制器文件 src/app.controller.ts 中:
新增了一个使用@Get注解的getVersion()方法，可以通过Get访问，路由为“/version”。
新增了一个使用@Post注解的postIndex()方法，可以通过Post访问, 路由为“/api”。

修改服务类文件 app.service.ts:

新增一个名为getVersion()的方法，返回 Object 格式的json数据。

// app.service.ts
import { Injectable } from '@nestjs/common';

@Injectable()
export class AppService {
  getHello(): string {
    return 'Hello World!';
  }
  // 自定义：获取版本
  getVersion(): Object {
    return {
      code: 200, 
      msg: "OK",
      data: {
        version:"0.0.1"
      }, 
    }
  }
}

使用 Control+C 结束终端运行，这次我们使用 npm run start:dev 启动(项目文件有修改会自动重启服务):

$ npm run start:dev  

5:17:42 PM - Starting compilation in watch mode...
[1] 
[1] 
[1] 5:17:44 PM - Found 0 errors. Watching for file changes.
[0][nodemon] 1.19.1
[0][nodemon] to restart at any time, enter `rs`
[0][nodemon] watching: /Users/wangtom/development/node/nest-app/dist/**/*
[0][nodemon] starting `node dist/main`
[0][Nest]3845-2019-06-13[NestFactory] Starting Nest application...
[0][Nest]3845-2019-06-13[InstanceLoader] AppModule dependencies initialized +20ms
[0][Nest]3845-2019-06-13[RoutesResolver] AppController {/}: +6ms
[0][Nest]3845-2019-06-13[RouterExplorer] Mapped {/, GET} route +8ms
[0][Nest]3845-2019-06-13[RouterExplorer] Mapped {/version, GET} route +2ms
[0][Nest]3845-2019-06-13[RouterExplorer] Mapped {/api, POST} route +2ms
[0][Nest]3845-2019-06-13[NestApplication] Nest application successfully started +4ms
 ...

现在我们使用 curl 命令分别来请求这几个路由地址:

请求 “localhost:3000/version”:

$ curl localhost:3000            
Hello World!% 
# 默认GET请求'/version': 存在，返回预期的结果
$ curl localhost:3000/version
{"code":200,"msg":"OK","data":{"version":"0.0.1"}}%                                                   

# 改成POST请求'/version': 不存在，框架自带的错误提示
$ curl -X POST localhost:3000/version    
{"statusCode":404,"error":"Not Found","message":"Cannot POST /version"}%

请求 “localhost:3000/api”:

# 使用POST请求'/api': 存在，返回预期的结果
$ curl -X POST localhost:3000/api
{"code":200,"msg":"OK","data":{"version":"0.0.1"}}% 

# 改成GET请求'/api': 不存在，框架自带的错误提示
$ curl localhost:3000/api 
{"statusCode":404,"error":"Not Found","message":"Cannot GET /api"}%

References

https://docs.nestjs.com/first-steps

Change log

2018.12.18 add this page, nestjs version 5.7.
2019.06.13 update nestjs 6.5.

感谢阅读，如有问题请留言。

[END]

Web后端技术
关注
专栏目录
Nestjs-Learning：nestjs学习教程，跟我一起学习nest框架〜
02-03
Nest.js教程 如果喜欢本教程请点击右上角的star :glowing_star: ，想订阅本教程请点击右上角手表 :eyes: 如有不解之惑，或者想要更多的详细教程，可以在中写下你的问题或需求。 框架介绍 Nest是一种高效，可扩展的Node.js Web应用程序框架。它使用现代JavaScript或TypeScript（保留与纯JavaScript的兼容性），并结合OOP（面向对象编程），FP（函数式编程）和FRP（函数响应式编程）的元素。 在宽敞，Nest使用了 ，但也提供了与其他各种库的兼容，例如 ，可以方便地使用各种可用的第三方插件。 主要特性 使用Typescript，强类型语言，类型假设机制，编译期类型检查等，为逐步开发和维护提供了很好的支持 初步开发，让应用程序更容易细分，提供提供易于使用的预设管理机制 内置IOC容器，大量使用依赖注入，开发更便捷，更高效 轻松编写AOP代码，面向切面编程，轻松实现日志，拦截器，过滤器等功能 支持TypeORM，最好的Typescript ORM框架，轻松编写DAO层的类别逻辑 轻松构建MVC，API，websocket，微服务等
写给前端的 Nest.js 教程——10分钟上手后端接口开发
热门推荐
程序员成长指北
10-23 1万+
前言这个教程的所有代码我都放在了我的 GitHub 仓库：Nest-CRUD-Demo[1]，欢迎大家点个 Star！框架简介❝Nest 是一个用于构建高效，可扩展的 Node.js 服...
Nest.js
最新发布
YUELEI118的博客
09-16 1047
nestjs，学习小满的视频，参考官方文档
NestJs简明教程
MELF晓宇的博客
08-13 2071
配置环境 1.下载并安装nodejs 2.下载并安装vscode 3.为vscode安装中文插件 ​ 在扩展应用栏搜索并安装 Chinese (Simplified) Language 4.检查nodejs和npm是否安装成功 node -v npm -v 5.cnpm安装 npm install cnpm -g --registry=https://registry.npm.taobao.org 检测cnpm安装是否成功 cnpm -v 创建Nestjs项目 安装nest cli cnpm i
NestJs
hulitong
02-08 2050
nestjs学习记录
Nest.js 入门教程
偷得浮生半日闲
09-24 845
Nest.js 入门教程
Nestjs框架快速入门之项目搭建与小试牛刀
我的开发博客(公众号:Web后端技术)
12-09 1546
Nest (NestJS)是一个用于构建高效、可伸缩的 Node.js 服务器端框架。 NestJS 默认使用 JavaScript 的超集 TypeScript 进行开发。 环境准备 查看node和npm版本: $ node --version v15.2.1 $ npm --version 7.0.14 安装 @nestjs/cli 使用 npm 全局安装 @nestjs/cli: $ npm i -g @nestjs/cli /usr/local/bin/nest -&g
Araxis Merge v6.5/Araxis Merge 2017比对工具
03-27
里面给大家内嵌了Araxis Merge v6.5和Araxis Merge 2017两个版本，并配备了使用说明。 Araxis Merge v6.5：免安装版本，解压直接运行merge.exe即可正常使用（目前好像不支持Win10系统了，但是我同事的win10可以用，...
HOLLiAS_MACS_V6.5_用户手册4_算法组态
01-19
"HOLLiAS_MACS_V6.5 算法组态用户手冊" 本手冊是HOLLiAS_MACS_V6.5 算法组態的使用手冊，...本手冊对HOLLiAS_MACS_V6.5 算法组態的使用、维护和应用提供了详细的指导和参考，旨在帮助用户快速上手和高效使用该软件。
台达伺服上位机软件 DELTA-IA-ASDA-ASDA-Soft-V6.5.0.0
10-18
台达伺服上位机软件DELTA-IA-ASDA-ASDA-Soft-V6.5.0.0是一款专门用于控制台达伺服电机的高级应用软件。该软件提供了丰富的功能，帮助用户对台达伺服系统进行高效、精确的调试、监控和管理。以下是关于这个软件及其...
HOLLiAS MACS_V6.5_用户手册3_工程组态
01-19
本手册面向 DCS 系统的操作和维护人员，旨在帮助用户快速熟悉 HOLLiAS MACS_V6.5 系统的操作和维护。手册中提供了详细的操作步骤和图表，帮助用户快速掌握系统的使用。 3. DCS 系统的组态设置 DCS 系统的组态设置...
基于Express的nodejs的快速、开放、极简的 Web 开发框架
11-30
该开发框架是在Express的基础上进行改造，可以进行web网站的开发，也可以只做node服务器开发，可以使用pm2进行进程管理的开发框架！
Nest.js 入门教程 第一章
偷得浮生半日闲
09-24 185
Nest.js 入门教程 第一章
NestJS入门及实战（一）NestJS入门、RESTful API
随便写写
03-30 2208
nestjs的快速入门和实战，搭建一个企业级nest模板
大前端nestjs入门教程系列(三):动态路由到底该怎么用
峰会路转的博客
12-29 763
我们在处理前端发送过来的请求时，需要访问客户端的request信息，那么我们该怎么操作呢?由于nestjs提供对底层平台的访问即express，所以我们可以通过注入的方式来方位请求对象。控制台的打印,request的内容很长，我们找重点看，拉到这里，是不是就和我们的接口请求上面的数据对上了。先上代码，看写法，与前端框架的动态路由是不是相似,一种似曾相识的感觉！后面的数据，cgs~~~~~~~~~~~是不是很方便，相比第一种方法，cgs~~~~~~看到下面的效果，是不是很ok~~~~~~~
nestjs从零到一，快速上手(一)
ben_grf的博客
03-06 1243
【代码】nestjs从零到一，快速上手。
知道了，去卷后端 →「Nest.js 入门及实践」：）
Mark
06-21 3438
Nest 是一个用于构建高效、可扩展的Node.js服务器端应用程序的开发框架。它利用 JavaScript 的渐进增强的能力，使用并完全支持TypeScript（仍然允许开发者使用纯 JavaScript 进行开发），并结合了 OOP（面向对象编程）、FP（函数式编程）和 FRP（函数响应式编程）。在底层，Nest 构建在强大的HTTP 服务器框架上，例如Express（默认），并且还可以通过配置从而使用Fastifysrc。
大前端nestjs入门教程系列(四):如何nestjs整合mysql数据库
峰会路转的博客
01-08 1206
经过前面的几篇文章，想必大家已经对nestjs有了基础的了解，那么这篇文章就带大家玩玩数据库，学会了这篇，就离大前端又进了一步Nest与数据库无关，使你可以轻松地与任何 SQL 或 NoSQL 数据库集成。根据你的喜好，你有多种选择。在最一般的层面上，将 Nest 连接到数据库只是为数据库加载适当的 Node.js 驱动程序的问题，下面我们就学习下如何整合mysql数据库为了与 SQL 和 NoSQL 数据库集成，Nest 提供了 @nestjs/typeorm 包。
Nest.js快速上手（学习笔记）
专研技术的大学生
08-22 537
Nest.js 是一个高效、可扩展的 Node.js 框架，用于构建服务器端应用程序。它使用 TypeScript（但也可以使用纯 JavaScript）进行开发，并遵循现代软件设计原则，如依赖注入、模块化等。以上就是今天的笔记内容，本文仅仅简单介绍了Nest.js的基本使用，而Nest.js提供了大量能使我们快速便捷地处理数据装饰器。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Web后端技术

您的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值