PythonWeb之Flask框架配置管理(一)

前言:

在学习Falsk框架的时候发现了网上资源比较繁杂,而涉及到工程项目的文件配置和管理也是各有千秋。所以花了点时间专门整理一个配置项目工程目录的文章,本篇文章从最初始化最简洁的Flask安装样例出发,从零开始编写代码和配置文件,旨在帮助本人以及广大读者理解项目目录文件之间的关系。

那么接下来就让我们进入到flask目录配置的学习中。

首先这里我选择pycharm进行开发,毋庸置疑,pycharm是最好最流行的Python IDE,功能强大,方便实用。借助于使用virtualenv创建好的虚拟环境,开始创建一个新的python空项目(这里不选择直接使用flask框架创建项目)。

PythonWeb之Flask框架配置管理(一)

创建好一个空项目后,由我们自己手动新建各部分所需文件目录,并编写原始代码。在这之前,我们先来了解一下Flask程序的默认(初始)结构。

Flask框架默认(初始)项目结构

app.py

from flask import Flask

app = Flask(__name__)
​
@app.route('/')
def index():
   return 'Hello Flask'
​
​
if __name__ == '__main__':
   app.run()

创建一个app.py 文件之后,写下上面的代码,点击运行。可以得到以下界面。

PythonWeb之Flask框架配置管理(一)

很显然,程序运行成功了。

现在我们来编写一些配置所需要的代码。

1.在单一文件中构建所有依赖工具

manage.py

from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_session import Session
from flask_wtf import CSRFProtect
​
import redis
​
​
app = Flask(__name__)
​
​
class BaseConfig(object):
   """配置信息"""
   DEBUG = True
​
   SECRET_KEY = "sdsadafafsfsd@$%9"
​
   # 数据库
   SQLALCHEMY_DATABASE_URL = "mysql://root:mysql@127.0.0.1:3306/database_name"
   SQLALCHEMY_TRACK_MODIFICATIONS = True
​
   # redis
   REDIS_HOST = "127.0.0.1"
   REDIS_PORT = 6379
​
   # flask_session 配置
   SESSION_TYPE = "redis"
   SESSION_REDIS = redis.StrictRedis(host=REDIS_HOST,port=REDIS_PORT) # 若是上线运行,此处可能是另一台redis服务器
   SESSION_USE_SIGNER = True # 对cookie中session_id 进行隐藏处理
   SESSION_SESSION_LIFETIME = 86400 # session数据的有效期,单位 秒
​
​
app.config.from_object(Config)
​
# 数据库
db = SQLAlchemy(app)
​
# 创建redis连接对象
redis_store = redis.StrictRedis(host=BaseConfig.REDIS_HOST,port=BaseConfig.REDIS_PORT)
​
# 利用flask-session,将session数据保存到redis中
Session(app)
​
# 为flask补充csrf防护
CSRFProtect(app)
​
​
@app.route('/')
def index():
   return 'Hello Flask'
​
​
if __name__ == '__main__':
   app.run()

2.(自定义)创建工程目录

在实际生产中,我们将单一配置文件中的依赖工具和功能提取抽离出来,写到不同的模块中,便于代码的管理和复用

2.1 第一次抽取

(1)第一次的抽取,先用工厂模式将app的创建抽离出来,并分匹配【配置模式】,将【配置模式】作为 类 来传递

config.py

# 所有的配置项都放到config.py中
# flask的配置项目,名字都是大写字母
​
import redis
​
class BaseConfig(object):
   DEBUG = True
​
   # 秘钥
   SECRET_KEY = "sdsadafafsfsd@$%9"
​
   # 数据库
   SQLALCHEMY_DATABASE_URL = "mysql://root:mysql@127.0.0.1:3306/database_name"
   SQLALCHEMY_TRACK_MODIFICATIONS = True
​
   # redis
   REDIS_HOST = "127.0.0.1"
   REDIS_PORT = 6379
​
   # flask_session 配置
   SESSION_TYPE = "redis"
   SESSION_REDIS = redis.StrictRedis(host=REDIS_HOST,port=REDIS_PORT) # 若是上线运行,此处可能是另一台redis服务器
   SESSION_USE_SIGNER = True # 对cookie中session_id 进行隐藏处理
   SESSION_SESSION_LIFETIME = 86400 # session数据的有效期,单位 秒
​
​
# 发行环境
class ProductionConfig(BaseConfig):
   DEBUG = False
​
​
# 开发环境
class DevelopmentConfig(BaseConfig):
   
   DEBUG = True
​
​
# 测试环境
class TestingConfig(BaseConfig):
   pass
​
​
# 配置信息
config_map = {
   'develop': DevelopmentConfig,
   'product': ProductionConfig,
   'test': TestingConfig
}

(2)第一次抽取后的manage.py 文件还剩下

manage.py

from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from flask_session import Session
from flask_wtf import CSRFProtect
from config import config_map
​
import redis
​
​
# 工厂模式
def create_app(config_name):
   """
  创建flask的应用对象
  :param config_name: str 配置模式的 模式的名字 ("develop","product")
  :return:
  """
   app = Flask(__name__)
​
   # 获取配置模式的名字,获取配置参数的类
   config_class = config_map.get(config_name)
   app.config.from_object(config_class)
​
   return app
​
​
app = create_app('develop')
​
# 数据库
db = SQLAlchemy(app)
​
# 创建redis连接对象
redis_store = redis.StrictRedis(host=Config.REDIS_HOST,port=Config.REDIS_PORT)
​
# 利用flask-session,将session数据保存到redis中
Session(app)
​
# 为flask补充csrf防护
CSRFProtect(app)
​
​
@app.route('/')
def index():
   return 'Hello Flask'
​
​
if __name__ == '__main__':
   app.run()

2.2 第二次抽取

(1)第二次抽取,首先在项目根目录创建一个新的 文件夹app,在app文件夹下创建--init--.py、models.py、views.py文件。

PythonWeb之Flask框架配置管理(一)

(2)将工厂模式函数create_app复制到--init--.py文件,同时将 数据库初始化/实例化 app应用程序的代码抽离过来,如下:

PythonWeb之Flask框架配置管理(一)

(3)此时有一个问题,db = SQLAlchemy(app) 中 app还没有被创建,当然我们可以导入manage模块来解决这个问题,如下

import manage
# 数据库
db = SQLAlchemy(manage.app)

但这样很明显就失去了一开始想要分隔抽离代码功能的作用,所以这里采用以下方法解决:

先创建SQLAlchemy对象,但不进行赋值,而后在工厂函数中进行赋值。

——init——.py

from flask import Flask
from config import config_map
from flask_sqlalchemy import SQLAlchemy
​
​
# 数据库 初始化关联app
db = SQLAlchemy()
​
​
# 工厂模式
def create_app(config_name):
   """
  创建flask的应用对象
  :param config_name: str 配置模式的 模式的名字 ("develop","product")
  :return:
  """
   app = Flask(__name__)
​
   # 获取配置模式的名字,获取配置参数的类
   config_class = config_map.get(config_name)
   app.config.from_object(config_class)
​
   # db初始化关联app过程
   # 使用app初始化db
   db.init_app(app)
​
   return app

manage.py

from flask_session import Session
from flask_wtf import CSRFProtect
​
import redis
​
from app import create_app
​
​
app = create_app('develop')
​
# 创建redis连接对象
redis_store = redis.StrictRedis(host=Config.REDIS_HOST,port=Config.REDIS_PORT)
​
# 利用flask-session,将session数据保存到redis中
Session(app)
​
# 为flask补充csrf防护
CSRFProtect(app)
​
​
@app.route('/')
def index():
   return 'Hello Flask'
​
​
if __name__ == '__main__':
   app.run()

2.3 第三次抽取

(1)这里将redis连接对象也抽取到--init--.py文件中,和上一个抽取中的db一样,其他模块中的代码也会使用到redis,所以这里db、redis不能放在工厂函数中,否则会导致其他模块导包是无法导入。

PythonWeb之Flask框架配置管理(一)

(2)设置全局变量redis_store = None,然后在工厂函数中再进行初始化。

PythonWeb之Flask框架配置管理(一)

2.4 第四次抽取

(1)第四次抽取,将session和csrf两个功能同样抽取到--init--.py文件中,因为session和csrf是Flask的补充功能,在程序执行中只需要初始化一次以修改 flask机制或引入该功能,初始化对象后,后续操作直接在视图函数中使用flask自己的全局对象session和flask_wtf中csrf生成的内容就可以了,并不使用Session(app)、CSRFProtect(app)对象。

因此,将Session(app)、CSRFProtect(app)对象直接写在工厂函数中,创建时初始化一次就可以了。

manage.py

from app import create_app
​
​
app = create_app('develop')
​
​
​
@app.route('/')
def index():
   return 'Hello Flask'
​
​
if __name__ == '__main__':
   app.run()

--init--.py

from flask import Flask
from config import config_map
from flask_sqlalchemy import SQLAlchemy
from flask_session import Session
from flask_wtf import CSRFProtect
​
import redis
​
# 数据库 初始化关联app
db = SQLAlchemy()
​
# 创建redis连接对象
redis_store = None
​
​
# 工厂模式
def create_app(config_name):
   """
  创建flask的应用对象
  :param config_name: str 配置模式的 模式的名字 ("develop","product")
  :return:
  """
   app = Flask(__name__)
​
   # 获取配置模式的名字,获取配置参数的类
   config_class = config_map.get(config_name)
   app.config.from_object(config_class)
​
   # db初始化关联app过程
   db.init_app(app)
​
   # 初始化redis工具
   global redis_store
   redis_store = redis.StrictRedis(host=config_class.REDIS_HOST, port=config_class.REDIS_PORT)
​
   # 利用flask-session,将session数据保存到redis中
   Session(app)
​
   # 为flask补充csrf防护
   CSRFProtect(app)
​
   return app

好了,到此将项目目录文件的一些基本配置完成了。接下来需要引入Flask蓝图的概念,继续进行代码分离,以及一些需要修改的地方,且放到下一篇文章来讲。

发表评论
留言与评论(共有 0 条评论) “”
   
验证码:

相关文章

推荐文章