기본 콘텐츠로 건너뛰기

Django 프로젝트 구조 이렇게 짜면 협업이 편해진다 (서비스 분리 전략)

Django 프로젝트 구조 이렇게 짜면 협업이 편해진다 (서비스 분리 전략)

안녕하세요! 오늘은 Django 프로젝트를 효율적으로 구조화하여 팀 협업을 개선하는 방법에 대해 알아보겠습니다. 잘 구조화된 프로젝트는 유지보수성과 확장성을 높여줍니다.

왜 프로젝트 구조가 중요한가요?

좋은 프로젝트 구조의 이점:

  1. 유지보수성: 코드를 쉽게 찾고 수정할 수 있습니다.
  2. 확장성: 새로운 기능을 쉽게 추가할 수 있습니다.
  3. 재사용성: 코드를 다른 프로젝트에서 재사용할 수 있습니다.
  4. 테스트 용이성: 단위 테스트와 통합 테스트가 쉬워집니다.
  5. 협업 효율성: 여러 개발자가 동시에 작업하기 좋습니다.

권장 프로젝트 구조

project/
├── apps/                      # 애플리케이션 디렉토리
│   ├── core/                  # 핵심 기능
│   ├── users/                 # 사용자 관리
│   ├── products/              # 상품 관리
│   └── orders/                # 주문 관리
├── config/                    # 프로젝트 설정
│   ├── settings/              # 설정 파일들
│   │   ├── base.py           # 기본 설정
│   │   ├── development.py    # 개발 환경 설정
│   │   └── production.py     # 프로덕션 환경 설정
│   ├── urls.py               # URL 설정
│   └── wsgi.py               # WSGI 설정
├── docs/                      # 문서
├── scripts/                   # 유틸리티 스크립트
├── tests/                     # 테스트
├── requirements/              # 의존성 관리
│   ├── base.txt              # 기본 의존성
│   ├── development.txt       # 개발용 의존성
│   └── production.txt        # 프로덕션용 의존성
└── manage.py                  # Django 관리 명령어

애플리케이션 구조

1. Core 앱

# apps/core/models.py
from django.db import models

class TimeStampedModel(models.Model):
    created_at = models.DateTimeField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)

    class Meta:
        abstract = True

# apps/core/managers.py
from django.db import models

class ActiveManager(models.Manager):
    def get_queryset(self):
        return super().get_queryset().filter(is_active=True)

2. Users 앱

# apps/users/models.py
from django.contrib.auth.models import AbstractUser
from django.db import models
from core.models import TimeStampedModel

class User(AbstractUser, TimeStampedModel):
    email = models.EmailField(unique=True)
    phone_number = models.CharField(max_length=15, blank=True)

    USERNAME_FIELD = 'email'
    REQUIRED_FIELDS = ['username']

# apps/users/serializers.py
from rest_framework import serializers
from .models import User

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = ['id', 'email', 'username', 'phone_number']

3. Products 앱

# apps/products/models.py
from django.db import models
from core.models import TimeStampedModel

class Product(TimeStampedModel):
    name = models.CharField(max_length=100)
    price = models.DecimalField(max_digits=10, decimal_places=2)
    description = models.TextField()
    stock = models.IntegerField(default=0)

    objects = models.Manager()
    active = ActiveManager()

# apps/products/services.py
class ProductService:
    @staticmethod
    def create_product(data):
        # 상품 생성 로직
        pass

    @staticmethod
    def update_stock(product_id, quantity):
        # 재고 업데이트 로직
        pass

설정 파일 구조

1. 기본 설정 (base.py)

# config/settings/base.py
import os
from pathlib import Path

BASE_DIR = Path(__file__).resolve().parent.parent.parent

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',

    # Third party apps
    'rest_framework',
    'corsheaders',

    # Local apps
    'apps.core',
    'apps.users',
    'apps.products',
    'apps.orders',
]

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'corsheaders.middleware.CorsMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

2. 개발 환경 설정 (development.py)

# config/settings/development.py
from .base import *

DEBUG = True

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': BASE_DIR / 'db.sqlite3',
    }
}

# 개발용 추가 설정
INSTALLED_APPS += ['debug_toolbar']
MIDDLEWARE += ['debug_toolbar.middleware.DebugToolbarMiddleware']

URL 구조

# config/urls.py
from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/v1/', include('apps.users.urls')),
    path('api/v1/', include('apps.products.urls')),
    path('api/v1/', include('apps.orders.urls')),
]

# apps/users/urls.py
from django.urls import path
from . import views

app_name = 'users'

urlpatterns = [
    path('users/', views.UserListView.as_view(), name='user-list'),
    path('users/<int:pk>/', views.UserDetailView.as_view(), name='user-detail'),
]

서비스 계층 구조

1. 서비스 클래스

# apps/orders/services.py
from django.db import transaction
from .models import Order, OrderItem

class OrderService:
    @staticmethod
    @transaction.atomic
    def create_order(user, items):
        order = Order.objects.create(user=user)
        for item in items:
            OrderItem.objects.create(
                order=order,
                product=item['product'],
                quantity=item['quantity']
            )
        return order

    @staticmethod
    def cancel_order(order_id):
        order = Order.objects.get(id=order_id)
        order.status = 'cancelled'
        order.save()
        return order

2. 뷰에서 서비스 사용

# apps/orders/views.py
from rest_framework import viewsets
from .models import Order
from .serializers import OrderSerializer
from .services import OrderService

class OrderViewSet(viewsets.ModelViewSet):
    queryset = Order.objects.all()
    serializer_class = OrderSerializer

    def perform_create(self, serializer):
        items = self.request.data.get('items', [])
        order = OrderService.create_order(self.request.user, items)
        serializer.instance = order

테스트 구조

# tests/test_orders.py
from django.test import TestCase
from apps.orders.services import OrderService
from apps.products.models import Product
from apps.users.models import User

class OrderServiceTest(TestCase):
    def setUp(self):
        self.user = User.objects.create_user(
            email='test@example.com',
            password='testpass123'
        )
        self.product = Product.objects.create(
            name='Test Product',
            price=1000
        )

    def test_create_order(self):
        items = [{'product': self.product, 'quantity': 2}]
        order = OrderService.create_order(self.user, items)
        self.assertEqual(order.user, self.user)
        self.assertEqual(order.items.count(), 1)

문서화

1. API 문서

# apps/orders/schemas.py
from drf_yasg import openapi

order_schema = {
    'operation_description': '주문 생성 API',
    'manual_parameters': [
        openapi.Parameter(
            'items',
            openapi.IN_BODY,
            description='주문 상품 목록',
            type=openapi.TYPE_ARRAY,
            items=openapi.Items(
                type=openapi.TYPE_OBJECT,
                properties={
                    'product_id': openapi.Schema(type=openapi.TYPE_INTEGER),
                    'quantity': openapi.Schema(type=openapi.TYPE_INTEGER),
                }
            )
        ),
    ],
    'responses': {
        201: openapi.Response(
            description='주문 생성 성공',
            schema=OrderSerializer
        ),
    }
}

협업을 위한 추가 팁

  1. 코드 스타일 가이드: black, isort, flake8 등의 도구 사용
  2. Git 전략: Git Flow 또는 Trunk Based Development 채택
  3. 리뷰 프로세스: Pull Request 템플릿과 리뷰 체크리스트 사용
  4. CI/CD: GitHub Actions 또는 GitLab CI 설정
  5. 문서화: README.md와 API 문서 꾸준히 업데이트

결론

잘 구조화된 Django 프로젝트는 팀의 생산성을 크게 향상시킵니다. 이 글에서 소개한 구조와 패턴들을 참고하여 자신의 팀에 맞는 프로젝트 구조를 설계해보세요. 추가적인 질문이나 궁금한 점이 있으시면 댓글로 남겨주세요!

라벨:

댓글

댓글 쓰기

이 블로그의 인기 게시물

Django에서 트랜잭션 관리하기

Django에서 트랜잭션 관리하기 안녕하세요! 오늘은 Django에서 데이터베이스 트랜잭션을 효과적으로 관리하는 방법에 대해 알아보겠습니다. 1. 트랜잭션의 중요성 트랜잭션은 데이터베이스의 일관성과 무결성을 보장하는 중요한 개념입니다. Django에서는 여러 가지 방법으로 트랜잭션을 관리할 수 있습니다. 1.1 기본 개념 원자성(Atomicity) : 트랜잭션은 모두 실행되거나 모두 실행되지 않아야 합니다. 일관성(Consistency) : 트랜잭션 전후로 데이터베이스의 일관성이 유지되어야 합니다. 격리성(Isolation) : 동시에 실행되는 트랜잭션들이 서로 영향을 주지 않아야 합니다. 지속성(Durability) : 완료된 트랜잭션의 결과는 영구적으로 저장되어야 합니다. 2. Django의 트랜잭션 관리 2.1 기본 설정 # settings.py DATABASES = { 'default': { 'ENGINE': 'django.db.backends.postgresql', 'NAME': 'mydatabase', 'USER': 'myuser', 'PASSWORD': 'mypassword', 'HOST': 'localhost', 'PORT': '5432', 'ATOMIC_REQUESTS': True, # 모든 뷰를 트랜잭션으로 래핑 } } 2.2 데코레이터 사용 from django.db import transaction @transaction.atomic def create_order(user, items): order = Order.objects.create(user=...
댓글 쓰기
자세한 내용 보기

AWS S3 + CloudFront로 정적 파일 서빙 완전 가이드

AWS S3 + CloudFront로 정적 파일 서빙 완전 가이드 안녕하세요! 오늘은 AWS S3와 CloudFront를 사용하여 정적 파일을 효율적으로 서빙하는 방법에 대해 알아보겠습니다. 왜 S3와 CloudFront를 사용할까요? 높은 가용성 : AWS의 글로벌 인프라를 활용 빠른 전송 속도 : CloudFront의 CDN 기능으로 전 세계 사용자에게 빠른 전송 비용 효율성 : 사용한 만큼만 지불 보안 : AWS의 보안 기능 활용 확장성 : 트래픽 증가에 자동 대응 1. S3 버킷 설정 1.1 버킷 생성 및 설정 import boto3 def create_s3_bucket(): s3 = boto3.client('s3') # 버킷 생성 bucket_name = 'your-static-files-bucket' s3.create_bucket( Bucket=bucket_name, CreateBucketConfiguration={ 'LocationConstraint': 'ap-northeast-2' } ) # 버킷 정책 설정 bucket_policy = { "Version": "2012-10-17", "Statement": [ { "Sid": "PublicReadGetObject", "Effect": "Allow", "Principal": "*", "Action": "s3:GetObje...
댓글 쓰기
자세한 내용 보기

Python에서 asyncio 완전 정복 (await, async, gather 등)

어휴, 요즘 파이썬으로 비동기 프로그래밍 하는 재미에 푹 빠졌어요! 특히 asyncio 는 정말 마법 같더라고요. 처음엔 좀 낯설었는데, 익숙해지니까 속도 향상이 눈에 띄게 느껴져서 완전 반해버렸습니다. 이 글에선 제가 asyncio 를 배우면서 깨달은 점들을 풀어놓을게요. 혹시 비동기 프로그래밍이 뭔지 잘 모르시겠다면, 간단히 말해 여러 작업을 동시에 처리해서 프로그램 속도를 엄청나게 높이는 기술이라고 생각하시면 돼요. 마치 여러 요리사가 동시에 음식을 만들어서 손님에게 빨리 제공하는 것과 비슷하죠! 일단 async 와 await 라는 녀석들이 핵심인데요, async 는 함수 앞에 붙여서 "얘는 비동기 함수야!"라고 선언하는 거예요. 그리고 await 는 다른 비동기 함수가 끝날 때까지 기다리라고 지시하는 역할을 하죠. 예를 들어, 네트워크에서 데이터를 가져오는 함수가 있다면, await 를 사용해서 데이터가 다 가져올 때까지 기다렸다가 다음 작업을 진행할 수 있어요. 그 동안 다른 작업을 처리할 수 있으니, 마치 멀티태스킹을 하는 것처럼 느껴져요. 신기하지 않나요? 그리고 asyncio.gather 는 여러 비동기 함수를 동시에 실행하고 결과를 모아주는 아주 유용한 친구입니다. 제가 웹사이트 여러 개에서 데이터를 동시에 가져와야 할 때 정말 요긴하게 썼어요. 하나씩 순서대로 가져오는 것보다 훨씬 빠르더라고요! 마치 여러 개의 탭을 동시에 열어놓고 작업하는 것과 같다고 생각하시면 될 것 같아요. 실제로 제가 썼던 코드를 보여드릴게요. 세 개의 웹사이트에서 데이터를 가져오는 예제인데요. (아래 코드 삽입) 이 코드를 보시면, fetch_data 함수가 각 웹사이트에서 데이터를 가져오는 역할을 하고, asyncio.gather 가 이 함수들을 동시에 실행하도록 도와주는 것을 볼 수 있을 거예요. asyncio.sleep(2) 는 네트워크 지연을 시뮬레이션하기 위해 넣...
댓글 쓰기
자세한 내용 보기