Django 프로젝트 개발
1. 프로젝트 개발 흐름
- Django 프로젝트를 생성하고 templates 디렉터리를 만든다. PyCharm에서 Django 프로젝트를 생성하면 templates 디렉터리와 settings.py 경로 설정이 자동으로 추가되는 경우가 있다.
- models.py에 모델 클래스를 작성한다.
- settings.py에 앱을 등록하고 정적 파일 경로와 templates 디렉터리 경로를 추가한다.
- urls.py에 뷰 함수 또는 뷰 클래스의 라우팅을 설정한다.
- views.py에 비즈니스 로직을 작성한다.
- templates 디렉터리에 프론트엔드 페이지를 작성한다.
2. auth 모듈 보충
(1) Django admin 관리 페이지
- 슈퍼유저만 로그인하여 조작할 수 있다.
- Django가 기본 제공하는 관리자 페이지에서 모델 데이터를 관리할 수 있다.
- admin 페이지에서 관리하려면 해당 앱의 admin.py에 모델을 등록해야 한다.
from django.contrib import admin
from .models import Profile
admin.site.register(Profile)
(2) admin 관리 페이지에서 모델 이름 표시
class Profile(AbstractUser):
def __str__(self):
return self.username
class Meta:
verbose_name = "사용자"
verbose_name_plural = "사용자 목록"
(3) auth 사용자 아바타 업로드 시 주의점
- FileField를
update()로 직접 갱신하면 파일 저장 처리와 경로 처리가 정상적으로 동작하지 않을 수 있다.
- 인스턴스의 파일 속성에 업로드 파일을 할당한 뒤 반드시
save()를 호출한다.
wrong_file = request.FILES.get("avatar")
Profile.objects.filter(pk=request.user.pk).update(avatar=wrong_file)
uploaded_file = request.FILES.get("avatar")
if uploaded_file:
request.user.avatar = uploaded_file
request.user.save()
(4) auth 모듈의 로그인 데코레이터
login_required가 적용된 뷰를 비로그인 상태에서 요청하면 지정한 로그인 페이지로 리다이렉트된다.
- 이때 로그인 페이지 URL 뒤에
?next=원래 요청한 URL 형태의 파라미터가 붙는다.
from django.contrib.auth.decorators import login_required
@login_required
def change_avatar(request):
return HttpResponse("OK")
# 로그인 페이지 예시
# /accounts/login/?next=/profile/avatar/
3. Django 트랜잭션 사용 예
from django.db import transaction
from django.db.models import F
from django.http import JsonResponse
def create_comment(request, article_id):
body = request.POST.get("content")
parent_id = request.POST.get("parent_id") or None
with transaction.atomic():
Comment.objects.create(
author=request.user,
article_id=article_id,
body=body,
parent_id=parent_id,
)
Article.objects.filter(pk=article_id).update(
comment_count=F("comment_count") + 1
)
return JsonResponse({"result": "ok", "message": "댓글이 등록되었습니다."})
Django media 정적 디렉터리
- media와 static은 관례적으로 사용하는 디렉터리 이름이다.
- media에는 사용자가 업로드한 이미지, 동영상, 음악, 문서 등을 저장한다.
- static에는 프로젝트에서 사용하는 CSS, JS, jQuery, 폰트, 기타 정적 파일을 저장한다.
- Django는 사용자 업로드 파일을 인식하여 settings.py에 정의된 media 경로에 저장한다. 저장 시 media 디렉터리가 없으면 자동으로 생성된다.
1. media 폴더 설정
(1) 로컬 리소스를 사용자에게 노출하는 방법
- 아래 방식은 로컬 리소스를 외부에 노출하므로 운영 환경에서는 주의해서 사용한다.
# settings.py
MEDIA_ROOT = BASE_DIR / "media"
# urls.py
from django.conf import settings
from django.urls import re_path
from django.views.static import serve
urlpatterns += [
re_path(r"^media/(?P<path>.*)$", serve, {"document_root": settings.MEDIA_ROOT}),
]
- named group 뒤에
/를 붙이지 않는다.
- URL 설정이 프로젝트의 최상위 urls.py가 아니고 라우팅 분기가 있는 경우 오류가 발생할 수 있다.
class UserProfile(AbstractUser):
phone = models.BigIntegerField(null=True, blank=True)
avatar = models.FileField(upload_to="avatars/", default="avatars/default.jpg")
joined_at = models.DateField(auto_now_add=True)
blog = models.OneToOneField("Blog", null=True, on_delete=models.SET_NULL)
blank=True는 admin 페이지에서 해당 필드가 비어 있어도 된다는 의미다.
- 파일을 전달하면
upload_to 경로에 자동으로 저장되고, 해당 디렉터리가 없으면 생성된다. 데이터베이스에는 파일 경로가 저장된다.
<img class="media-object" src="/media/{{ user_profile.avatar }}" alt="avatar" height="60">
Django 프로젝트의 작은 팁
1. 프론트엔드
(1) form의 serializeArray()
const payload = new FormData();
$("#comment-form").serializeArray().forEach(function (field) {
payload.append(field.name, field.value);
});
serializeArray()는 CSRF 토큰을 포함한 일반 키-값 쌍을 수집한다.
(2) img 태그의 src 속성
- 리소스의 절대 경로
- 사이트 내 이미지 URL
- 바이너리 데이터
(3) FormData 객체
- FormData에 값을 추가해 AJAX로 전송할 때는
contentType과 processData를 모두 false로 지정해야 한다.
- FormData는 파일 전송을 염두에 둔 객체이므로 브라우저가 데이터를 임의로 처리하지 않도록 설정한다.
const formData = new FormData();
$("#upload-form").serializeArray().forEach(function (item) {
formData.append(item.name, item.value);
});
$.ajax({
url: "/upload/",
method: "POST",
data: formData,
contentType: false,
processData: false,
success: function (response) {
console.log(response);
}
});
2. 백엔드
(1) 게시글을 날짜별로 그룹화하여 조회
from django.db.models import Count
from django.db.models.functions import TruncMonth
monthly_counts = (
Article.objects.filter(blog=blog)
.annotate(month=TruncMonth("created_at"))
.values("month")
.annotate(total=Count("id"))
.values_list("month", "total")
)
(2) request.path와 request.get_full_path()
full_path = request.get_full_path() # /users/signup/?name=kim
path_only = request.path # /users/signup/
import os
print(os.path.abspath(__file__))
print(os.getcwd())
request.get_full_path()는 쿼리 문자열을 포함한 전체 경로를 반환한다.
request.path는 쿼리 문자열을 제외한 경로만 반환한다.
(3) settings.py의 국제화 설정
LANGUAGE_CODE = "ko-kr"
# 필요에 따라 "zh-hans"(간체 중국어), "zh-hant"(번체 중국어) 사용 가능
TIME_ZONE = "Asia/Seoul"
USE_I18N = True
USE_L10N = True
USE_TZ = False
TIME_ZONE을 Asia/Seoul로 설정하고 USE_TZ = True로 두면 데이터베이스에는 UTC 시간이 저장된다.
- MySQL은 시간대를 유연하게 저장하지 못하므로 글로벌 서비스에서는 UTC 저장이 일반적이다. 예를 들어 한국 시간 08시는 UTC 23시 또는 00시로 변환되어 저장될 수 있다.
TIME_ZONE 설정은 데이터베이스에 저장된 UTC 시간을 읽을 때 자동 변환하는 역할을 한다. 프론트엔드에서는 자동 변환되지만 백엔드에서는 수동 변환이 필요할 수 있다.
(4) TODO 주석
# TODO: 이미지 업로드 전에 확장자와 MIME 타입 검사 추가
- TODO 주석은 에디터의 TODO 창에서 바로 해당 위치로 이동할 수 있다.
XSS 공격
1. XSS 공격
- XSS는 사용자 입력이 HTML로 렌더링되는 지점에 악성 JavaScript를 삽입하는 공격이다.
- 게시글, 댓글, 업로드 파일 등 사용자 입력을 그대로 출력하면 악성 스크립트가 실행되어 세션 탈취, 페이지 변조, 리소스 소모 등이 발생할 수 있다.
2. XSS 방어 방법
- BeautifulSoup 모듈로
script 태그를 제거할 수 있다.
- 설치:
pip install beautifulsoup4
from bs4 import BeautifulSoup
def sanitize_html(raw_html):
soup = BeautifulSoup(raw_html, "html.parser")
for script_tag in soup.find_all("script"):
script_tag.decompose()
plain_text = soup.get_text()
summary = plain_text[:150]
return str(soup), summary
- 위 예시는
script 태그만 제거한다. 실제 서비스에서는 허용 목록 기반 새니타이저를 함께 사용하는 것이 안전하다.
- 게시글 요약은 본문 텍스트를 150자로 단순 절단하는 방식으로 만들 수 있다.
이미지 핫링크 방지
- 다른 사이트가 자신의 서버 리소스를 무단으로 사용하는 것을 막기 위한 기능이다.
- HTTP 표준의
Referer 헤더를 활용한다.
Referer에는 이전 요청 페이지 주소가 기록되며, 리소스 요청 시에는 해당 리소스를 포함한 페이지의 주소를 추적할 수 있다.
- 따라서 대부분의 핫링크 방지 방식은
Referer 필드를 기반으로 동작한다.
이미지 CAPTCHA
- 실무에서는 네이버, 구글 CAPTCHA 같은 외부 CAPTCHA API를 사용하는 경우가 많다.
- 직접 이미지 CAPTCHA를 생성할 때는 Pillow와 io 모듈을 사용한다.
BytesIO는 데이터를 바이너리로 반환하고, StringIO는 문자열로 반환한다.
Image는 이미지 생성, ImageDraw는 이미지 위 텍스트 그리기, ImageFont는 글꼴 스타일 제어에 사용한다.
from io import BytesIO
import random
from PIL import Image, ImageDraw, ImageFont
from django.http import HttpResponse
def random_rgb():
return tuple(random.randint(0, 255) for _ in range(3))
def captcha_image(request):
image = Image.new("RGB", (360, 35), random_rgb())
drawer = ImageDraw.Draw(image)
font = ImageFont.truetype("static/fonts/NanumGothic.ttf", 30)
chars = []
for index in range(5):
candidates = [
chr(random.randint(65, 90)),
chr(random.randint(97, 122)),
str(random.randint(0, 9)),
]
char = random.choice(candidates)
drawer.text((60 + index * 60, 0), char, fill=random_rgb(), font=font)
chars.append(char)
code = "".join(chars)
request.session["captcha_code"] = code
buffer = BytesIO()
image.save(buffer, format="PNG")
return HttpResponse(buffer.getvalue(), content_type="image/png")
- 폰트 경로는 실제 프로젝트의 폰트 파일 위치에 맞게 수정한다.
- 생성한 CAPTCHA 코드는 세션에 저장하여 사용자가 입력한 값과 비교할 수 있다.
KindEditor 기본 사용
- 세부 사용법은 KindEditor 공식 문서를 참고한다.
프론트엔드 설정
<p>
<textarea name="content" id="editor-content" cols="30" rows="10" class="form-control"></textarea>
</p>
<script>
KindEditor.ready(function (K) {
window.editor = K.create("#editor-content", {
width: "100%",
height: "450px",
resizeType: 0,
uploadJson: "/upload/editor-image/",
extraFileUploadParams: {
csrfmiddlewaretoken: "{{ csrf_token }}"
}
});
});
</script>
백엔드 처리
# urls.py
from django.urls import path
from . import views
urlpatterns = [
path("upload/editor-image/", views.upload_editor_image, name="upload_editor_image"),
]
# views.py
import os
from django.conf import settings
from django.http import JsonResponse
from django.views.decorators.http import require_POST
@require_POST
def upload_editor_image(request):
response = {"error": 0}
image_file = request.FILES.get("imgFile")
if image_file is None:
return JsonResponse({"error": 1, "message": "이미지 파일이 없습니다."})
target_dir = os.path.join(settings.BASE_DIR, "media", "editor")
os.makedirs(target_dir, exist_ok=True)
saved_path = os.path.join(target_dir, image_file.name)
with open(saved_path, "wb") as fp:
for chunk in image_file.chunks():
fp.write(chunk)
response["url"] = "/media/editor/%s" % image_file.name
return JsonResponse(response)
- KindEditor는 업로드 응답으로 특정 JSON 형식을 요구한다.
imgFile은 KindEditor가 업로드 파일에 사용하는 키다.
업로드 응답 JSON
// 성공
{"error": 0, "url": "/media/editor/example.png"}
// 실패
{"error": 1, "message": "오류 메시지"}