nest.js学习笔记(一)
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 应用实例。
核心文件介绍
- main.ts 入口文件主文件 类似于vue 的main.ts
通过 NestFactory.create(AppModule) 创建一个app 就是类似于绑定一个根组件App.vue
app.listen(3000); 监听一个端口
- Controller.ts 控制器
可以理解成vue 的路由 private readonly appService: AppService 这一行代码就是依赖注入不需要实例化 appService 它内部会自己实例化的我们主需要放上去就可以了
- 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 标头将指定版本 |
- 在main.ts文件中开启版本控制
- 在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码规范
状态码 | 代表的意思 |
---|---|
200 | OK 连接成功 |
304 | Not Modified 协商缓存了 |
400 | Bad Request 参数错误 |
401 | Unauthorized token错误 |
403 | Forbidden referer origin 验证失败 |
404 | Not Found 接口不存在 |
500 | Internal Server Error 服务端错误 |
502 | Bad Gateway 上游接口有问题或者服务器问题 |
相关文章:

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

win下载配置CIC Flowmeter环境并提取流量特征
提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档 文章目录前言一、下载CIC Flowmeter二、安装java、maven、gradle和IDEA1.java 1.82.maven3.gradle4.IDEA三、CICFlowMeter-master使用四、流量特征1.含义2.获取前言 配了一整…...
【LeetCode刷题-Java/Python】二分查找
二分查找704.二分查找题目实现总结35.搜索插入位置题目实现34. 在排序数组中查找元素的第一个和最后一个位置题目实现69.x的平方根题目实现367. 有效的完全平方数题目实现704.二分查找 题目 题目链接 给定一个 n 个元素有序的(升序)整型数组 nums 和一…...

Linux 6.2 已正式发布
Linus Torvalds 发布了稳定的 Linux 6.2 内核,这是 2023 年的第一个主要内核版本。硬件方面,Linux 6.2 提升了 Intel Arc 显卡 (DG2/Alchemist) 的稳定性,真正做到开箱即用。英特尔的 On Demand 驱动程序现在状态良好,适用于第 4 …...
Kubernetes 101,第一部分,基础知识
已经有一段时间了,我想花点时间坐下来写写关于Kubernetes 的文章。时机已到。 简而言之,Kubernetes是一个用于自动化和管理容器化应用程序的开源系统。Kubernetes 就是关于容器的。 ❗如果你对什么...

企业级信息系统开发学习笔记1.7 基于XML配置方式使用Spring MVC
文章目录零、本节学习目标一、Spring MVC概述1、MVC架构2、Spring MVC3、使用Spring MVC的两种方式二、基于XML配置与注解的方式使用Spring MVC(一)创建Spring项目【SpringMVCDemo01】(二)在pom文件里添加相关依赖(三&…...
java反射,动态代理
1. 反射 1.1 反射的概述: 专业的解释(了解一下): 是在运行状态中,对于任意一个类,都能够知道这个类的所有属性和方法; 对于任意一个对象,都能够调用它的任意属性和方法…...

React(六):Redux的使用、react-redux简化代码、redux模块化、RTK的使用
React(六)一、Redux测试项目搭建1.创建store仓库2.创建reducer函数(纯函数)3.constants.js保存action名字4.修改store中的数据5.动态生成action二、React中如何使用redux1.安装redux2.创建store3.组件中订阅store4.派发action修改…...

静态库和动态库的打包与使用
静态库和动态库 静态库和动态库的打包 生成可执行程序时链接使用 运行可执行程序时加载使用 提前声明,笔者示例的文件有mian.c/child.c/child.h。OK,我们先了解一下,库文件是什么?它其实就是打包了一堆实现常用功能的代码文件. ⭐…...

h264编码之SPS解析
一、概念 SPS即Sequence Paramater Set,又称作序列参数集。SPS中保存了一组编码视频序列(Coded video sequence)的全局参数。 二、定义 H.264标准协议中规定的SPS格式位于文档的7.3.2.1.1,如下图所示: 1、profile_idc 根据《T-REC-H.264-2…...

使用R语言包clusterProfiler做KEGG富集分析时出现的错误及解决方法
使用enrichKEGG做通路富集分析时,一直报错:显示No gene can be mapped....k <- enrichKEGG(gene gene, organism "hsa", pvalueCutoff 1, qvalueCutoff 1)但是之前用同样的基因做分析是能够成功地富集到通路,即便是网上的数据…...

框架——MyBatis的入门案例
框架概述1.1什么是框架框架(Framework)是整个或部分系统的可重用设计,表现为一组抽象构件及构件实例间交与的方法;另一种定义认为,框架是可被应用开发者定制的应用骨架。前者是从应用方面而后者是从目的方面给出的定义…...

hadoop兼容性验证
前言 Hadoop是一个由Apache基金会所开发的分布式系统基础架构,主要解决海量数据的存储和海量数据的分析计算问题,广义上来说,Hadoop通常是指一个更广泛的概念–hadoop生态圈 Hadoop优缺点: 优点: 1、高可靠性&#x…...

运维提质增效,有哪些办法可以做
凡是代码,难免有 bug。 开发者们的日常,除了用一行行代码搭产品外,便是找出代码里的虫,俗称 debug。 随着移动互联网的快速发展,App 已经成为日常生活中不可或缺的一部分。但是在开发者/运维人员的眼里简直就是痛苦的…...
c++基础——结构体
结构体结构体(struct),可以看做是一系列称为成员元素的组合体。可以看做是自定义的数据类型。定义结构体struct abc {int x;int y; } e[array_length];const abc a; abc b, B[array_length], tmp; abc *c;上例中定义了一个名为 abc 的结构体&…...

applicationContext相关加载
spring refresh 概述 refresh是一个方法,spring中所有的ApplicationContext容器都需要通过refresh方法初始化; 处理步骤 其中refresh方法包含12个主要的处理步骤: 1、第1个步骤做前置准备 2、第2~6步骤创建BeanFactory(Appl…...

数据同步工具Sqoop
大数据Hadoop之——数据同步工具SqoopSqoop基本原理及常用方法 1 概述 Apache Sqoop(SQL-to-Hadoop)项目旨在协助RDBMS(Relational Database Management System:关系型数据库管理系统)与Hadoop之间进行高效的大数据交…...
Kafka 版本
kafka-2.11-2.1.1 : Kafka 1.0.0 后,Kafka 版本命名规则从 4 位到 3 位Kafka版本号是 2.1.1前 2 : 大版本号 (MajorVersion)中 1 : 小版本号或次版本号 (Minor Version)后 1 : 修订版本号 (Patch) Kafka 0.7 最早开源版本 : 只提供最基础的消息队列功…...

ElasticSearch 在Java中的各种实现
ES JavaAPI的相关体系: 词条查询 所谓词条查询,也就是ES不会对查询条件进行分词处理,只有当词条和查询字符串完全匹配时,才会被查询到。 等值查询-term 等值查询,即筛选出一个字段等于特定值的所有记录。 【SQL】 s…...

SpringBoot整合Knife4j
文章目录前言一、Knife4j是什么?二、使用步骤1.导入依赖2.编写配置文件3.编写controller和实体类4.测试总结前言 接上篇整合Swagger链接奉上http://t.csdn.cn/9mXSu 一、Knife4j是什么? 官方文档:https://doc.xiaominfo.com/ knife4j可以理解…...
Vue记事本应用实现教程
文章目录 1. 项目介绍2. 开发环境准备3. 设计应用界面4. 创建Vue实例和数据模型5. 实现记事本功能5.1 添加新记事项5.2 删除记事项5.3 清空所有记事 6. 添加样式7. 功能扩展:显示创建时间8. 功能扩展:记事项搜索9. 完整代码10. Vue知识点解析10.1 数据绑…...

label-studio的使用教程(导入本地路径)
文章目录 1. 准备环境2. 脚本启动2.1 Windows2.2 Linux 3. 安装label-studio机器学习后端3.1 pip安装(推荐)3.2 GitHub仓库安装 4. 后端配置4.1 yolo环境4.2 引入后端模型4.3 修改脚本4.4 启动后端 5. 标注工程5.1 创建工程5.2 配置图片路径5.3 配置工程类型标签5.4 配置模型5.…...
golang循环变量捕获问题
在 Go 语言中,当在循环中启动协程(goroutine)时,如果在协程闭包中直接引用循环变量,可能会遇到一个常见的陷阱 - 循环变量捕获问题。让我详细解释一下: 问题背景 看这个代码片段: fo…...

【入坑系列】TiDB 强制索引在不同库下不生效问题
文章目录 背景SQL 优化情况线上SQL运行情况分析怀疑1:执行计划绑定问题?尝试:SHOW WARNINGS 查看警告探索 TiDB 的 USE_INDEX 写法Hint 不生效问题排查解决参考背景 项目中使用 TiDB 数据库,并对 SQL 进行优化了,添加了强制索引。 UAT 环境已经生效,但 PROD 环境强制索…...
【ROS】Nav2源码之nav2_behavior_tree-行为树节点列表
1、行为树节点分类 在 Nav2(Navigation2)的行为树框架中,行为树节点插件按照功能分为 Action(动作节点)、Condition(条件节点)、Control(控制节点) 和 Decorator(装饰节点) 四类。 1.1 动作节点 Action 执行具体的机器人操作或任务,直接与硬件、传感器或外部系统…...

【Java_EE】Spring MVC
目录 Spring Web MVC 编辑注解 RestController RequestMapping RequestParam RequestParam RequestBody PathVariable RequestPart 参数传递 注意事项 编辑参数重命名 RequestParam 编辑编辑传递集合 RequestParam 传递JSON数据 编辑RequestBody …...

零基础在实践中学习网络安全-皮卡丘靶场(第九期-Unsafe Fileupload模块)(yakit方式)
本期内容并不是很难,相信大家会学的很愉快,当然对于有后端基础的朋友来说,本期内容更加容易了解,当然没有基础的也别担心,本期内容会详细解释有关内容 本期用到的软件:yakit(因为经过之前好多期…...

深度学习习题2
1.如果增加神经网络的宽度,精确度会增加到一个特定阈值后,便开始降低。造成这一现象的可能原因是什么? A、即使增加卷积核的数量,只有少部分的核会被用作预测 B、当卷积核数量增加时,神经网络的预测能力会降低 C、当卷…...
【生成模型】视频生成论文调研
工作清单 上游应用方向:控制、速度、时长、高动态、多主体驱动 类型工作基础模型WAN / WAN-VACE / HunyuanVideo控制条件轨迹控制ATI~镜头控制ReCamMaster~多主体驱动Phantom~音频驱动Let Them Talk: Audio-Driven Multi-Person Conversational Video Generation速…...

招商蛇口 | 执笔CID,启幕低密生活新境
作为中国城市生长的力量,招商蛇口以“美好生活承载者”为使命,深耕全球111座城市,以央企担当匠造时代理想人居。从深圳湾的开拓基因到西安高新CID的战略落子,招商蛇口始终与城市发展同频共振,以建筑诠释对土地与生活的…...