Flask-Login使用详解

小灰灰 2022-03-22 03:36 614阅读 0赞

## 先看一下flask-login模块的整体架构 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d5bWFpc3ls_size_16_color_FFFFFF_t_70]  
基础的信息和全局配置这里就不多说，需要用到再斟酌也可以的。  
这里也是针对每个模块较为常用的进行解释说明，后期再使用过程中遇到会进行补充。

# Login\_Manager #

![在这里插入图片描述][20190125160133660.png]  
LoginManager是一个类，有多个方法和属性；此类初始化的对象用于保存用于登录的设置。实例：class：`LoginManager` \* \*不绑定到特定应用程序，因此可以在代码的主体中创建一个，然后将其绑定到您的应用程序app中 工厂函数。

#### 初始化一个LoginManager类对象 ####

`login_manager = LoginManager()`

#### init\_\_app() – 配置该对象 ####

`login_manager.init_app(app)`

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d5bWFpc3ls_size_16_color_FFFFFF_t_70 1]

#### user\_loader() 回调函数 ####

自定义回调函数，user\_loader源代码参考下图：

源代码注释：

> 这将设置从会话重新加载用户的回调。 您设置的函数应该使用用户ID（“unicode”）并返回用户对象，如果用户不存在则返回“None”。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d5bWFpc3ls_size_16_color_FFFFFF_t_70 2]  
自定义回调函数

@login_manager.user_loader
    def load_user(userid):
        return User.get(userid)

在执行该段代码之后，注册了load\_user()这个自定义的callback。

#### reload\_user() ####

1、首先获取user id，如果获取不到有效的id，就将user设为anonymous user  
2、获取到id后，再通过@login\_manager.user\_loader装饰的函数获取到user对象，如果没有获取到有效的user对象，就认为是anonymous user  
3、最后将user保存于request context中（无论是正常的用户还是anonymous用户）  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d5bWFpc3ls_size_16_color_FFFFFF_t_70 3]  
源代码注释

> 这将ctx.user设置为由您的自定义user\_loader回调函数加载的用户对象，该函数应使用从session获取的user\_id检索用户对象。  
> 语法示例：  
> 来自于flask\_login导入LoginManager  
> @ login\_manager.user\_loader  
> def any\_valid\_func\_name（user\_id）：  
> ＃使用给定的user\_id获取用户对象，  
> ＃如果您使用SQLAlchemy，例如：  
> user\_obj = User.query.get（int（user\_id））  
> return user\_obj  
> 让你定义这个self.user\_callback的原因：  
> 因为我们不知道你将如何/在哪里加载用户对象。

## （实例属性的配置） ##

#### login-view ：验证失败跳转的界面 ####

`login_manager.login_view = "/"` 跳转到/首页目录  
![在这里插入图片描述][20190125165541279.png]

#### login-message：用户重定向到登录页面时闪出的消息 ####

`login_manager.login_message ='Please login first!'`  
![在这里插入图片描述][20190125165852123.png]

#### refresh-view：用户需要重新进行身份验证时要重定向到的视图的名称。 ####

l`ogin_manager.refresh_view = "/"`  
![在这里插入图片描述][2019012517013368.png]

#### needs-refresh-message：用户重定向到“需要刷新”页面时闪出的消息。 ####

`login_manager.needs_refresh_message = 'Refresh for login!'`  
![在这里插入图片描述][2019012517030723.png]

#### session-protection：使用会话保护的模式。这可以是`'basic'`（默认）或`'strong'`，或`None`禁用 ####

`login_manager.session_protection = ‘strong’`  
![在这里插入图片描述][20190125171253664.png]

# utils #

#### Login\_required ####

current\_user.is\_authenticated，判断当前用户是否认证，如果没有认证的话就执行unauthorized()，  
unauthorized()会重定向到login\_view参数设置的路由函数中去，所以在实例化LoginManager后要设置login\_view属性，  
当用户没有登陆时，会自动重定向到登陆界面，没有设置会返回401错误， 用户登陆后，这个装饰器就直接返回func(\*args, \*\*kwargs)，相当于没有包装一样，装饰器起到包装接口的作用。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d5bWFpc3ls_size_16_color_FFFFFF_t_70 4]  
源码解释：

> 1、如果使用此装饰视图，它将确保在调用实际视图之前登录并验证当前用户。如果验证不通过，那么则会调用LoginManager.unauthorized（）  
> 2、\#如果request method为例外method，即在EXEMPT\_METHODS中的method，可以不必鉴权  
> 3、如果\_login\_disabled为True则不必鉴权

#### Login\_user ####

用户登录操作，用户在通过自定义的login视图函数，通过验证并登录成功后，需要

# Flask-Login中的login_user可以记录/保存当前成功登陆的用户
        login_user(user)

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d5bWFpc3ls_size_16_color_FFFFFF_t_70 5]

#### logout\_user ####

登出功能类似，除了基本的操作外，还需要把flask-login中的登出进行操作

@app.route('/logout')
    @login_required
    def logout():
        logout_user()
        return 'Logged out successfully!'

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d5bWFpc3ls_size_16_color_FFFFFF_t_70 6]

# UserMixin #

**is\_authenticated**  
当用户通过验证时，也即提供有效证明时返回 True 。（只有通过验证的用户会满足 login\_required 的条件。）  
**is\_active**  
如果这是一个活动用户且通过验证，账户也已激活，未被停用，也不符合任何你 的应用拒绝一个账号的条件，返回 True 。不活动的账号可能不会登入（当然， 是在没被强制的情况下）。  
**is\_anonymous**  
如果是一个匿名用户，返回 True 。（真实用户应返回 False 。）  
**get\_id()**  
返回一个能唯一识别用户的，并能用于从 user\_loader 回调中加载用户的 unicode 。注意着 必须 是一个 unicode —— 如果 ID 原本是 一个 int 或其它类型，你需要把它转换为 unicode 。  
要简便地实现用户类，你可以从 UserMixin 继承，它提供了对所有这些方法的默认 实现。（虽然这不是必须的。）  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d5bWFpc3ls_size_16_color_FFFFFF_t_70 7]

## Flask-Login 一般使用基础流程 ##

Flask-Login 通过 user session，提供登录的常见任务，比如登入 (logging in)、登出 (logging out) 和当前用户 (current user)

`login_user()`：实现用户的登入，一般在登入的视图函数中调用

`logout_user()`：实现登出功能

`current_user 属性`：获取当前用户  
如果需要页面是授权用户才可见，在相应视图函数前加上 `@login_required` 装饰器进行声明即可，@login\_required 装饰器对于未登录用户访问，默认处理是重定向到 `LoginManager.login_view` 所指定的视图

1.定义 User  
登录基于用户，需要定义 User 类，Flask-Login 规定 User 类必须实现三个属性和一个方法：

is\_authenticated 属性

is\_active 属性

is\_anonymous 属性

get\_id() 方法

最简单的方法是从 UserMixin 类继承，该类提供了默认的实现。

from flask_login import UserMixin
    
    class User(UserMixin，db.Model):
        pass

2.应用程序的配置  
创建 LoginManager 实例，然后与 app 绑定。、

from flask_login import LoginManager
    
    login_manager = LoginManager()
    
    login_manager.login_view = 'login'
    login_manager.login_message_category = 'info'
    login_manager.login_message = 'Access denied.'
    
    login_manager.init_app(app)

3.user\_loader 回调函数  
user session 记录的是用户 ID (user\_id)，回调函数的作用就是通过 user\_id 返回对应的 User 对象。user\_loader 回调函数在 user\_id 非法的时候不应该抛出异常，而要返回 None。没有这个回调函数的话，Flask-Login 将无法工作

@login_manager.user_loader
    def load_user(user_id):
        if query_user(user_id) is not None:
            curr_user = User()
            curr_user.id = user_id
    
            return curr_user

4.登入功能实现

@app.route('/login', methods=['GET', 'POST'])
    def login():
        if request.method == 'POST':
            user_id = request.form.get('userid')
            user = query_user(user_id)
            if user is not None and request.form['password'] == user['password']:
    
            curr_user = User()
            curr_user.id = user_id
    
            # 通过Flask-Login的login_user方法登录用户
            login_user(curr_user)
    
            return redirect(url_for('index'))
    
        flash('Wrong username or password!')
    
    # GET 请求
    return render_template('login.html')

关键就是 login\_user(curr\_user) 这句代码，之前要构建 User 对象，并指定 id。

5.登出功能实现

@app.route('/logout')
    @login_required
    def logout():
        logout_user()
        return 'Logged out successfully!'

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d5bWFpc3ls_size_16_color_FFFFFF_t_70]: /images/20220322/24c453d619bc41c0b61886888952a911.png
[20190125160133660.png]: /images/20220322/e307f60fb09443fd81c855923898c824.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d5bWFpc3ls_size_16_color_FFFFFF_t_70 1]: /images/20220322/c8bd3705294647109b909262cf00653e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d5bWFpc3ls_size_16_color_FFFFFF_t_70 2]: /images/20220322/be25a48ff0b049e0b92c6c277b8c5d8d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d5bWFpc3ls_size_16_color_FFFFFF_t_70 3]: /images/20220322/7853cb0b6f47405ea2d8336cd53f279b.png
[20190125165541279.png]: /images/20220322/c360374b76b8462cb4f97f7a09ad6a51.png
[20190125165852123.png]: /images/20220322/461b367095af45229e81fff4eba87366.png
[2019012517013368.png]: /images/20220322/5fbe7a037f2b45028de56013f819de43.png
[2019012517030723.png]: /images/20220322/edac782877b84ef1af27812e00b5f4a4.png
[20190125171253664.png]: /images/20220322/df20c88b13d94e20b71555ec018e7e0a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d5bWFpc3ls_size_16_color_FFFFFF_t_70 4]: /images/20220322/34078807014f4d37a3354b365ca384c0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d5bWFpc3ls_size_16_color_FFFFFF_t_70 5]: /images/20220322/9e796b5a1807426ab7f4ec2066c65cc0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d5bWFpc3ls_size_16_color_FFFFFF_t_70 6]: /images/20220322/79fe220c784b4fa8ad3438e0e850e8ac.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2d5bWFpc3ls_size_16_color_FFFFFF_t_70 7]: /images/20220322/76d55205757f46a99ff789fe95e22829.png