前言为什么要生成一个统一的入口文件，其实也是为了简化引入，在Nestjs中我们会根据业务产生很多的DTO和Entity文件，还有一些公共的封装，比如封装的拦截器、过滤器、管道等；这些东西为了方便管理，我们都会存放在不同的目录下。比如我个人常用的：common/guards这是一个自定义守卫的目录，但是不同的守卫它会有自己的一些文件，这是我就会做二次划分：common/guards/jwt-auth common/guards/content-type common/guards/index.ts我会将不同的守卫单独再用一个文件夹存放，然后在同级的情况下使用一个index.ts文件来做...
前言因为后端用java写的项目用到了swagger来生成文档，用起来真的一言难尽，但是为了快速开发，很多时候并没有太多时间来单独写一份api文档，更别说长期更新维护了。所以用代码来生成文档，好像就成了一种需求。刚好有机会我能全栈负责一个项目，当然要搞起来啊，虽然不用，但是这不就是成为项目经验的一种了。开搞。安装依赖并封装启动相关代码pnpm i @nestjs/swagger安装后我们先去环境变量文件新增几个配置项，用于开发和生产环境使用。# 是否启用swagger SWAGGER_ENABLED=true # swagger 标题 SWAGGER_TITLE="API 文档&...
前言最近在Nestjs项目中使用了swagger来帮助生成api文档，但是当我在返回的类上使用了泛型来传递类型约束的时候，swagger就报错了。我先声明了一个父类用于复用分页属性：// pagination.entity.ts export interface PaginationEntityData<T> { current_page: number; page_size: number; total: number; list: T[]; } export class PaginationEntity<T> { /...
前言终于有机会上生产环境实战了，特意写上一篇文章方便以后使用。首先我们在本地开发的时候确实需要配置Nestjs的CORS，因为前端在开发阶段使用的api往往是我们本地起的服务，通过ip+端口的形式访问我们的后端，在浏览器中就会触发安全限制，报CORS跨域。为此在开发阶段我们就需要配置它。但是当我们上了生成环境后，就略有不同了。首先node本身没法去映射域名，所以我们需要通过Nginx或者其他做一个反向代理，想域名映射到本地的node服务上去，但是这就产生了问题，就是前端实际上请求的是nginx，nginx再跟nestjs沟通，但是nginx本身就是后端的，所以它不存在跨域的问题，反倒是前...
前言实现了文件上传，自然要实现文件下载，经过我的实践总结出两个下载本地文件的方式：第一种是通过api请求，以返回文件流的形式将本地文件返给前端，前端自己接受到文件流后自己把Blob转一下；这种方式的话可以监听文件是否下载完成，完后下载完后删除本地磁盘上的文件。第二种是后端将文件存储在本地磁盘上，创建一个访客也能访问的下载目录，将文件丢到这里，再放开这个目录供访客下载，后端只需要在api返回下载地址即可。这种方式对于用户来说会更加方便，因为可以使用不同的下载工具下载文件。前端也省事，直接创建a链接元素，触发点击就是使用浏览器下载文件了。教程[hide]文件流下载我就不详细写服务了，直接在控...
前言最近在实际项目运用中，发现之前学习的DTO还是太浅显了，在实战后了解了两个非常重要的知识，特此分享出来。[hide]继承在代码中，复用是一个很重要的部分，如果编写的代码没有任何可复用的部分，只能说编写代码的能力太差，业务代码中，极大部分都是可以复用的，而复用的手段之一就是继承。在Nestjs中DTO是与class-validator配合做校验使用的，如果我们简单的使用extends继承的话，就会丢失class-validator的校验规则。import { IsNotEmpty, IsNumber, Min, Max } from "class-validator"...
前言对接第三方登录，最有名的肯定是谷歌了，全球大部分web程序，都有对接谷歌登录的功能。在之前的文章中我们通过passport的jwt策略，实现了本地jwt鉴权登录处理，passport本身就是一种策略模式，通过调用不同的策略实现不同的效果，其中就有关于谷歌登录的处理，这就大大的减少了我们的心智负担。但是需要注意，谷歌登录对网络要求非常高，因为咱们是国内环境，我尝试使用windows下的clash进行fq处理，哪怕是全局规则，nestjs这边还是无法访问到谷歌的服务，从而导致报错：Failed to obtain access token我最终通过路由器的OpenClash解决这个问题，...
前言Nestjs和Prisma的打包部署教程很少，网上比较热门的一个就是利用webpack将Nestjs打包 ，它和前端的打包差不多，会把所有的依赖项打包进来，生成的dist目录，可以直接单独部署，而如果我们使用Nestjs提供的build命令打包，不改动它的情况下，它只会将开发目录中的ts文件，转换成js文件，丢入dist目录中，其他什么也不做，就是个ts转js。这估计会让大部分人诧异，如果遵循官方这种方式，你在启动node服务的时候就必须使用dist目录下的main.js文件了。但是还要考虑环境变量等文件，我们下面细说。Prisma的打包部署需要考虑两方面：一是需要同步数据库模型，也...
前言在后端服务中，我们总是会遇到一些不安全的情况，毕竟web本身也不是一点漏洞都没有，好在有一些便捷的插件拱我们使用。helmet，通过设置 HTTP 响应标头来帮助保护 Express 应用程序；express-rate-limit，用于限制对公共 API 和/或终结点（例如密码重置）的重复请求，防止暴力攻击；本来还有一个跨域处理的CORS插件，但是目前还没有时间实际部署上线，所以在没有实际经验暂时就不写了，到时候单开一篇文章。安装依赖pnpm i helmet express-rate-limit教程这两个插件我们都需要在main.ts中启用。main.tsimport { Nest...
前言日志的记录在后端开发中是不可或缺的，在node中有一个很有名的库winston，这个库支持多种日志传输方式，比如本地文件，控制台，远程传输等。而nestjs有一个winston的模块库：nest-winston既然有了模块，那说明什么？说明我们可以通过依赖注入的形式，在其他地方直接调用模块的服务，从而实现日志记录。在log记录之前，需要分析我们要记录什么内容，比如最重要的错误日志，当发生错误的时候，我们需要记录日志，方便后续在生产环境查看问题，其次就是请求日志记录，我们记录用户的请求，url、ip地址、路由地址、请求参数等，以及我们的响应数据，也就是发送给前端的数据，针对这三种需求我...
前言之前使用了crypto-js做了一个md5加密用户密码的操作，但是由于该库本身没有提供比对方法，于是自己去实现了一个方法，而且还需要自己提供一个唯一值盐。最近发现bcrypt这个库更好用，于是改用它了。安装依赖pnpm i bcrypt pnpm i @types/bcrypt -D教程原来使用crypto-js的MD5方法，需要自己提供盐（salt），之前的做法是创建一个环境变量，然后预设一个定死的string字符串，这就导致我们需要维护一份唯一值的盐，有点麻烦。而bcrypt自身可以生成盐，并且它的盐会通过某些方式存储在加密后的字符串上，然后比对的时候，我们不需要知道之前它的盐是...
前言在之前的文章，我们实现了一个jwt的权限管理，通过一个自定义的Public装饰器声明公共接口，再通过app.module.ts添加一个全局守卫JwtAuthGuard。但是这种方式只能判断这个用户是登录了还是未登录了，没法实现更细化的权限管理，比如一个普通用户，他是无法管理自己的账号的，而管理员缺可以控制普通用户的账号，是禁用还是正常使用。显然我们需要一个更加细化的权限管理方式，经典就是 RBAC（Role-Based Access Control）角色访问控制设计。RBAC在RBAC中是通过不同的角色来实现权限的划分，比如普通用户user只能查看文章列表，而admin管理员是可以增...
Prisma是一个现代的数据库访问库，它本身不直接提供软删除（soft delete）和硬删除（hard delete）这样的内建机制，但你可以在应用层面实现这两种删除策略。硬删除：直接从数据库中删除记录，这是数据库最基本的删除操作。在Prisma中，你可以使用delete或deleteMany方法来执行硬删除。软删除：软删除通常是通过在数据库记录中设置一个标记（如deletedAt时间戳字段）来实现的，而不是实际从数据库中移除记录。这样做的好处是，你可以保留数据，以便将来需要恢复或保留删除记录的历史。为了在Prisma中实现软删除，你可以按照以下步骤操作：在你的模型中添加一个如dele...
前言在之前的文章中我们已经实现了格式化响应的数据结构，现在我们就来处理响应的具体数据，很常见的一个场景：我们查询了一条用户信息，这个信息可能包含了用户的账号、密码、昵称、头像，但是我们肯定不能把密码也返回给前端，所以我们就需要控制返回的数据。有很多种做法，比如简单的就是通过js的delete操作符去删除对象上的属性。如果是使用prisma的话，可以在查询的时候，配置select属性来限制返回的查询数据。// 假设我们有一个User模型，带有id, name, email和password字段 // 我们想要返回用户的id和name，但不返回email和password const us...
区分两种注册方式在nestjs中我们有两种注册全局的方式，一种是通过NestFactory.create得到app实例，在通过app.useGlobalXXX的方式去注册全局的东西，比如全局拦截器，全局过滤器等。import { NestFactory } from "@nestjs/core"; import { AppModule } from "./app.module"; import { ResultFormatInterceptor } from "@/utils/interceptor"; async funct...
前言这个是非常常见的一种配置，我们的接口通过域名访问，但是这个域名不一定全部都给后端使用，所以一般后端服务都是基于域名，通过一个前缀路由来实现区分，比如：www.xxx.com # 后端服务1 www.xxx.com/v1 # 后端服务2 www.xxx.com/v2通过一个统一的路径名来区分。教程在nestjs中，这个配置放在了文档比较末端的地方，代码如下：import { NestFactory } from "@nestjs/core"; import { AppModule } from "./app.module"; async f...
前言在前端项目开发的时候，使用路径别名@/已经是基操了，但是在后端开发的时候，如何使用路径别名确实也没怎么了解过，配置后才发现真的超级简单。教程由于Nestjs本身就是ts运行的，所以在项目初始化后就有tsconfig.json文件了，我们只需要配置一下paths就可以直接使用了。tsconfig.json{ "compilerOptions": { "paths": { "@/*": ["src/*"] } } }使用：import {...
前言Nestjs的文件上传官方文档给的讲解非常少，在掘金搜对应文章也大多数不全，有的都是好几年前的处理了，这里贴一下我学习到的处理方式。首先我们需要三个依赖：multer，这个是一个express的中间件，它只会处理multipart/form-data 类型的表单数据，主要用于上传文件。@types/multer 这个是multer的一个类型声明依赖。@nestjs/platform-express，这个依赖提供了上传模块和拦截器用于处理上传，它本身也依赖于multer。大概流程：首先我们从 @nestjs/platform-express引入MulterModule模块进行注册，为此...
NestJS 提供了多种预设的错误类，这些错误类对应于常见的 HTTP 状态码，并在 @nestjs/common 包中。BadRequestException: 对应于状态码 400（Bad Request），表明客户端请求的语法错误或无法处理请求。UnauthorizedException: 对应于状态码 401（Unauthorized），表明请求需要用户的身份认证。NotFoundException: 对应于状态码 404（Not Found），表明服务器找不到请求的资源。ForbiddenException: 对应于状态码 403（Forbidden），表明服务器理解请求但拒绝...
前言Nestjs文档中有两种鉴权方式，一种是自定义一个守卫，在守卫中自己从上下文header中取出token信息，然后自己解析判定。import { CanActivate, ExecutionContext, Injectable, UnauthorizedException } from '@nestjs/common'; import { JwtService } from '@nestjs/jwt'; import { jwtConstants } from './constants'; import { Request...
前言jwt生成，nestjs官方有一个专门的库@nestjs/jwt，它是一个模块，我们只需要将他注册为全局模块，并且传入secret密匙就能直接去使用它的服务了。教程先安装依赖：pnpm i @nestjs/jwt在app.module.ts中引入该模块，通过useFactory工厂模式，获取到ConfigModule提供的ConfigService服务，从而拿到环境变量文件中配置的secret。.env.development在环境变量中配置TOKEN_SECRET# token-secret TOKEN_SECRET="xxxxx"注意不要泄露这个密匙。app....
简介所有的数据库中，对密码的保存永远不是明文的，这是一种常识，我们使用Nestjs和Prisma创建用户时也是一样的，对用户的密码也不是明文的。有些教程使用argon2库来加密密码，但是这个库在windows上永远是安装失败，为此直接放弃使用它，改用crypto-js，来实现相同功能。教程先安装依赖：pnpm i crypto-js @types/crypto-js然后我们封装一个简单的工具文件：md5.tsimport { MD5 } from "crypto-js"; /** * @description: hash加密 * @param {string} ...
前言一个很经典的业务需求，注册用户时需要判断用户的账号是否已经存在，登录的时候也需要判断用户是否存在，只不过一个需要存在时报错，另一个需要判断不存在时报错。教程官方文档：class-validator创建文件：IsFieldExist.tsimport { registerDecorator, ValidationOptions, ValidationArguments } from "class-validator"; import { PrismaClient } from "@prisma/client"; let prisma: Pris...
最近评论