Node.js 및 TypeScript에서 Symbols를 활용한 서비스 레지스트리 및 의존성 주입을 위한 고유 키

소개

현대 소프트웨어 개발, 특히 대규모 애플리케이션에서는 서비스를 효과적으로 관리하고 종속성을 관리하는 것이 매우 중요합니다. Node.js 애플리케이션이 복잡해짐에 따라 다양한 서비스를 등록하고 검색하기 위한 중앙 집중식 메커니즘이 필요하게 되는 경우가 많습니다. 이 패턴은 일반적으로 서비스 레지스트리 또는 제어 역전(IoC) 컨테이너로 알려져 있으며, 종종 의존성 주입(DI)을 통해 구현됩니다. 이러한 시스템에서 일반적인 과제는 등록된 각 서비스가 정말 고유한 식별자를 갖도록 하는 것입니다. 이러한 키에 간단한 문자열을 사용하면 특히 대규모 팀이나 타사 모듈을 통합할 때 이름 충돌이 발생할 수 있습니다. 이 글에서는 JavaScript Symbols와 TypeScript를 결합하여 이 문제에 대한 우아하고 강력한 솔루션을 제공하고 서비스 레지스트리 및 DI 컨테이너에 대한 진정한 고유 키를 제공하는 방법을 살펴봅니다. 이점과 실제 구현을 살펴보고 Symbols가 Node.js 애플리케이션의 안정성과 유지 관리성을 얼마나 향상시키는지 시연할 것입니다.

Symbols 및 TypeScript를 사용한 강력한 서비스 레지스트리 구현

실제 예시를 통해 설명해 보겠습니다. 간단한 서비스 레지스트리를 구축할 것입니다.

먼저 샘플 서비스를 정의해 보겠습니다.

// services/logger.ts
export interface ILogger {
  log(message: string): void;
  warn(message: string): void;
  error(message: string): void;
}

export class ConsoleLogger implements ILogger {
  log(message: string): void {
    console.log(`[INFO] ${message}`);
  }
  warn(message: string): void {
    console.warn(`[WARN] ${message}`);
  }
  error(message: string): void {
    console.error(`[ERROR] ${message}`);
  }
}

// services/config.ts
export interface IConfigService {
  get(key: string): string | undefined;
}

export class EnvConfigService implements IConfigService {
  private config: Map<string, string>;

  constructor() {
    this.config = new Map(Object.entries(process.env));
  }

  get(key: string): string | undefined {
    return this.config.get(key);
  }
}

이제 고유 Symbol 키와 서비스 레지스트리 자체를 정의해 보겠습니다.

// core/service-identifiers.ts
// 여기서는 Symbol.for()를 사용하여 공유 Symbol을 생성합니다.
// Symbol()을 사용하면 호출할 때마다 새로운 고유 Symbol이 생성됩니다.
// Symbol.for()를 사용하면 Symbol 레지스트리에서 전역 Symbol을 가져올 수 있습니다.
// 다른 파일/모듈에서 동일한 식별자로 서비스를 검색하는 데 중요합니다.

export const LOGGER_SERVICE = Symbol.for('LoggerService');
export const CONFIG_SERVICE = Symbol.for('ConfigService');

// 서비스 레지스트리 항목에 대한 타입 정의
export type ServiceEntry<T> = new (...args: any[]) => T | T;

다음은 서비스 레지스트리 구현입니다.

// core/service-registry.ts
import { ServiceEntry } from './service-identifiers';

export class ServiceRegistry {
  private services = new Map<symbol, ServiceEntry<any> | any>();
  private instances = new Map<symbol, any>();

  public register<T>(identifier: symbol, service: ServiceEntry<T> | T, singleton: boolean = true): void {
    if (this.services.has(identifier)) {
      console.warn(`Service with identifier ${identifier.description} already registered. Overwriting.`);
    }
    this.services.set(identifier, service);
    // 싱글톤이 아닌 인스턴스인 경우 'instances'에 초기화하지 않습니다.
    // 'get'이 호출될 때마다 싱글톤이 아닌 경우 새 인스턴스를 생성합니다.
    // 단순성을 위해 이 예제는 등록된 모든 항목을 싱글톤이거나
    // 직접 제공된 인스턴스로 취급합니다. 전체 DI 컨테이너의 일반적인 다음 단계는
    // 팩토리 함수나 임시 서비스에 대한 이 확장을 포함하는 것입니다.
  }

  public get<T>(identifier: symbol): T {
    if (!this.services.has(identifier)) {
      throw new Error(`Service with identifier ${identifier.description} not found.`);
    }

    // 싱글톤에 대한 지연 인스턴스화
    if (!this.instances.has(identifier)) {
      const serviceEntry = this.services.get(identifier);
      if (typeof serviceEntry === 'function') { // 생성자임
        const instance = new (serviceEntry as new (...args: any[]) => T)();
        this.instances.set(identifier, instance);
      } else { // 이미 제공된 인스턴스임
        this.instances.set(identifier, serviceEntry);
      }
    }
    return this.instances.get(identifier) as T;
  }
}

// 레지스트리의 싱글톤 인스턴스
export const registry = new ServiceRegistry();

마지막으로 레지스트리를 사용해 보겠습니다.

// app.ts
import { registry } from './core/service-registry';
import { ConsoleLogger, ILogger } from './services/logger';
import { EnvConfigService, IConfigService } from './services/config';
import { LOGGER_SERVICE, CONFIG_SERVICE } from './core/service-identifiers';

// 서비스 등록
registry.register<ILogger>(LOGGER_SERVICE, ConsoleLogger);
registry.register<IConfigService>(CONFIG_SERVICE, EnvConfigService);

// 이제 이러한 서비스에 종속되는 클래스를 만들어 보겠습니다.
class Application {
  private logger: ILogger;
  private configService: IConfigService;

  constructor() {
    this.logger = registry.get<ILogger>(LOGGER_SERVICE);
    this.configService = registry.get<IConfigService>(CONFIG_SERVICE);
  }

  public start(): void {
    this.logger.log('Application started!');
    const appPort = this.configService.get('PORT') || '3000';
    this.logger.log(`Server listening on port: ${appPort}`);
    this.logger.warn('This is a warning message.');
    this.logger.error('This is an error message, perhaps something went wrong.');
  }
}

const app = new Application();
app.start();

// 충돌이 회피되는 방법의 예시:
// 다른 모듈이 실수로 상수를 정의한다고 상상해 보세요:
// const FAKE_LOGGER_SERVICE = 'LoggerService';
// registry.register(FAKE_LOGGER_SERVICE, new SomeOtherLogger());
// 를 사용하여 등록하려고 한 다음 registry.get<ILogger>('LoggerService')로 검색하려고 하면
// 잘못된 로거를 받게 됩니다.
// Symbols를 사용하면 LOGGER_SERVICE는 고유하며 FAKE_LOGGER_SERVICE는 문자열이므로
// 충돌 또는 우발적인 검색을 방지합니다.

이 설정에서:

고유 식별자: LOGGER_SERVICE 및 CONFIG_SERVICE는 Symbol.for() 값입니다. 이는 애플리케이션 전체에서 일관되게 참조할 수 있는 진정한 고유성을 보장합니다.
타입 안전성: TypeScript는 서비스를 register하거나 get할 때 올바른 타입(ILogger 또는 IConfigService)을 제공하고 받는 것을 보장합니다.
충돌 방지: 애플리케이션의 다른 부분이 문자열 'LoggerService'를 정의하더라도 Symbol 기반 LOGGER_SERVICE와 충돌하지 않습니다. 이렇게 하면 이름 충돌로부터 레지스트리가 보호됩니다.
디커플링: Application 클래스는 ConsoleLogger 또는 EnvConfigService를 직접 인스턴스화하지 않습니다. 대신 ServiceRegistry에서 요청하므로 느슨한 결합을 촉진합니다.

결론

Node.js 애플리케이션에서 서비스 레지스트리 및 의존성 주입을 위한 고유 키로 JavaScript Symbols을 사용하고, 특히 TypeScript의 타입 안전성과 결합할 때 일반적인 아키텍처 문제에 대한 강력하고 우아한 솔루션을 제공합니다. 이는 식별자의 진정한 고유성을 보장하고, 이름 충돌을 방지하며, 코드베이스의 전반적인 견고성과 유지 관리성을 향상시킵니다. 이 기본 유형을 활용함으로써 개발자는 서비스 해결이 명시적이고 예상치 못한 간섭이 없는 보다 안정적이고 확장 가능한 시스템을 구축할 수 있습니다. Symbols는 애플리케이션 아키텍처가 받을 자격이 있는 완벽한 키를 제공합니다.

Node.js 및 TypeScript에서 Symbols를 활용한 서비스 레지스트리 및 의존성 주입을 위한 고유 키

소개

최신 JavaScript에서 고유 식별자 살펴보기

Symbols 및 TypeScript를 사용한 강력한 서비스 레지스트리 구현

결론

Share this article

More Posts from Leapcell

Popular Posts