Nestjs响应序列化与对象数组
我想通过nestjs序列化技术序列化控制器响应。我没有找到任何方法,我的解决方案如下:
用户实体
export type UserRoleType = "admin" | "editor" | "ghost";
@Entity()
export class User {
@PrimaryGeneratedColumn() id: number;
@Column('text')
username: string;
@Column('text')
password: string;
@Column({
type: "enum",
enum: ["admin", "editor", "ghost"],
default: "ghost"
})
roles: UserRoleType;
@Column({ nullable: true })
profileId: number;
}
用户响应类
import { Exclude } from 'class-transformer';
export class UserResponse {
id: number;
username: string;
@Exclude()
roles: string;
@Exclude()
password: string;
@Exclude()
profileId: number;
constructor(partial: Partial<UserResponse>) {
Object.assign(this, partial);
}
}
import { Exclude, Type } from 'class-transformer';
import { User } from 'src/_entities/user.entity';
import { UserResponse } from './user.response';
export class UsersResponse {
@Type(() => UserResponse)
users: User[]
constructor() { }
}
调节器
@Controller('user')
export class UsersController {
constructor(
private readonly userService: UserService
) {
}
@UseInterceptors(ClassSerializerInterceptor)
@Get('all')
async findAll(
): Promise<UsersResponse> {
let users = await this.userService.findAll().catch(e => { throw new NotAcceptableException(e) })
let rsp =new UsersResponse()
rsp.users = users
return rsp
}
它可以工作,但我必须显式地将db查询结果分配给响应用户成员。有没有更好的办法?非常感谢
这里是实际的响应和想要的结果,以获得更好的解释。
这种方法的结果
{
"users": [
{
"id": 1,
"username": "a"
},
{
"id": 2,
"username": "bbbbbb"
}
]
}
结果通缉
{
{
"id": 1,
"username": "a"
},
{
"id": 2,
"username": "bbbbbb"
}
}
回答如下:
我建议直接将@Exclude
装饰器放在你的实体类User
上,而不是复制UserResponse
中的属性。以下答案假设您已经这样做了。
平坦的回应
如果你看一下ClassSerializerInterceptor
的代码,你会发现它会自动处理数组:
return isArray
? (response as PlainLiteralObject[]).map(item =>
this.transformToPlain(item, options),
)
: this.transformToPlain(response, options);
但是,它只会转换它们,如果你直接返回数组,那么return users
而不是return {users: users}
:
@UseInterceptors(ClassSerializerInterceptor)
@Get('all')
async findAll(): Promise<User> {
return this.userService.findAll()
}
嵌套响应
如果您需要嵌套响应,那么您的方式是一个很好的解决方案。或者,您可以直接调用class-transformer的serialize
而不是使用ClassSerializerInterceptor
。它还自动处理数组:
import { serialize } from 'class-transformer';
@Get('all')
async findAll(): Promise<UsersResponse> {
const users: User[] = await this.userService.findAll();
return {users: serialize(users)};
}