Django에서 다운로드 가능한 파일 제공하기

2024-07-27

정적 파일 사용하기

가장 간단한 방법은 정적 파일을 사용하는 것입니다. 정적 파일은 이미지, CSS, JavaScript 등 웹 페이지에 필요한 모든 파일을 포함합니다. Django는 이러한 파일을 별도의 디렉토리에 저장하고 웹 서버가 직접 제공하도록 설정할 수 있습니다.

다음은 정적 파일을 사용하여 다운로드 가능한 파일을 제공하는 방법입니다.

다운로드 가능한 파일을 settings.py 파일에 정의된 STATICFILES_DIRS 디렉토리에 저장합니다.
파일을 제공할 URL을 정의하는 뷰 함수를 작성합니다.
HttpResponse 객체를 반환하여 뷰 함수에서 파일을 다운로드하도록 설정합니다.

from django.http import HttpResponse

def download_file(request, filename):
    # 다운로드할 파일의 경로를 지정합니다.
    file_path = os.path.join(settings.STATICFILES_DIRS[0], filename)

    # 파일이 존재하는지 확인합니다.
    if not os.path.exists(file_path):
        return HttpResponseNotFound('파일을 찾을 수 없습니다.')

    # 파일을 읽고 바이너리 형식으로 반환합니다.
    with open(file_path, 'rb') as f:
        response = HttpResponse(f.read(), content_type='application/octet-stream')

    # 다운로드 속성을 설정합니다.
    response['Content-Disposition'] = f'attachment; filename="{filename}"'

    return response

sendfile 함수 사용하기

sendfile 함수를 사용하면 웹 서버가 직접 파일을 전송하도록 하여 성능을 향상시킬 수 있습니다.

from django.http import sendfile

def download_file(request, filename):
    # 다운로드할 파일의 경로를 지정합니다.
    file_path = os.path.join(settings.MEDIA_ROOT, filename)

    # 파일이 존재하는지 확인합니다.
    if not os.path.exists(file_path):
        return HttpResponseNotFound('파일을 찾을 수 없습니다.')

    # sendfile 함수를 사용하여 파일을 전송합니다.
    return sendfile(request, file_path, as_attachment=True)

서드파티 라이브러리 사용하기

Django-rest-framework-fileobject와 같은 서드파티 라이브러리를 사용하여 다운로드 가능한 파일을 제공할 수도 있습니다. 이러한 라이브러리는 종종 추가 기능 및 사용 편의성을 제공합니다.

추가 정보

다운로드 가능한 파일에 대한 메타데이터(예: 파일 이름, 파일 크기)를 제공하려면 뷰 함수에서 추가 작업을 수행해야 할 수도 있습니다.
사용자 인증이 필요한 경우 다운로드 가능한 파일에 대한 액세스를 제어하기 위해 인증 검사를 뷰 함수에 추가해야 할 수도 있습니다.

예제 코드

정적 파일 사용하기

# settings.py

STATICFILES_DIRS = [
    os.path.join(BASE_DIR, 'static'),
]

# views.py

from django.http import HttpResponse

def download_file(request, filename):
    # 다운로드할 파일의 경로를 지정합니다.
    file_path = os.path.join(settings.STATICFILES_DIRS[0], filename)

    # 파일이 존재하는지 확인합니다.
    if not os.path.exists(file_path):
        return HttpResponseNotFound('파일을 찾을 수 없습니다.')

    # 파일을 읽고 바이너리 형식으로 반환합니다.
    with open(file_path, 'rb') as f:
        response = HttpResponse(f.read(), content_type='application/octet-stream')

    # 다운로드 속성을 설정합니다.
    response['Content-Disposition'] = f'attachment; filename="{filename}"'

    return response

sendfile 함수 사용하기

# settings.py

MEDIA_ROOT = os.path.join(BASE_DIR, 'media')

# views.py

from django.http import sendfile

def download_file(request, filename):
    # 다운로드할 파일의 경로를 지정합니다.
    file_path = os.path.join(settings.MEDIA_ROOT, filename)

    # 파일이 존재하는지 확인합니다.
    if not os.path.exists(file_path):
        return HttpResponseNotFound('파일을 찾을 수 없습니다.')

    # sendfile 함수를 사용하여 파일을 전송합니다.
    return sendfile(request, file_path, as_attachment=True)

Django에서 다운로드 가능한 파일을 제공하는 대체 방법

StreamingHttpResponse 사용하기

큰 파일을 다운로드할 때는 StreamingHttpResponse 클래스를 사용하는 것이 더 효율적일 수 있습니다. 이 클래스는 파일을 한 번에 모두 읽는 대신, 작은 청크 단위로 스트리밍하여 전송합니다.

from django.http import StreamingHttpResponse

def download_file(request, filename):
    # 다운로드할 파일의 경로를 지정합니다.
    file_path = os.path.join(settings.MEDIA_ROOT, filename)

    # 파일이 존재하는지 확인합니다.
    if not os.path.exists(file_path):
        return HttpResponseNotFound('파일을 찾을 수 없습니다.')

    # 파일을 스트리밍합니다.
    with open(file_path, 'rb') as f:
        response = StreamingHttpResponse(f, content_type='application/octet-stream')
        response['Content-Disposition'] = f'attachment; filename="{filename}"'
        return response

Django REST framework 사용하기

Django REST framework를 사용하는 경우, GenericAPIView 클래스를 상속받아 다운로드 뷰를 만들 수 있습니다. 이 뷰는 StreamingResponse 클래스를 사용하여 파일을 스트리밍할 수 있습니다.

from rest_framework.views import GenericAPIView
from rest_framework.response import StreamingResponse

class DownloadFileView(GenericAPIView):
    def get(self, request, filename):
        # 다운로드할 파일의 경로를 지정합니다.
        file_path = os.path.join(settings.MEDIA_ROOT, filename)

        # 파일이 존재하는지 확인합니다.
        if not os.path.exists(file_path):
            return Response({'error': '파일을 찾을 수 없습니다.'}, status=404)

        # 파일을 스트리밍합니다.
        with open(file_path, 'rb') as f:
            response = StreamingResponse(f, content_type='application/octet-stream')
            response['Content-Disposition'] = f'attachment; filename="{filename}"'
            return response