flask_login.current_user.name()函数的使用及返回值解析

flask_login.current_user.name() 函数用于获取当前登录用户的用户名。该函数会返回一个字符串类型的值，即当前用户的用户名。

使用例子如下：

from flask import Flask
from flask_login import LoginManager, UserMixin, login_user, login_required, current_user

app = Flask(__name__)
app.config['SECRET_KEY'] = 'secret_key'

login_manager = LoginManager(app)
login_manager.login_view = 'login'

# 模拟一个用户类
class User(UserMixin):
    def __init__(self, username):
        self.username = username

@login_manager.user_loader
def load_user(user_id):
    # 根据用户ID加载用户对象
    # 这里我们简单地模拟一个用户类，并返回一个具有指定ID的用户对象
    return User(user_id)

@app.route('/')
@login_required
def home():
    # 获取当前登录用户的用户名
    username = current_user.name()
    return f'欢迎 {username} 登录！'

if __name__ == '__main__':
    app.run()

在上述代码中，我们通过 Flask-Login 插件实现了一个基本的登录功能。首先，我们创建了一个继承自 UserMixin 的用户类 User，并在其中定义了一个 username 属性。然后，我们编写了一个装饰器 @login_manager.user_loader，用于加载用户对象。在 load_user 函数中，我们简单地返回一个具有指定 ID 的用户对象。

接着，我们创建了一个根路由 /，用于展示当前登录用户的用户名。我们使用了 @login_required 装饰器来保护该路由，确保只有登录用户可以访问。在路由函数中，我们调用了 current_user.name() 函数，获取当前登录用户的用户名，并将其作为字符串返回。

注意，在调用 current_user.name() 函数之前，我们需要确保用户已登录。这可以通过 @login_required 装饰器来实现，它会自动检查用户是否登录，若未登录则会重定向到登录页面。

总结：

- flask_login.current_user.name() 函数用于获取当前登录用户的用户名。

- 返回值为一个字符串，即当前用户的用户名。

- 使用前需要确保用户已登录，可以使用 @login_required 装饰器来保护相关路由。

- 该函数在获取用户的用户名时非常有用，可以方便地在视图函数中使用该信息。