django-allauth入门学习和使用

django-allauth是集成的Django应用程序,用于解决网站身份验证,用户的注册登录及账户管理,以及第三方(社交)账户的身份验证。

既然你知道并准备使用django-allauth,所以本文假定你已经掌握了基本的django知识(比如会用django搭建Web App,甚至是一个小型博客网站)。

安装与基本配置

安装

pip install django-allauth

基本配置

1.在你项目的settings.py里加上以下相对应的代码

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.request',
            ],
        },
    },
]

AUTHENTICATION_BACKENDS = (
    'django.contrib.auth.backends.ModelBackend',
    'allauth.account.auth_backends.AuthenticationBackend',
)

INSTALLED_APPS = (
   
    # 这两个django本身的app也是需要的,但不需要重复添加
    'django.contrib.auth',
    'django.contrib.sites',

    'allauth',
    'allauth.account',
    'allauth.socialaccount',

    # 下面是django-allauth目前支持的社交账号,加上你需要的就行了,不用全加上:
    'allauth.socialaccount.providers.amazon', # 亚马逊
    'allauth.socialaccount.providers.angellist',
    'allauth.socialaccount.providers.asana',
    'allauth.socialaccount.providers.auth0',
    'allauth.socialaccount.providers.authentiq',
    'allauth.socialaccount.providers.baidu', # 百度
    'allauth.socialaccount.providers.basecamp',
    'allauth.socialaccount.providers.bitbucket',
    'allauth.socialaccount.providers.bitbucket_oauth2',
    'allauth.socialaccount.providers.bitly',
    'allauth.socialaccount.providers.coinbase',
    'allauth.socialaccount.providers.dataporten',
    'allauth.socialaccount.providers.daum',
    'allauth.socialaccount.providers.digitalocean',
    'allauth.socialaccount.providers.discord',
    'allauth.socialaccount.providers.douban', # 豆瓣
    'allauth.socialaccount.providers.draugiem',
    'allauth.socialaccount.providers.dropbox',
    'allauth.socialaccount.providers.dwolla',
    'allauth.socialaccount.providers.edmodo',
    'allauth.socialaccount.providers.eveonline',
    'allauth.socialaccount.providers.evernote',
    'allauth.socialaccount.providers.facebook',
    'allauth.socialaccount.providers.feedly',
    'allauth.socialaccount.providers.fivehundredpx',
    'allauth.socialaccount.providers.flickr',
    'allauth.socialaccount.providers.foursquare',
    'allauth.socialaccount.providers.fxa',
    'allauth.socialaccount.providers.github', # GitHub
    'allauth.socialaccount.providers.gitlab',
    'allauth.socialaccount.providers.google',
    'allauth.socialaccount.providers.hubic',
    'allauth.socialaccount.providers.instagram',
    'allauth.socialaccount.providers.kakao',
    'allauth.socialaccount.providers.line',
    'allauth.socialaccount.providers.linkedin',
    'allauth.socialaccount.providers.linkedin_oauth2',
    'allauth.socialaccount.providers.mailru',
    'allauth.socialaccount.providers.mailchimp',
    'allauth.socialaccount.providers.meetup',
    'allauth.socialaccount.providers.naver',
    'allauth.socialaccount.providers.odnoklassniki',
    'allauth.socialaccount.providers.openid',
    'allauth.socialaccount.providers.orcid',
    'allauth.socialaccount.providers.paypal',
    'allauth.socialaccount.providers.persona',
    'allauth.socialaccount.providers.pinterest',
    'allauth.socialaccount.providers.reddit',
    'allauth.socialaccount.providers.robinhood',
    'allauth.socialaccount.providers.shopify',
    'allauth.socialaccount.providers.slack',
    'allauth.socialaccount.providers.soundcloud',
    'allauth.socialaccount.providers.spotify',
    'allauth.socialaccount.providers.stackexchange',
    'allauth.socialaccount.providers.stripe',
    'allauth.socialaccount.providers.trello',
    'allauth.socialaccount.providers.tumblr',
    'allauth.socialaccount.providers.twentythreeandme',
    'allauth.socialaccount.providers.twitch',
    'allauth.socialaccount.providers.twitter',
    'allauth.socialaccount.providers.untappd',
    'allauth.socialaccount.providers.vimeo',
    'allauth.socialaccount.providers.vk',
    'allauth.socialaccount.providers.weibo', # 新浪微博
    'allauth.socialaccount.providers.weixin', # 微信
    'allauth.socialaccount.providers.windowslive',
    'allauth.socialaccount.providers.xing',
    
)

SITE_ID = 1    # 不要漏了这句哦

2.在项目的urls.py(即与setting.py在同一文件夹的urls.py)里加上下面这句:

urlpatterns = [
    url(r'^accounts/', include('allauth.urls')),
]

温馨提示
如果你了解或者用过django.contrib.auth.urls这个模块的话,那么用了django-allauth后你就可以用由allauth提供的account_login, account_logout ,account_set_password ......这些URLs来替代原先的login, logout, password_change......

3.在项目的根目录(即manage.py所在文件夹)里执行以下命令:

python manage.py migrate

4.重启服务器。

添加社交账号登录

后台设置

注意:因为做网站一般有两种环境:开发环境(即网站在本地主机上开发)和生产环境(即网站部署在服务器),而开发环境网站主页一般为:http://127.0.0.1:8000,生产环境则类似为http://www.honkerzhou.com,为简单描述,所以下文我会直接用你的域名代替你的网站主页地址,故请分清自己的网站主页地址,以免混淆。

  1. 进入后台管理界面(你的域名/admin/ ),点击站点(Sites),在里面增加一个站点,域名就写你的域名,名称随意,填好后点保存;
  2. 在社交账号(SOCIAL ACCOUNTS)下的社交app(Social application)里增加一个社交app,需要你填上相关信息(下面以支持GitHub社交账号登录为例)。
  3. Provider:选择GitHub;
  4. 名称(Name):可以随便写,只有你自己能辨别就好,建议写GitHub;
  5. Client id和Secret key: 需要到GitHub上申请获取。如没有或不会,详见获取第三方应用的Client id和Secret key;
  6. Key: 可不填;
  7. Sites: 在可用的sites下选中你的域名,将其移到右边选中的sites中,点保存。

获取第三方应用的Client id和Secret key

1.GitHub

登录GitHub后 --> 进入Settings --> 进入Developer settings --> 在OAuth Apps下进入New OAuth App --> 然后按步骤填写信息 --> 进入下一步后就可以看到Client id和Secret key了。

注意:

  1. Homepage URL填写你的域名;
  2. Authorization callback URL填写你的域名/accounts/github/login/callback/

验证和初步使用

  1. 重要:注销你的管理员账号!!!
  2. 进入这个网址:你的域名/accounts/login/ ,你会看到一个排版很乱很丑的页面,这是django-allauth自带的模板。如果这时你选择通过GitHub账号登录并且出现了GitHub登录授权的提示说明你前面都做对了,恭喜你!
  3. 但你会发现授权登录后链接到了这个网址:你的域名/accounts/profile/ ,并且得到一个404页面,这时请别慌张,你只需要在你的settings.py文件里加上这句代码:LOGIN_REDIRECT_URL = '/'保存后刷新页面,你会发现跳转到了你网站的主页面;
  4. 如果你要退出登录,进入这个网址: 你的域名/accounts/logout/ 注销即可。

相关推荐