Flask项目log的集成

一、引入log

在项目的init.py文件中：

import logging
from logging.handlers import RotatingFileHandler

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

# 定义redis_store变量
redis_store = None


def create_app(config_name):
    # 调用日志方法，记录程序运行信息
    log_file()

    app = Flask(__name__)

    # 获取config配置
    config = config_dict.get(config_name)

    app.config.from_object(config)

    # 创建数据库关联对象并关联app
    db = SQLAlchemy(app)

    # 创建redis对象
    # 当 decode_responses 设置为 True 时，Redis 返回的字符串数据将会被解码为 Python 字符串类型。这样可以方便地处理 Redis 中存储的文本数据。
    # 而当 decode_responses 设置为 False（默认值）时，Redis 返回的字符串数据将会以字节字符串（bytes）的形式返回。
    # 这在处理二进制数据或者需要与其他 Redis 客户端进行交互时可能更为合适
    global redis_store  # global将局部变量声明为全局变量
    redis_store = StrictRedis(host=config.REDIS_HOST, port=config.REDIS_PORT, decode_responses=True)

    # 创建session对象
    Session(app)

    # 使用CSRFProtect保护app
    CSRFProtect(app)

    # 注册蓝图
    from info.modules.index import index_blue
    app.register_blueprint(index_blue)

    return app


def log_file():
    # 设置日志的记录等级，常见的有四种，DEBUG

这个时候执行的话会报错的，所以需要创建一个logs文件在项目根文件下，至于是不是叫logs取决与你在配置中设置的文件名

二、log的使用

from info.modules.index import index_blue
from flask import current_app  # flask中app的原生对象


@index_blue.route('/', methods=['GET', 'POST'])
def hello_world():
    #  因为log_file中的这个 logging.getLogger().addHandler(file_log_handler)将logger挂载到了原生对象中去了
    current_app.logger.debug('输入详细信息')
    current_app.logger.info('输入详细信息')
    current_app.logger.warning('输入详细信息')
    current_app.logger.error('输入详细信息')
    return "helloworld"

三、log的抽取，将log等级与环境挂钩

#####################将log的level单独抽取出来并在调用时传入####################
import logging
from logging.handlers import RotatingFileHandler

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

# 定义redis_store变量
redis_store = None


def create_app(config_name):

    app = Flask(__name__)

    # 获取config配置
    config = config_dict.get(config_name)

    # 调用日志方法，记录程序运行信息
    log_file(config.LEVEL_NAME)

    app.config.from_object(config)

    # 创建数据库关联对象并关联app
    db = SQLAlchemy(app)

    # 创建redis对象
    # 当 decode_responses 设置为 True 时，Redis 返回的字符串数据将会被解码为 Python 字符串类型。这样可以方便地处理 Redis 中存储的文本数据。
    # 而当 decode_responses 设置为 False（默认值）时，Redis 返回的字符串数据将会以字节字符串（bytes）的形式返回。
    # 这在处理二进制数据或者需要与其他 Redis 客户端进行交互时可能更为合适
    global redis_store  # global将局部变量声明为全局变量
    redis_store = StrictRedis(host=config.REDIS_HOST, port=config.REDIS_PORT, decode_responses=True)

    # 创建session对象
    Session(app)

    # 使用CSRFProtect保护app
    CSRFProtect(app)

    # 注册蓝图
    from info.modules.index import index_blue
    app.register_blueprint(index_blue)

    return app


def log_file(LEVEL_NAME):
    # 设置日志的记录等级，常见的有四种，DEBUG

################将log的等级与环境条件挂钩，不用的环境参数绑定不用的log等级##############
import logging
from datetime import timedelta
from redis import StrictRedis


class Config():
    # 调试信息
    DEBUG = True
    SECRET_KEY = 'fjsiogkgnmdinging'

    # 数据库信息
    SQLALCHEMY_DATABASE_URI = 'mysql+pymysql://root:123456@localhost:3306/info36'
    SQLALCHEMY_TRACK_MODIFICATIONS = False

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

    # session配置
    SESSION_TYPE = 'redis'  # 设置session的存储类型
    SESSION_REDIS = StrictRedis(host=REDIS_HOST, port=REDIS_PORT)  # 指定session存储的服务器
    # SESSION_USE_SIGNER = True  # 设置签名存储
    PERMANENT_SESSION_LIFETIME = timedelta(days=1)  # 设置签名过期时间

    # 配置默认的log等级
    LEVEL_NAME = logging.DEBUG


# 开发环境配置信息
class DevelopConfig(Config):
    pass


# 生产（线上）环境配置信息
class ProductConfig(Config):
    DEBUG = False
    LEVEL_NAME = logging.ERROR


# 测试环境配置信息
class TestConfig(Config):
    pass


# 提供一个统一的访问入口
config_dict = {
    "develop": DevelopConfig,
    "product": ProductConfig,
    "test": TestConfig
}

备注：要想让空的logs文件夹上传到git中，可以在logs文件夹下添加

.gitkeep文件即可