自訂管理指令：程式碼詳細解說
更新日期： 2024 年 12 月 24 日
本文為 Django 分類功能系列教學，第 5 篇：
以下是一個完整的 Django 自訂管理指令範例，用於初始化分類資料（Category 模型）。
接下來我們將針對程式碼進行詳細解說，幫助新手理解其功能與運作方式。
指令程式碼
完整程式碼
from django.core.management.base import BaseCommand
from categories.models import Category
class Command(BaseCommand):
help = "Seeds the database with categories"
def handle(self, *args, **options):
initial_categories = [
{"name": "設計與創意", "created_at": "2024-12-23"},
{"name": "技術程式開發", "created_at": "2024-12-23"},
{"name": "寫作與內容創作", "created_at": "2024-12-23"},
{"name": "行銷與廣告", "created_at": "2024-12-23"},
{"name": "攝影創作", "created_at": "2024-12-23"},
{"name": "顧問與專業服務", "created_at": "2024-12-23"},
{"name": "生活娛樂", "created_at": "2024-12-23"},
]
for category_data in initial_categories:
category, created = Category.objects.get_or_create(
name=category_data["name"], created_at=category_data["created_at"]
)
if created:
self.stdout.write(self.style.SUCCESS(f"Category '{category.name}' created"))
else:
self.stdout.write(self.style.WARNING(f"Category '{category.name}' already exists"))
程式碼解說
匯入必要的模組
from django.core.management.base import BaseCommand
from categories.models import Category
BaseCommand：自訂指令的基礎類，提供指令的框架和方法。Category模型：初始化分類資料所需的模型，確保指令能操作分類表。
定義指令類
class Command(BaseCommand):
help = "Seeds the database with categories"Command：繼承自BaseCommand，用於定義具體指令邏輯的類別。help屬性：定義指令的用途，在執行python manage.py help seed_categories時會顯示，方便開發者了解功能。
核心邏輯：handle 方法
handle 方法是自訂指令的入口，執行指令時會調用這個方法。
定義初始資料
initial_categories = [
{"name": "設計與創意", "created_at": "2024-12-23"},
{"name": "技術程式開發", "created_at": "2024-12-23"},
{"name": "寫作與內容創作", "created_at": "2024-12-23"},
{"name": "行銷與廣告", "created_at": "2024-12-23"},
{"name": "攝影創作", "created_at": "2024-12-23"},
{"name": "顧問與專業服務", "created_at": "2024-12-23"},
{"name": "生活娛樂", "created_at": "2024-12-23"},
]
- 初始資料格式：
使用列表包裹字典，每個字典包含分類的名稱（name）和建立時間（created_at）。 - 靈活性：
可以根據需求修改或擴展分類資料，新增更多分類。
迴圈處理每個分類
for category_data in initial_categories:<br> category, created = Category.objects.get_or_create(**category_data)Category.objects.get_or_create：- 試圖從資料庫查詢是否存在指定分類（以
name和created_at為條件）。 - 如果存在，返回該分類物件（
category）和布林值created=False。 - 如果不存在，創建該分類並返回物件（
category）和布林值created=True。
- 試圖從資料庫查詢是否存在指定分類（以
- 參數解構：
**category_data 取出字典中的鍵值，傳遞給查詢方法。
拆解說明：解構與未解構版本對比
在 Django 的
get_or_create方法中，返回值是一個 tuple，包含兩個元素：
- 第一個元素：查詢到的或新創建的模型實例（如
Category）。- 第二個元素：布林值，指示資料是否是新建的（
True表示新建，False表示已存在）。以下是對比解構與未解構版本的說明：
解構版本
category, created = Category.objects.get_or_create(**category_data)說明
- 動作：
- 解構
get_or_create返回的 tuple。- 將第一個元素賦值給
category，將第二個元素賦值給created。- 簡潔性：
- 適合熟悉解構語法的開發者，節省代碼行數。
- 結構：
- 直接分配兩個變數，表達結果含義清晰。
未解構版本
result = Category.objects.get_or_create( name=category_data["name"], created_at=category_data["created_at"] ) # get_or_create 返回一個 tuple，第一個元素是物件，第二個元素是布林值 category = result[0] # 取得返回的 Category 物件 created = result[1] # 取得是否創建的布林值說明
- 動作：
- 先將
get_or_create的結果存為變數result。- 手動從 tuple 中提取兩個元素：
result[0]：模型實例（category）。result[1]：布林值（created）。- 清晰性：
- 適合學習階段，幫助理解
get_or_create的返回結構。- 結構：
- 更明確地展示了 tuple 的組成，方便新手理解。
判斷分類是否新建
if created:
self.stdout.write(self.style.SUCCESS(f"Category '{category.name}' created"))
else:
self.stdout.write(self.style.WARNING(f"Category '{category.name}' already exists"))if created判斷：
根據created值，輸出不同的提示訊息：True：分類是新建的，輸出成功訊息（綠色字體）。False：分類已存在，輸出警告訊息（黃色字體）。
- 輸出方法：
self.stdout.write：將訊息輸出到命令行。self.style.SUCCESS：以綠色字體格式化成功訊息。self.style.WARNING：以黃色字體格式化警告訊息。
結束訊息
self.stdout.write(self.style.SUCCESS("初始化分類資料完成！"))- 作用：在所有分類處理完成後，輸出最終訊息，提示指令執行完畢。
總結
這段程式碼的核心邏輯是：
- 定義初始分類資料列表。
- 遍歷分類資料，使用
get_or_create確保資料不重複。 - 根據新增或已存在的情況輸出對應訊息。
- 在所有操作完成後，輸出結尾提示。
指令的優點
- 避免重複新增：透過
get_or_create確保分類不會重複插入。 - 清晰的反饋：提供不同顏色的提示訊息，方便辨識操作結果。
- 擴展性強：可輕鬆修改初始分類資料，適應不同需求。
實際操作
執行以下命令來執行指令：
python manage.py seed_categories輸出示例：
Category '設計與創意' created
Category '技術程式開發' already exists
Category '寫作與內容創作' created
初始化分類資料完成！這樣，分類資料就成功初始化到資料庫中！