Flask框架（二）数据库操作

本文介绍Flask的数据库操作，是用flask_sqlalchemy进行相关操作，下面详细介绍：

一、flask_sqlalchemy安装

这里是安装在虚拟环境里面，采用了镜像加速，安装命令如下：

venv\Scripts\python.exe -m pip install -i https://pypi.tuna.tsinghua.edu.cn/simple/ pymysql
venv\Scripts\python.exe -m pip install -i https://pypi.tuna.tsinghua.edu.cn/simple/ flask-mysqldb
venv\Scripts\python.exe -m pip install -i https://pypi.tuna.tsinghua.edu.cn/simple/ flask-sqlalchemy

二、数据库配置

class Config:
    DEBUG = False
    SQLALCHEMY_DATABASE_URI = 'mysql+pymysql://{0}:{1}@{2}:3306'.format(DB_USER, DB_PWD, DB_ADDR)  # 默认数据库引擎，数据库根目录
    # 配置多个数据库连接
    SQLALCHEMY_BINDS = {
        'client': 'mysql+pymysql://{0}:{1}@{2}:3306/{3}?charset=utf8'.format(DB_USER, DB_PWD, DB_ADDR, DB_NAME)
    }

    # 在app设置里开启自动提交会出现 sqlalchemy.exc.InvalidRequestError: Can't reconnect until invalid transaction is rolled back
    SQLALCHEMY_COMMIT_ON_TEARDOWN = False
    SQLALCHEMY_TRACK_MODIFICATIONS = False  # 关闭数据追踪，避免内存资源浪费
}

三、定义数据模型基类

定义数据模型基类BaseModel，数据模型继承这个基类

from flask_sqlalchemy import SQLAlchemy
import logging
import json

# 客户数据库连接，用作数据模型
# 此处db是默认的数据库引擎连接SQLALCHEMY_DATABASE_URI，指向数据库根目录，运行sql语句时要指定具体数据库
db = SQLAlchemy()

class BaseModel(object):
    def update(self):  # 更新记录
        try:
            db.session.commit()  # 事务提交
        except Exception as e:
            db.session.rollback()  # 事务回滚
            logging.error('[BaseModel->update]Failed to run update, {0}'.format(e))
            return False

        return True

    def add_update(self):  # 增加一条记录
        try:
            db.session.add(self)  # 添加数据对象
            db.session.commit()  # 事务提交
        except Exception as e:
            db.session.rollback()  # 事务回滚
            logging.error('[BaseModel->add_update]Failed to run add_update, {0}'.format(e))
            return False

        return True

    def add_all_update(self, datas: list):  # 增加多条记录
        try:
            db.session.add_all(datas)  # 添加数据对象
            db.session.commit()  # 事务提交
        except Exception as e:
            db.session.rollback()  # 事务回滚
            logging.error('[BaseModel->add_all_update]Failed to run add_all_update, {0}'.format(e))
            return False

        return True

    def delete(self):  # 删除一条记录
        try:
            db.session.delete(self)  # 删除数据对象
            db.session.commit()  # 事务提交
        except Exception as e:
            db.session.rollback()  # 事务回滚
            logging.error('[BaseModel->delete]Failed to run delete, {0}'.format(e))
            return False

        return True

    def to_json(self):  # SQLAlchemy转json对象
        fields = {}
        for field in [x for x in self.__dict__ if not x.startswith('_') and x != 'metadata']:
            data = self.__getattribute__(field)
            try:
            	# 非json识别的数据类型在这里转换，这里以DataTime类型转换举例
                if isinstance(data, datetime):
                    data = data.strftime('%Y-%m-%d %H:%M:%S')
                json.dumps(data)  # this will fail on non-encodable values, like other classes
                fields[field] = data
            except TypeError:
                fields[field] = None
                logging.error(traceback.format_exc())
        return fields


# 执行自定义sql语句查询，失败最多重试3次
def mysql_execute(sql: str):
    results = []
    session = db.session()

    n = 0
    while (not results and n < 3):
        n += 1
        try:
            resultproxy = session.execute(sql)
            if resultproxy.keys():
                results = resultproxy.fetchall()
        except Exception as e:
            session.rollback()  # 事务回滚
            logging.error('[mysql_execute]Failed to run mysql_execute, {0}'.format(e))
    session.close()

    return results

创建数据库函数

def create_db(dbname: str):
    if not mysql_execute("show databases like '{0}';".format(dbname)):
        sql = 'CREATE DATABASE IF NOT EXISTS {0} default charset utf8 COLLATE utf8_general_ci;'.format(dbname)
        mysql_execute(sql)

生成数据表函数

def create_db_client(dbname: str):
    try:
        create_db(dbname)  # 创建数据库
        db.create_all()  # 创建客户数据表
    except Exception as e:
        logging.error('[create_db_client]Failed to run create_db_client, {0}'.format(e))

四、定义具体数据模型

以创建用户数据模型为举例：

# 客户用户信息数据表模型
class AccountUsers(BaseModel, db.Model):
    __bind_key__ = 'client'  # 数据库引擎，这就表示数据库名称，在config.py中定义，在SQLALCHEMY_BINDS中配置
    __tablename__ = 'account_users'  # 账户信息->用户表

    Id = db.Column(db.INTEGER, primary_key=True)
    Name = db.Column(db.String(50), unique=True)  # 用户名称
    Pwd = db.Column(db.String(300))  # 用户密码
    Nick = db.Column(db.String(150))  # 用户姓名
    PostId = db.Column(db.INTEGER, nullable=False)  # 职位ID
    Mobile = db.Column(db.String(150))  # 用户手机号码
    Email = db.Column(db.String(150))  # 用户邮箱地址
    Authview = db.Column(db.Text, default='{}')  # 用户查看权限
    Authoper = db.Column(db.Text, default='{}')  # 用户操作权限
    Valid = db.Column(db.INTEGER, default=1)  # 账号是否有效：0注销，1生效
    RegTime = db.Column(TIMESTAMP, server_default=func.current_timestamp(), index=True)

五、创建数据库和数据表

from FlaskDemo.controls.Base import db

# 1.创建app对象
from FlaskDemo.manager import create_app
from FlaskDemo.config import DevelopConfig

def create_client_db():
    # 创建所以客户数据表
    create_db_client(DB_NAME)

    # 初始化表数据
    AccountUsers.init_data()  # 初始化用户数据

# 创建Flask App
app = create_app(DevelopConfig)

def init_data():
    with app.app_context():
        # 初始化数据库配置
        init_database()

六、完整教程地址

Flask搭建项目完整教程：Flask+Vue搭建系统