专栏文章测试平台系列 (4) 使用 Flask 蓝图 (blueprint)

米洛 · 2021年11月26日 · 最后由我去热饭回复于 2021年11月26日 · 3694 次阅读

使用 Flask 蓝图 (blueprint)

回顾

先来看一下上一篇的作业吧，使用logbook的时候，遇到了时区不对的情况。那么我们怎么去解决这个问题呢？

实际上 logbook 默认采用的是世界标准时间 (utc)，而我们的北京时间是比世界标准时间早 8 个小时的。

解决方案

其实在我们工作中经常会遇到很多奇怪的问题，最最简单的方式就是使用搜索引擎搜索对应的报错信息。然后找到结果最接近的内容，一般在Stack Overflow segmentfault 简书 CSDN 博客园 开源中国等社区可以找到对应的答案。

遇到问题其实并不可怕，我们有自己的套路去解决就好。

这里我介绍一下，我个人工作中的一些解决问题的方式吧。

官方文档

一切大家常见的问题，基本上都会被写入到官方文档里。官方文档一般含有如何使用，以及一些需要注意的地方。

Logbook 官网

logbook官网截图

由于官网是英文版，所以需要有一定的英文基础。由于没有搜索框，所以只能暂时利用浏览器的 ctrl+f 搜索关键字了。试图搜索"time"和"utc"关键字，无果。

Github/Stack Overflow

作为一个 star 量 1000+ 的 opensource 项目，必定会有一群侠义人士帮忙维护更新以及提出解决问题 (这也是我选择它的原因)。所以肯定不只是我一个人遇到了时间的问题。

果断进入 github，搜索logbook

进入之后点击 issues(问题) 页面

可以看到，目前有 32 个打开的问题，里面都是关于大家使用问题之后的反馈。第一眼就看到了 correct date 这个问题，注意上面是有搜索框的，所以我们可以直接搜索 utc。现在我们先不搜索, 进入查看一下。

可以看到，这不是我们想要的答案，这些人和我们一样都是被困惑的。但没关系，我们可以利用刚才的搜索框。在搜索框中输入utc，我们优先看我们需要的问题。

(简单的改变，可以允许展示本地时间)

我们进入这个 issue

可以看到这是一个pull requests，简称 pr。pr 大概意思是说，虽然项目是 A 或者 A 团队做的，但是你有一些改进或者修复，可以提交 pr 并通过 A 审核过后将你的代码合并到 master 分支 (这个好像是 git 教程了)。这里可以看到这人说他不想显示 utc 时间，但是又木有现有方法显示本地时间。

在一大堆巴拉巴拉及互相讨论以后，将 api 命名为set_datetime_format，好了，我们想要的东西拿到了。现在去代码里看看吧！

所以可以看到，我们调用 logbook.set_datetime_format("local")，这样就能把时间设置为本地时间了。接着来测试一下~

先上 logger.py 文件

import logbook

from app import pity
from .decorator import SingletonDecorator


# 注意这里
@SingletonDecorator
class Log(object):
    handler = None

    def __init__(self, name='pity', filename=pity.config['LOG_NAME']):  # Logger标识默认为app
        """
        :param name: 业务名称
        :param filename: 文件名称
        """
        self.handler = logbook.FileHandler(filename, encoding='utf-8')
        logbook.set_datetime_format("local")  # 将日志时间设置为本地时间
        self.logger = logbook.Logger(name)
        self.handler.push_application()

    def info(self, *args, **kwargs):
        return self.logger.info(*args, **kwargs)

    def error(self, *args, **kwargs):
        return self.logger.error(*args, **kwargs)

    def warning(self, *args, **kwargs):
        return self.logger.warning(*args, **kwargs)

    def debug(self, *args, **kwargs):
        return self.logger.debug(*args, **kwargs)

接下来测试一下修改后的 hello world 接口 run.py

from datetime import datetime

from app import pity
from app.utils.logger import Log


@pity.route('/')
def hello_world():
    log = Log("hello world")
    log.info("有人访问了你的网站了")
    now = datetime.now().strftime("%Y-%M-%d %H:%M:%S")
    print(now)
    return now


if __name__ == "__main__":
    pity.run("0.0.0.0", threaded=True, port="7777")

StackOverflow

学习golang以来，时常会用到，所以大家可以多上去一下。虽然英文居多，但是也顺便培养下自己的阅读能力。好了，我要去给刚才那 2 个用户回答一下设置 local_format_string 了。

使用蓝图 blueprint

引入目的

不知道大家有没有关注过浏览器的 url 情况，作为一个测试，比如我们会经常见到 /login 这些 url，不同的 url 当然有自己不同的含义啦。如果我们接下来接口很多，比如一个 user，需要有增删改查等接口，如果全部写在 run.py 里面，会太杂乱了。所以我们打算引入蓝图来帮我们解决这个问题。
使用方法

我一般都会抛出官网的实例，但是我这里推荐一本书，Flask 相关的，我们叫它狗书。长下面这个样子~如果要深入学习 flask 的话，适合看看，也不厚重。

废话少说，今天作业讲太多了，正题没了。

由于我们做前后端分离，所以后端杜绝任何与 html 有关的东西，比如我如果现在要做用户模块的话。我需要我的 url 路径统一以/user 开始，后面再按照内容划分。

以简书为例，大概讲一下，虽然这似乎是前端的路由。不过后端也差不多适应，大家可以了解下 restful api 的概念。

比如我这边的用户登录接口，我是打算这样命名: /user/register, 前面的 user 代表模块，后面代表内容。这样特别清晰明了。

那我们开始吧！

首先我们需要创建 controller 文件夹，专门处理路由和方法的映射。举个栗子！

这里我创建了 auth(认证模块)，又创建了user.py文件。

user.py

from flask import Blueprint
from flask import jsonify

auth = Blueprint("auth", __name__, url_prefix="/auth")


# 这里以auth.route注册的函数都会自带/auth，所以url是/auth/register
@auth.route("/register")
def register():
    return jsonify(dict(status=True, msg="注册成功"))

这里我直接 return 了 json 字符串: {"status": true, "msg": "注册成功"}，因为我的具体函数还没开始写。

然后我们需要在 app 中注册这个蓝图! app/__init__.py代码如下

from flask import Flask

from app.controllers.auth.user import auth
from config import Config

pity = Flask(__name__)

# 注册蓝图
pity.register_blueprint(auth)

pity.config.from_object(Config)