在 Django 中使用第三方社交认证登录示例

使用 social-auth-app-django 插件在 Django Admin 中添加第三方社交认证登录方式。由于 Github 申请应用比较方便，所以这里以 Github 为例。下面是效果图：

开发环境

• Python36
• Pipenv

准备工作

在github 开发者平台新建一个 OAuth 应用。并填写下面信息：

• Application name: django-social-auth-demo（可以随意填写）
• Homepage URL: http://127.0.0.1:8000/
• Authorization callback URL: http://127.0.0.1:8000/complete/github/（固定，不能随便改动）

获取到 Client ID 和 Client Secret 后，在当前项目目录下新建.env并填写下面信息

    SOCIAL_AUTH_GITHUB_KEY = '<your client id>'
    SOCIAL_AUTH_GITHUB_SECRET = '<your client secret>'

安装插件

pipenv install social-auth-app-django

插件快速开始

下面创建一个Django项目，按以下步骤修改settings.py文件：

1、添加social_djangoApp

INSTALLED_APPS = [
    ...
    # 1、添加 social_django app
    'social_django',
]

2、添加模板选项

TEMPLATES = [
    {
        ...
        'OPTIONS': {
            'context_processors': [
                ...

                # 2、添加下面两句
                'social_django.context_processors.backends',
                'social_django.context_processors.login_redirect',
            ],
        },
    },
]

3、自定义用户验证，添加第三方登录方式

AUTHENTICATION_BACKENDS = (
    # https://python-social-auth.readthedocs.io/en/latest/backends/github.html
    'social_core.backends.github.GithubOAuth2',    # Gtihub

    'django.contrib.auth.backends.ModelBackend',    # django默认的必须添加
)

4、配置第三方平台对应的密匙

SOCIAL_AUTH_GITHUB_KEY = os.getenv('SOCIAL_AUTH_GITHUB_KEY', '')
SOCIAL_AUTH_GITHUB_SECRET = os.getenv('SOCIAL_AUTH_GITHUB_SECRET', '')

5、登录成功后重定向页面，该重定向不是前面在github配置的Authorization callback URL，是在此认证成功后的再次重定向

SOCIAL_AUTH_LOGIN_REDIRECT_URL = '/admin/'

6、配置URL

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    # 6、添加URL
    path('', include('social_django.urls', namespace='social')),
]

上是social-auth-app-django插件快速配置使用的方式，接下来改造django admin默认的登录后台。

1、重写django.contrib.admin

#admin.py
from django.contrib import admin

class MyAdminSite(admin.AdminSite):
    # 重写登录页面
    login_template = 'admin/login.html'

# apps.py
from django.contrib.admin.apps import AdminConfig

class MyAdminConfig(AdminConfig):
    default_site = 'proj.admin.MyAdminSite'

之后把INSTALLED_APPS的django.contrib.admin改为proj.apps.MyAdminConfig。

INSTALLED_APPS = [
    # 'django.contrib.admin',   # 切换下面的配置
    'proj.apps.MyAdminConfig',
    ...

    # 1、添加 social_django app
    'social_django',
]

2、添加模板文件

TEMPLATES = [{
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(BASE_DIR, 'templates')], # 添加这一句
        ...
    },
]

3、重写登录页面

在主目录下新建templates\admin\login.html文件，从django官方源码拷贝相关代码过来（路径django\contrib\admin\templates\admin\login.html）。添加下面一行代码，即修改了django admin登录页面。

<a href="{% url "social:begin" "github" %}">GitHub+</a>

效果图如前面所示。

最后， 我把该完整示例到了Github，欢迎star，地址为：https://github.com/AngelLiang/django-social-auth-demo

---

最近新建了博客：https://yannanxiu.cn/ ，计划以后在该博客发布文章了，欢迎访问。