1、概述

Django中自带的User Model使用起来是比较方便的，但是通常我们的需求使用原生的User Model并不合适，或者少了一些必要的属性，或者多了些不必要的属性，这时就需要使用我们自己的User Model，自定义用户模块。

参考：Django官方文档 “Customizing authentication in Django” 部分，文档最后有完整的例子。

虽然自定义了用户模块，但是仍然可以使用Django原有的用户认证机制。

主要包含三个步骤

1. 定义自己的用户模块，包含用户类及用户Manager 类继承自Django中的
AbstractBaseUser、BaseUserManager

2. 将自己定义的用户模块注册到Django的admin，即将自己的模块注册到Django的后台管理系统

3. 在settings.py中设置AUTH_USER_MODEL=“自定义用户模块类”

2、操作步骤

2.1 定义自己的用户模块

在自己的用户认证app的model.py中定义两个类，用户类和用户Manager类。

用户类：名字自定义，该例中名字为SysUser，该类继承自AbstractBaseUser，为了使用Django permission 框架，需再继承 PermissionsMixin。该类主要定义了用户的属性。

用户Manager类：名字自定义，该例中名字为SysUserManager，该类继承
BaseUserManager，主要重定义create_user、create_superuser这两个函数。

点击(此处)折叠或打开

1. from django.db import models
   
2. from django.contrib.auth.models import (BaseUserManager, AbstractBaseUser)
3. # Create your models here.
6. class SysUserManager(BaseUserManager):
7.     def create_user(self, username, password=None):
8.         “”“
   
9.         Creates and saves a User with the username
10.         ““”
12.         user = self.model(
13.             username=username,
14.         )
17.         user.set_password(password)
18.         user.save(using=self._db)
19.         return user
22.     def create_superuser(self, username, password):
23.         “”“
    
24.         Creates and saves a superuser
25.         ““”
26.         user = self.create_user(username,password)
29.         user.is_admin = True
30.         user.save(using=self._db)
31.         return user
34. class SysUser(AbstractBaseUser, PermissionsMixin):
35.     username = models.CharField(max_length=20, unique=True,)
36.     full_name = models.CharField(max_length=20,default=“姓名”)
37.     user_group = models.CharField(max_length=10,default=“NULL”)
38.     is_active = models.BooleanField(default=True)
39.     is_admin = models.BooleanField(default=False)
42.     objects = SysUserManager()
45.     USERNAME_FIELD = ‘username’
46.     #REQUIRED_FIELDS = [‘full_name’]
49.     def __str__(self):
50.         return self.username
53.     def has_perm(self, perm, obj=None):
54.         “Does the user have a specific permission?”
55.         # Simplest possible answer: Yes, always
56.         return True
59.     def has_module_perms(self, app_label):
60.         “Does the user have permissions to view the app `app_label`?”
61.         # Simplest possible answer: Yes, always
62.         return True
65.     @property
66.     def is_staff(self):
67.         “Is the user a member of staff?”
68.         # Simplest possible answer: All admins are staff
69.         return self.is_admin

2.2 注册到Django Admin

在用户认证app的admin.py中必须定义的两个类，
UserCreationForm和UserChangeForm，其他可以自定义的类参考Django官方文档。

点击(此处)折叠或打开

1. from django.contrib import admin
   
2. from django import forms
3. from django.contrib.auth.models import Group
4. from django.contrib.auth.admin import UserAdmin as BaseUserAdmin
5. from django.contrib.auth.forms import ReadOnlyPasswordHashField
6. from myauth.models import SysUser
8. # Register your models here.
11. class UserCreationForm(forms.ModelForm):
12.     “”“A form for creating new users. Includes all the required
    
13.        fields, plus a repeated password.”“”
14.     password1 = forms.CharField(label=‘Password’, widget=forms.PasswordInput)
15.     password2 = forms.CharField(label=‘Password confirmation’, widget=forms.PasswordInput)
17.     class Meta:
18.         model = SysUser
19.         fields = (‘username’, ‘full_name’, ‘user_group’,‘is_active’,‘is_admin’)
21.     def clean_password2(self):
22.         # Check that the two password entries match
23.         password1 = self.cleaned_data.get(“password1”)
24.         password2 = self.cleaned_data.get(“password2”)
25.         if password1 and password2 and password1 != password2:
26.             raise forms.ValidationError(“Passwords don’t match”)
27.         return password2
29.     def save(self, commit=True):
30.         # Save the provided password in hashed format
31.         user = super().save(commit=False)
32.         user.set_password(self.cleaned_data[“password1”])
33.         if commit:
34.             user.save()
35.         return user
38. class UserChangeForm(forms.ModelForm):
39.     “”“A form for updating users. Includes all the fields on
    
40.     the user, but replaces the password field with admin’s
41.     password hash display field.
42.     ““”
43.     #password = ReadOnlyPasswordHashField()
45.     class Meta:
46.         model = SysUser
47.         fields = (‘username’, ‘password’, ‘full_name’, ‘user_group’,‘is_active’,‘is_admin’)
50. class SysUserAdmin(BaseUserAdmin):
51.     # The forms to add and change user instances
52.     form = UserChangeForm
53.     add_form = UserCreationForm
55.     # The fields to be used in displaying the User model.
56.     # These override the definitions on the base UserAdmin
57.     # that reference specific fields on auth.User.
58.     list_display = (‘username’, ‘full_name’, ‘user_group’, ‘is_active’, ‘is_admin’)
59.     list_filter = (‘is_admin’,)
60.     fieldsets = (
61.         (None, {‘fields’: (‘username’,‘full_name’,‘user_group’,‘is_active’)}),
62.         (‘Permissions’, {‘fields’: ( ‘is_admin’,)}),
63.     )
64.     # add_fieldsets is not a standard ModelAdmin attribute. UserAdmin
65.     # overrides get_fieldsets to use this attribute when creating a user.
66.     add_fieldsets = (
67.         (None, {
68.             ‘classes’: (‘wide’,),
69.             ‘fields’: (‘username’, ‘password1’, ‘password2’,)}
70.          ),
71.     )
72.     search_fields = (‘username’,)
73.     ordering = (‘username’,)
74.     filter_horizontal = ()
76.     # Now register the new UserAdmin...
79. admin.site.register(SysUser, SysUserAdmin)
80. # ... and, since we‘re not using Django’s built–in permissions,
81. # unregister the Group model from admin.
82. admin.site.unregister(Group)

2.3 修改AUTH_USER_MODEL

修改项目settings.py 中AUTH_USER_MODEL=’myauth.SysUser’

点击(此处)折叠或打开

1. AUTH_USER_MODEL = ‘myauth.SysUser’

这样就可以使用自己的用户模块了。