Django单点登录

简介

Django是一个开放源代码的Web框架，基于Python编程语言。它遵循MTV（模型-模板-视图）的设计模式，致力于帮助开发人员构建高效和可维护的Web应用程序。

单点登录（SSO）是一种让用户只需一次登录就能访问多个系统的认证机制。它简化了用户的登录流程，提高了用户体验，并减少了用户需要记住的账号和密码的数量。

本文将详细介绍如何在Django框架中实现单点登录功能。

实现原理

实现单点登录的基本原理如下：

用户访问主应用的登录页面，并输入用户名和密码。
主应用验证用户的身份信息，并生成一个包含用户标识的令牌（Token）。
主应用将令牌发送给其他子应用。
子应用接收到令牌后，向主应用验证令牌的有效性。
如果令牌有效，子应用将用户标识保存到本地，并为用户创建一个会话。
用户访问其他子应用时，子应用可以通过检查用户的会话来验证用户的身份。

基于以上原理，下面将介绍如何使用Django框架实现单点登录。

环境准备

在开始实现单点登录功能之前，我们需要准备以下环境：

Python 3.x
Django 3.x

确保在本地环境中已经安装了Python和Django，并且能够正常运行。

创建Django项目

首先，在命令行中进入一个合适的目录，并执行以下命令创建一个Django项目：

$ django-admin startproject sso
$ cd sso

以上命令将创建一个名为sso的Django项目，并进入该项目的根目录。

创建主应用

接下来，我们将创建一个名为main的Django应用作为主应用。

执行以下命令创建应用：

$ python manage.py startapp main

然后，在项目的settings.py文件中将应用添加到INSTALLED_APPS列表中：

INSTALLED_APPS = [
    ...
    'main',
    ...
]

创建用户模型

在主应用中，我们需要定义一个用户模型来保存用户的身份信息。

在main应用的models.py文件中，添加以下代码：

from django.db import models


class User(models.Model):
    username = models.CharField(max_length=100)
    password = models.CharField(max_length=100)

上述代码定义了一个名为User的模型，包含了username和password两个字段。

然后，执行以下命令创建数据库表：

$ python manage.py makemigrations main
$ python manage.py migrate

以上命令将根据模型的定义自动创建数据库表。

创建登录和验证视图

在主应用中，我们需要创建登录和验证的视图。

在main应用的views.py文件中，添加以下代码：

from django.shortcuts import render, redirect
from .models import User


def login(request):
    if request.method == 'POST':
        username = request.POST['username']
        password = request.POST['password']
        user = User.objects.get(username=username)
        if user.password == password:
            # 登录成功，生成令牌并重定向到验证视图
            token = 'generate_token()'
            return redirect('validate', token)
        else:
            return render(request, 'main/login.html', {'error': '用户名或密码错误'})
    else:
        return render(request, 'main/login.html')


def validate(request, token):
    # 调用身份验证服务验证令牌的有效性
    if 'valid_token(token)':
        # 令牌有效，保存用户标识到本地并创建会话
        request.session['user_id'] = 'get_user_id_from_token(token)'
        return redirect('home')
    else:
        return redirect('login')

上述代码中，login视图处理登录页面的请求，当用户提交表单时，会验证用户的身份信息，并生成一个令牌。然后，将令牌作为参数重定向到validate视图。

validate视图会调用一个身份验证服务来验证令牌的有效性。如果令牌有效，它将保存用户的标识到本地，并为用户创建一个会话。最后，将用户重定向到主页。

创建子应用

除了主应用，我们还需要创建两个子应用来模拟单点登录的场景。

执行以下命令分别创建两个子应用：

$ python manage.py startapp app1
$ python manage.py startapp app2

然后，将这两个子应用添加到INSTALLED_APPS列表中：

INSTALLED_APPS = [
    ...
    'app1',
    'app2',
    ...
]

配置路由

在项目的根目录下，创建一个名为urls.py的文件，并添加以下代码：

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

urlpatterns = [
    path('admin/', admin.site.urls),
    path('main/', include('main.urls')),
    path('app1/', include('app1.urls')),
    path('app2/', include('app2.urls')),
]

然后，在主应用的目录下，创建一个名为urls.py的文件，并添加以下代码：

from django.urls import path
from . import views

urlpatterns = [
    path('login/', views.login, name='login'),
    path('validate/<str:token>/', views.validate, name='validate'),
]

接下来，在每个子应用的目录下，分别创建一个名为urls.py的文件，并添加以下代码：

from django.urls import path
from . import views

urlpatterns = [
    path('', views.index, name='index'),
]

以上代码定义了各个应用的URL路由。

创建模拟验证服务

在实际情况中，身份验证服务通常是一个独立的服务。为了便于演示，我们将使用一个简单的函数来模拟身份验证服务的功能。

在主应用的views.py文件中，添加以下代码：

def valid_token(token):
    # 模拟验证令牌的有效性
    return True


def get_user_id_from_token(token):
    # 模拟获取用户标识
    return '123'

以上代码中，valid_token函数模拟验证令牌的有效性，始终返回True。get_user_id_from_token函数模拟获取用户标识，始终返回123。

编写模拟子应用代码

我们将在两个子应用中编写一些简单的代码来模拟单点登录的场景。

在app1应用的views.py文件中，添加以下代码：

from django.shortcuts import render

def index(request):
    user_id = request.session.get('user_id')
    if user_id:
        return render(request, 'app1/index.html', {'user_id': user_id})
    else:
        return render(request, 'app1/index.html')

在app2应用的views.py文件中，添加以下代码：

from django.shortcuts import render

def index(request):
    user_id = request.session.get('user_id')
    if user_id:
        return render(request, 'app2/index.html', {'user_id': user_id})
    else:
        return render(request, 'app2/index.html')

接下来，在每个子应用的目录下，创建一个名为index.html的模板文件，并分别添加以下代码：

app1/templates/app1/index.html：

<!DOCTYPE html>
<html>
<head>
    <title>App1</title>
</head>
<body>
    {% if user_id %}
        <h1>Welcome to App1</h1>
        <p>User ID: {{ user_id }}</p>
    {% else %}
        <h1>Welcome to App1</h1>
        <p>Please <a href="/main/login/">login</a> to access this page.</p>
    {% endif %}
</body>
</html>

app2/templates/app2/index.html：

<!DOCTYPE html>
<html>
<head>
    <title>App2</title>
</head>
<body>
    {% if user_id %}
        <h1>Welcome to App2</h1>
        <p>User ID: {{ user_id }}</p>
    {% else %}
        <h1>Welcome to App2</h1>
        <p>Please <a href="/main/login/">login</a> to access this page.</p>
    {% endif %}
</body>
</html>

以上代码定义了两个简单的模板，显示用户的标识和登录链接。