Flask框架(十一)~Flask 项目搭建

项目框架搭建

项目框架搭建

• 新建项目，虚拟环境选择python3版本，创建 manage.py 文件

from flask import Flask

app = Flask(__name__)

@app.route('/index')
def index():
    return 'index'

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

项目基本配置

Config类

• 先在当前类中定义配置的类，并从中加载配置

app = Flask(__name__)

class Config(object):
    """工程配置信息"""
    DEBUG = True

app.config.from_object(Config)

SQLAlchemy

• 导入数据库扩展，并在配置中填写相关配置

from flask_sqlalchemy import SQLAlchemy

...

class Config(object):
    """工程配置信息"""
    DEBUG = True
    # 数据库的配置信息
    SQLALCHEMY_DATABASE_URI = "mysql://root:mysql@127.0.0.1:3306/information"
    SQLALCHEMY_TRACK_MODIFICATIONS = False

app.config.from_object(Config)
db = SQLAlchemy(app)

• 在终端创建数据库

mysql> create database information charset utf8;

Redis

• 创建redis存储对象，并在配置中填写相关配置

import redis
...

class Config(object):
    """工程配置信息"""
    ...
    # redis配置
    REDIS_HOST = "127.0.0.1"
    REDIS_PORT = 6379

app.config.from_object(Config)
db = SQLAlchemy(app)
redis_store = redis.StrictRedis(host=Config.REDIS_HOST, port=Config.REDIS_PORT)

CSRF

• 包含请求体的请求都需要开启CSRF

from flask_wtf.csrf import CSRFProtect
...
app.config.from_object(Config)
...
CSRFProtect(app)

CSRFProtect只做验证工作，cookie中的 csrf_token 和表单中的 csrf_token 需要我们自己实现

Session

• 利用 flask-session扩展，将 session 数据保存到 Redis 中

from flask_session import Session
...

class Config(object):
    """工程配置信息"""
    SECRET_KEY = "EjpNVSNQTyGi1VvWECj9TvC/+kq3oujee2kTfQUs8yCM6xX9Yjq52v54g+HVoknA"
    ...
    # flask_session的配置信息
    SESSION_TYPE = "redis" # 指定 session 保存到 redis 中
    SESSION_USE_SIGNER = True # 让 cookie 中的 session_id 被加密签名处理
    SESSION_REDIS = redis.StrictRedis(host=REDIS_HOST, port=REDIS_PORT) # 使用 redis 的实例
    PERMANENT_SESSION_LIFETIME = 86400 # session 的有效期，单位是秒

app.config.from_object(Config)
...
Session(app)

运行测试
文档地址：http://pythonhosted.org/Flask-Session/

Flask-Script与数据库迁移扩展

from flask_script import Manager
from flask_migrate import Migrate, MigrateCommand
...
manager = Manager(app)
Migrate(app, db)
manager.add_command('db', MigrateCommand)
...

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

代码抽取

配置文件

• 在与 manage.py 同级目录下创建 config.py 文件，用作于项目的配置文件

import redis


class Config(object):
    """工程配置信息"""
    SECRET_KEY = "EjpNVSNQTyGi1VvWECj9TvC/+kq3oujee2kTfQUs8yCM6xX9Yjq52v54g+HVoknA"

    DEBUG = True

    # 数据库的配置信息
    SQLALCHEMY_DATABASE_URI = "mysql://root:mysql@127.0.0.1:3306/information"
    SQLALCHEMY_TRACK_MODIFICATIONS = True

    # redis配置
    REDIS_HOST = "127.0.0.1"
    REDIS_PORT = 6379

    # session 配置
    SESSION_TYPE = "redis"  # 指定 session 保存到 redis 中
    SESSION_USE_SIGNER = True  # 让 cookie 中的 session_id 被加密签名处理
    SESSION_REDIS = redis.StrictRedis(host=REDIS_HOST, port=REDIS_PORT)  # 使用 redis 的实例
    PERMANENT_SESSION_LIFETIME = 86400  # session 的有效期，单位是秒

• 在 manager.py 中引入 Config 类，直接使用

from config import Config

app = Flask(__name__)

# 配置
app.config.from_object(Config)

业务逻辑独立

在整个项目文件夹中，除了启动文件 manage.py 和配置文件 config.py 放在根目录，其他具体业务逻辑文件都放在一个单独的文件夹内，与 manage.py 同级.

• 创建 info Package，与 manage.py 同级
  
• manage.py 只做最基本的启动工作，将 app 的创建操作移动到 info 的 init.py 文件中

import redis
from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_wtf.csrf import CSRFProtect
from flask_session import Session
from config import Config

app = Flask(__name__)

# 配置
app.config.from_object(Config)
# 配置数据库
db = SQLAlchemy(app)
# 配置redis
redis_store = redis.StrictRedis(host=Config.REDIS_HOST, port=Config.REDIS_PORT)
# 开启csrf保护
CSRFProtect(app)
# 设置session保存位置
Session(app)

• manage.py 的代码为

from flask_script import Manager
from flask_migrate import Migrate, MigrateCommand
from info import app, db

# Flask-script
manager = Manager(app)
# 数据库迁移
Migrate(app, db)
manager.add_command('db', MigrateCommand)


@app.route('/index')
def index():
    return 'index'


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

项目多种配置

一个web程序在开发阶段可能与生产阶段所需要的配置信息可能不一样，所以为了实现此功能，可以给不同情况创建不同的配置类，比如开发阶段使用的配置类名为 DevelopementConfig，生产阶段使用的配置类名为 ProdutionConfig.

• 修改 config.py 文件的配置文件如下

import redis


class Config(object):
    """工程配置信息"""

    SECRET_KEY = "EjpNVSNQTyGi1VvWECj9TvC/+kq3oujee2kTfQUs8yCM6xX9Yjq52v54g+HVoknA"

    # 数据库的配置信息
    SQLALCHEMY_DATABASE_URI = "mysql://root:mysql@127.0.0.1:3306/information"
    SQLALCHEMY_TRACK_MODIFICATIONS = False

    # redis配置
    REDIS_HOST = "127.0.0.1"
    REDIS_PORT = 6379

    # flask_session的配置信息
    SESSION_TYPE = "redis"  # 指定 session 保存到 redis 中
    SESSION_USE_SIGNER = True  # 让 cookie 中的 session_id 被加密签名处理
    SESSION_REDIS = redis.StrictRedis(host=REDIS_HOST, port=REDIS_PORT)  # 使用 redis 的实例
    PERMANENT_SESSION_LIFETIME = 86400  # session 的有效期，单位是秒


class DevelopementConfig(Config):
    """开发模式下的配置"""
    DEBUG = True


class ProductionConfig(Config):
    """生产模式下的配置"""
    pass

工厂类方法创建应用实例

要在不同环境下去使用不同的配置，那么可以在 manage.py 文件中给 info 包传入不同的配置信息，让 ihome 去根据传入指定配置去创建 app，所以可以在 info 的 init.py 文件中添加一个工厂方法，根据传入的配置不同创建其对应的应用实例.

• 在 config.py 文件中添加以下代码：

# 定义配置字典
config = {
    "development": DevelopementConfig,
    "production": ProductionConfig
}

• 修改 info 文件夹下 init.py，添加 create_app 的工厂方法

def create_app(config_name):
    """通过传入不同的配置名字，初始化其对应配置的应用实例"""
    pass

• 修改 manage.py 文件中的代码

from info import create_app, db

# 创建 app，并传入配置模式：development / production
app = create_app('development')

• 将 init.py 文件中创建 app 实例的方法移动到 create_app 方法中

from config import config


# 数据库
db = SQLAlchemy()
redis_store = None


def create_app(config_name):
    """通过传入不同的配置名字，初始化其对应配置的应用实例"""

    app = Flask(__name__)

    # 配置
    app.config.from_object(config[config_name])
    # 配置数据库
    db.init_app(app)
    # 配置redis
    global redis_store
    redis_store = redis.StrictRedis(host=config[config_name].REDIS_HOST, port=config[config_name].REDIS_PORT)
    # 开启csrf保护
    CSRFProtect(app)
    # 设置session保存位置
    Session(app)

    return app

集成日志到当前项目

• 在 config.py 文件中在不同的环境的配置下添加日志级别

class Config(object):
    ...

    # 默认日志等级
    LOG_LEVEL = logging.DEBUG


class ProductionConfig(Config):
    """生产模式下的配置"""
    LOG_LEVEL = logging.ERROR

• 在 info 目录下的 init.py 文件中添加日志配置的相关方法

def setup_log(config_name):
    """配置日志"""

    # 设置日志的记录等级
    logging.basicConfig(level=config[config_name].LOG_LEVEL)  # 调试debug级
    # 创建日志记录器，指明日志保存的路径、每个日志文件的最大大小、保存的日志文件个数上限
    file_log_handler = RotatingFileHandler("logs/log", maxBytes=1024 * 1024 * 100, backupCount=10)
    # 创建日志记录的格式 日志等级 输入日志信息的文件名 行数 日志信息
    formatter = logging.Formatter('%(levelname)s %(filename)s:%(lineno)d %(message)s')
    # 为刚创建的日志记录器设置日志记录格式
    file_log_handler.setFormatter(formatter)
    # 为全局的日志工具对象（flask app使用的）添加日志记录器
    logging.getLogger().addHandler(file_log_handler)

• 在 create_app 方法中调用上一步创建的方法，并传入 config_name

def create_app(config_name):
    ...

    # 配置项目日志
    setup_log(config_name)
    app = Flask(__name__)
    ...

• 在项目根目录下创建日志目录文件夹 logs，如下：
  

运行项目，当前项目日志已输出到 logs 的目录下自动创建的 log 文件中

• 在 logs 文件夹下创建 .gitkeep 文件，以便能将 logs 文件夹添加到远程仓库，并在 .gitignore 文件中添加忽略提交生成的日志文件

logs/log*

在 Flask框架 中，其自己对 Python 的 logging 进行了封装，在 Flask 应用程序中，可以以如下方式进行输出 log:

current_app.logger.debug('debug')
current_app.logger.error('error')

当前应用程序的 logger 会根据应用程序的调试状态去调整日志级别，如下图：