python之Flask实现登录功能

网站少不了要和数据库打交道，归根到底都是一些增删改查操作，这里做一个简单的用户登录功能来学习一下Flask如何操作MySQL。

用到的一些知识点：Flask-SQLAlchemy、Flask-Login、Flask-WTF、PyMySQL

这里通过一个完整的登录实例来介绍，程序已经成功运行，在未登录时拦截了success.html页面跳转到登录页面，登录成功后才能访问success。

以下是项目的整体结构图：

首先是配置信息，配置了数据库连接等基本的信息，config.py

DEBUG = True 
SQLALCHEMY_ECHO = False 
SQLALCHEMY_DATABASE_URI = 'mysql+pymysql://root:1011@localhost/rl_project?charset=utf8' 
SECRET_KEY = '*\xff\x93\xc8w\x13\x0e@3\xd6\x82\x0f\x84\x18\xe7\xd9\\|\x04e\xb9(\xfd\xc3'

common/_init_.py

# config=utf-8  
from flask_sqlalchemy import SQLAlchemy  
   
__all__ = ['db']  
db = SQLAlchemy()  

数据库配置类，common/data.py

# config=utf-8  
from sqlalchemy import create_engine  
from sqlalchemy.sql import text  
from config import SQLALCHEMY_DATABASE_URI, SQLALCHEMY_ECHO  
   
   
def db_query(sql, settings=None, echo=None):  
   
    if settings is None:  
        settings = SQLALCHEMY_DATABASE_URI  
   
    if echo is None:  
        echo = SQLALCHEMY_ECHO  
   
    return create_engine(settings, echo=echo).connect().execute(text(sql)).fetchall()  
   
   
def db_execute(sql, settings=None, echo=None):  
   
    if settings is None:  
        settings = SQLALCHEMY_DATABASE_URI  
   
    if echo is None:  
        echo = SQLALCHEMY_ECHO  
   
    return create_engine(settings, echo=echo).connect().execute(text(sql)).rowcount  

SQLALCHEMY_DATABASE_URI用于连接数据的数据库。
SQLALCHEMY_ECHO如果设置成 True，SQLAlchemy 将会记录所有发到标准输出(stderr)的语句，这对调试很有帮助。
当然，我们在setting中设置了基本的连接数据库信息，启动时加载app = create_app('../config.py')，所以这个类删掉也不会报错。

form/login_form.py

# config=utf-8  
from flask_wtf import FlaskForm as Form  
from wtforms import StringField, PasswordField  
from wtforms.validators import DataRequired  
   
   
class LoginForm(Form):  
    accountNumber = StringField('accountNumber', validators=[DataRequired('accountNumber is null')])  
    password = PasswordField('password', validators=[DataRequired('password is null')])  

使用Flask-WTF做登录的表单验证，这里简单做了账号密码不为空

如，当我们不填写密码时，点击登录：

model/_init_.py

# config=utf-8  
from flask import Flask  
from flask_login import LoginManager  
from common import db  
   
login_manager = LoginManager()  
login_manager.login_view = "user.login" 
   
   
def create_app(config_filename=None):  
    app = Flask(__name__)  
    login_manager.init_app(app)  
   
    if config_filename is not None:  
        app.config.from_pyfile(config_filename)  
        configure_database(app)  
   
    return app  
   
   
def configure_database(app):  
    db.init_app(app)  

其中，login_manager.login_view = "user.login" 指定了未登录时跳转的页面，即被拦截后统一跳到user/login这个路由下

model/user_model.py

# config=utf-8  
from flask_login import UserMixin  
from common import db  
   
   
class User(db.Model, UserMixin):  
   
    user_id = db.Column('id', db.Integer, primary_key=True)  
    accountNumber = db.Column(db.String(200), unique=True)  
    password = db.Column(db.String(50), unique=True)  
    name = db.Column(db.String(20), unique=True)  
   
    __tablename__ = 'tb_user' 
   
    def __init__(self, user_id=None, account_number=None, password=None, name="anonymous"):  
   
        self.user_id = user_id  
        self.accountNumber = account_number  
        self.password = password  
        self.name = name  
   
    def is_authenticated(self):  
        return True 
   
    def is_active(self):  
        return True 
   
    def is_anonymous(self):  
        return False 
   
    def get_id(self):  
        return unicode(self.user_id)  
   
    def __repr__(self):  
        return '<User %r>' % (self.accountNumber)  

这里需要注意：

1 2	`def` `get_id(self):` `return` `unicode(self.user_id)`

该方法不可缺少，否则会报：NotImplementedError: No `id` attribute - override `get_id`错误。

get_id()

返回一个能唯一识别用户的，并能用于从 user_loader 回调中加载用户的 unicode 。注意着必须是一个 unicode ——如果 ID 原本是一个 int 或其它类型，你需要把它转换为 unicode 。

is_authenticated()

当用户通过验证时，也即提供有效证明时返回 True

is_active()

如果这是一个通过验证、已激活、未被停用的账户返回 True 。

is_anonymous()

如果是一个匿名用户，返回 True 。

#encoding:utf-8  
#!/usr/bin/env python  
from flask import render_template, request, redirect, Flask, Blueprint  
from flask_login import login_user, login_required  
from model.user_model import User  
from model import login_manager  
from form.login_form import LoginForm  
   
   
userRoute = Blueprint('user', __name__, url_prefix='/user', template_folder='templates', static_folder='static')  
  
@login_manager.user_loader  
def load_user(user_id):  
    return User.query.get(int(user_id))  
  
  
@userRoute.before_request  
def before_request():  
    pass 
  
@userRoute.route('/success')  
@login_required 
def index():  
    return render_template('success.html')  
  
@userRoute.route('/login', methods=['GET', 'POST'])  
def login():  
    form = LoginForm()  
    if request.method == 'POST':  
        if not form.validate_on_submit():  
            print form.errors  
            return render_template('login.html', form=form)  
   
        user = User.query.filter(User.accountNumber == form.accountNumber.data,  
                                 User.password == form.password.data).first()  
        if user:  
            login_user(user)  
            return render_template('success.html')  
   
    return render_template('login.html', form=form) 

其中，要实现一个load_user()回调方法，这个回调用于从会话中存储的用户 ID 重新加载用户对象，id存在则返回对应的用户对象，不存在则返回none。

有些操作是需要用户登录的，有些操作则无需用户登录，这里使用到了@login_required，在每一个需要登录才能访问的路由方法上加@login_required即可。

启动类，runserver.py

# config=utf-8  
from login import userRoute  
from model import create_app  
   
DEFAULT_MODULES = [userRoute]  
   
app = create_app('../config.py')  
   
for module in DEFAULT_MODULES:  
    app.register_blueprint(module)  
  
  
@app.before_request  
def before_request():  
    pass 
   
   
if __name__ == '__main__':  
    app.run(debug=True)  

DEFAULT_MODULES = [userRoute]是将userRoute蓝图注册入app，才能启动login中的userRoute路由，我们在login.py中使用了蓝图：userRoute = Blueprint('user', __name__, url_prefix='/user', template_folder='templates', static_folder='static')

@app.before_request  
def before_request():  
    pass 

这是一个全局的方法，在请求开始之前被调用，在某些场景下做一些提示或者特殊处理，当然这里没用上，直接pass，这个方法去掉对项目没有影响。

基本样式模版，base.html

<!DOCTYPE html>  
<html lang="cn">  
<head>  
    <meta charset="UTF-8">  
    <title>{% block title %}{% endblock %}</title>  
    <script src="{{ url_for('static', filename='jquery1.42.min.js') }}"></script>  
    {% block head %}{% endblock %}  
</head>  
<body>  
{% block content %}{% endblock %}  
</body>  
</html>  

登录前台页面，login.html

{% extends "base.html" %}  
{% block title %}python flask user page{% endblock %}  
{% block head %}  
    <style type="text/css"></style>  
{% endblock %}  
{% block content %}  
    <form action="{{ url_for('user.login') }}" method="post">  
        {% if form.errors %}  
            <ul>  
                {% for name, errors in form.errors.items() %}  
                    {% for error in errors %}  
                        <li>{{ error }}</li>  
                    {% endfor %}  
                {% endfor %}  
            </ul>  
        {% endif %}  
        账号：{{ form.accountNumber(size=20) }}<label>{{ form.accountNumber.errors[0] }}</label><br/>  
        密码：<input name="password" type="password"/><br/>  
        {{ form.hidden_tag() }}  
        <button type="submit">登录</button>  
    </form>  
{% endblock %}  