Django 已經是一套相當成熟的 Web 框架,該有的功能也都一應俱全,但有些時候不免需要進行客製化。例如 Django 內建的 User model 雖已堪用,但難免需要額外增加欄位或修改 Primary Key ,本篇將介紹如何擴充 Django 既有的 User model 。

執行環境

本文的執行環境:

  • Python 3
  • Django 1.10.6

新增共用的 Django App

一般共用的元件,我都會放在一個稱為 core 的 app 中集中管理:

$ ./manage.py startapp core

繼承 AbstractUser

擴充既有的 User model 很簡單,只要繼承 AbstractUser 即可,例如以下為修改 Primary Key 的範例:

# core/models.py
import uuid

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

class MyUser(AbstractUser):
    id = UUIDField(primary_key=True, default=uuid.uuid4, editable=False)

修改 settings.py

擴充完既有的 User model 之後必須於 settings.py 中增加一個設定 AUTH_USER_MODEL ,將認證的 model 改為新的 User model 。

例如改為 core app 底下的 MyUser ,同時把 core app 加到 INSTALLED_APPS 中:

# settings.py
AUTH_USER_MODEL = 'core.MyUser'

INSTALLED_APPS = [
    # skipped
    'core',
]

接著 migrate DB:

$ ./manage.py makemigrations core
$ ./manage.py migrate core

這樣就修改完畢了!

使用新的 User model

新的 User model 在使用時就不再是透過原有的 import 方式進行使用,若在其他 model 中需要用到的話,則需改用 settings.AUTH_USER_MODEL ,例如:

# mytestapp/models.py
from django.conf import settings
from django.db import models
from django.db.models import OneToOneField


class MyTestModel(models.Model):
    user = OneToOneField(settings.AUTH_USER_MODEL, on_delete=CASCADE)

此外, Django 也有提供 get_user_model() 來取得設定好的 User model ,但前提是必須讓 Django import 完所有 models 才能夠使用,否則就會出現 django.core.exceptions.AppRegistryNotReady: Models aren't loaded yet. 錯誤訊息。

以上本文結束!