Nest.js參數校驗和自定義返回數據格式詳解
更新時間：2021年03月28日 11:55:14 作者：Jaxson Wang
這篇文章主要給大家介紹了關于Nest.js參數校驗和自定義返回數據格式的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧
0x0 參數校驗
參數校驗大部分業(yè)務是使用 Nest.js 中的管道 方法實現，具體可以查閱文檔 。不過編寫過程中遇到一些問題，雖然文檔講得比較晦澀。
在做個查詢接口，里面包含一些參數，做成 dto 結構數據：
import { ApiProperty } from '@nestjs/swagger'
export class QueryUserDto {
@ApiProperty({
required: false,
description: '頁碼'
})
readonly currentPage: number
@ApiProperty({
required: false,
description: '條數'
})
readonly pageSize: number
@ApiProperty({
required: false,
description: '用戶賬號'
})
readonly username?: string
@ApiProperty({
required: false,
description: '用戶狀態(tài)'
})
readonly activeStatus: number
@ApiProperty({
required: false,
description: '排序的方式: ASC, DESC'
})
readonly order: 'DESC' | 'ASC'
}
TYPESCRIPT
在 @Query 請求傳入對應的參數，發(fā)現得到的數據類型都是 String ，然后查閱相關文檔才明白還需要 class-transformer 的 Type 進行轉換：
import { ApiProperty } from '@nestjs/swagger'
import { Type } from 'class-transformer'
export class QueryUserDto {
@ApiProperty({
required: false,
description: '頁碼'
})
@Type(() => Number)
readonly currentPage: number = 1
@ApiProperty({
required: false,
description: '條數'
})
@Type(() => Number)
readonly pageSize: number = 10
@ApiProperty({
required: false,
description: '用戶賬號'
})
readonly username?: string
@ApiProperty({
required: false,
description: '用戶狀態(tài)'
})
@Type(() => Number)
readonly activeStatus: number = 3
@ApiProperty({
required: false,
description: '排序的方式: ASC, DESC'
})
readonly order: 'DESC' | 'ASC' = 'DESC'
}
然后在 ValidationPipe 管道方法里開啟 transform 選項：
app.useGlobalPipes(
new ValidationPipe({
transform: true
})
)
或者在 app.modules.ts 注入：
import { ValidationPipe } from '@nestjs/common'
import { APP_PIPE } from '@nestjs/core'
@Module({
imports: [
// ...
],
controllers: [AppController],
providers: [
{
provide: APP_PIPE,
useValue: new ValidationPipe({
transform: true
})
}
]
})
倆者使用方法區(qū)別于程序的是否混合應用類型。
我這邊為了省事直接寫在全局方法里，最終到 service 拿到的數據就是經過管道業(yè)務處理過的數據，不需要在 service 層進行大量的數據類型判斷。
0x1 自定義返回數據格式
在 controller 返回的數據都是從數據庫表結構而來：
{
"id": "d8d5a56c-ee9f-4e41-be48-5414a7a5712c",
"username": "Akeem.Cremin",
"password": "$2b$10$kRcsmN6ewFC2GOs0TEg6TuvDbNzf1VGCbQf2fI1UeyPAiZCq9rMKm",
"email": "Garrett87@hotmail.com",
"nickname": "Wallace Nicolas",
"role": "user",
"isActive": true,
"createdTime": "2021-03-24T15:24:26.806Z",
"updatedTime": "2021-03-24T15:24:26.806Z"
}
如果需要定義最終返回接口的數據格式例如：
{
"statusCode": 200,
"message": "獲取成功",
"data": {
"id": "d8d5a56c-ee9f-4e41-be48-5414a7a5712c",
"username": "Akeem.Cremin",
"password": "$2b$10$kRcsmN6ewFC2GOs0TEg6TuvDbNzf1VGCbQf2fI1UeyPAiZCq9rMKm",
"email": "Garrett87@hotmail.com",
"nickname": "Wallace Nicolas",
"role": "user",
"isActive": true,
"createdTime": "2021-03-24T15:24:26.806Z",
"updatedTime": "2021-03-24T15:24:26.806Z"
}
}
這里就需要做個自定義成功請求攔截器：
nest g in shared/interceptor/transform
import { CallHandler, ExecutionContext, Injectable, Logger, NestInterceptor } from '@nestjs/common'
import { Observable } from 'rxjs'
import { map } from 'rxjs/operators'
import { Request } from 'express'
interface Response<T> {
data: T
}
@Injectable()
export class TransformInterceptor<T> implements NestInterceptor<T, Response<T>> {
intercept(context: ExecutionContext, next: CallHandler<T>): Observable<any> {
const request = context.switchToHttp().getRequest<Request>()
Logger.log(request.url, '正常接口請求')
return next.handle().pipe(
map(data => {
return {
data: data,
statusCode: 200,
message: '請求成功'
}
})
)
}
}
然后在 app.module.ts 引入即可使用：
import { ValidationPipe } from '@nestjs/common'
import { APP_INTERCEPTOR } from '@nestjs/core'
import { TransformInterceptor } from '@/shared/interceptor/transform.interceptor'
@Module({
imports: [
// ...
],
controllers: [AppController],
providers: [
{
provide: APP_INTERCEPTOR,
useClass: TransformInterceptor
}
]
})
不過 APP_INTERCEPTOR 排序要注意，TransformInterceptor 最好放在第一個，否則會失效。
錯誤過濾器：
nest g f shared/filters/httpException
import { ArgumentsHost, Catch, ExceptionFilter, HttpException, Logger } from '@nestjs/common'
import { Response, Request } from 'express'
@Catch(HttpException)
export class HttpExceptionFilter implements ExceptionFilter {
catch(exception: HttpException, host: ArgumentsHost) {
const context = host.switchToHttp()
const response = context.getResponse<Response>()
const request = context.getRequest<Request>()
const status = exception.getStatus()
const message = exception.message
Logger.log(`${request.url} - ${message}`, '非正常接口請求')
response.status(status).json({
statusCode: status,
message: message,
path: request.url,
timestamp: new Date().toISOString()
})
}
}
然后在 app.module.ts 引入即可使用：
import { ValidationPipe } from '@nestjs/common'
import { APP_FILTER } from '@nestjs/core'
import { HttpExceptionFilter } from '@/shared/filters/http-exception.filter'
@Module({
imports: [
// ...
],
controllers: [AppController],
providers: [
{
provide: APP_FILTER,
useClass: HttpExceptionFilter
}
]
})
0x2 隱藏實體類中的某個字段
本來想使用 @Exclude 屬性來隱藏數據庫中一些敏感的字段，但發(fā)現無法滿足特殊的需求，如果是返回單條實例可以實現隱藏，但是我有個 findAll 就無法實現了，上面在 Serialization | NestJS - A progressive Node.js framework 文檔里說的非常詳細，不過這里還有個辦法。首先在實力類敏感數據字段上添加屬性：
import { BaseEntity, Entity, Column, PrimaryGeneratedColumn } from 'typeorm'
@Entity('user')
export class UserEntity extends BaseEntity {
@PrimaryGeneratedColumn('uuid', {
comment: '用戶編號'
})
id: string
@Column({
type: 'varchar',
length: 50,
unique: true,
comment: '登錄用戶'
})
username: string
@Column({
type: 'varchar',
length: 200,
select: false,
comment: '密碼'
})
password: string
select: false 可以在返回查詢結果隱藏這個字段，但所有涉及到這個字段查詢必須添加這個字段，比如我在 user.service.ts 登錄查詢中：
const user = await getRepository(UserEntity)
.createQueryBuilder('user')
.where('user.username = :username', { username })
.addSelect('user.password')
.getOne()
.addSelect('user.password') 添加這個屬性查詢將會包括 password 這個字段，否則普通查詢的方法不會包括這個字段。
總結
到此這篇關于Nest.js參數校驗和自定義返回數據格式的文章就介紹到這了,更多相關Nest.js參數校驗和數據格式內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要為大家介紹了Node.js工具庫yeoman的使用介紹,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2024-01-01
詳解nodejs微信公眾號開發(fā)——4.自動回復各種消息
這篇文章主要介紹了詳解nodejs微信公眾號開發(fā)——4.自動回復各種消息，非常具有實用價值，需要的朋友可以參考下2017-04-04
這篇文章主要介紹了node版本與node-sass版本不兼容時的問題及解決方案，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-04-04
最近項目遇到了個需求,需要將存放圖片進行預覽,所以這篇文章主要給大家介紹了關于Node如何實現在瀏覽器預覽項目的所有圖片的相關資料,文中通過實例代碼介紹的非常詳細,需要的朋友可以參考下2023-01-01
這篇文章主要給大家介紹了關于no-vnc和node.js實現web遠程桌面的完整步驟，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面來一起學習學習吧2019-08-08
Nodejs讀寫流流的傳輸過程默認是以buffer的形式傳輸的,除非你給他設置其他編碼形式, 小伙伴可以參考下。2016-03-03
下面小編就為大家?guī)硪黄褂肗ode.js實現簡易MVC框架的方法。小編覺得挺不錯的，現在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-08-08
這篇文章主要介紹了nodejs連接mysql數據庫,結合實例形式總結分析了nodejs連接與操作mysql數據庫的相關模板、配置及mysql數據庫查詢、添加數據等操作技巧,需要的朋友可以參考下2018-03-03
這篇文章主要介紹了nodejs實現獲取某寶商品分類,十分的簡單實用，進入后臺直接打開控制臺，把代碼粘進去運行就OK了，有需要的小伙伴可以參考下。2015-05-05
這篇文章主要介紹了如何在node的express中使用socket.io,需要的朋友可以參考下2014-12-12