계정 관리 시스템

계정을 관리 하는 시스템 입니다. 해당 본 문서는 django 기반의 계정 관리 시스템을 빠르게 웹 프로그램에 적용하기 위해 개발 되었습니다.
⚠️ 해당 문서는 django account을 사용해 개발을 하는 개발자용 문서입니다.
해당 문서를 읽고 django 계정 관리 시스템을 본인이 진행하고자 하는 프로젝트에 적용 및 커스텀마이징 할수 있습니다.
git page : account

0. 들어가기 전에

Project 생성 ( 해당 포스팅에서는 ams )
app 생성( 해당 포스팅에서는 account)
app 등록
app url 생성 및 등록
package install

1. auth url 등록

django 내 기본 app 중 하나인 auth app url 을 등록한다.

# 파일 위치
# ams
# |-account
#   |-ams
#     |-urls.py <-- 파일 위치 

urlpatterns = [
    path('admin/', admin.site.urls),
    path('account', include('account.urls'), name='account'),
    path('account/', include('django.contrib.auth.urls')),  #<-- django auth app url 을 등록
]

서버 실행시 후 http://127.0.0.1:8000/account/ 실행시 아래와 같은 페이지 생성 되면 정상
✅ checkpoint

2. 회원 가입 시스템

django 설치시 기본 앱 기능으로 유저 모델을 제공한다.하지만 유저 생성 기능은 관리자 앱에서 제공된다. 해당 페이지에서는 django 기본 유저 모델을 활용해 회원 가입 페이지를 만들고 기본 유저 모델을 확장하여 기존 유저 모델에 새로운 필드를 추가 할 수 있도록 한다.

Model - Form - View- Template 패턴으로 개발 됨.

2.1. Custom Model 생성

User 모델 상속받아 새로운 field 추가하기

from django.contrib.auth.models import AbstractUser
from django.db import models


# Create your models here.
class CustomUser(AbstractUser): # <-- 상속 부분
    phone_number = models.CharField(max_length=11)  # 전화번호(char)
    career = models.IntegerField()  # 경력 (int)
    rank = models.CharField(max_length=10)  # 직급 (select)
    region = models.CharField(max_length=100)  # 주소
    date_company_joined = models.DateField()  # 입사 기간
    id_number = models.CharField(max_length=13)  # 주민등록번호
    department = models.CharField(max_length=13)  # 부서
    resume = models.FileField(blank=True, null=True)  # 이력서
    id_photo = models.ImageField(blank=True, null=True, upload_to='')  # 증명사진


    def __str__(self):
        return self.username

AbstractUser 을 상속받는 CustomUser 에서는 위 AbstractUser 에서 정의된 field 이외에 추가 하고 싶은 field 을 정의하면 된다
- AbstractUser 아래와 같은 field을 가지고 있다.
  - username
  - first_name
  - last_name
  - email
  - date_joined
  - is_staff
⚠️ 새롭게 추가되는 필드에 null 허용이 안되거나 필드에 기본값이 설정되지 않으면 manage.py createsupseruser 으로 슈퍼유저생성시 admin site 에 접근이 안될수 있다.

2.2 Signup `ModelForm` 생성

class CustomUserCreationForm(UserCreationForm):
    class Meta:
        model = CustomUser
        fields = ('username',
                  'date_company_joined',
                  'phone_number',
                  'career',
                  'rank',
                  'date_company_joined',
                  'gender',
                  'id_number',
                  'department',
                  'resume',
                  'id_photo',
                  'password1',
                  'password2')  # <- User 생성시 보여줄 field 을 정의한다.

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)

        # null=True로 설정한 필드에 대해 required를 False로 설정
        self.fields['resume'].required = False
        self.fields['id_photo'].required = False

UserCreationForm의 상속 관계는 아래와 같다. forms.ModelForm →BaseUserCreationForm → UserCreationForm ModelForm 이 부모 클래스이다. ModelForm 사용 방법대로 UserCreateForm 을 사용하면 된다.
image field 을 사용할려면 Pillow package 가 필요하다. pip install Pillow

2.3 Signup 모델 등록

settings.py 에 모델 등록

# settings.py
AUTH_USER_MODEL = 'account.CustomUser'

2.4 Migrate

python manage.py makemigrations
python manage.py migrates

2.5 Signup 모델

2.5.1 HTML Tempalte

폴더 생성
```
 mkdir -p account/templates/account
```

templates 생성

touch account/templates/account/signup.html

<!-- templates/registration/login.html -->
<h2>Signup</h2>
<form action="" method="post" enctype="multipart/form-data">
  {% csrf_token %}
  {{ form.as_p }}
  <button type="submit">Signup</button>
</form>

{{ errors }}

2.5.2 View

회원가입

def signup(request):
    if request.method == 'POST':
        form = CustomUserCreationForm(request.POST, request.FILES)  # <-- FILES 와 같이 입력이 되어야 한다.
        if form.is_valid():
            # file field 데이터 저장
            inst = form.save(commit=False)

            # file field 데이터 저장
            id_photo = form.cleaned_data['id_photo']
            inst.id_photo.save(id_photo.name, id_photo)

            # Signup 결과 페이지
            return HttpResponse('Signup complete')
        else:
            print('Errors:', form.errors)
            return render(request, template_name='account/signup.html', context={'errors': form.errors})

    elif request.method == 'GET':
        form = CustomUserCreationForm()  # <-바뀐 부분
        return render(request, template_name='account/signup.html', context={'form': form})

    else:
        raise NotImplementedError

2.5.3 URLConf 등록

account URLConf 등록

# ams/account/urls.py
from django.urls import path, include
from account.views import signup

app_name = 'account'
urlpatterns = [
    path('signup/', signup, name='signup')
]

✅ Checkpoint

2.5.4 Media 파일 저장 위치 설정

# settings.py
MEDIA_ROOT = BASE_DIR / 'media'
MEDIA_URL = '/media/'

# ams/urls.py
from django.conf.urls.static import static
from ams import settings

urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

3. Login & Logout

3.1 Login

3.1.1 Login template 위치 변경

LoginView class 로 이동 후 아래 코드로 변경 LoginView 는 해당 위치에 정의되어 있다. ( django.contrib.auth.views import LoginView )

# django.contrib.auth.views import LoginView <-- 여기로 이동후 변경
class LoginView(RedirectURLMixin, FormView):
    ...
    template_name = "account/login.html"  # <-- ❗️ 여기 부분을 변경한다.
    ...

3.1.2 Html Template 생성

touch account/templates/account/login.html

<!-- templates/account/login.html -->
<h2>Log In</h2>
<form method="post">
  {% csrf_token %}
  {{ form.as_p }}
  <button type="submit">Log In</button>
</form>

✅ Checkpoint (3.1, 3.2)

(⚠️ django 에서는 기본적으로 login 성공 시 accounts/profile/ 경로로 redirect 한다.)

3.1.3 Login redirect 설정

로그인 이후 가고자 하는 url 을 settings.py 에 등록
아래 예시에서는 account/profile 로 로그인 이후 redicrect 하도록 변경 (4. Profile 에서 추가 셋팅 진행 예정)

# settings.py
LOGIN_REDIRECT_URL = '/account/profile'

3.2 Logout

3.2.1 Logout URL

1.1 auth app 등록 단계를 진행했다면 단순히 /accounts/logout url 로 접속하면 된다.

3.2.2 로그 아웃시 특정 페이지로 이동하게 하기

로그인 페이지와 같게 settings.py 에 logout 성공 시 이동하는 페이지를 정의해 둔다.

LOGOUT_REDIRECT_URL = 'home' # new

4. Profile

4.1 HTML Templates

templatetags 생성

mkdir -p account/templatetags
touch account/templatetags/index.py

# account/templatetags/index.py 
from django import template
register = template.Library()

@register.filter
def index(indexable, i):
    return indexable[i]

@register.filter
def getattribute(indexable, attr):
    return indexable.__getattribute__(attr)

template profile.html 생성

touch account/templates/account/profile.html

<!-- account/templates/account/profile.html -->
{% load index %}
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>

{% for field in field_names %}
    {% with field_type=types|index:forloop.counter0 attr=user|getattribute:field %}
        {% if field_type == 'ImageField' %}
            {{ field }} : <p><img src={{ attr|getattribute:'url' }}></p>
        {% elif field_type == 'FileField' %}
            {{ field }} : <p><a href={{ attr|getattribute:'url' }}>{{ attr }}</a></p>
        {% else %}
            <p>{{ field }} : {{ attr }} : {{ types | index:forloop.counter0 }}</p>
        {% endif %}
    {% endwith %}
{% endfor %}

</body>
</html>

4.2 Profile Forms

# 경로 : ams/account/forms.py 
class CustomUserProfileForm(UserCreationForm):
    class Meta:
        model = CustomUser
        # 회원 가입 페이지에서 보여줄 기본 유저 필드
        base_field = ['username',
                      'first_name',
                      'last_name',
                      'email']

        # 회원 가입 페이지에서 보여줄 커스텀 유저 필드
        custom_field = ['phone_number',
                        'career',
                        'rank',
                        'date_company_joined',
                        'id_number',
                        'department',
                        'resume',
                        'id_photo',
                        'region']
        fields = tuple(base_field + custom_field)

4.3 Views

from django.db import models

@csrf_exempt
def profile(request):
    user = CustomUser.objects.get(username=request.user)
    # field 이름을 추출합니다.
    field_names = CustomUserProfileForm.Meta.field 

    # field 별 type 을 추출합니다.
    types = []
    for name in field_names:
        field = user._meta.get_field(name)
        # field 가 Image type 이면 'ImageType' 으로 타입을 저장합니다.
        # 모델 필드의 내부 타입은 실제 데이터베이스에서 사용되는 타입입니다.
        # get_internal_type()으로 반환되는 값은 FileField 입니다.
        if isinstance(field, models.ImageField):
            types.append('ImageField')
        else:
            types.append(field.get_internal_type())
    # template 을 rendering 합니다.
    context = {'user': user, 'field_names': field_names, 'types':types}
    return render(request, template_name='account/profile.html', context=context)

4.4 URLConf

# ams/account/urls.py
app_name = 'account'
urlpatterns = [
    path('signup/', signup, name='signup'),
    path('profile/', profile, name='profile'),
]

✅ Checkpoint (4.Profile) profile_checkpoint

5. Superuser

5.1 Superuser 생성

helper.py 파일 생성

touch ams/account/helper.py

# touch ams/account/helper.py 에 아래 코드 생성
from account.models import CustomUser

def createsuperuser():
    CustomUser.objects.create_superuser(username='admin',
                                        email='[email protected]',
                                        password='q1w2e3r4Q!W@E#R$',
                                        first_name='admin',
                                        last_name='admin',
                                        phone_number='01062766596',
                                        career=2,
                                        rank='manager',
                                        date_company_joined='2022-02-02',
                                        id_number='admin',
                                        department='관리부',
                                        region='서울').save()
    return 'Create Superuser : admin '
if __name__ == '__main__':
    createsuperuser()

helper 파일 실행

python manage.py shell

from account.helper import createsuperuser
createsuperuser()

✅ terminal 에 아래 명령어 보일시 성공 'Create Superuser : admin '

6. Admin site

ams/account/admin.py 에 아래 코드 추가
profile page 에서 보이는 유저 속성을 모두 확인 할 수 있음

from django.contrib import admin

# Register your models here.

from django.contrib import admin
from django.contrib.auth.admin import UserAdmin
from account.forms import CustomUserProfileForm
from account.models import CustomUser


class CustomUserAdmin(UserAdmin):
    model = CustomUser
    list_display = CustomUserProfileForm.Meta.fields


admin.site.register(CustomUser, CustomUserAdmin)

✅ Checkpoint

account system - pai-plznw4me/django-initializer GitHub Wiki

계정 관리 시스템

목차

0. 들어가기 전에

1. auth url 등록

2. 회원 가입 시스템

2.1. Custom Model 생성

2.2 Signup `ModelForm` 생성

2.3 Signup 모델 등록

2.4 Migrate

2.5 Signup 모델

2.5.1 HTML Tempalte

2.5.2 View

2.5.3 URLConf 등록

2.5.4 Media 파일 저장 위치 설정

3. Login & Logout

3.1 Login

3.1.1 Login template 위치 변경

3.1.2 Html Template 생성

3.1.3 Login redirect 설정

3.2 Logout

3.2.1 Logout URL

3.2.2 로그 아웃시 특정 페이지로 이동하게 하기

4. Profile

4.1 HTML Templates

4.2 Profile Forms

4.3 Views

4.4 URLConf

5. Superuser

5.1 Superuser 생성

6. Admin site

⚠️ GitHub.com Fallback ⚠️

account system - pai-plznw4me/django-initializer GitHub Wiki

계정 관리 시스템

목차

0. 들어가기 전에

1. auth url 등록

2. 회원 가입 시스템

2.1. Custom Model 생성

2.2 Signup ModelForm 생성

2.3 Signup 모델 등록

2.4 Migrate

2.5 Signup 모델

2.5.1 HTML Tempalte

2.5.2 View

2.5.3 URLConf 등록

2.5.4 Media 파일 저장 위치 설정

3. Login & Logout

3.1 Login

3.1.1 Login template 위치 변경

3.1.2 Html Template 생성

3.1.3 Login redirect 설정

3.2 Logout

3.2.1 Logout URL

3.2.2 로그 아웃시 특정 페이지로 이동하게 하기

4. Profile

4.1 HTML Templates

4.2 Profile Forms

4.3 Views

4.4 URLConf

5. Superuser

5.1 Superuser 생성

6. Admin site

⚠️ **GitHub.com Fallback** ⚠️

2.2 Signup `ModelForm` 생성

⚠️ GitHub.com Fallback ⚠️