Django AllAuth Bab Memperluaskan model pengguna Django AllAuth dengan medan tersuai

NOTA: Artikel ini pada mulanya disiarkan pada Substack saya, di https://andresalvareziglesias.substack.com/

Ini ialah bab terakhir bagi siri siaran Django AllAuth ini. Dalam lima bab ini kami telah menemui sedikit keajaiban, komponen Django yang sangat membantu untuk mengendalikan semua keperluan pengesahan kami. Dalam bab ini kita akan belajar cara melanjutkan model pengguna Django asas untuk menambah medan tersuai.

Senarai bab

• Bab 1 - Penyelesaian All-in-one untuk Auth dalam Django
• Bab 2 - Cara memasang dan mengkonfigurasi Django AllAuth
• Bab 3 - Log masuk sosial dengan Django AllAuth
• Bab 4 - Menyesuaikan Django AllAuth UI
• Bab 5 - Memanjangkan model pengguna Django AllAuth dengan medan tersuai ←Yang ini!

Model pengguna Django

AllAuth menggunakan model pengguna Django standard, serta beberapa jadual tambahan untuk mengendalikan log masuk sosial dan token log masuk. Dalam Django 5, model pengguna terletak dalam pakej django.contrib.auth, dan mempunyai sekumpulan medan yang dipratentukan, seperti yang anda boleh baca dalam dokumen rasmi:

• https://docs.djangoproject.com/en/5.0/ref/contrib/auth/

Kadang-kadang, ini tidak mencukupi untuk projek kami. Django membolehkan anda membuat jadual Pengguna tersuai dan pengurus Pengguna, untuk mengendalikan keperluan setiap projek.

Kami akan membuat jadual Pengguna tersuai dan Pengurus Pengguna tersuai untuk mengendalikan proses log masuk dan pendaftaran kami.

Mencipta jadual Pengguna tersuai

Buka models.py dalam projek sampel kami dan tulis kod seperti ini:

class MyCustomUser(AbstractBaseUser):
   email = models.EmailField(unique=True)
   first_name = models.CharField(max_length=30, blank=True)
   last_name = models.CharField(max_length=30, blank=True)
   is_active = models.BooleanField(default=True)
   is_admin = models.BooleanField(default=False)
   timezone = models.CharField(max_length=30, default='UTC')
   is_custom = models.BooleanField(default=False)
   is_staff = models.BooleanField(default=False)
   created_at = models.DateTimeField(auto_now_add=True)
   updated_at = models.DateTimeField(auto_now=True)

   objects = MyCustomUserManager()
   USERNAME_FIELD = 'email'
   EMAIL_FIELD = 'email'

   def __str__(self):
       return self.email
   def has_perm(self, perm, obj=None):
       return True
   def has_module_perms(self, app_label):
       return True

   @property
   def is_utc(self):
       return self.timezone == 'UTC'

Kami boleh menentukan model Pengguna baharu yang dilanjutkan daripada model AbstractBaseUser Django. Dalam model baharu ini, kami boleh menambah semua medan atau sifat tersuai yang kami perlukan.

Barisan ini penting:

   objects = MyCustomUserManager()
   USERNAME_FIELD = 'email'
   EMAIL_FIELD = 'email'

Dengan baris ini kami memautkan model pengguna dengan UserManager tersuai kami, dan kami juga mentakrifkan medan yang bertindak sebagai "nama pengguna" yang unik.

Ingat untuk mendaftarkan model baharu dalam admin.py untuk mengurusnya daripada alat pentadbir Django.

from django.contrib import admin
from .models import MyCustomUser

admin.site.register(MyCustomUser)

Mencipta pengurus Pengguna tersuai

Buka sekali lagi models.py dalam projek sampel kami (atau jana fail lain untuk UserManager tersuai jika anda mahu) dan tulis kod seperti ini:

class MyCustomUserManager(BaseUserManager):

   def create_user(self, email, password=None):
       if not email:
           raise ValueError('Users must have an email address')

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

       user.set_password(password)

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

   def create_superuser(self, email, password):
       user = self.create_user(
           email=email,
           password=password,
       )

       user.is_admin = True
       user.is_staff = True

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

Dalam contoh ini, kami memperluaskan BaseUserManager untuk mencipta UserManager tersuai kami. Ia mencipta pengguna baharu kami dan mengisi medan tersuai seperti yang kami jangkakan.

Kami menentukan sebelum UserManager untuk model Pengguna tersuai kami, jadi Django tahu kelas yang hendak digunakan semasa penciptaan pengguna baharu.

Menggunakan pengurus dan model Pengguna tersuai

Dalam fail tetapan projek kami, kami boleh menetapkan model pengguna semasa untuk projek kami dengan:

# Set custom user model as the active one
AUTH_USER_MODEL = 'demo.MyCustomUser'

# Configure AllAuth username related management, because we are 
# using the e-mail as username. See:
# https://docs.allauth.org/en/latest/account/advanced.html
ACCOUNT_AUTHENTICATION_METHOD = 'email'
ACCOUNT_EMAIL_REQUIRED = True
ACCOUNT_UNIQUE_EMAIL = True
ACCOUNT_USERNAME_REQUIRED = False
ACCOUNT_USER_MODEL_USERNAME_FIELD = None

Hanya dengan perubahan kecil ini (dan penghijrahan DB yang diperlukan, seperti biasa), kami boleh mula mencipta pengguna dengan paparan pendaftaran AllAuth untuk melihat UserManager tersuai kami yang berkilat dan modelnya dalam tindakan. Cepat dan mudah.

Kami juga melumpuhkan pengurusan berkaitan nama pengguna AllAuth, kerana kami menggunakan e-mel sebagai nama pengguna dalam contoh ini.

Dan itulah penghujungnya... atau tidak?

Kami telah mencapai bab terakhir pada siri AllAuth ini. AllAuth ialah pustaka yang menarik untuk mengendalikan pengesahan dalam apl kami dan menjadikannya lebih mudah untuk berfungsi dengan log masuk sosial, terima kasih kepada senarai penyepaduan yang dipratentukan yang besar.

Ini adalah bab terakhir siri ini, tetapi saya akan melawat semula AllAuth dalam siaran akan datang. Terima kasih kerana membaca dan selamat mengekod!

Mengenai senarai

Di antara siaran Python dan Docker, saya juga akan menulis tentang topik lain yang berkaitan (sentiasa topik teknologi dan pengaturcaraan, saya berjanji... dengan bersilang jari), seperti:

• Seni bina perisian
• Persekitaran pengaturcaraan
• Sistem pengendalian Linux
• Dll.

Jika anda menemui beberapa teknologi yang menarik, bahasa pengaturcaraan atau apa sahaja, sila beritahu saya! Saya sentiasa terbuka untuk mempelajari sesuatu yang baharu!

Mengenai penulis

Saya Andrés, pembangun perisian tindanan penuh yang berpangkalan di Palma, dalam perjalanan peribadi untuk meningkatkan kemahiran pengekodan saya. Saya juga seorang penulis fantasi yang diterbitkan sendiri dengan empat novel terbitan atas nama saya. Sila tanya saya apa-apa sahaja!

Atas ialah kandungan terperinci Django AllAuth Bab Memperluaskan model pengguna Django AllAuth dengan medan tersuai. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!