Node.js 백엔드 확장 가능한 앱 구축: 프로젝트 구조에 대한 실용 가이드

주니어 개발자로서 Node.js 백엔드 구축에서 가장 어려운 측면 중 하나는 코드 자체를 작성하는 것이 아니라 확장 가능한 방식으로 코드를 구성하는 것입니다. 오늘은 애플리케이션의 템플릿으로 사용할 수 있는 프로덕션용 Node.js 프로젝트 구조를 살펴보겠습니다.

비정형 코드의 문제점
시작하기 전에 책이 무작위로 선반에 놓여 있는 도서관에서 특정 책을 찾으려고 한다고 상상해 보세요. 실망스럽죠? 코드에도 동일하게 적용됩니다. 적절한 구조가 없으면 Node.js 애플리케이션은 유지 관리 및 확장이 어려운 스파게티 코드의 미로가 될 수 있습니다.

더 나은 방법: 최신 Node.js 프로젝트 구조
많은 성공적인 기업이 사용하는 전문가급 Node.js 프로젝트 구조를 분석해 보겠습니다.

? 백엔드/
├─? 소스/
│ └── ? @types # TypeScript 유형 정의
│ └──? 구성 # 구성 파일
│ └── ? 컨트롤러 # 요청 핸들러
│ └── ? 엔터티 # 데이터베이스 모델/엔티티
│ └── ? helper # 도우미/유틸리티 함수
│ └── ? 미들웨어 # 익스프레스 미들웨어
│ └── ? 경로 # API 경로 정의
│ └── ? 서비스 # 비즈니스 로직
│ └── ? 유형 # 추가 유형 정의
│ └── ? utils # 유틸리티 기능
└── ? app.ts # 애플리케이션 진입점
└── ? .eslintrc.js # ESLint 구성
└── ? .prettierrc # 더 예쁜 구성
└── ? Dockerfile # Docker 구성
└── ? package.json # 프로젝트 종속성
└── ? tsconfig.json # TypeScript 구성
└── ? .dockerignore # Docker 무시 규칙
└── ? .env # 환경 변수
└── ? docker-compose.yml # Docker Compose 구성

각 구성요소 이해
1. @유형 및 유형 디렉토리

`// @types/express/index.d.ts
declare namespace Express {
 export interface Request {
 user?: {
 id: string;
 role: string;
 };
 }
}`

이 폴더에는 TypeScript 유형 정의가 포함되어 있습니다. @types 폴더에는 일반적으로 외부 모듈에 대한 선언이 포함되어 있는 반면, 유형은 애플리케이션별 유형을 보유합니다.

2. 구성 디렉터리

// config/database.ts
export const dbConfig = {
 host: process.env.DB_HOST,
 port: process.env.DB_PORT,
 username: process.env.DB_USER,
 // … other configuration
};

이 디렉토리에는 모든 구성 파일이 저장되어 있어 다양한 환경(개발, 스테이징, 프로덕션)을 쉽게 관리할 수 있습니다.

3. 컨트롤러

// controllers/userController.ts
export class UserController {
  async getUser(req: Request, res: Response) {
    try {
      const user = await userService.findById(req.params.id);
      res.json(user);
    } catch (error) {
      res.status(500).json({ error: error.message });
    }
  }
}

컨트롤러는 HTTP 요청과 응답을 처리하여 경로와 서비스 사이의 브리지 역할을 합니다.

4. 엔터티

typescript// entity/User.ts
@Entity()
export class User {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  username: string;

  @Column()
  email: string;
}

엔티티 디렉터리에는 일반적으로 TypeORM 또는 Sequelize와 같은 ORM을 사용하는 데이터베이스 모델이 포함되어 있습니다.

5. 서비스

services/userService.ts
export class UserService {
  async createUser(userData: CreateUserDto) {
    const user = new User();
    Object.assign(user, userData);
    return await this.userRepository.save(user);
  }
}

서비스에는 비즈니스 로직이 포함되어 있어 컨트롤러와 별도로 유지됩니다.

6. 미들웨어

`// @types/express/index.d.ts
declare namespace Express {
 export interface Request {
 user?: {
 id: string;
 role: string;
 };
 }
}`

미들웨어는 인증, 로깅, 오류 처리 등의 교차 문제를 처리합니다.

모범 사례 및 팁

1. 단일 책임: 각 디렉터리에는 명확하고 단일한 목적이 있어야 합니다. 비즈니스 로직과 경로 정의를 혼합하지 마세요.

2. 종속성 주입: 종속성 주입을 사용하면 코드를 더욱 테스트하고 유지 관리할 수 있습니다.

// config/database.ts
export const dbConfig = {
 host: process.env.DB_HOST,
 port: process.env.DB_PORT,
 username: process.env.DB_USER,
 // … other configuration
};

3. 환경 구성: 환경별 변수에 .env 파일을 사용하고 버전 제어에 커밋하지 마세요.

4. Docker 통합: Dockerfile 및 docker-compose.yml이 있다는 것은 컨테이너화 지원을 의미하므로 환경 전반에 걸쳐 일관된 배포가 가능합니다.

피해야 할 일반적인 함정
순환 종속성: 모듈 간에 순환 종속성을 만들지 않도록 주의하세요.
대규모 파일: 파일이 너무 커지면 아마도 너무 많은 일을 하고 있는 것일 수 있습니다. 더 작고 집중적인 모듈로 분할하세요.
일관성 없는 오류 처리: 애플리케이션 전반에 걸쳐 일관된 오류 처리 전략을 수립하세요.

결론

잘 구성된 Node.js 애플리케이션은 장기적인 유지 관리와 확장성에 매우 중요합니다. 이 구조는 애플리케이션이 성장함에 따라 구축할 수 있는 견고한 기반을 제공합니다. 목표는 단지 ​​작동하도록 만드는 것이 아니라 유지 관리, 확장 가능, 즐겁게 작업할 수 있도록 만드는 것입니다.

다음에 새로운 Node.js 프로젝트를 시작할 때 이 구조를 템플릿으로 사용하는 것을 고려해 보세요. 이를 통해 수많은 리팩토링 시간을 절약하고 첫날부터 코드베이스를 더욱 전문적으로 만들 수 있습니다.

프로 팁: 이 구조로 템플릿 저장소를 생성하면 동일한 조직에서 새 프로젝트를 신속하게 부트스트랩할 수 있습니다.

위 내용은 Node.js 백엔드 확장 가능한 앱 구축: 프로젝트 구조에 대한 실용 가이드의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!