40.Nest.js와 Next.js에서 웹소켓 활용하기, 실시간 댓글 기능 구현을 위한 웹소켓 설정

현대 웹 애플리케이션에서 실시간 기능을 제공하는 것은 점점 더 중요해지고 있습니다. 실시간 댓글 기능은 사용자 참여를 증가시키고, 웹사이트의 상호작용을 향상시키는 좋은 예입니다. 오늘은 Nest.js와 Next.js를 활용하여 웹소켓을 설정하고, 이를 바탕으로 실시간 댓글 기능을 구현하는 방법을 살펴보겠습니다.

1. 웹소켓이란?

웹소켓(WebSocket)은 서버와 클라이언트 간의 전이중 통신을 가능하게 하는 프로토콜입니다. HTTP 프로토콜과는 달리, 웹소켓은 클라이언트와 서버 간의 지속적인 연결을 유지하며, 양방향으로 데이터를 실시간으로 주고받을 수 있도록 해줍니다. 이러한 특성 덕분에 특히 채팅, 실시간 알림 등 다양한 애플리케이션에서 활용되고 있습니다.

웹소켓의 장점

  • 빠른 데이터 전송: HTTP 요청-응답 방식에 비해 각 요청마다 새로운 연결을 맺지 않기 때문에 지연 시간이 적습니다.
  • 양방향 통신: 서버에서 클라이언트로, 클라이언트에서 서버로 데이터를 자유롭게 전송할 수 있습니다.
  • 실시간 데이터 업데이트: 연결이 유지되는 동안 실시간으로 데이터를 수신할 수 있습니다.

2. Nest.js와 Next.js 소개

Nest.js

Nest.js는 Node.js의 프레임워크로, 서버 사이드 애플리케이션을 구축할 때 주로 사용됩니다. TypeScript로 작성되어 있으며, 모듈화된 구조와 다양한 기능을 제공합니다. 웹소켓을 사용하여 실시간 기능을 쉽게 구현할 수 있는 @nestjs/websockets 모듈이 기본 제공됩니다.

Next.js

Next.js는 리액트 기반의 프레임워크로, SSR(서버 사이드 렌더링)과 SSG(정적 사이트 생성)를 지원하여 SEO에 유리한 웹 애플리케이션을 만들 수 있습니다. 또한, 클라이언트 측에서 웹소켓을 사용하여 실시간 기능을 쉽게 통합할 수 있습니다.

3. 개발 환경 설정

실시간 댓글 기능을 구현하기 위해, Nest.js와 Next.js 프로젝트를 설정해야 합니다. 이 예제에서는 Nest.js를 백엔드로, Next.js를 프론트엔드로 사용합니다.

3.1 Nest.js 설치 및 설정

npm install -g @nestjs/cli
nest new nest-websocket

프로젝트가 생성되면, 아키텍처를 고려하여 필요한 모듈들을 추가합니다. 웹소켓을 사용하기 위해 @nestjs/websockets 패키지를 설치합니다.

npm install @nestjs/websockets @nestjs/platform-socket.io socket.io

3.2 Next.js 설치 및 설정

npx create-next-app next-websocket

Next.js 프로젝트가 생성되면, 클라이언트 측에서 웹소켓 기능을 사용할 수 있도록 socket.io-client를 설치합니다.

npm install socket.io-client

4. Nest.js에서 웹소켓 설정하기

Nest.js에서 웹소켓을 사용하려면 간단한 설정이 필요합니다. 우선, 웹소켓의 게이트웨이를 생성해야 합니다. 이를 통해 클라이언트와의 소통을 관리합니다.

4.1 웹소켓 게이트웨이 생성

import { WebSocketGateway, SubscribeMessage, MessageBody } from '@nestjs/websockets';
import { WebSocketServer } from 'socket.io';
import { Namespace } from 'socket.io';

@WebSocketGateway()
export class CommentsGateway {
    @WebSocketServer() server: Namespace;

    @SubscribeMessage('sendComment')
    handleComment(@MessageBody() comment: string): void {
        this.server.emit('newComment', comment);
    }
}

위의 코드에서는 @WebSocketGateway() 데코레이터를 사용하여 웹소켓 게이트웨이를 설정합니다. handleComment 메소드는 클라이언트로부터 댓글을 수신하고, 이를 모든 사용자에게 전송합니다.

4.2 모듈에 게이트웨이 등록

import { Module } from '@nestjs/common';
import { CommentsGateway } from './comments.gateway';

@Module({
    providers: [CommentsGateway],
})
export class AppModule {}

5. Next.js에서 웹소켓 연결하기

Next.js에서는 웹소켓 클라이언트를 설정하여, 백엔드와의 연결을 생성합니다.

5.1 웹소켓 클라이언트 설정

import { useEffect, useState } from 'react';
import io from 'socket.io-client';

const socket = io('http://localhost:3000');

const Comments = () => {
    const [comments, setComments] = useState([]);
    const [comment, setComment] = useState('');

    useEffect(() => {
        socket.on('newComment', (newComment) => {
            setComments((prev) => [...prev, newComment]);
        });

        return () => {
            socket.off('newComment');
        };
    }, []);

    const sendComment = () => {
        socket.emit('sendComment', comment);
        setComment('');
    };

    return (
        

실시간 댓글

{comments.map((c, index) => (
{c}
))}
setComment(e.target.value)} placeholder="댓글을 입력하세요." />
); }; export default Comments;

6. 전체 애플리케이션 통합

이제 Nest.js와 Next.js를 통합하여 실시간 댓글 기능을 구현할 수 있습니다. 두 부분을 연결하여 사용자에게 실시간으로 댓글을 전송하고 받을 수 있도록 설정합니다.

6.1 CORS 설정

크로스 오리진 요청을 허용하기 위해 Nest.js에서 CORS를 설정해야 합니다.

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
    const app = await NestFactory.create(AppModule);
    app.enableCors({
        origin: 'http://localhost:3000',
        credentials: true,
    });
    await app.listen(3001);
}
bootstrap();

6.2 Next.js 앱 실행

Next.js 앱을 실행합니다.

npm run dev

7. 결론

이번 강좌를 통해 Nest.js와 Next.js를 활용하여 실시간 댓글 기능을 웹소켓으로 구현하는 방법을 배웠습니다. 웹소켓을 이용한 실시간 통신은 사용자 경험을 향상시키며, 상호작용을 더 매끄럽게 만들어 줍니다. Nest.js는 강력한 백엔드 프레임워크로, Next.js는 유연한 프론트엔드 프레임워크로, 함께 사용할 때 큰 시너지를 발휘할 수 있습니다.

향후 개선 및 확장

이 기본 댓글 시스템에 다음과 같은 기능들을 추가하여 확장할 수 있습니다:

  • 댓글 삭제 및 수정 기능
  • 채팅방 기능 추가
  • 인증 및 권한 관리
  • 서버가 다운됐을 때 복구 기능

여기까지 읽어주셔서 감사합니다. 이 강좌가 Nest.js와 Next.js를 활용한 웹소켓 기반 애플리케이션 개발에 도움이 되었기를 바랍니다.

16.Next.js와 Nest.js로 사용자 인증 구현하기, JWT(Json Web Token)를 활용한 사용자 인증 시스템

웹 애플리케이션에서 사용자 인증은 매우 중요한 요소입니다. 이 글에서는 Next.jsNest.js를 사용하여 JWT(Json Web Token)를 활용한 사용자 인증 시스템을 구현하는 방법에 대해 자세히 설명합니다.

목차

1. 사용자 인증이란?

사용자 인증은 사용자가 누구인지 확인하는 프로세스입니다. 일반적으로 로그인 및 로그아웃 기능을 통해 사용자의 신원을 확인합니다. 이 과정은 애플리케이션의 보안성을 높이는 중요한 요소입니다. 인증에는 서버와 클라이언트 간에 정보를 교환하는 여러 가지 방법이 있으며, 가장 널리 사용되는 방법 중 하나는 JWT(Json Web Token)를 사용하는 것입니다.

2. JWT란?

JWT는 JSON 객체를 안전하게 전송하기 위한 개방형 표준입니다. JWT는 세 부분으로 구성된 문자열로, 각각 헤더(Header), 페이로드(Payload), 서명(Signature)로 나뉩니다.

  • 헤더(Header): 토큰의 유형과 해싱 알고리즘을 지정합니다.
  • 페이로드(Payload): 사용자의 정보와 권한을 포함하는 데이터입니다.
  • 서명(Signature): 헤더와 페이로드의 정보를 기반으로 생성된 해시 값으로, 토큰의 무결성을 확인합니다.

JWT의 주요 장점은 클라이언트 측에서 정보를 저장하고 이를 검증할 수 있는 점입니다. 또한 상태 비저장(stateless) 방식으로 서버의 부담을 최소화할 수 있습니다.

3. 환경 설정

이 프로젝트를 진행하기 위해서는 Node.js와 npm(Node Package Manager)이 필요합니다. 다음 링크에서 이를 설치할 수 있습니다: Node.js 공식 웹사이트

4. Nest.js 프로젝트 설정

Nest.js는 프레임워크를 통해 서버 사이드 애플리케이션을 구축하기 위한 강력한 도구입니다. 다음은 Nest.js 프로젝트를 설정하는 방법입니다.

npm install -g @nestjs/cli
nest new auth-example
cd auth-example
npm install @nestjs/jwt passport-jwt passport bcryptjs class-validator class-transformer

위 명령을 사용하여 Nest.js 프로젝트를 생성하고 필요한 라이브러리를 설치합니다.

4.1. 모듈 생성

인증 기능을 위한 모듈을 생성합니다. 다음 명령어를 사용합니다.

nest g module auth
nest g service auth
nest g controller auth

이 명령어는 auth 모듈, 서비스, 및 컨트롤러를 각각 생성합니다.

4.2. AuthService 구현

AuthService는 사용자의 등록 및 로그인을 처리하는 서비스입니다. 아래와 같이 auth.service.ts 파일을 수정합니다.

import { Injectable } from '@nestjs/common';
import { JwtService } from '@nestjs/jwt';
import { User } from 'src/user/user.entity'; // 예시를 위한 User 모델
import * as bcrypt from 'bcryptjs';

@Injectable()
export class AuthService {
    constructor(private jwtService: JwtService) {}

    async register(userData: any): Promise {
        const hashedPassword = await bcrypt.hash(userData.password, 10);
        const user = new User();  // 사용자를 DB에 저장하는 로직 필요
        user.username = userData.username;
        user.password = hashedPassword;
        // save user to DB logic
        return user;
    }

    async validateUser(username: string, password: string): Promise {
        const user = await this.findUserByUsername(username); // 사용자를 DB에서 찾는 로직 필요
        if (user && await bcrypt.compare(password, user.password)) {
            return user;
        }
        return null;
    }

    async login(user: any) {
        const payload = { username: user.username, sub: user.userId };
        return {
            access_token: this.jwtService.sign(payload),
        };
    }
}

4.3. AuthController 구현

인증 관련 HTTP 요청을 처리하는 AuthController 를 구현합니다.

import { Controller, Post, Request, UseGuards } from '@nestjs/common';
import { AuthService } from './auth.service';
import { LocalAuthGuard } from './local-auth.guard'; // 로컬 인증 가드

@Controller('auth')
export class AuthController {
    constructor(private readonly authService: AuthService) {}

    @Post('register')
    async register(@Request() req) {
        return this.authService.register(req.body);
    }

    @UseGuards(LocalAuthGuard)
    @Post('login')
    async login(@Request() req) {
        return this.authService.login(req.user);
    }
}

4.4. JWT 설정

JWT를 사용할 수 있도록 설정합니다.

import { Module } from '@nestjs/common';
import { JwtModule } from '@nestjs/jwt';
import { AuthService } from './auth.service';
import { AuthController } from './auth.controller';

@Module({
    imports: [
        JwtModule.register({
            secret: 'secretKey', // 환경변수로 분리할 것
            signOptions: { expiresIn: '60s' }, // 토큰 만료 시간
        }),
    ],
    controllers: [AuthController],
    providers: [AuthService],
})
export class AuthModule {}

5. Next.js 프로젝트 설정

Next.js는 React 기반으로 서버 사이드 렌더링을 지원하는 프레임워크입니다. 다음은 Next.js 프로젝트를 설정하는 방법입니다.

npx create-next-app next-auth-example
cd next-auth-example
npm install axios js-cookie

5.1. 로그인 페이지 생성

Next.js 프로젝트에 로그인 기능을 추가합니다. pages/login.js 파일을 만들고 아래와 같이 수정합니다.

import { useState } from 'react';
import axios from 'axios';
import Cookies from 'js-cookie';

const Login = () => {
    const [username, setUsername] = useState('');
    const [password, setPassword] = useState('');

    const handleLogin = async () => {
        try {
            const response = await axios.post('http://localhost:3000/auth/login', { username, password });
            Cookies.set('token', response.data.access_token);
            alert('로그인 성공');
        } catch (error) {
            alert('로그인 실패');
        }
    };

    return (
        

로그인

setUsername(e.target.value)} placeholder="사용자명" /> setPassword(e.target.value)} placeholder="비밀번호" />
); }; export default Login;

5.2. 사용자 인증 상태 관리

사용자 인증 상태를 관리하고, 인증이 필요한 페이지를 보호하는 방법을 살펴보겠습니다.

import { useEffect } from 'react';
import Router from 'next/router';
import Cookies from 'js-cookie';

const withAuth = (WrappedComponent) => {
    return (props) => {
        useEffect(() => {
            const token = Cookies.get('token');
            if (!token) {
                Router.push('/login');
            }
        }, []);

        return ;
    };
};

export default withAuth;

이렇게 구현하면 인증되지 않은 사용자가 특정 페이지에 접근할 때 로그인 페이지로 리디렉션됩니다.

6. 인증 구현

지금까지 설정한 내용을 바탕으로 전체적인 인증 흐름을 요약합니다. 사용자가 로그인 요청을 보내면 Nest.js의 AuthService가 해당 요청을 처리하게 됩니다. 사용자가 존재하고 비밀번호가 올바르게 입력되면 JWT 토큰을 발급받고, 이를 클라이언트는 쿠키에 저장합니다. 이후 요청은 이 토큰을 사용하여 인증된 사용자로서 처리됩니다.

이와 같이 Next.js와 Nest.js를 활용하면 효율적이고 안전한 사용자 인증 시스템을 구축할 수 있습니다.

7. 결론

본 글에서는 Next.js와 Nest.js를 이용하여 JWT 기반의 사용자 인증 시스템을 구현하는 방법에 대해 살펴보았습니다. 이러한 방법을 통해 현대의 웹 애플리케이션에서 필수적인 사용자 관리와 보안 기능을 효과적으로 개발할 수 있습니다. 앞으로 더 나아가 다양한 인증 방식 및 보안 관련 기능들도 고려해 보는 것이 좋습니다.

이 글이 여러분의 웹 개발 여정에 도움이 되기를 바랍니다. 질문이 있으시면 댓글로 남겨주세요!

20.Nest.js와 Next.js에서 Middleware와 Guard 사용하기, Next.js에서 API 요청 시 미들웨어 적용하기

현대 웹 애플리케이션은 성능과 보안을 우선시하며, 이를 달성하기 위해 다양한 기술 스택과 구조를 사용합니다. 특히 Nest.jsNext.js는 이러한 요구 사항을 충족시키기 위해 인기 있는 프레임워크입니다. 본 글에서는 Nest.js와 Next.js에서 미들웨어와 가드를 사용하는 방법에 대해 자세히 설명하고, Next.js에서 API 요청 시 미들웨어를 적용하는 과정을 살펴보도록 하겠습니다.

1. Nest.js의 Middleware 이해하기

Nest.js는 Node.js 기반의 프레임워크로, TypeScript로 작성된 애플리케이션을 개발하는 데 유용하며, 미들웨어를 통해 요청-응답 사이클을 제어할 수 있습니다. 미들웨어는 프레임워크의 요청과 응답이 처리되는 과정에서 특정 로직을 실행할 수 있도록 해줍니다.

1.1 Middleware의 작동 원리

미들웨어는 주로 다음과 같은 기능을 수행합니다:

  • 요청 데이터의 변환
  • 인증 및 권한 검사
  • 로깅
  • 오류 처리

1.2 Nest.js에서 Middleware 구현하기

Nest.js에서 미들웨어를 구현하기 위한 기본적인 코드 예시는 다음과 같습니다.

import { Injectable, NestMiddleware } from '@nestjs/common';

@Injectable()
export class LoggerMiddleware implements NestMiddleware {
    use(req: Request, res: Response, next: Function) {
        console.log('Request...');
        next();
    }
}

위 코드는 요청이 들어올 때마다 로그를 출력하는 간단한 미들웨어입니다. 이를 애플리케이션에 적용하려면 해당 미들웨어를 모듈에 등록해야 합니다.

1.3 Middleware 등록하기

미들웨어는 app.module.ts 파일 또는 특정 모듈 파일에 등록할 수 있습니다.

import { Module, MiddlewareConsumer } from '@nestjs/common';
import { LoggerMiddleware } from './logger.middleware';

@Module({
    // ...
})
export class AppModule {
    configure(consumer: MiddlewareConsumer) {
        consumer
            .apply(LoggerMiddleware)
            .forRoutes('*'); // 모든 경로에 미들웨어 적용
    }
}

2. Nest.js에서 Guard의 역할

Nest.js의 Guard는 요청을 처리하기 전에 특정 조건을 검사하는 데 사용됩니다. 주로 인증 및 권한 부여와 관련된 로직을 구현하는 데 활용됩니다.

2.1 Guard의 실제 사용 예시

Guard의 예시는 다음과 같이 구현할 수 있습니다.

import { Injectable, CanActivate, ExecutionContext } from '@nestjs/common';

@Injectable()
export class AuthGuard implements CanActivate {
    canActivate(context: ExecutionContext): boolean {
        const request = context.switchToHttp().getRequest();
        // 인증 로직 예시
        return request.headers.authorization === 'Bearer YOUR_TOKEN';
    }
}

3. Next.js의 Middleware 소개

Next.js는 React 기반의 서버 사이드 렌더링(SSR) 프레임워크입니다. Next.js에서도 미들웨어를 활용하여 HTTP 요청을 가로채고, 특정 기능을 처리할 수 있습니다.

3.1 Next.js의 Middleware 사용 방법

Next.js의 미들웨어는 기본적으로 파일 시스템 기반의 라우팅을 사용하며, middleware.js 파일을 생성하여 적용할 수 있습니다.

import { NextResponse } from 'next/server';

export function middleware(req) {
    if (!req.headers.get('Authorization')) {
        return NextResponse.redirect(new URL('/api/auth/unauthorized', req.url));
    }
    return NextResponse.next();
}

4. Next.js에서 API 요청 시 미들웨어 적용하기

Next.js에서 API 요청에 미들웨어를 적용하여 인증 및 권한 검사를 수행하는 방법을 구체적으로 알아보겠습니다.

4.1 Next.js API Routes 만들기

우선, API 경로를 생성하여 기본적인 API 엔드포인트를 설정해야 합니다. pages/api 디렉토리 내에 hello.js 파일을 생성합니다.

export default function handler(req, res) {
        res.status(200).json({ message: 'Hello, World!' });
    }

4.2 미들웨어 적용하기

이제 위에서 정의한 미들웨어를 적용하여 요청 시 인증 검사를 수행하도록 합니다.

import { NextResponse } from 'next/server';

export function middleware(req) {
    if (!req.headers.get('Authorization')) {
        return NextResponse.redirect(new URL('/api/auth/unauthorized', req.url));
    }
    return NextResponse.next();
}

4.3 전체 응용 프로그램에 미들웨어 적용하기

Next.js에서 모든 API 요청에 미들웨어를 적용하려면 middleware.js 파일을 프로젝트의 루트에 추가하여 전역 미들웨어로 설정해야 합니다.

5. Nest.js와 Next.js 통합하기

Nest.js와 Next.js를 함께 사용하여 전체 스택 애플리케이션을 구축할 수 있습니다. 이 때, Nest.js는 백엔드로서 API 서버 역할을 수행하고, Next.js는 프론트엔드로써 클라이언트 요청을 처리합니다.

5.1 Nest.js에서 API 및 인증 설정하기

@Controller('api')
export class ApiController {
    @Get('data')
    @UseGuards(AuthGuard)
    getData() {
        return { data: 'Some protected data' };
    }
}

5.2 Next.js에서 API 요청 처리하기

const fetchData = async () => {
        const res = await fetch('/api/data', {
            headers: {
                'Authorization': 'Bearer YOUR_TOKEN'
            }
        });
        if (!res.ok) throw new Error('Failed to fetch data');
        return res.json();
    }

6. 결론

Nest.js와 Next.js의 미들웨어 및 가드는 현대 웹 애플리케이션에서 중요한 요소입니다. 이러한 기능을 적절히 활용하면 성능과 보안을 높일 수 있습니다. 본 강좌를 통해 이들 프레임워크의 기본 개념과 활용 방법에 대해 소개했으며, 실제 코드 예시를 통해 이해를 돕고자 했습니다. 앞으로도 이러한 기술을 활용하여 더욱 강력한 애플리케이션을 개발하시길 바랍니다.

위 글은 Nest.js와 Next.js의 미들웨어 및 가드에 대한 강좌입니다.

48.Next.js와 Nest.js를 배포하는 방법, 환경변수 설정과 빌드 최적화 방법

1. 서론

모던 웹 개발에서 주목받고 있는 Next.js와 Nest.js는 각각 React와 Node.js의 강력한 도구입니다. Next.js는 서버 사이드 렌더링(SSR)과 정적 사이트 생성(SSG)을 지원하는 React 프레임워크이며, Nest.js는 효율적인 서버 사이드 애플리케이션을 만들 수 있도록 돕는 프레임워크입니다. 본 강좌에서는 Next.js와 Nest.js 애플리케이션을 배포하는 방법, 환경변수 설정, 빌드 최적화 방법에 대해 살펴보겠습니다.

2. Next.js 배포하기

2.1. Next.js 애플리케이션 빌드하기

Next.js 애플리케이션을 배포하기 전에 먼저 빌드해야 합니다. 배포 시 빌드 버전을 생성하기 위해 다음 명령어를 실행합니다:

npm run build

이 명령어를 통해 .next 디렉터리에 최적화된 빌드가 생성됩니다. 이 빌드를 서버에 배포하여 실제 서비스를 제공할 수 있습니다.

2.2. Next.js 배포 방법

2.2.1. Vercel을 사용한 배포

Next.js는 Vercel이 만든 프레임워크이므로, Vercel을 통해 배포하는 것이 가장 간단합니다. Vercel에 회원가입한 후 새로운 프로젝트를 생성하고 GitHub 또는 GitLab 레포지토리를 선택하세요. Vercel은 자동으로 애플리케이션을 감지하고 배포할 준비를 합니다.

2.2.2. 넷리파이(Netlify) 사용하기

넷리파이는 정적 사이트와 서버리스 기능을 갖춘 인기 있는 호스팅 서비스입니다. Netlify 버튼을 클릭하여 연결한 후, Build Command를 npm run build, Publish Directory를 out로 설정한 후 배포를 시작할 수 있습니다.

2.2.3. AWS에 배포하기

AWS Elastic Beanstalk를 사용해 Next.js 애플리케이션을 배포할 수도 있습니다. Elastic Beanstalk 환경을 생성하고, Docker 또는 Node.js 플랫폼을 선택하여 애플리케이션을 업로드하면 됩니다.

3. Nest.js 배포하기

3.1. Nest.js 애플리케이션 빌드하기

Nest.js 애플리케이션을 배포하기 위해 다음 명령어를 사용해 빌드합니다:

npm run build

이 명령어는 dist 디렉터리에 컴파일된 JavaScript 파일을 생성합니다.

3.2. Nest.js 배포 방법

3.2.1. Heroku를 통한 배포

Heroku는 빠르게 애플리케이션을 배포하기에 적합한 클라우드 플랫폼입니다. Heroku CLI를 사용해 애플리케이션을 생성한 후, git push heroku main 명령어로 배포할 수 있습니다.

3.2.2. AWS EC2에 배포하기

AWS EC2 인스턴스에 Nest.js 애플리케이션을 배포하려면 Node.js 및 Git을 설치하고, 필요한 종속성을 설치한 후, 애플리케이션을 클론하여 실행합니다.

3.2.3. Docker를 사용한 배포

Nest.js 애플리케이션을 Docker 컨테이너로 감싸서 배포하면, 환경에 구애받지 않고 실행할 수 있습니다. Dockerfile을 작성한 후, docker build 명령어로 이미지를 생성하고, docker run 명령어로 컨테이너를 실행합니다.

4. 환경변수 설정

4.1. Next.js 환경변수 설정

Next.js에서는 .env.local 파일을 사용하여 비밀 정보를 저장할 수 있습니다. 예를 들어, API 키나 데이터베이스 연결 문자열을 정의할 수 있습니다:

DATABASE_URL=my_database_url

환경변수는 process.env.DATABASE_URL을 통해 접근할 수 있습니다. Next.js는 환경변수가 NEXT_PUBLIC_로 시작하지 않는 경우 클라이언트 사이드에서 접근할 수 없도록 설정합니다.

4.2. Nest.js 환경변수 설정

Nest.js에서는 @nestjs/config 패키지를 사용하면 환경변수 관리가 편리해집니다. 다음과 같이 설치하고 설정할 수 있습니다:

npm install @nestjs/config

그 후, ConfigModule을 애플리케이션 모듈에 추가하고, .env 파일을 사용하여 환경변수를 설정합니다:

DATABASE_URL=my_database_url

그 후, this.configService.get('DATABASE_URL')를 사용해 환경변수에 접근합니다.

5. 빌드 최적화 방법

5.1. Next.js 빌드 최적화

Next.js의 성능을 최적화하기 위해 몇 가지 방법이 있습니다:

  • 서버 컴포넌트와 클라이언트 컴포넌트를 구분: 서버 사이드 렌더링을 필요로 하지 않는 컴포넌트들은 클라이언트 컴포넌트로 변환하여 성능을 극대화합니다.
  • 이미지 최적화: next/image 컴포넌트를 사용하여 이미지의 크기를 자동으로 조정하고 웹 퍼포먼스를 향상시킵니다.
  • 라우팅 최적화: 동적 라우팅을 사용하고, 필요하지 않은 페이지는 next/link를 사용하여 필요 시에만 로드할 수 있습니다.

5.2. Nest.js 빌드 최적화

Nest.js 앱의 성능 최적화를 위한 전략으로는 다음과 같습니다:

  • AOT 컴파일 사용: Ahead-of-Time 컴파일을 사용하면 런타임 성능을 향상시키고 빌드 크기를 줄일 수 있습니다.
  • 모듈 분할: 대규모 애플리케이션에서 모듈을 잘 분리해 코드의 가독성과 재사용성을 높입니다.
  • 캐싱 전략: 데이터베이스 쿼리 결과를 캐시하여 성능을 최적화합니다. Redis와 같은 캐싱 솔루션을 사용하는 것이 좋습니다.

6. 결론

Next.js와 Nest.js는 각각 클라이언트 사이드와 서버 사이드에서 매력적인 옵션입니다. 이 강좌를 통해 두 프레임워크의 배포 방법, 환경변수 설정, 빌드 최적화 방법을 살펴보았습니다. 이를 통해 효율적이고 성능이 뛰어난 웹 애플리케이션을 개발하는 데 큰 도움이 되기를 바랍니다.

저자: 조광형

날짜: [2023년 10월 1일]

5.Next.js와 Nest.js 기본 프로젝트 구조 만들기, TypeScript 설정과 기본 디렉토리 구성

최근 웹 개발의 트렌드에서 Next.js와 Nest.js는 각각 프론트엔드 및 백엔드 개발에서 매우 인기가 있습니다. Next.js는 React 기반의 프레임워크로 SEO 친화적인 서버 사이드 렌더링(SSR)을 지원하며, Nest.js는 타입스크립트를 사용하여 효율적인 서버 애플리케이션을 구축하는 데 최적화된 프레임워크입니다. 이번 글에서는 Next.js와 Nest.js를 결합하여 기본 프로젝트 구조를 만들고, TypeScript 설정 및 기본적인 디렉토리 구조에 대해 자세히 살펴보겠습니다.

1. Next.js 소개

Next.js는 React 애플리케이션을 위한 강력한 프레임워크로, 다양한 기능을 제공합니다. 다음은 Next.js의 주요 특징입니다:

  • 서버 사이드 렌더링(SSR): SEO와 초기 로딩 성능 향상을 위해 페이지를 서버에서 렌더링합니다.
  • 정적 사이트 생성(SSG): 정적 파일 생성으로 빠른 퍼포먼스를 제공합니다.
  • API 라우트: 간단한 API를 서버에서 구축할 수 있습니다.
  • 자동 코드 분할: 페이지에 필요한 자바스크립트 코드만 로드합니다.

2. Nest.js 소개

Nest.js는 Node.js에서 서버 애플리케이션을 구축하기 위한 프레임워크로, TypeScript를 사용하여 생산성을 높입니다. Nest.js의 특징은 다음과 같습니다:

  • 모듈화: 코드 구조를 개선하고 관리하기 쉽게 합니다.
  • 의존성 주입: 서비스 간의 의존성을 쉽게 관리할 수 있습니다.
  • 확장성: 필요에 따라 모듈을 추가하여 기능을 확장할 수 있습니다.
  • 테스트 용이성: 코드를 단위 테스트하기 쉽게 구조화되어 있습니다.

3. 프로젝트 생성

이제 Next.js와 Nest.js가 설치된 개발 환경을 설정해보겠습니다. 각 프레임워크의 프로젝트를 생성하고 기본적인 디렉토리 구조를 설명하겠습니다.

3.1 Next.js 프로젝트 생성

npx create-next-app@latest my-next-app --typescript

위의 명령어를 터미널에 입력하여 Next.js 프로젝트를 생성합니다. my-next-app은 프로젝트 이름이며, 필요에 따라 변경할 수 있습니다.

3.2 Nest.js 프로젝트 생성

npm i -g @nestjs/cli
nest new my-nest-app

위의 명령어를 사용하여 Nest.js 프로젝트를 생성합니다. my-nest-app이 프로젝트 이름입니다. 안정성을 위해 npm이 아닌 yarn을 사용할 수도 있습니다.

4. TypeScript 설정

Next.js와 Nest.js 두 프로젝트 모두 TypeScript를 사용하여 작성할 수 있습니다. 기본적으로 Next.js에서 TypeScript를 설치하면 tsconfig.json 파일이 생성됩니다. Nest.js도 마찬가지로 기본적으로 TypeScript로 설정되어 있습니다.

4.1 Next.js TypeScript 설정

Next.js는 TypeScript 설정이 이미 포함되어 있으므로, 아래 파일을 수정하거나 추가하여 추가 설정을 할 수 있습니다.

{
    "compilerOptions": {
        "target": "es5",
        "lib": ["dom", "dom.iterable", "esnext"],
        "allowJs": true,
        "skipLibCheck": true,
        "strict": true,
        "forceConsistentCasingInFileNames": true,
        "noEmit": true,
        "esModuleInterop": true,
        "module": "esnext",
        "moduleResolution": "node",
        "resolveJsonModule": true,
        "isolatedModules": true,
        "jsx": "preserve",
        "incremental": true,
        "baseUrl": "."
    },
    "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
    "exclude": ["node_modules"]
}

4.2 Nest.js TypeScript 설정

Nest.js에서는 프로젝트 기본 구성이 TypeScript를 사용하도록 되어 있습니다. tsconfig.json 파일도 기본적으로 다음과 같이 설정되어 있습니다:

{
    "compilerOptions": {
        "module": "commonjs",
        "target": "es6",
        "lib": ["es6", "dom"],
        "outDir": "./dist",
        "rootDir": "./src",
        "strict": true,
        "baseUrl": "./",
        "paths": {
            "@/*": ["src/*"]
        }
    },
    "include": ["src/**/*.ts"],
    "exclude": ["node_modules", "dist"]
}

5. 기본 디렉토리 구성

Next.js와 Nest.js 프로젝트 각각의 기본 디렉토리 구조를 알아보겠습니다.

5.1 Next.js 기본 디렉토리 구성

Next.js 프로젝트의 기본 디렉토리 구조는 다음과 같습니다:

my-next-app/
├── node_modules/
├── public/
│   ├── favicon.ico
│   ├── vercel.svg
│   └── ...
├── src/
│   ├── pages/
│   ├── components/
│   └── styles/
├── .gitignore
├── package.json
├── tsconfig.json
├── next.config.js
└── README.md

각 디렉토리의 역할은 다음과 같습니다:

  • public: 정적 파일을 저장하는 디렉토리입니다. 이미지, 폰트 등 클라이언트에서 직접 접근할 수 있는 파일을 저장합니다.
  • src/pages: Next.js에서 페이지를 정의하는 디렉토리입니다. 각 파일 이름이 URL 경로로 매핑됩니다.
  • src/components: 재사용 가능한 컴포넌트를 정의하는 디렉토리입니다.
  • src/styles: CSS 파일 및 스타일 관련 파일을 저장합니다.
  • next.config.js: Next.js 설정 파일입니다. 필요한 모든 구성 설정을 여기에 추가할 수 있습니다.

5.2 Nest.js 기본 디렉토리 구성

Nest.js 프로젝트의 기본 디렉토리 구조는 다음과 같습니다:

my-nest-app/
├── node_modules/
├── src/
│   ├── app.module.ts
│   ├── app.controller.ts
│   ├── app.service.ts
│   └── main.ts
├── test/
├── .eslintrc.js
├── package.json
├── tsconfig.json
├── jest.config.js
└── README.md

각 디렉토리의 역할은 다음과 같습니다:

  • src: 애플리케이션의 소스 코드가 위치하는 디렉토리입니다.
  • app.module.ts: 애플리케이션의 루트 모듈입니다. 다른 모듈을 불러오고 관리합니다.
  • app.controller.ts: 라우팅과 관련된 요청을 처리하는 컨트롤러입니다.
  • app.service.ts: 비즈니스 로직을 처리하는 서비스입니다.
  • main.ts: 애플리케이션 진입점입니다. 서버를 시작하는 코드가 위치합니다.

6. 결론

이번 글에서는 Next.js와 Nest.js의 기본적인 프로젝트 구조를 설정하고, TypeScript 설정과 기본 디렉토리 구성에 대해 알아보았습니다. 두 프레임워크를 함께 사용하면 강력한 풀스택 애플리케이션을 효과적으로 구축할 수 있습니다. 이러한 기본 구조를 통해 더 나아가 복잡한 애플리케이션을 개발할 수 있으며, 실전에서 유용하게 사용할 수 있을 것입니다.

이제 여러분은 Next.js와 Nest.js를 활용하여 개발을 시작할 준비가 되었습니다! 더 깊이 있는 내용을 원하신다면, 두 프레임워크에 대한 공식 문서 및 추가 강좌를 참고하시기 바랍니다.