django-allauth的安装和配置

文章转载于：https://mp.weixin.qq.com/s/IWOqbp5ZUuLPkMt25ylgPQ

django-allauth是最受欢迎的管理用户登录与注册的第三方Django安装包。django-allauth支持本地和第三方账号（Github，百度、微博、微信等等。。），集成了邮箱验证、密码修改、本地账号关联（多个）第三方账号等各种功能。

安装

pip install django-allauth

settings.py中的配置

INSTALLED_APPS = [# 必须安装的app
       'django.contrib.auth', 
       'django.contrib.sites', 'allauth',
       'allauth.account',   
       'allauth.socialaccount',
      # 下面是第三方账号相关的，比如github 
      'allauth.socialaccount.providers.github',
]
 # django-allauth相关设置
AUTHENTICATION_BACKENDS = (
      # django admin所使用的用户登录与django-allauth无关 
      'django.contrib.auth.backends.ModelBackend',
      # `allauth` specific authentication methods, such as login by e-mail 
      'allauth.account.auth_backends.AuthenticationBackend',
)
# 前面我们app里添加了django.contrib.sites,需要设置
SITE_IDSITE_ID = 1
ACCOUNT_AUTHENTICATION_METHOD = 'username_email'  # 当用户登录时，既可以使用用户名也可以使用email
ACCOUNT_EMAIL_REQUIRED = True       # 注册时必须填写email
LOGIN_REDIRECT_URL = '/accounts/个人中心'    # 设置登录后跳转链接


# django-allauth相关设置
AUTHENTICATION_BACKENDS = (
    # django admin使用的用户登录于django-allauth无关
    'django.contrib.auth.backends.ModelBackend',
    'allauth.account.auth_backends.AuthenticationBackend',
)

# django的邮箱设定，使用allauth的话，注册后它会给邮箱发送一条注册信息给注册邮箱验证
EMAIL_HOST = 'smtp.qq.com'  # 这里使用QQ的smtp服务
EMAIL_PORT = 25
EMAIL_HOST_USER = '280****[email protected]'   # 你的 QQ 账号和授权码
EMAIL_HOST_PASSWORD = 'vdltztnwuggbddei'
EMAIL_USE_TLS = True  # 这里必须是 True，否则发送不成功
EMAIL_FROM = '280****[email protected]'  # 发件人邮箱
DEFAULT_FROM_EMAIL = '280****[email protected]'    # 默认发件人邮箱

在根urls.py中添加django-allauth的路径

urlpatterns = [
    path('admin/', admin.site.urls),
    path('accounts/', include('allauth.urls')),
]

django-allauth常见设置选项

你也可以添加其它设置选项来实现你所想要的功能，比如设置邮件确认过期时间，限制用户使用错误密码登录的持续时间。

ACCOUNT_AUTHENTICATION_METHOD (="username" | "email" | "username_email")：指定要使用的登录方法（用户名、电子邮件地址或两者之一）
ACCOUNT_EMAIL_CONFIRMATION_EXPIRE_DAYS (=3)：邮件确认邮件的截止日期(天数)
ACCOUNT_EMAIL_VERIFICATION (="optional")：注册中邮件验证方法:“强制（mandatory）”,“可选（optional）”或“否（none）”之一
ACCOUNT_EMAIL_CONFIRMATION_COOLDOWN (=180)：邮件发送后的冷却时间(以秒为单位)
ACCOUNT_LOGIN_ATTEMPTS_LIMIT (=5)：登录尝试失败的次数
ACCOUNT_LOGIN_ATTEMPTS_TIMEOUT (=300)：从上次失败的登录尝试，用户被禁止尝试登录的持续时间
ACCOUNT_LOGIN_ON_EMAIL_CONFIRMATION (=False)：更改为True，用户一旦确认他们的电子邮件地址，就会自动登录
ACCOUNT_LOGOUT_ON_PASSWORD_CHANGE (=False)：更改或设置密码后是否自动退出
ACCOUNT_LOGIN_ON_PASSWORD_RESET (=False)：更改为True，用户将在重置密码后自动登录
ACCOUNT_SESSION_REMEMBER (=None)：控制会话的生命周期，可选项还有:False,True
ACCOUNT_SIGNUP_EMAIL_ENTER_TWICE (=False):用户注册时是否需要输入邮箱两遍
ACCOUNT_SIGNUP_PASSWORD_ENTER_TWICE (=True): 用户注册时是否需要用户输入两遍密码
ACCOUNT_USERNAME_BLACKLIST (=[]):用户不能使用的用户名列表
ACCOUNT_UNIQUE_EMAIL (=True)：加强电子邮件地址的唯一性
ACCOUNT_USERNAME_MIN_LENGTH (=1)：用户名允许的最小长度的整数
SOCIALACCOUNT_AUTO_SIGNUP (=True)：使用从社会帐户提供者检索的字段(如用户名、邮件)来绕过注册表单
LOGIN_REDIRECT_URL (="/") 设置登录后跳转链接
ACCOUNT_LOGOUT_REDIRECT_URL (="/") 设置退出登录后跳转链接

以上基本设置后，需要同步数据库

python manage.py makemigrations
python manage.py migrate
python manage.py runserver

登录admin后，设置好site域名127.0.0.1:8000和名字，再退出登录。就可以访问以下链接查看allauth的效果了。由于我们已经设置好了邮箱，所以涉及邮箱验证和密码重置部分都可以正常进行的。

当你注册成功后，你会收到一份邮件验证你的邮箱。在你提交表单后，django-allauth会自动检测用户名和email是否已存在

点击邮件中的链接，点击确认就可以验证邮箱了。如果你不需要邮箱验证，你只需要设置ACCOUNT_EMAIL_VERIFICATION (="nonel")就可以了。

django-allauth的URLs及视图

下面是django_allauth所有内置的URLs，均可以访问的。

/accounts/login/（URL名account_login): 登录
/accounts/signup/ (URL名account_signup): 注册
/accounts/password/reset/(URL名: account_reset_password) ：重置密码
/accounts/logout/ (URL名account_logout): 退出登录
/accounts/password/set/ (URL名:account_set_password): 设置密码
/accounts/password/change/ (URL名: account_change_password): 改变密码（需登录）
/accounts/email/(URL名: account_email) 用户可以添加和移除email，并验证
/accounts/social/connections/（URL名:socialaccount_connections): 管理第三方账户

url中有一个为 /accounts/profile/的路径，这个是我们登录后会跳转的链接，由于每个人的需求不一样，所有django-allauth没有提供这个视图。