[Django] Admin을 이용하여 DB 관리

📚  Django admin이란?

 

Django 에서 기본적으로 제공해주는 관리자 앱을 의미한다.  django.contrib.admin 앱을 통해 제공되고 있으며 모델 클래스를 등록하여 기본적인 CRUD을 웹UI을 통해 제공한다. 

 

서비스 초기에 관리도구로 사용하기 좋으며, 관리 도구 만들 시간을 줄일 수 있다는 점이 장점이다. 

 

 

 

📚  모델 클래스 admin에 등록하기

 

model을 admin에 추가하는 방법으로는 아래 3가지 방법 중에서 하나 선택해서 admin에 등록하여 사용하면 된다. 내가 듣고 있는 inflearn 강의에서는 3번 방법을 추천한다. 

from django.contrib import admin
from .models import object


# 등록법 #1
admin.site.register(object) # 기본 ModelAdmin으로 동작


# 등록법 #2
class objectAdmin(admin.ModelAdmin):
	pass
admin.site.register(object, objectAdmin) # 지정한 ModelAdmin으로 동작


# 등록법 #3
@admin.register(object)
class objectAdmin(admin.ModelAdmin):
	pass

📚  admin에 등록된 모델명 직관적으로 나타내기

 

 

admin에 등록되는 모델 객체의 명을 직관적으로 나타내기 위해서 Python 특수 메소드 __str__을 이용한다. 

from django.db import models

# Create your models here.
class Post(models.Model):
    message = models.TextField()
    created_at = models.DateTimeField(auto_now_add=True)
    updated_at = models.DateTimeField(auto_now=True)

    def __str__(self):
        return f"<{self.pk}> {self.massage}"

 

 

 

 

📚  @admin.register(Item) 으로 구현된 admin 속성 제어

 

list_display 속성을 이용하여 admin 페이지에 보여주고자 하는 필드 값을 조정 할 수 있으며 list_display_links을 눌러 해당 객체에 대한 속성들을 확인 할 수 있도록 제어 할 수 있다. 

from django.contrib import admin
from .models import Post

# Register your models here.
@admin.register(Post)
class Postadmin(admin.ModelAdmin):
    list_display = ["message", "created_at"]
    
    # message를 누르면 model detail로 넘어가도록 설정
    list_display_links = ["message"]

 

 

search_fields 속성을 이용하면 검색 UI을 통해 DB을 검색 할 수 있다. 

from django.contrib import admin
from .models import Post

# Register your models here.
@admin.register(Post)
class Postadmin(admin.ModelAdmin):
    list_display = ["message", "created_at"]
    list_display_links = ["message", "created_at"]

    search_fields = ['message']

 

 

 

list_filter 속성을 이용하면 admin 페이지 오른쪽에 필터 옵션이 추가되어 해당 필터에 따른 결과를 받을 수 있다.

from django.contrib import admin
from .models import Post

# Register your models here.
@admin.register(Post)
class Postadmin(admin.ModelAdmin):
    list_display = ["message", "created_at"]
    list_display_links = ["message", "created_at"]
    list_filter = ["created_at"]

    search_fields = ['message']