Django에서 프로젝트를 할 때, 내가 만드는 것은 거의 없고 다 가져와서 쓰는 것이다. 모든 것이 모듈에서 빌려 쓰는 것이이기 때문에 Django의 규칙을 이해하는 것이 중요하다.

그래서 입문 자료를 정리하면서 어떤 flow인지 익히고, 내가 궁금했던 개념들만 우선적으로 정리해놓으려고 한다. (사실 tutorial을 너무 발번역 해놔서 개념을 다시 정리하는 거...)

0. Django?

장고는 파이썬으로 작성된 오픈 소스 웹 애플리케이션 프레임워크로, 모델-뷰-컨트롤러 패턴을 따르고 있다. 현재는 장고 소프트웨어 재단에 의해 관리되고 있다. 고도의 데이터베이스 기반 웹사이트를 작성하는 데 있어서 수고를 더는 것이 장고의 주된 목표이다.

• 라이브러리: 내 코드에 불러와서 쓰는 것 모듈과 같은 것이다.
• 프레임워크: 프레임워크가 원하는 상태가 있더. 틀 안에서 설명서대로 원하는 결과를 받을 수 있다.
• 마이크로 프레임워크: 단순한 기능으로만 만들어져 있는 프레임워크. 예)플라스크

MVC

모델-뷰-컨트롤러는 소프트웨어 공학에서 사용되는 소프트웨어 디자인 패턴이다. 위키의 개념 설명을 참고해보자.

모델, 뷰, 컨트롤러의 관계를 묘사하는 간단한 다이어그램. 주: 굵은 선은 직접적인 관계를, 점선은 간접적인 관계를 나타낸다

• Model: 모델의 상태에 변화가 있을 때 컨트롤러와 뷰에 이를 통보한다. 이와 같은 통보를 통해서 뷰는 최신의 결과를 보여줄 수 있고, 컨트롤러는 모델의 변화에 따른 적용 가능한 명령을 추가·제거·수정할 수 있다. 어떤 MVC 구현에서는 통보 대신 뷰나 컨트롤러가 직접 모델의 상태를 읽어 오기도 한다.
• View: 사용자가 볼 결과물을 생성하기 위해 모델로부터 정보를 얻어 온다.
• Controller: 모델에 명령을 보냄으로써 모델의 상태를 변경할 수 있다. (예: 워드 프로세서에서 문서를 편집하는 것) 또, 컨트롤러가 관련된 뷰에 명령을 보냄으로써 모델의 표시 방법을 바꿀 수 있다. (문서를 스크롤하는 것)

1. setup

본격적으로 django를 사용해보자. 아래부터는 미니콘다3이 깔려있는 것을 전제로 한다. 가상환경에 패키지를 깔고 프로젝트를 만들 수 있는 상태로 만들어보자.

1.1 가상환경

내가 프로젝트를 시작할 때 만약 원하는 버전의 가상환경이 이미 만들어져 있다면, 굳이 새로운 env를 만들 필요는 없을 것이다. 다만 미디콘다3을 통해 가상환경 만드는 것에 익숙해지기 위해서 프로젝트마다 환경을 만들고 Django를 설치하는 습관을 들이고 있다.

- 가상환경 생성

conda create -n myenv python=3.8 django 

conda create -n myenv --clone base
# 새 가상환경을 만들 때 로컬의 기존 가상환경에 설치된 패키지 똑같이 설치하면서 생성할 수 있다.

가상환경 생성 시 파이썬 버전을 지정해야 한다. 현재 기준으로 안정화된 최신 버전은 3.8이다. 지정하지 않으면 conda에 기본 포함된 파이썬 버전으로 생성되니 버전 설정을 까먹지 말자!

-n 옵션은 --name과 동일한 명령어다. 가상환경 이름을 정한다.

엔터를 누르면 다음과 같이 가상 환경을 해당 경로에 설치할 것이라고 안내 해주는 화면이 뜬다. 이상 없으면 y를 눌러 최종적으로 설치를 완료한다.

## Package Plan ##

  environment location: /Users/yeni/miniconda3/envs/myenv
conda env list

Proceed ([y]/n)? y

- 생성 확인

이후 대충 설치 완료됐다는 화면이 뜬다. 이제 conda env list 명령어를 통해 conda에 설치되어 있는 여러 가상환경을 확인할 수 있다.

conda env list 명령어는 내가 만든 env(environment) 즉 가상 환경의 리스트를 보여준다. 활성화되어있는 가상환경 옆에 *이 표시되어 있는 것을 볼 수 있다.

conda env list 
''' 
conda environments:

base                  *  /Users/yeni/miniconda3
test01                   /Users/yeni/miniconda3/envs/test01
yeni                     /Users/yeni/miniconda3/envs/yeni
'''

- 가상환경 실행

사실 설치 완료 화면에 가상환경을 활성화하는 명령어가 나오긴 한다. 프로세스상 마지막이니 그냥 따로 넣어보았다.

conda activate myenv 
conda deactivate

- django 설치

만약 가상환경을 만들 때 패키지를 설치하지 못했다면, 가상환경이 실행된 뒤에 추가로 원하는 패키지를 설치할 수 있다. conda list 명령어를 통해 패키지 설치가 잘 되어 있는지 리스트에서 확인한다.

conda install django # django 설치해주세요
conda list #설치되어 있는 패키지 리스트 보여주세요 

1.2 project

conda activate 가상환경이름 을 입력하면 이제 가상환경이 돌아갈 것이다. 로컬에서 내가 프로젝트를 저장할 경로에 들어가자.

- project 만들기

원하는 경로에 접속해 아래 명령어를 입력하면, django가 알아서 myapp이라는 디렉토리를 만든다. tree를 통해 확인해보면 다음과 같다. (tree는 mac에서 디렉토리를 트리 구조로 보기 위해 따로 설치해야 한다. brew install tree 입력 후 설치하자!)

django-admin startproject myapp # myapp 프로젝트 만들어줘

❯ myapp 
❯ tree
.
├── manage.py 
└── myapp 
    ├── __init__.py
    ├── asgi.py
    ├── settings.py
    ├── urls.py
    └── wsgi.py

1 directory, 6 files

- root directory

django project를 만들면 root directory는 manage.py 파일이 있는 곳이다. manage.py가 commnad line utility이기 때문에, 서버 실행을 하려면 꼭 해당 디렉토리에 위치해있어야 한다는 점을 기억하자.

- app 만들기

root dir에서 polls라는 앱을 만들어보자. 명령어는 project와 비슷하다. startproject를 startapp으로 바꾸면 된다. 그러면 root dir에 새로운 파일이 생기고, project에는 없었던 admin.py, apps.py, models.py가 생긴다.

app을 만들면 root dir와는 다르게 urls.py 파일이 생기지 않는다. 라우팅을 해주려면 내가 파일을 따로 만들어야 한다!

❯ python manage.py startapp polls # polls라는 app 만들어주세요
❯ ls # 리스트좀 보여주세요 
manage.py myapp polls # root dir에 polls가 생겼습니다.
❯ cd polls # polls에 들어가보아요 
❯ tree # 디렉토리는 이렇게 생겼어요!
.
├── __init__.py
├── admin.py
├── apps.py
├── migrations
│   └── __init__.py
├── models.py
├── tests.py
└── views.py

1 directory, 7 files

2. what files do

위 root directory에 기본적으로 있는 파일의 역할에 대해 알아보자. part1을 정리할 때 했지만 이해가 안가니^^ 또^^ 해보자^^

2.1 default

• outer myapp: 프로젝트를 담는 그릇. 이름은 상관 없고 내 마음대로 바꿀 수 있다.
• inner myapp: 실제 파이썬 패키지로, 바깥 myapp과는 전혀 다르다. 어떤 것이든 myapp 안에 넣기 위해 해당 이름을 사용해야 하기 때문이다.
• manage.py: 커맨드라인 *유틸리티. django 프로젝트와 상호작용하게 만든다.
• __init__.py: 요 파일이 포함된 디렉토리가 python package로 인식되어야 한다고 알려준다.
• asgi.py : 비동기 통신(채팅 같이 동시 다발적으로 발생하는)을 위한 모듈이다.
• wsgi.py : python 웹 서버를 만들 때 사용하는 모듈이다. 표준 같은 것으로 flask에서도 쓴다. 즉 django여서 있는게 아니라, 갖다 쓰는 것이라는 뜻이다.

장고 공식 문서의 설명이 간결해서 몇 개는 영문도 함께 넣었다.

outer myapp - container of project. its name doesn't matter.

inner myapp - actual python package. you need to use this name to import anything insde it (e.g. myapp.urls)

manage.py - command line utility. lets you interact with django project

유틸리티: 컴퓨터에서 유틸리티란 운영체계에서 제공되는 것 외에 추가의 기능을 제공하는 작은 프로그램을 의미한다.

2.2 사용 파일

settings.py / views.py / migrations / models.py / urls.py 에 대해서 자세히 매우 자세히 살펴보도록 하자. 앞으로 자주 써야되니까 확실히 알고 넘어가자😎

- settings.py

프로젝트를 만들고 가장 먼저 봐야 할, 처음에 가장 중요한 파일이다. settings, configuration 정보를 담고 있다. 들어가서 읽어보면 중요한 설정을 내 프로젝트에 어떻게 적용할지를 보여주고 있다. 대충 아래 내용을 포함한다.

• 디버그 : 개발할 때는 True 상태로 해야 에러 메시지를 받을 수 있고, 배포 시에는 False로 바꾼다. 배포 했는데 True 상태이면 없는 경로에 들어갔을 때 아무에게나 코드와 경로를 공개하는 불상사가 생긴다 😞

• 접근권한 : '*'로 설정하면 모두에게 허용하게 되고, 아무 것도 쓰지 않으면 나만 접근할 수 있다. 주소나 ip대역을 넣어 특정 국가 등으로 권한을 제한할 수 있다.

• INSTALLED_APPS : admin, auth, session 등 처음 설치하면 내장 앱이 깔려있다. project 내에 app을 만들면 해당 리스트에 추가해주어야 한다.

• ROOT_URLCONF: localhost:8000에 host로 들어오면 해당 urls를 바라보게 하겠다는 뜻이다.

ROOT_URLCONF = 'test01.urls' 
# localhost:8000(=/)로 들어오면 test01.urls를 호출할게!

• 탬플릿: html, css를 뿌리는 것에 대한 내용이다. 앞으로 진행할 프로젝트에서 화면 구현은 다루지 않을 것이라 넘어갔지만, 추후 어떤 내용인지 이해하는 것이 필요하다.

• 데이터베이스: django는 데이터베이스 없이 돌아갈 수 없다. default일 경우 python을 설치할 때 포함된 sqlite3을 사용하게 된다. 데이터베이스는 변경할 수 있다.

• 타임존: 한국은 Asia/seoul로 설정한다. 그리니치 기준시로 설정하면 파이썬에서 타임존을 인식하는 방법과 다른 것인지 읽어들이지 못한다.

• 다국어지원 등 등 등

- views.py

로직을 담당하는 파일. 프로젝트를 만들면서 가장 많이 들어가게 된다. vies.py에서 어떤 행동을 하게 만들기 위해서 function이 아닌 class를 사용한다.

로직을 짤 때에는 내가 구현하고 싶은 행동이 무슨 method에 해당하는지 잘 알아야 한다. 예를 들어 데이터 조회는 가져오는 것이니까 get이고, 데이터를 추가하면 post다. 내가 데이터를 받는건지, 수정하는지, 지우는건지 것인지 등 행위에 맞게 메소드를 지정해줘야 한다!

다음 단계에서 많이 다루게 될 것이므로 우선 이정도로만 정리하겠다.

class based view
뷰에는 함수형 뷰, 클래스형 뷰가 있다. 함수형 뷰는 method가 뭔지 알 수 없는 반면, 클래스형 뷰는 class 안에서 get, post 등 로직을 구분할 수 있어 메소드가 명확하다는 장점이 있다.

class 내에서 post, get 함수를 중복해서 사용할 수 없기 때문에 class는 하나의 로직에 대해서만 쓰고, 내가 원하는 endpoint가 있다면 class를 만들어 urls.py에서 라우팅한다. class 안의 as_view 함수가 알아서 라우팅을 해주기 때문에 편하다.

- models.py

장고의 핵심 기능중 하나인 ORM과 관련된 파일. 저장된 데이터의 구조를 정한다. 모델에서 구조와 코드를 작성하면, Django가 데이터베이스와 소통하는 모든 더러운 작업을 대신 해준다. 구성하고 있는 요소들은 다음과 같다.

• 필드 타입
• 데이터의 최대 크기
• 기본값
• 선택 리스트 옵션
• 문서를 위한 도움 텍스트
• 폼을 위한 라벨 텍스트

- migrations 파일

models.py에서 정의한 테이블 구조를 manage.py의 makemigrations 옵션을 통해 새성해 저장하는 디렉토리. 여기서 궁금한 것도 많고 정리할 것도 많아서 다른 게시물에 따로 정리했다.

https://velog.io/@matisse/Django-migrations-집중-탐구

- urls.py

경로를 라우팅을 해주는 파일이다. root dir의 urls.py 파일에 들어가면, urlpatterns = [] 라는 빈 리스트 파일이 있다.

localhost8000에서 갖고 있는 주소는 /를 기본으로 받는다. 무조건 받는 고유 주소이다. 만약 root dir에서 app의 url을 지정하면, 나머지는 앱에 위임하게 된다.

주의사항

root urls.py에서 path를 'user'로 지정했기 때문에, app urls.py에서는 path 앞에 슬래이시를 붙여야 올바르게 주소가 설정된다.

만약 myproject root 디렉토리의 urls 파일에서 앱으로 연결했다면, app(아래 예시에서 app의 이름은 comment로 가정)의 urls.py에서는 앞에 /를 붙여줘야 하는 것이다. 그래야 127.0.0.1:8000/uesr/comment 로 연결될 수 있다.

# my project root directory urls.py
urlpatterns = [ path('user', include ('user.urls')) ] 

# comment urls,py
urlpatterns = [ path('/comment', CommentView.as_view()) ]

에러 발생 시

위처럼 app의 path에 /를 붙이고 runserver에서 include, slash 관련 에러가 뜬다면 root directory settings.py에서 아래 설정을 추가해주면 된다. (추가 하지 않으면 디폴트는 True이다)

APPEND_SLASH = False

말이 길어졌는데 결론은! django에서 작업할 때 urls에 경로를 지정한 것을 enpoint로 보면 된다.

endpoint?

http 통신에서 request를 받는 곳이다. request에 대한 response가 있어야 완전한 http 통신이라고 할 수 있는데, endpoint라는 접점에 접근하면서 행위에 대한 결과(POST, GET 등)를 받게되는 것이다. 불필요한 end point, 즉 urls 경로에 쓸데 없이 많은 경로를 넣지 않는 것이 중요하다.

사전적 정의:

data를 얻기 위해, 혹은 API를 통해 어떤 actin을 할 때 접근하는 URL. endpoint는 웹 서비스로 가는 주소나 연결 지점를 정의한다.

ENDPOINT Defines the address or connection point to a Web service. It is typically represented by a simple HTTP URL string.

3. workflow

🙄 개발자가 일하는 순서와 장고가 일하는 순서는 반대라고 한다 🙄

• 보통 프로젝트를 만들 때 개발자가 일 하게 되는 순서: 테이블 만들고 로직 짜서 연결 시켜주기
  models.py -> views.py -> urls

• 장고 프로그램이 작동하는 순서: url(경로)을 보고 로직을 확인해 테이블에서 데이터 가져오기
  urls -> views -> models

+++ 추가: python shell에서 데이터가 어떻게 들어가는지 검증을 한 다음에, view에 가서 로직을 작성하면 좋다.

3.1 개발 순서

아직 정리가 다 안 되었기 때문에 아마 계속 수정할 것 같다. 우선 지금 하고 있는 작업을 기준으로 정리해보자.

- root dir.

1. 가상 환경 실행 후 project 를 만들고, 프로젝트 안에 app을 만든다.
2. root dir. settings의 INSTALLED_APPS에 내가 만든 app을 리스트 마지막에 껴주고, 프로젝트 관련 설정(시간대 등)을 바꿔준다.
3. root dic. urls에서 app의 경로를 지정해준다.

- app dir.

5. models: 데이터 틀을 만든다.(=모델을 정의한다)
6. views: models에서 만든 데이터의 행동(=method)을 정의한다. python shell에서 models를 가지고 검증도 해본다.
7. urls: views에서 만든 행동과 endpoint를 연결한다. urls.py에서 정리할 때 언급했듯 /에 주의하자.

root, app이 셋팅됐다면

makemigrations & migrate를 통해 데이터베이스를 설치 및 적용한다. 이제 models에서 만든 class로 데이터베이스가 만들어지고, 거기에 데이터를 넣을 수 있다.

httpie 로 데이터가 받아지고 200이 뜨면 정말 신기하고 뿌듯하다. 에러도 받다보니 어디서 잘못됐는지 조금 감이 잡힌다. 😎