nest.js学习笔记（一）

news/2025/2/12 15:47:51/

nest.js学习笔记（一）

    • 一、安装nest.js
      • 前置条件
      • 运行项目
      • 目录介绍
    • 二、nest.js cli 常用命令
    • 三、RESTful 风格设计
      • 1.接口url
      • 2.RESTful 版本控制
    • 四、获取前端传过来的参数
      • 1.获取Get请求参数
      • 2.获取Post请求参数
      • 3.动态路由
      • 4.获取Header信息
      • 5.自定义状态码

nest.js 英文官网 NestJS - A progressive Node.js framework

nest.js 中文网 NestJS 简介 | NestJS 中文文档 | NestJS 中文网

nest.js 中文网2 Nest.js 中文文档

一、安装nest.js

前置条件

请确保您的操作系统上安装了 Node.js（>= 12, v13 版本除外）。

安装完成node之后可以运行下面的npm安装命令来全局安装Nest CLI 

// 全局安装nestjs脚手架
npm i -g @nestjs/cli// 创建新项目
nest new project-name

运行项目

下边几个为运行/打包命令，如果需要热更新 启动npm run start:dev 如不需要，运行npm run start即可

	"start": "nest start","start:dev": "nest start --watch","start:debug": "nest start --debug --watch","start:prod": "node dist/main",

ps：如果感觉start:dev有些长，也可以直接改为dev,后面运行npm run dev就可以了

目录介绍

核心文件简要概述

app.controller.ts带有单个路由的基本控制器示例。
app.controller.spec.ts对于基本控制器的单元测试样例
app.module.ts应用程序的根模块。
app.service.ts带有单个方法的基本服务
main.ts应用程序入口文件。它使用 NestFactory 用来创建 Nest 应用实例。

核心文件介绍

  1. main.ts 入口文件主文件 类似于vue 的main.ts

通过 NestFactory.create(AppModule) 创建一个app 就是类似于绑定一个根组件App.vue

app.listen(3000); 监听一个端口

  1. Controller.ts 控制器

可以理解成vue 的路由 private readonly appService: AppService 这一行代码就是依赖注入不需要实例化 appService 它内部会自己实例化的我们主需要放上去就可以了

  1. app.service.ts

这个文件主要实现业务逻辑的 当然Controller可以实现逻辑，但是就是单一的无法复用，放到app.service有别的模块也需要就可以实现复用

二、nest.js cli 常用命令

查看所有命令：

nest --help // 可以查看nestjs所有的命令

在这里插入图片描述

以上命令可以根据需要，自动生成对应的文件，如感觉一个个生成的太慢，可以直接使用一个命令生成整套CURD

nest g resource study // resource可以全写，也可以使用res简写

在这里插入图片描述

此处一般选用第一项就可以，如果是第一次使用这个命令，除了生成文件之外还会自动使用 npm 帮我们更新资源，安装一些额外的插件，后续再次使用就不会更新了。

在这里插入图片描述

如图所示，一套标准的CURD模板就生成好了此处我更改了端口号，默认端口号为3000

在这里插入图片描述

三、RESTful 风格设计

RESTFUL 是一种网络应用程序的设计风格和开发方式，基于HTTP，可以使用XML格式定义或JSON格式定义。RESTFUL适用于移动互联网厂商作为业务接口的场景，实现第三方OTT调用移动网络资源的功能，动作类型为新增、变更、删除所调用资源。

1.接口url

  • 传统接口

    • 利用?来拼接到URL地址进行数据参数传输,且不支持Post方式，Post方式需要在请求体中携带参数
    http://localhost:8080/api/get_list?id=1
http://localhost:8080/api/delete_list?id=1
http://localhost:8080/api/update_list?id=1

  • RESTful 接口

    • 利用/来拼接到URL地址进行数据传输，一个接口就会完成 增删改差 他是通过不同的请求方式来区分的
    // 查询GET 提交POST 更新 PUT PATCH 删除 DELETE
http://localhost:8080/api/get_list/1

2.RESTful 版本控制

版本备注
URI Versioning版本将在请求的 URI 中传递（默认）
Header Versioning自定义请求标头将指定版本
Media Type Versioning请求的Accept标头将指定版本
  1. 在main.ts文件中开启版本控制

在这里插入图片描述

  1. 在study.controller 配置版本（共两种方式，如果在Controller 内配置，则页面内所有的请求路径都必须加上版本，如果单独配置则仅需要在单独配置的路径加上版本即可）

在这里插入图片描述

在这里插入图片描述

四、获取前端传过来的参数

nest.js提供了许多的方法参数装饰器 用来帮助我们快速获取参数 常用的装饰器如下

方法参数
@Request()/@Req()req
@Response()/@Res()res
@Next()next
@Session()req.session
@Param(key?: string)req.params/req.params[key]
@Body(key?: string)req.body/req.body[key]
@Query(key?: string)req.query/req.query[key]
@Headers(name?: string)req.headers/req.headers[name]
@HttpCode()

1.获取Get请求参数

  • 使用@Request()装饰器来获取到前端传过来的参数，同理，使用@Req()也是一样的效果，这里我就不演示了，下图中打印的req为整个Request的内容，通过req.query获取到对应的参数ps:装饰器后边跟的参数(req)可以随便写

在这里插入图片描述

  • 因为获取到的参数在Request中的query中存放，也可以直接使用 @Query()来获取，此时效果是一样的，就不需要再通过req.query获取参数了

在这里插入图片描述

import { Controller, Get, Request,Query } from '@nestjs/common';
import { StudyService } from './study.service';// @Controller({
//   path: 'study',
//   version: '1',
// })
@Controller('study')
export class StudyController {constructor(private readonly studyService: StudyService) {}// @Get()// getParams(@Request() req) {//   console.log(req);//   return {//     data: req.query,//     status: 200,//   };// }@Get()getParams(@Query() query) {console.log(query);return {data: query,status: 200,};}
}

2.获取Post请求参数

  • Post请求与上边Get请求类似，不同的是传的值存放在body中，而不是query中，需要利用res.body草可以获取到值

在这里插入图片描述

  • 和@Query()修饰器一样，可以利用@Body()修饰器来直接获取到参数,结果也是一样的，除此之外，@Body()修饰器也支持直接读取key

在这里插入图片描述

import { Body, Controller, Post } from '@nestjs/common';
import { StudyService } from './study.service';// @Controller({
//   path: 'study',
//   version: '1',
// })
@Controller('study')
export class StudyController {constructor(private readonly studyService: StudyService) {}// @Post()// getPost(@Request() req) {//   console.log(req.body);//   return {//     data: req.body,//     status: 200,//   };// }@Post()getPost(@Body('name') body) {console.log(body);return {data: body,status: 200,};}
}

3.动态路由

  • 此处和上面@Request() 用法一样，就不赘述了，直接上结果

在这里插入图片描述

import { Controller, Get, Param } from '@nestjs/common';
import { StudyService } from './study.service';// @Controller({
//   path: 'study',
//   version: '1',
// })
@Controller('study')
export class StudyController {constructor(private readonly studyService: StudyService) {}@Get(':id')getParams(@Param() params) {console.log(params);return {data: params,status: 200,};}
}

4.获取Header信息

此处我拿动态路由来举例子，无论get请求还是post，都可以获取到Header信息

在这里插入图片描述

import { Controller, Get, Headers } from '@nestjs/common';
import { StudyService } from './study.service';// @Controller({
//   path: 'study',
//   version: '1',
// })
@Controller('study')
export class StudyController {constructor(private readonly studyService: StudyService) {}@Get(':id')getParams(@Headers() headers) {console.log(headers);return {data: headers,status: 200,};}
}

5.自定义状态码

  • 在@HttpCode()中直接写数字就可以，但也不能写的特别离谱的数字（建议按照标准状态码来写），否则看不到返回的参数

在这里插入图片描述

常见Code码规范

状态码代表的意思
200OK 连接成功
304Not Modified 协商缓存了
400Bad Request 参数错误
401Unauthorized token错误
403Forbidden referer origin 验证失败
404Not Found 接口不存在
500Internal Server Error 服务端错误
502Bad Gateway 上游接口有问题或者服务器问题

http://www.ppmy.cn/news/30725.html

相关文章

交互：可以执行命令行的框架才是好框架

交互：可以执行命令行的框架才是好框架

上一节课，我们开始把框架向工业级迭代，重新规划了目录，这一节课将对框架做更大的改动，让框架支持命令行工具。 第三方命令行工具库 cobra obra 不仅仅能让我们快速构建一个命令行，它更大的优势是能更快地组织起有许多…
阅读更多...
HTTPS简介

HTTPS简介

HTTPS是HTTP开启TLS传输协议，客户端要拿到服务端的公钥，用公钥加密数据后再进行传输，防止数据泄露后背篡改。它要解决两个问题：怎么保证公钥可信怎么加密数据公钥可信问题客户端从服务端获取公钥的时候，存在请求被拦截…
阅读更多...
sort函数对结构体|pair对组|vector容器|map排序|二维数组的第x列 的排序

sort函数对结构体|pair对组|vector容器|map排序|二维数组的第x列 的排序

目录 sort对 vector容器 sort对 vector<pair<int,int>>对组 sort对 结构体 结构体外部规定排序 结构体内部运算符重载 map容器的排序 map的键排序 map的值排序 sort对二维数组的排序 sort对 vector容器 sort()函数可以用于对vector容器进行排序。具体来…
阅读更多...
curl请求常用参数和返回码

curl请求常用参数和返回码

curl是一个用于传输数据的工具&#xff0c;支持各种协议&#xff0c;如HTTP、FTP、SMTP等。以下是一些常用的curl请求参数及其作用&#xff1a; -X, --request&#xff1a;指定HTTP请求方法&#xff0c;常见的有GET、POST、PUT、DELETE等。 -H, --header&#xff1a;设置HTTP请…
阅读更多...
【LeetCode】1. 两数之和

【LeetCode】1. 两数之和

题目链接&#xff1a;https://leetcode.cn/problems/two-sum/ &#x1f4d5;题目要求&#xff1a; 给定一个整数数组 nums 和一个整数目标值 target&#xff0c;请你在该数组中找出 和为目标值 target 的那 两个 整数&#xff0c;并返回它们的数组下标。 你可以假设每种输入…
阅读更多...
webview的工作、内存泄漏、漏洞以及缓存机制原理原理+方案解决

webview的工作、内存泄漏、漏洞以及缓存机制原理原理+方案解决

分析一段appium的日志来分析webview的工作原理&#xff0c;文章尾部附有自动化脚本及完整日志&#xff1a; 解析&#xff1a; 获取上下文列表 服务端发送命令adb shell cat /proc/net/unix获取域套接字列表。那什么是域套接字呢&#xff1f; 域套接字&#xff1a;是unix系统里…
阅读更多...
c语言基础练习题详解

c语言基础练习题详解

&#x1f49e;&#x1f49e; 1.C语言程序的基本单位是&#xff08;C&#xff09;。 A&#xff0e;程序行 B&#xff0e; 语句 C&#xff0e; 函数 D&#xff0e;字符 &#x1f49e;&#x1f49e; 2.已知各变量的类型说明如下&#xff1a; int m6,n,a,b; unsigned long w8;…
阅读更多...
【Linux】-- 权限和Shell运行原理

【Linux】-- 权限和Shell运行原理

目录 Shell的运行原理 用户切换 su - / su sudo 权限 chmod chown chgrp 八进制方法修改文件属性 目录权限 粘滞位 umask 自定义默认权限 Shell的运行原理 广义上&#xff0c;Linux发行版 Linux内核 外壳程序 Linux 从广义上来理解它是一个操作系统 而从狭义上…
阅读更多...
最新文章

Copyright @ 2022~2023