공통 설정을 위한 클래스 수준 데코레이터
사용자 지정 클래스 데코레이터로 컨트롤러와 프로바이더에 태그를 지정해 기능 플래그와 테넌트 범위를 제어합니다
공통 설정을 위한 클래스 수준 데코레이터은(는) CoddyKit의 무료 NestJS Enterprise Backend APIs 강의입니다. 이것은 4개 중 4번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 NestJS Enterprise Backend APIs 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. NestJS Enterprise Backend APIs 강의에는 총 4개의 강의가 포함되어 있습니다.
이 강의의 일부는 아직 번역되지 않았으며 영어로 표시됩니다.
Why Class-Level Decorators?
In an enterprise NestJS API, some configuration applies to a whole controller or provider, not a single route. Think feature flags, tenant scoping, audit categories, or rate-limit tiers.
- Repeating this on every method is noisy and error-prone.
- A class-level decorator lets you tag the class once and read that tag later.
The pattern: attach metadata to the class, then read it inside a guard, interceptor, or middleware to drive cross-cutting behavior.
Decorators Are Just Functions
A class decorator is a function that receives the class constructor as its only argument. You can wrap it in a factory so callers pass options.
Here is the raw shape, with no framework involved, so you can see exactly what runs at class-definition time.
// Plain TypeScript: a class decorator factory
function Tag(label: string) {
return function (target: Function) {
console.log(`Decorating ${target.name} with label=${label}`);
};
}
@Tag('billing')
class InvoiceController {}
console.log('Class defined:', InvoiceController.name);Storing Metadata with Reflect
Logging is not useful by itself. We need to store the config so other code can read it. NestJS builds on the reflect-metadata library, which lets you attach key/value metadata to a class.
Reflect.defineMetadata(key, value, target)writes.Reflect.getMetadata(key, target)reads.
The class itself is the storage target, so the tag travels with the type.
A Tenant-Scope Decorator
Let's build a real one: @TenantScope('strict') marks a controller so that all its routes must resolve a tenant. We define a metadata key and a factory that writes it.
In NestJS you would normally use the built-in SetMetadata helper, but writing it by hand shows what it does under the hood.
import 'reflect-metadata';
export const TENANT_SCOPE = 'tenant:scope';
export function TenantScope(mode: 'strict' | 'optional') {
return (target: Function) => {
Reflect.defineMetadata(TENANT_SCOPE, mode, target);
};
}
@TenantScope('strict')
class OrdersController {}
const mode = Reflect.getMetadata(TENANT_SCOPE, OrdersController);
console.log('Tenant mode:', mode); // strictUsing SetMetadata in NestJS
NestJS ships SetMetadata(key, value) which returns a decorator usable on both classes and methods. Wrapping it in a named factory gives you a clean, self-documenting API.
This is the idiomatic way to author custom decorators in NestJS instead of calling Reflect.defineMetadata yourself.
import { SetMetadata } from '@nestjs/common';
export const FEATURE_FLAG = 'feature:flag';
// Class-level decorator built on SetMetadata
export const FeatureFlag = (flag: string) =>
SetMetadata(FEATURE_FLAG, flag);
@FeatureFlag('beta-checkout')
export class CheckoutController {}Reading Metadata with Reflector
To consume the tag at request time, inject NestJS's Reflector service. A guard can read the class-level metadata from context.getClass().
reflector.get(KEY, context.getClass())reads the controller-level tag.reflector.getAllAndOverride(KEY, [handler, class])lets a method override the class default.
import { CanActivate, ExecutionContext, Injectable } from '@nestjs/common';
import { Reflector } from '@nestjs/core';
import { FEATURE_FLAG } from './feature-flag.decorator';
@Injectable()
export class FeatureFlagGuard implements CanActivate {
constructor(private reflector: Reflector) {}
canActivate(context: ExecutionContext): boolean {
const flag = this.reflector.get<string>(
FEATURE_FLAG,
context.getClass(),
);
if (!flag) return true; // no flag => always allowed
return isFeatureEnabled(flag);
}
}
declare function isFeatureEnabled(flag: string): boolean;Method Overrides Class
A common enterprise need: the controller sets a default, but one route opts out. getAllAndOverride checks the handler first, then falls back to the class.
Order matters: the array is searched left to right, so put the most specific target (the method handler) first.
canActivate(context: ExecutionContext): boolean {
const mode = this.reflector.getAllAndOverride<'strict' | 'optional'>(
TENANT_SCOPE,
[context.getHandler(), context.getClass()],
);
// method @TenantScope('optional') wins over class @TenantScope('strict')
return mode === 'optional' ? true : this.hasTenant(context);
}Composing Multiple Tags
Cross-cutting config often combines concerns: a feature flag and a tenant mode and an audit category. Use applyDecorators to bundle them into one expressive decorator.
This keeps controllers readable: one decorator communicates the full intent.
import { applyDecorators, SetMetadata } from '@nestjs/common';
import { FEATURE_FLAG } from './feature-flag.decorator';
import { TENANT_SCOPE } from './tenant-scope.decorator';
import { AUDIT_CATEGORY } from './audit.decorator';
export function EnterpriseModule(opts: {
flag: string;
tenant: 'strict' | 'optional';
audit: string;
}) {
return applyDecorators(
SetMetadata(FEATURE_FLAG, opts.flag),
SetMetadata(TENANT_SCOPE, opts.tenant),
SetMetadata(AUDIT_CATEGORY, opts.audit),
);
}
@EnterpriseModule({ flag: 'beta-checkout', tenant: 'strict', audit: 'orders' })
export class OrdersController {}Tagging Providers, Not Just Controllers
Class-level decorators are not limited to controllers. You can tag any provider class and read the metadata wherever you have the class reference, for example in a factory or a discovery service.
NestJS's DiscoveryService can enumerate all providers and inspect their metadata, which is how you build registries of tagged services.
import 'reflect-metadata';
const CACHE_TIER = 'cache:tier';
function CacheTier(tier: 'hot' | 'cold') {
return (target: Function) => Reflect.defineMetadata(CACHE_TIER, tier, target);
}
@CacheTier('hot')
class PricingService {}
@CacheTier('cold')
class ReportService {}
for (const svc of [PricingService, ReportService]) {
const tier = Reflect.getMetadata(CACHE_TIER, svc);
console.log(`${svc.name} -> ${tier}`);
}Wiring the Guard Globally
For cross-cutting config to take effect everywhere, register the consuming guard or interceptor once at the module level. The guard then inspects each request's target class.
A global guard plus class-level metadata means you configure behavior declaratively on each controller, with zero per-route wiring.
import { Module } from '@nestjs/common';
import { APP_GUARD } from '@nestjs/core';
import { FeatureFlagGuard } from './feature-flag.guard';
@Module({
providers: [
{ provide: APP_GUARD, useClass: FeatureFlagGuard },
],
})
export class AppModule {}Typing Metadata Keys Safely
Stringly-typed keys ('tenant:scope') are easy to mistype. Two safeguards used in enterprise codebases:
- Export the key as a
constfrom the decorator file so producer and consumer share one symbol. - Make the factory's argument a union type so invalid modes fail at compile time.
This turns config typos into TypeScript errors instead of silent runtime bugs.
type TenantMode = 'strict' | 'optional';
function validate(mode: TenantMode): TenantMode {
return mode;
}
console.log(validate('strict'));
// validate('loose') would be a compile-time error
console.log('Allowed modes: strict | optional');Quick Check
A controller is tagged @TenantScope('strict') at the class level, and one of its methods is tagged @TenantScope('optional'). Your guard must let that method opt out while keeping the strict default for the rest.
Recap
You learned how to drive cross-cutting config with class-level decorators:
- Author a decorator with
SetMetadata(orReflect.defineMetadata) wrapped in a typed factory. - Consume the tag with
Reflectorfromcontext.getClass()inside a guard or interceptor. - Override class defaults per-method using
getAllAndOverridewith the handler listed first. - Compose multiple concerns via
applyDecorators, and tag providers too, not just controllers. - Register the consumer globally with
APP_GUARDso the config applies declaratively across the app.
The result: feature flags and tenant scoping configured once per class, enforced everywhere.
AI 튜터와 함께 TypeScript을(를) 배우세요 — 무료
브라우저에서 실제 코드를 작성하고 실행하며, 24/7 AI 튜터로부터 즉각적인 도움을 받고, 웹이나 앱에서 중단한 부분부터 계속 학습하세요.
- 코스
- 20
- 레슨
- 76
자주 묻는 질문
“공통 설정을 위한 클래스 수준 데코레이터” 강의는 무료인가요?
네 — “공통 설정을 위한 클래스 수준 데코레이터” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 NestJS Enterprise Backend APIs 강의 전체를 잠금 해제할 수 있습니다. NestJS Enterprise Backend APIs 강의에는 총 4개의 강의가 포함되어 있습니다.
“공통 설정을 위한 클래스 수준 데코레이터”에서 뭘 배우나요?
사용자 지정 클래스 데코레이터로 컨트롤러와 프로바이더에 태그를 지정해 기능 플래그와 테넌트 범위를 제어합니다 브라우저에서 직접 실행하는 실습 코드로 NestJS Enterprise Backend APIs을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.
NestJS Enterprise Backend APIs을(를) 시작하는 데 경험이 필요한가요?
사전 경험은 필요하지 않습니다. CoddyKit의 NestJS Enterprise Backend APIs은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 4개 중 4번째 강의입니다.
“공통 설정을 위한 클래스 수준 데코레이터” 강의는 얼마나 걸리나요?
대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.
이 NestJS Enterprise Backend APIs 강의에서 코드를 작성하고 실행할 수 있나요?
네. 모든 NestJS Enterprise Backend APIs 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.
이 강의의 모든 강의
- 매개변수 데코레이터로 요청 컨텍스트 읽기
- SetMetadata와 Reflector로 메타데이터 연결하기
- applyDecorators로 데코레이터 조합하기
- 공통 설정을 위한 클래스 수준 데코레이터