Seiriúsú a dhéanann tú a rialú ar an chaoi a ndéantar rudaí a chlaochlú ina JSON a sheoladh i bhfreagartha — go tábhachtach, agus réimsí íogaire á bhreiseán (ar nós focal faire) agus an t-aschur á chruthú. Bainistithe an NestJS seo leis an ClassSerializerInterceptor agus na ghréasáin class-transformer.
// ❌ returning an entity directly leaks the password hash!
(":id")
findOne(("id") id: string) {
return this.usersService.findOne(id); // { id, name, email, password: "$2b$..." } 😱
}
Ar ais a thabhairt ar eintitis an bhunstora go díreach is féidir le réimsí a nochtadh nach ba cheart a bheith ag an chliaint riamh (hais-úsáidí focal faire, bratacha inmheánacha, tokens) — ceist dhomhain slándála/príobháideachta.
import { Exclude } from "class-transformer";
export class User {
id: number;
name: string;
email: string;
@Exclude() // this field is REMOVED from responses
password: string;
}
// enable the serializer interceptor (globally or per-controller)
@UseInterceptors(ClassSerializerInterceptor)
@Controller("users")
export class UsersController {
@Get(":id")
findOne(@Param("id") id): User {
return this.usersService.findOne(id); // password is automatically stripped
}
}
// or globally: app.useGlobalInterceptors(new ClassSerializerInterceptor(app.get(Reflector)))
Cuireann an ClassSerializerInterceptor ghréasáin class-transformer i bhfeidhm agus á seiriúsú freagartha, mar sin baintear réimsí @Exclude() go huathoibríoch — ach ach amháin má thaigeann tú eascanna rang (ní réada simplí).
export class User {
@Expose() id: number; // explicitly include (with excludeAll strategy)
@Exclude() password: string; // remove from output
@Expose({ name: "full_name" }) // rename in the output
name: string;
@Transform(({ value }) => value.toUpperCase()) // transform the value
code: string;
@Exclude({ toPlainOnly: true }) // exclude only when serializing OUT (not on input)
internalField: string;
}
// ⚠️ the interceptor only transforms CLASS INSTANCES — plain objects pass through unchanged
return new User(data); // ✅ decorators apply
return plainToInstance(User, data); // ✅ convert a plain object to an instance
return { ...data }; // ❌ plain object — @Exclude is IGNORED!
Gaothú coitiantúil: ní oibríonn ghréasáin seiriúsú ach ar eascanna rang iarbhír, mar sin caithfidh tú eascanna a thabhairt ar ais (is ionann eintitis ORM agus eascanna den ghnáth; réada simplí dhéanta de láimh ag teastáil iompair).
Instead of decorating entities, map to a separate Response DTO containing only the
fields meant for the client — explicit, decoupled from the DB model, and very safe.
Is tábhachtach seiriúsú freagartha a rialú le haghaidh slándála agus dearadh glan API.
An chúis is tábhachtaí ná ní a chur i bhfeidhm ar gheal-sonraí íogaire — ar ais a thabhairt ar eintitis an bhunstora go díreach is féidir le hais-úsáidí focal faire, réimsí inmheánacha, tokens, nó sonraí eile a nochtadh nach mór ar chor ar bith a bheith ag cliaint, dearcadh coitiantúil agus domhain.