Django 用户模块扩展

1
2
3
4
5
6
7
8
from django.contrib.auth.models import AbstractUser
from django.db import models


class User(AbstractUser): # 继承老的用户模型
    phone = models.CharField(max_length=20, null=True, blank=True, help_text='手机号码')

    # USERNAME_FIELD = ['phone'] 这个设置用于用户模块的唯一键, 用来区分用户的唯一标识

1
2
3
4
5
6
7
8
9
10
11
12
13
14
from django.utils.translation import gettext_lazy as _
from django.contrib import admin
from django.contrib.auth.admin import UserAdmin as UserAdminBase
from .models import User


@admin.register(User)
class UserAdmin(UserAdminBase):
    ''' 用户视图 '''
    list_display = UserAdminBase.list_display + ('phone',) # 扩展列表页展示字段
    fieldsets = UserAdminBase.fieldsets + (
        (_('用户信息'), {'fields': ('phone',)}),
    ) # 扩展展示字段

1
2
# settings.py
AUTH_USER_MODEL = "<应用>.User"

1
2
3
4
5
6
7
8
9
10
11
# account/models.py
from django.utils.translation import gettext_lazy as _
from django.db import models
from django.conf import settings
# from django.contrib import auth

class UserInfo(models.Model):
    user = models.OneToOneField(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
    # user = models.OneToOneField(auth.get_user_model(), on_delete=models.CASCADE,)

    phone = models.CharField(_('phone'), max_length=20, null=True, blank=True, help_text='手机号码')

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# account/admin.py
from django.contrib import admin
from django.contrib import auth
from .models import UserInfo


class UserInfoInline(admin.StackedInline):
    model = UserInfo
    verbose_name_plural = 'info'


class UserAdmin(auth.admin.UserAdmin):
    inlines = auth.admin.UserAdmin.inlines + [UserInfoInline, ]


admin.site.unregister(auth.models.User)  # 取消之前注册的 User Admin
admin.site.register(auth.models.User, UserAdmin)  # 重新注册最新的 User Admin

1
2
3
4
5
6
7
8
# account/view.py
from django.contrib import auth 
from django.http import HttpResponse


@auth.decorators.login_required
def test_view(request):
    return HttpResponse(f'您的手机号为: {request.user.userinfo.phone}')

1
2
3
4
5
6
from django.contrib.auth.models import AbstractUser
from django.db import models

class User(AbstractUser): 
    class Meta:
        db_table = 'auth_user'

1
2
3
4
5
6
INSTALLED_APPS = (
        # ...
        'Accounts', # <你的APP名称>
    )

AUTH_USER_MODEL = 'Accounts.User' # <你的APP名称>.<你的用户模型名称>

1
from django.contrib.auth.models import User

1
2
# 你的模块.User
from Accounts.models import User

1
2
3
4
5
6
7
8
9
class User(AbstractUser):
    name_cn = models.CharField(_('name_cn'), max_length=255, default='', null=True, blank=True, help_text='中文名')
    name_en = models.CharField(_('name_en'), max_length=255, default='',  null=True, blank=True, help_text='英文名')
    phone = models.CharField(_('phone'), max_length=22, default='', null=True, blank=True, help_text='手机号码')
    avatar_url = models.URLField(_('avatar_url'), max_length=255, default='', null=True, blank=True, help_text='头像地址')
    info = JSONField(_('info'), default={}, dump_kwargs={'ensure_ascii': False}, blank=True, help_text='其他信息')

    class Meta(AbstractUser.Meta):
        db_table = 'auth_user'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# account/auth.py
from apps.account.models import UserInfo
from django.contrib import auth


DjangoUser = auth.get_user_model()


def authenticate(request, username=None, password=None, token=None, is_staff=True):
    ''' 你的自定义认证流程, 无论是 LDAP 还是 COOKIE/JWT 信息校验方法 '''
    user_info = {'id': -2, 'phone': '13212341234'}  # 这里获取你认证的结果
    if user_info['id']:  # 认证成功
        # 留存用户到 Django 默认用户表
        django_user, _ = DjangoUser.objects.update_or_create(id=user_info['id'], defaults={
            'is_active': True,  # 设置为可进入用户
            'is_staff': is_staff,  # 设置为可以登录到 Admin 页面
        })
        # 留存扩展信息到扩展表, 若是直接扩展忽略
        UserInfo.objects.update_or_create(user=django_user, defaults={'phone': user_info['phone']})
        auth.login(request, django_user, backend='django.contrib.auth.backends.ModelBackend')
        return django_user


class UserBackend:
    ''' 该认证模块用于认证信息 '''

    def authenticate(self, *args, **kwargs):
        ''' 登录时调用 '''
        return authenticate(*args, **kwargs)

    def get_user(self, user_id):
        ''' 认证成功后总是在调用 '''
        try:
            return DjangoUser.objects.get(pk=user_id)
        except auth.models.User.DoesNotExist:
            return None

1
2
3
4
5
6
# setting.py

AUTHENTICATION_BACKENDS = [
    'account.auth.UserBackend',  # 我的认证模块
    'django.contrib.auth.backends.ModelBackend',  # Django 默认的认证
]