Node.js에서 견고한 백엔드 시스템을 위한 타사 API 적응

소개

현대 백엔드 개발에서 수많은 타사 서비스와의 통합은 더 이상 예외가 아니라 규칙입니다. 결제 게이트웨이, CRM, 이메일 서비스 또는 외부 데이터 공급자든 관계없이 Node.js 애플리케이션은 다양한 외부 API에서 데이터를 소비하고 처리하는 오케스트레이터 역할을 자주 수행합니다. 이 의존성은 강력하지만 상당한 과제를 제기합니다. 이러한 외부 서비스에 대한 의존성을 어떻게 우아하게 처리할 수 있을까요? API가 변경될 수 있고, 클라이언트가 일관되지 않을 수 있으며, 심지어 제공업체를 완전히 전환하기로 결정할 수도 있습니다. 타사 API 클라이언트 코드를 애플리케이션 전체에 직접 포함하면 깨지기 쉽고 유지 관리하기 어려운 긴밀하게 결합된 시스템으로 이어질 수 있습니다. 이 글에서는 고전적인 소프트웨어 디자인 패턴인 어댑터 패턴이 이 문제에 대한 우아한 솔루션을 어떻게 제공하여 Node.js 백엔드에서 타사 API 클라이언트를 캡슐화하고 쉽게 교체할 수 있는지 살펴보겠습니다.

핵심 개념

구현에 들어가기 전에 논의의 기초가 되는 핵심 개념을 간략하게 정의해 보겠습니다.

• 타사 API 클라이언트: 외부 서비스(예: Stripe의 Node.js SDK, Twilio의 헬퍼 라이브러리)에서 제공하여 해당 API와의 상호 작용을 단순화하는 SDK 또는 라이브러리를 말합니다.
• 어댑터 패턴: 인터페이스가 호환되지 않는 객체가 협업할 수 있도록 하는 구조적 디자인 패턴입니다. 래퍼 역할을 하여 클래스의 인터페이스를 클라이언트가 예상하는 다른 인터페이스로 변환합니다.
• 대상 인터페이스(또는 계약): 애플리케이션의 비즈니스 논리가 서비스 제공자로부터 예상하는 인터페이스입니다. 애플리케이션에 필요한 메서드와 데이터 구조를 정의합니다.
• Adaptee (적응 대상): 인터페이스를 조정해야 하는 기존 클래스 또는 객체(이 경우 타사 API 클라이언트)입니다.
• Adapter (어댑터): 대상 인터페이스를 구현하고 Adaptee를 래핑하여 대상 인터페이스에서 Adaptee의 인터페이스로의 호출을 번역하는 클래스입니다.

어댑터 패턴은 비즈니스 논리를 타사 구현의 세부 사항과 분리하는 데 도움이 되므로 시스템을 외부 변경 사항에 더 탄력적으로 만들고 향후 통합에 대한 더 큰 유연성을 제공합니다.

실제 어댑터 패턴

실제 시나리오를 고려해 보겠습니다. Node.js 백엔드에서 다양한 유형의 알림(이메일, SMS)을 보내야 합니다. 처음에는 SMS에 Twilio, 이메일에 SendGrid를 사용하기로 결정했습니다. 나중에는 Vonage와 같은 다른 SMS 제공업체나 Mailgun과 같은 다른 이메일 제공업체로 전환하고 싶을 수 있습니다. 이 경우 핵심 애플리케이션 로직을 변경하지 않고 전환할 수 있습니다.

1. 대상 인터페이스 정의

먼저 애플리케이션이 모든 알림 서비스에서 예상하는 일반 인터페이스(또는 계약)를 정의합니다. JavaScript에서는 공유 메서드 서명을 통해 인터페이스를 암시적으로 표현하거나 TypeScript를 사용하여 명시적으로 표현하는 경우가 많습니다. 일반 JavaScript의 단순성을 위해 개념적 인터페이스를 정의합니다.

// interfaces/INotificationService.js
// 이것은 애플리케이션이 모든 알림 서비스에서 예상하는 계약을 나타냅니다.
class INotificationService {
    async sendSMS(toNumber, message) {
        throw new Error('Method "sendSMS" must be implemented.');
    }

    async sendEmail(toEmail, subject, body) {
        throw new Error('Method "sendEmail" must be implemented.');
    }
}

module.exports = INotificationService;

2. 타사 클라이언트에 대한 어댑터 구현

이제 선택한 타사 서비스(Twilio 및 SendGrid)에 대해 INotificationService 인터페이스를 준수하는 어댑터를 만듭니다.

Twilio SMS 어댑터

// adapters/TwilioSMSAdapter.js
const twilio = require('twilio');
const INotificationService = require('../interfaces/INotificationService');

class TwilioSMSAdapter extends INotificationService {
    constructor(accountSid, authToken, fromNumber) {
        super();
        this.client = twilio(accountSid, authToken);
        this.fromNumber = fromNumber;
    }

    async sendSMS(toNumber, message) {
        console.log(`Sending SMS via Twilio to ${toNumber}: ${message}`);
        try {
            const result = await this.client.messages.create({
                body: message,
                to: toNumber,
                from: this.fromNumber,
            });
            console.log('Twilio SMS sent successfully:', result.sid);
            return result;
        } catch (error) {
            console.error('Error sending SMS via Twilio:', error);
            throw new Error(`Failed to send SMS via Twilio: ${error.message}`);
        }
    }

    // Twilio가 직접 지원하지 않더라도 인터페이스를 충족시키기 위해 이메일도 구현합니다.
    // 오류를 throw하거나 특정 상태를 반환할 수 있습니다.
    async sendEmail(toEmail, subject, body) {
        throw new Error('TwilioSMSAdapter does not support email functionality.');
    }
}

module.exports = TwilioSMSAdapter;

SendGrid 이메일 어댑터

// adapters/SendGridEmailAdapter.js
const sgMail = require('@sendgrid/mail');
const INotificationService = require('../interfaces/INotificationService');

class SendGridEmailAdapter extends INotificationService {
    constructor(apiKey, fromEmail) {
        super();
        sgMail.setApiKey(apiKey);
        this.fromEmail = fromEmail;
    }

    // 인터페이스를 충족시키기 위해 SMS도 구현합니다.
    async sendSMS(toNumber, message) {
        throw new Error('SendGridEmailAdapter does not support SMS functionality.');
    }

    async sendEmail(toEmail, subject, body) {
        console.log(`Sending Email via SendGrid to ${toEmail} - Subject: ${subject}`);
        const msg = {
            to: toEmail,
            from: this.fromEmail,
            subject: subject,
            html: body,
        };
        try {
            await sgMail.send(msg);
            console.log('SendGrid Email sent successfully.');
            return { success: true };
        } catch (error) {
            console.error('Error sending email via SendGrid:', error);
            if (error.response) {
                console.error(error.response.body);
            }
            throw new Error(`Failed to send email via SendGrid: ${error.message}`);
        }
    }
}

module.exports = SendGridEmailAdapter;

3. 애플리케이션에서 서비스 사용

이제 애플리케이션 코드는 타사 구현의 내부를 완전히 알지 못한 채 INotificationService 인터페이스와만 상호 작용합니다. 런타임에 적절한 어댑터를 주입할 수 있습니다.

// services/NotificationService.js
// 이 서비스는 INotificationService 인터페이스를 사용합니다.
class ApplicationNotificationService {
    constructor(smsService, emailService) {
        // smsService 및 emailService는 INotificationService의 인스턴스입니다.
        if (!(smsService instanceof require('../interfaces/INotificationService'))) {
            throw new Error('smsService must implement INotificationService');
        }
        if (!(emailService instanceof require('../interfaces/INotificationService'))) {
            throw new Error('emailService must implement INotificationService');
        }
        this.smsService = smsService;
        this.emailService = emailService;
    }

    async sendUserWelcomeNotification(user) {
        // 환영 SMS 보내기
        await this.smsService.sendSMS(
            user.phoneNumber,
            `Welcome, ${user.name}! Thanks for joining our service.`
        );

        // 환영 이메일 보내기
        await this.emailService.sendEmail(
            user.email,
            'Welcome Aboard!',
            `<h1>Hello ${user.name},</h1><p>We're thrilled to have you!</p>`
        );

        console.log(`Welcome notifications sent to ${user.name}`);
    }
}

module.exports = ApplicationNotificationService;

4. 연결(의존성 주입)

주요 애플리케이션 파일 또는 의존성 주입 컨테이너를 통해 특정 어댑터를 인스턴스화하고 ApplicationNotificationService에 주입합니다.

// app.js 또는 메인 진입점
require('dotenv').config(); // 환경 변수 로드

const TwilioSMSAdapter = require('./adapters/TwilioSMSAdapter');
const SendGridEmailAdapter = require('./adapters/SendGridEmailAdapter');
const ApplicationNotificationService = require('./services/NotificationService');

// 환경별 자격 증명으로 어댑터 인스턴스화
const twilioAdapter = new TwilioSMSAdapter(
    process.env.TWILIO_ACCOUNT_SID,
    process.env.TWILIO_AUTH_TOKEN,
    process.env.TWILIO_FROM_PHONE_NUMBER
);

const sendgridAdapter = new SendGridEmailAdapter(
    process.env.SENDGRID_API_KEY,
    process.env.SENDGRID_FROM_EMAIL
);

// 애플리케이션의 알림 서비스에 어댑터 주입
const appNotificationService = new ApplicationNotificationService(
    twilioAdapter,
    sendgridAdapter
);

// 예시 사용법:
async function main() {
    const user = {
        name: 'John Doe',
        email: 'john.doe@example.com',
        phoneNumber: '+15551234567' // 유효한 테스트 번호로 바꾸십시오.
    };

    try {
        await appNotificationService.sendUserWelcomeNotification(user);
        console.log('Notification process completed.');
    } catch (error) {
        console.error('Failed to send welcome notifications:', error);
    }
}

main();

// 스와핑 시연:
// SMS에 Vonage를 사용하기로 전환한다고 가정합니다.
// INotificationService를 준수하는 새로운 VonageSMSAdapter를 만듭니다.
// 그리고 TwilioSMSAdapter 대신 여기에 주입합니다. ApplicationNotificationService를 변경하지 않고도 가능합니다.

// const VonageSMSAdapter = require('./adapters/VonageSMSAdapter');
// const vonageAdapter = new VonageSMSAdapter(...);
// const appNotificationServiceWithVonage = new ApplicationNotificationService(
//     vonageAdapter,
//     sendgridAdapter
// );
// appNotificationServiceWithVonage.sendUserWelcomeNotification(user); // 동일한 호출, 다른 내부 SMS 제공업체

애플리케이션 시나리오

어댑터 패턴은 Node.js 백엔드에서 다음과 같은 경우에 특히 유용합니다.

• 결제 게이트웨이: Stripe, PayPal, Square 등 통합 인터페이스 표준화.
• 클라우드 스토리지: S3, Google Cloud Storage, Azure Blob Storage에 대한 통합 API 제공.
• CRM 통합: Salesforce, HubSpot 또는 맞춤형 CRM API 추상화.
• 마이크로서비스 통신: 다른 통신 프로토콜(REST, gRPC)을 공통 내부 인터페이스로 조정.
• 레거시 시스템 통합: 오래되고 복잡한 API를 현대적이고 깔끔한 인터페이스로 래핑.

결론

어댑터 패턴은 Node.js 백엔드 애플리케이션에서 타사 API 종속성을 관리하기 위한 강력하고 우아한 솔루션을 제공합니다. 명확한 대상 인터페이스를 설정하고 이를 준수하는 어댑터를 생성함으로써 외부 서비스의 복잡성과 잠재적 변동성으로부터 핵심 비즈니스 로직을 효과적으로 분리합니다. 이 접근 방식은 유지보수성, 테스트 용이성 및 유연성을 크게 향상시켜 코드베이스에 미치는 영향을 최소화하면서 타사 서비스 제공업체를 원활하게 교체하거나 업그레이드할 수 있습니다. 어댑터 패턴을 채택하는 것은 더 견고하고 미래 지향적인 백엔드 시스템을 구축하기 위한 투자입니다.