the flask mega tutorial自学记录 之 第五章 用户登录(注册和登录)

1. hash 密码
   1.1 我们访问网站的时候，经常需要注册，注册以后自然就会存留密码。
   为了防止意外数据外泄导致用户的密码暴露，故可以通过hash算法将用户密码加密处理。

from werkzeug.security import generate_password_hash
hash = generate_password_hash('foobar')   #将密码foobar通过hash算法加密

1.2 有了加密，自然就会用到解密了。flask自带了一个密码检核的方法。

from werkzeug.security import check_password_hash
check_password_hash(hash, 'foobar')        #检核密码

1.3 为了方便后期USER表（app/models.py）的操作，可以在原有的USER类中新增密码hash及密码核对的方法

from werkzeug.security import generate_password_hash, check_password_hash

# ...

class User(db.Model):
    # ...

    def set_password(self, password):
        self.password_hash = generate_password_hash(password)

    def check_password(self, password):
        return check_password_hash(self.password_hash, password)

2、登录设计
2.1 准备user model
Flask有一个扩展模块Flask-Login，专门管理用户登录相关的内容。安装方法如下：

pip install flask-login

2.2 在用户登录的时候，我们经常需要获取用户登录的一些属性值来进一步判读下一步操作：
is_authenticated: 是否有效认证
is_active:是否活跃账户.
is_anonymous: 是否匿名账户
get_id(): 返回用户的id.
flask_login包含的一个类UserMixin，这个类包含了很多通用的用户model类。

# ...
from flask_login import UserMixin
class User(UserMixin, db.Model):     #通过继承方式承接那些类属性
    # ...

2.3 用户加载
用户登录的时候，再匹配用户信息的时候，就需要先加载用户信息。
app/models.py

from app import login
# ...

@login.user_loader
def load_user(id):
    return User.query.get(int(id))     #通过int把id转换成数字

2.4 用户登录视图

# ...
from flask_login import current_user, login_user
from app.models import User

# ...

@app.route('/login', methods=['GET', 'POST'])
def login():
    #如果是已经注册过的用户，直接跳转到首页
    if current_user.is_authenticated:
        return redirect(url_for('index'))
    form = LoginForm()              #实例化登录表单
    if form.validate_on_submit():
        user = User.query.filter_by(username=form.username.data).first()  #根据用户名查询对应用户的记录
        if user is None or not user.check_password(form.password.data):    #如果登录信息不全，提交后仍然提留在登录页面
            flash('Invalid username or password')
            return redirect(url_for('login'))             
        login_user(user, remember=form.remember_me.data)   #login_user(user)，其实也是调用user_loads()把用户设置到session中
        return redirect(url_for('index'))
    return render_template('login.html', title='Sign In', form=form)

2.5 注销账户
app/routes.py

# ...
from flask_login import logout_user

# ...

@app.route('/logout')
def logout():
    logout_user()
    return redirect(url_for('index'))

为了方便用户注销，在导航栏中增加注销菜单项：

   <div>
        Microblog:
        <a href="{{ url_for('index') }}">Home</a>
        {% if current_user.is_anonymous %}   #判断当前用户是否匿名账户
        <a href="{{ url_for('login') }}">Login</a>
        {% else %}
        <a href="{{ url_for('logout') }}">Logout</a>
        {% endif %}
    </div>

2.6 强制注册
有时页面或内容，需要会员或注册用户才可以查看，Flask可以很方便的实现此功能。
2.6.1 首页要告知Flask，那个视图函数是控制登录的。

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

2.6.2 设置强制注册
app/routes.py:

from flask_login import login_required

@app.route('/')
@app.route('/index')
@login_required      #强制注册装饰器
def index():
    # ...

2.7 登录后跳转回原访问页面
强制跳转到登录页面，此时的页面路径地址中会自动增添nex访问t参数，例如： URL /login?next=/index

from flask import request
from werkzeug.urls import url_parse

@app.route('/login', methods=['GET', 'POST'])
def login():
    # ...
    if form.validate_on_submit():
        user = User.query.filter_by(username=form.username.data).first()
        if user is None or not user.check_password(form.password.data):
            flash('Invalid username or password')
            return redirect(url_for('login'))
        login_user(user, remember=form.remember_me.data)
        #获取登录页面路由地址中的next参数值
        next_page = request.args.get('next')
        #url_parse编译路由地址，netloc属性指域名
        #当next_page为空或者路由地址是相对地址时，返回index网页，否则返回next_page制定页面（绝对的地址）
        if not next_page or url_parse(next_page).netloc != '':
            next_page = url_for('index')
        return redirect(next_page)
    # ...

2.8 设置首页样式

{% extends "base.html" %}

{% block content %}
    <h1>Hi, {{ current_user.username }}!</h1>   #返回当前用户名称
    {% for post in posts %}    #循环遍历当前用户的博文
    <div><p>{{ post.author.username }} says: <b>{{ post.body }}</b></p></div>
    {% endfor %}
{% endblock %}

2.9 注册账户
当在登录界面的时候，如果用户没有登录账号，就需要注册了。
2.9.1 清除先前的测试账户信息
app/routes.py

@app.route('/')
@app.route('/index')
def index():
    # ...             #把user字典变量删除
    return render_template("index.html", title='Home Page', posts=posts)

2.9.2 设置注册表单ORM的类对象
app/forms.py

from flask_wtf import FlaskForm
from wtforms import StringField, PasswordField, BooleanField, SubmitField
from wtforms.validators import ValidationError, DataRequired, Email, EqualTo
from app.models import User

# ...

class RegistrationForm(FlaskForm):
    username = StringField('Username', validators=[DataRequired()])
    email = StringField('Email', validators=[DataRequired(), Email()])
    password = PasswordField('Password', validators=[DataRequired()])
    password2 = PasswordField(
        'Repeat Password', validators=[DataRequired(), EqualTo('password')])   #EqualTo判断等于
    submit = SubmitField('Register')

    def validate_username(self, username):
        user = User.query.filter_by(username=username.data).first()
        if user is not None:
            raise ValidationError('Please use a different username.')

    def validate_email(self, email):
        user = User.query.filter_by(email=email.data).first()
        if user is not None:
            raise ValidationError('Please use a different email address.')

2.9.3 设置注册页面格式

{% extends "base.html" %}

{% block content %}
    <h1>Register</h1>
    <form action="" method="post">
        {{ form.hidden_tag() }}
        <p>
            {{ form.username.label }}<br>
            {{ form.username(size=32) }}<br>
            {% for error in form.username.errors %}
            <span style="color: red;">[{{ error }}]</span>
            {% endfor %}
        </p>
        <p>
            {{ form.email.label }}<br>
            {{ form.email(size=64) }}<br>
            {% for error in form.email.errors %}
            <span style="color: red;">[{{ error }}]</span>
            {% endfor %}
        </p>
        <p>
            {{ form.password.label }}<br>
            {{ form.password(size=32) }}<br>
            {% for error in form.password.errors %}
            <span style="color: red;">[{{ error }}]</span>
            {% endfor %}
        </p>
        <p>
            {{ form.password2.label }}<br>
            {{ form.password2(size=32) }}<br>
            {% for error in form.password2.errors %}
            <span style="color: red;">[{{ error }}]</span>
            {% endfor %}
        </p>
        <p>{{ form.submit() }}</p>
    </form>
{% endblock %}

2.9.3 在登录页面的下边增加一个跳转到注册页面的连接

<p>New User? <a href="{{ url_for('register') }}">Click to Register!</a></p>

2.9.4 定义注册视图函数

from app import db
from app.forms import RegistrationForm

# ...

@app.route('/register', methods=['GET', 'POST'])
def register():
    if current_user.is_authenticated:
        return redirect(url_for('index'))
    form = RegistrationForm()
    if form.validate_on_submit():
        user = User(username=form.username.data, email=form.email.data)
        user.set_password(form.password.data)
        db.session.add(user)
        db.session.commit()
        flash('Congratulations, you are now a registered user!')
        return redirect(url_for('login'))
    return render_template('register.html', title='Register', form=form)