การขยายโมเดลผู้ใช้ด้วยฟิลด์ที่กำหนดเองใน Django


442

อะไรคือวิธีที่ดีที่สุดในการขยายโมเดลผู้ใช้ (รวมกับแอพตรวจสอบความถูกต้องของ Django) ด้วยฟิลด์ที่กำหนดเอง ฉันอาจต้องการใช้อีเมลเป็นชื่อผู้ใช้ (เพื่อจุดประสงค์ในการตรวจสอบ)

ฉันได้เห็นวิธีการบาง อย่างแล้ว แต่ไม่สามารถตัดสินใจได้ว่าวิธีไหนดีที่สุด


24
คำตอบส่วนใหญ่ล้าสมัย / เลิกใช้แล้ว โปรดดู stackoverflow.com/a/22856042/781695 & stackoverflow.com/q/14104677/781695 & stackoverflow.com/q/16880461/781695
ผู้ใช้

@buffer - คำถามแรกที่คุณเชื่อมโยงกับ (stackoverflow.com/a/22856042/781695) ได้ถูกลบไปแล้ว คนอื่น ๆ ยังคงใช้ได้
โทนี่

3
หากต้องการใช้อีเมลแทนชื่อผู้ใช้สำหรับการตรวจสอบสิทธิ์บทความนี้มีประโยชน์


ฉันรู้สึกทึ่งมากที่เห็นคำถามถูกถามในปี 2008 ก่อนที่ Django จะวางจำหน่าย @Farinha
Tessaracter

คำตอบ:


253

วิธีที่เจ็บปวดและน้อยที่สุดที่ Django แนะนำในการทำเช่นนี้คือผ่านทางOneToOneField(User)ที่พัก

การขยายโมเดลผู้ใช้ที่มีอยู่

...

หากคุณต้องการเก็บข้อมูลที่เกี่ยวข้องUserคุณสามารถใช้ความสัมพันธ์แบบหนึ่งต่อหนึ่งกับโมเดลที่มีฟิลด์สำหรับข้อมูลเพิ่มเติม โมเดลแบบหนึ่งต่อหนึ่งนี้มักจะเรียกว่ารูปแบบโปรไฟล์เนื่องจากอาจเก็บข้อมูลที่ไม่เกี่ยวข้องกับผู้ใช้เว็บไซต์

ที่กล่าวว่าการขยายdjango.contrib.auth.models.Userและแทนที่มันยังใช้งานได้ ...

การแทนที่โมเดลผู้ใช้ที่กำหนดเอง

โครงการบางประเภทอาจมีข้อกำหนดการรับรองความถูกต้องซึ่งUserรูปแบบในตัวของ Django นั้นไม่เหมาะสมเสมอไป ตัวอย่างเช่นในบางเว็บไซต์คุณควรใช้ที่อยู่อีเมลเป็นโทเค็นการระบุแทนชื่อผู้ใช้

[Ed: คำเตือนสองคำและการแจ้งเตือนมีการพูดถึงว่านี่ค่อนข้างรุนแรง ]

ฉันจะอยู่ห่างจากการเปลี่ยนคลาสผู้ใช้จริงในต้นไม้ต้นกำเนิด Django ของคุณและ / หรือคัดลอกและแก้ไขโมดูลรับรองความถูกต้อง


51
FYI วิธีการใหม่ที่แนะนำ (1.0+) คือ OneToOneField (ผู้ใช้) docs.djangoproject.com/en/dev/topics/auth/…
Dave Forgac

2
Shawn Rider จาก PBS ให้เหตุผลที่ดีมากว่าทำไมคุณไม่ควรขยาย django.contrib.auth.models.User ใช้ OneToOneField (ผู้ใช้) แทน
pydanny

2
user = models.ForeignKey(User, unique=True)เป็นเช่นนี้user = models.OneToOneField(User)หรือไม่ ฉันคิดว่าผลสุดท้ายจะเหมือนกันหรือไม่ แต่การใช้งานในแบ็กเอนด์อาจแตกต่างกัน
Sam Stoelinga

7
ทุกคนสามารถเชื่อมโยงไปยังอาร์กิวเมนต์ Shawn Riders / เหตุผลได้หรือไม่
Jeremy Blanchard

1
นี่คือข้อมูลเพิ่มเติมบางส่วนเกี่ยวกับการขยายโมเดลผู้ใช้ ณ django 1.7 docs
Derek Adair

226

หมายเหตุ: คำตอบนี้เลิกใช้แล้ว ดูคำตอบอื่น ๆ หากคุณใช้ Django 1.7 หรือใหม่กว่า

นี่คือวิธีที่ฉันทำ

#in models.py
from django.contrib.auth.models import User
from django.db.models.signals import post_save

class UserProfile(models.Model):  
    user = models.OneToOneField(User)  
    #other fields here

    def __str__(self):  
          return "%s's profile" % self.user  

def create_user_profile(sender, instance, created, **kwargs):  
    if created:  
       profile, created = UserProfile.objects.get_or_create(user=instance)  

post_save.connect(create_user_profile, sender=User) 

#in settings.py
AUTH_PROFILE_MODULE = 'YOURAPP.UserProfile'

สิ่งนี้จะสร้างโปรไฟล์ผู้ใช้ทุกครั้งที่มีการบันทึกผู้ใช้หากมีการสร้างขึ้น จากนั้นคุณสามารถใช้

  user.get_profile().whatever

นี่คือข้อมูลเพิ่มเติมจากเอกสาร

http://docs.djangoproject.com/en/dev/topics/auth/#storing-additional-information-about-users

อัปเดต:โปรดทราบว่าAUTH_PROFILE_MODULEเลิกใช้แล้วตั้งแต่ v1.5: https://docs.djangoproject.com/en/1.5/ref/settings/#auth-profile-module


6
ขอบคุณสำหรับตัวอย่างที่ชัดเจนโปรดทราบว่า def create_user .... ไม่ได้เป็นส่วนหนึ่งของคลาส UserProfile และควรจัดชิดซ้าย
PhoebeB

5
ด้วยวิธีนี้ควรใช้รุ่นอื่น ForeignKey to User หรือ UserProfile หรือไม่
andrewrk

9
รุ่นอื่น ๆ ที่ควรใช้และเรียกวัตถุรายละเอียดผ่านทางuser = models.ForeignKey( User ) อย่าลืมuser.get_profile() from django.contrib.admin.models import User
Craig Trader

1
โดยใช้วิธีนี้ฉันต้องแยกเมื่อฉันดึงข้อมูลปกติ (ชื่อรหัสผ่าน) และกำหนดเองหรือมีวิธีที่จะทำในครั้งเดียว? เหมือนกันสำหรับการสร้างผู้ใช้ใหม่หรือไม่?
Martin Trigaux

5
คำตอบและความคิดเห็นนี้ล้าสมัยแล้วเช่น AUTH_PROFILE_MODULE เลิกใช้แล้วUser
ผู้ใช้

196

บางเวลาผ่านไปตั้งแต่ปี 2008 และถึงเวลาแล้วที่คำตอบใหม่ ๆ ตั้งแต่ Django 1.5 คุณจะสามารถสร้างคลาสผู้ใช้ที่กำหนดเองได้ อันที่จริงแล้วในขณะที่ฉันกำลังเขียนสิ่งนี้มันถูกรวมเข้ากับต้นแบบดังนั้นคุณจึงสามารถลองใช้ได้

มีข้อมูลบางอย่างเกี่ยวกับมันในเอกสารหรือถ้าคุณต้องการที่จะขุดลึกลงไปในมันในการกระทำนี้

สิ่งที่คุณต้องทำคือเพิ่มAUTH_USER_MODELการตั้งค่าด้วยพา ธ ไปยังคลาสผู้ใช้ที่กำหนดเองซึ่งขยายAbstractBaseUser(รุ่นที่ปรับแต่งได้มากขึ้น) หรือAbstractUser(คลาสผู้ใช้เก่าที่คุณสามารถขยายได้)

สำหรับผู้ที่ขี้เกียจคลิกตัวอย่างรหัสต่อไปนี้ (นำมาจากเอกสาร ):

from django.db import models
from django.contrib.auth.models import (
    BaseUserManager, AbstractBaseUser
)


class MyUserManager(BaseUserManager):
    def create_user(self, email, date_of_birth, password=None):
        """
        Creates and saves a User with the given email, date of
        birth and password.
        """
        if not email:
            raise ValueError('Users must have an email address')

        user = self.model(
            email=MyUserManager.normalize_email(email),
            date_of_birth=date_of_birth,
        )

        user.set_password(password)
        user.save(using=self._db)
        return user

    def create_superuser(self, username, date_of_birth, password):
        """
        Creates and saves a superuser with the given email, date of
        birth and password.
        """
        u = self.create_user(username,
                        password=password,
                        date_of_birth=date_of_birth
                    )
        u.is_admin = True
        u.save(using=self._db)
        return u


class MyUser(AbstractBaseUser):
    email = models.EmailField(
                        verbose_name='email address',
                        max_length=255,
                        unique=True,
                    )
    date_of_birth = models.DateField()
    is_active = models.BooleanField(default=True)
    is_admin = models.BooleanField(default=False)

    objects = MyUserManager()

    USERNAME_FIELD = 'email'
    REQUIRED_FIELDS = ['date_of_birth']

    def get_full_name(self):
        # The user is identified by their email address
        return self.email

    def get_short_name(self):
        # The user is identified by their email address
        return self.email

    def __unicode__(self):
        return self.email

    def has_perm(self, perm, obj=None):
        "Does the user have a specific permission?"
        # Simplest possible answer: Yes, always
        return True

    def has_module_perms(self, app_label):
        "Does the user have permissions to view the app `app_label`?"
        # Simplest possible answer: Yes, always
        return True

    @property
    def is_staff(self):
        "Is the user a member of staff?"
        # Simplest possible answer: All admins are staff
        return self.is_admin

ฟังก์ชั่น create_user ดูเหมือนจะไม่จัดเก็บชื่อผู้ใช้เป็นเช่นนั้นได้อย่างไร!
Orca

6
เพราะในตัวอย่างนี้emailคือชื่อผู้ใช้
Ondrej Slinták

5
คุณต้องเพิ่มลงunique=Trueในช่องอีเมลเพื่อให้USERNAME_FIELDยอมรับ
Richard de Wit

สวัสดีฉันพยายามสร้างผู้ใช้ที่กำหนดเองตามที่คุณพูด แต่ไม่สามารถเข้าสู่ระบบโดยใช้อีเมลของอีเมลผู้ใช้ที่กำหนดเอง คุณไม่รังเกียจที่จะพูดว่าทำไม
ไลโอเนล

ฉันไม่สามารถช่วยคุณได้โดยเฉพาะ คงจะดีกว่าถ้าคุณสร้างคำถามใหม่
Ondrej Slinták

47

ตั้งแต่ Django 1.5 คุณสามารถขยายโมเดลผู้ใช้ได้อย่างง่ายดายและเก็บตารางไว้ในฐานข้อมูล

from django.contrib.auth.models import AbstractUser
from django.db import models
from django.utils.translation import ugettext_lazy as _

class UserProfile(AbstractUser):
    age = models.PositiveIntegerField(_("age"))

คุณต้องกำหนดค่าเป็นคลาสผู้ใช้ปัจจุบันในไฟล์การตั้งค่าของคุณ

# supposing you put it in apps/profiles/models.py
AUTH_USER_MODEL = "profiles.UserProfile"

หากคุณต้องการเพิ่มการตั้งค่าของผู้ใช้จำนวนมากตัวเลือก OneToOneField อาจเป็นตัวเลือกที่ดีกว่า

หมายเหตุสำหรับผู้ที่พัฒนาห้องสมุดบุคคลที่สาม: หากคุณต้องการเข้าถึงคลาสผู้ใช้โปรดจำไว้ว่าผู้ใช้สามารถเปลี่ยนได้ ใช้ผู้ช่วยอย่างเป็นทางการเพื่อรับชั้นเรียนที่เหมาะสม

from django.contrib.auth import get_user_model

User = get_user_model()

3
หากคุณวางแผนที่จะใช้django_social_authฉันขอแนะนำให้ใช้ความสัมพันธ์ OneToOne อย่าใช้วิธีนี้มิฉะนั้นจะทำให้การย้ายข้อมูลของคุณยุ่งเหยิง
Nimo

@Nimo: คุณสามารถทำอย่างละเอียดหรืออ้างอิงการอ้างอิง
ผู้ใช้

@buffer มันเป็นเวลานาน แต่ฉันคิดว่าฉันลองรวมdjango_social_authปลั๊กอินและกำหนด AUTH_USER_MODEL ให้กับผู้ใช้รับรองความถูกต้องทางสังคม จากนั้นเมื่อฉันรัน Manage.py ย้ายข้อมูลทำให้แอปของฉันยุ่ง เมื่อใดที่ฉันใช้โมเดลผู้ใช้การรับรองความถูกต้องโซเชียลแทน OneToOne ความสัมพันธ์ที่อธิบายไว้ที่นี่: stackoverflow.com/q/10638293/977116
Nimo

3
อาจเกี่ยวข้องกับChanging this setting after you have tables created is not supported by makemigrations and will result in you having to manually write a set of migrations to fix your schemaแหล่งข้อมูล: docs.djangoproject.com/en/dev/topics/auth/customizing/?hl=th
ผู้ใช้

43

มีคำแนะนำอย่างเป็นทางการในคือการจัดเก็บข้อมูลเพิ่มเติมเกี่ยวกับผู้ใช้ Django มีหนังสือยังกล่าวถึงปัญหานี้ในส่วนโปรไฟล์


23

ด้านล่างเป็นอีกวิธีในการขยายผู้ใช้ ฉันรู้สึกว่ามันชัดเจนง่ายกว่าอ่านได้มากกว่าสองวิธี

http://scottbarnham.com/blog/2008/08/21/extending-the-django-user-model-with-inheritance/

ใช้วิธีการดังกล่าว:

  1. คุณไม่จำเป็นต้องใช้ user.get_profile (). newattributeเพื่อเข้าถึงข้อมูลเพิ่มเติมที่เกี่ยวข้องกับผู้ใช้
  2. คุณสามารถเข้าถึงคุณสมบัติใหม่เพิ่มเติมได้โดยตรงผ่าน user.newattribute

1
ฉันชอบวิธีการของสกอตต์ที่ดีกว่ามากขึ้นอยู่กับการสืบทอดของวัตถุผู้ใช้แทนที่จะเป็นแบบจำลองโดยตรง ทุกคนสามารถพูดได้ว่าวิธีนี้ไม่ฉลาด?
BozoJoe

1
@BozoJoe - ฉันเพิ่งพบปัญหาการนำเข้าข้อมูลการถ่ายโอนข้อมูลซึ่งดูเหมือนว่าจะเป็นผลมาจากการใช้วิธีนี้: stackoverflow.com/questions/8840068//
Regenspan Ben

15

คุณสามารถขยายโปรไฟล์ผู้ใช้ได้เพียงสร้างรายการใหม่ในแต่ละครั้งที่ผู้ใช้สร้างโดยใช้สัญญาณบันทึกการโพสต์ Django

models.py

from django.db.models.signals import *
from __future__ import unicode_literals

class UserProfile(models.Model):

    user_name = models.OneToOneField(User, related_name='profile')
    city = models.CharField(max_length=100, null=True)

    def __unicode__(self):  # __str__
        return unicode(self.user_name)

def create_user_profile(sender, instance, created, **kwargs):
    if created:
        userProfile.objects.create(user_name=instance)

post_save.connect(create_user_profile, sender=User)

สิ่งนี้จะสร้างอินสแตนซ์ของพนักงานโดยอัตโนมัติเมื่อมีการสร้างผู้ใช้ใหม่

หากคุณต้องการขยายโมเดลผู้ใช้และต้องการเพิ่มข้อมูลเพิ่มเติมในขณะที่สร้างผู้ใช้คุณสามารถใช้ django-betterforms ( http://django-betterforms.readthedocs.io/en/latest/multiform.html ) สิ่งนี้จะสร้างรูปแบบการเพิ่มผู้ใช้ที่มีฟิลด์ทั้งหมดที่กำหนดในโมเดล UserProfile

models.py

from django.db.models.signals import *
from __future__ import unicode_literals

class UserProfile(models.Model):

    user_name = models.OneToOneField(User)
    city = models.CharField(max_length=100)

    def __unicode__(self):  # __str__
        return unicode(self.user_name)

forms.py

from django import forms
from django.forms import ModelForm
from betterforms.multiform import MultiModelForm
from django.contrib.auth.forms import UserCreationForm
from .models import *

class ProfileForm(ModelForm):

    class Meta:
        model = Employee
        exclude = ('user_name',)


class addUserMultiForm(MultiModelForm):
    form_classes = {
        'user':UserCreationForm,
        'profile':ProfileForm,
    }

views.py

from django.shortcuts import redirect
from .models import *
from .forms import *
from django.views.generic import CreateView

class AddUser(CreateView):
    form_class = AddUserMultiForm
    template_name = "add-user.html"
    success_url = '/your-url-after-user-created'

    def form_valid(self, form):
        user = form['user'].save()
        profile = form['profile'].save(commit=False)
        profile.user_name = User.objects.get(username= user.username)
        profile.save()
        return redirect(self.success_url)

addUser.html

<!DOCTYPE html>
<html lang="en">
    <head>
        <meta charset="UTF-8">
        <title>Title</title>
    </head>
    <body>
        <form action="." method="post">
            {% csrf_token %}
            {{ form }}     
            <button type="submit">Add</button>
        </form>
     </body>
</html>

urls.py

from django.conf.urls import url, include
from appName.views import *
urlpatterns = [
    url(r'^add-user/$', AddUser.as_view(), name='add-user'),
]

สวัสดีและขอบคุณสำหรับคำตอบนี้ ฉันยังคงดิ้นรนที่จะเข้าใจวิธีการเชื่อมโยงทั้งหมดเข้าด้วยกันใน urls.py .. คำแนะนำใด ๆ ?
sal

@sal เพิ่ม URL ตัวอย่างที่คุณสามารถตรวจสอบได้ตอนนี้
Atul Yadav

ขอบคุณ !! มันช่วยฉันได้มาก ตัวอย่างที่ดี
Sunny Chaudhari

@AtulYadav .. Django รุ่นไหนที่คุณใช้?
Rido

8

การขยายโมเดลผู้ใช้ Django (UserProfile) อย่างมืออาชีพ

ฉันพบว่ามีประโยชน์มาก: ลิงค์

สารสกัด:

จาก django.contrib.auth.models นำเข้าผู้ใช้

class Employee(models.Model):
    user = models.OneToOneField(User)
    department = models.CharField(max_length=100)

>>> u = User.objects.get(username='fsmith')
>>> freds_department = u.employee.department

2
เสร็จสิ้น ฉันไม่ uderstand ทำไม -1 แก้ไขได้ดีกว่า downvote ในกรณีนี้
Massimo Variolo

3

ใหม่ใน Django 1.5 ตอนนี้คุณสามารถสร้างโมเดลผู้ใช้ของคุณเอง (ซึ่งน่าจะเป็นสิ่งที่ดีที่จะทำในกรณีข้างต้น) อ้างถึง'การปรับแต่งการรับรองความถูกต้องใน Django'

อาจเป็นคุณสมบัติใหม่ที่ยอดเยี่ยมที่สุดในรุ่น 1.5


1
ใช่แน่นอน. แต่ระวังว่าควรหลีกเลี่ยงสิ่งนี้หากจำเป็น การใช้งานของคุณเองด้วยเหตุผลในคำถามนี้ใช้ได้อย่างสมบูรณ์แม้ว่าในกรณีที่คุณพอใจกับผลที่ได้รับการบันทึกไว้ สำหรับการเพิ่มฟิลด์เพียงอย่างเดียวขอแนะนำให้ใช้ความสัมพันธ์กับโมเดลผู้ใช้ทั่วไป
gertvdijk

2

นี่คือสิ่งที่ฉันทำและในความคิดของฉันวิธีที่ง่ายที่สุดในการทำเช่นนี้ กำหนดตัวจัดการวัตถุสำหรับโมเดลที่คุณกำหนดเองใหม่จากนั้นกำหนดโมเดลของคุณ

from django.db import models
from django.contrib.auth.models import PermissionsMixin, AbstractBaseUser, BaseUserManager

class User_manager(BaseUserManager):
    def create_user(self, username, email, gender, nickname, password):
        email = self.normalize_email(email)
        user = self.model(username=username, email=email, gender=gender, nickname=nickname)
        user.set_password(password)
        user.save(using=self.db)
        return user

    def create_superuser(self, username, email, gender, password, nickname=None):
        user = self.create_user(username=username, email=email, gender=gender, nickname=nickname, password=password)
        user.is_superuser = True
        user.is_staff = True
        user.save()
        return user



  class User(PermissionsMixin, AbstractBaseUser):
    username = models.CharField(max_length=32, unique=True, )
    email = models.EmailField(max_length=32)
    gender_choices = [("M", "Male"), ("F", "Female"), ("O", "Others")]
    gender = models.CharField(choices=gender_choices, default="M", max_length=1)
    nickname = models.CharField(max_length=32, blank=True, null=True)

    is_active = models.BooleanField(default=True)
    is_staff = models.BooleanField(default=False)
    REQUIRED_FIELDS = ["email", "gender"]
    USERNAME_FIELD = "username"
    objects = User_manager()

    def __str__(self):
        return self.username

อย่าลืมเพิ่มรหัสบรรทัดนี้ในsettings.py:

AUTH_USER_MODEL = 'YourApp.User'

นี่คือสิ่งที่ฉันทำและใช้งานได้เสมอ


0

ปัจจุบันเป็นของ Django 2.2 วิธีที่แนะนำเมื่อเริ่มต้นโครงการใหม่คือการสร้างรูปแบบผู้ใช้ที่กำหนดเองซึ่งสืบทอดมาจาก AbstractUser จากนั้นชี้ AUTH_USER_MODEL ไปที่โมเดล

ที่มา: https://docs.djangoproject.com/en/2.2/topics/auth/customizing/#using-a-custom-user-model-when-starting-a-project


0

วิธีที่ง่ายและมีประสิทธิภาพคือ models.py

from django.contrib.auth.models import User
class CustomUser(User):
     profile_pic = models.ImageField(upload_to='...')
     other_field = models.CharField()
โดยการใช้ไซต์ของเรา หมายความว่าคุณได้อ่านและทำความเข้าใจนโยบายคุกกี้และนโยบายความเป็นส่วนตัวของเราแล้ว
Licensed under cc by-sa 3.0 with attribution required.