上下文

上下文：即语境，语意，在程序中可以理解为在代码执行到某一时刻时，根据之前代码所做的操作以及下文即将要执行的逻辑，可以决定在当前时刻下可以使用到的变量，或者可以完成的事情。
Flask中有两种上下文，请求上下文和应用上下文
Flask中上下文对象：相当于一个容器，保存了 Flask 程序运行过程中的一些信息。

1 请求上下文(request context)

思考：在视图函数中，如何取到当前请求的相关数据？比如：请求地址，请求方式，cookie等等
在 flask 中，可以直接在视图函数中使用 request 这个对象进行获取相关数据，而 request 就是请求上下文的对象，保存了当前本次请求的相关数据，请求上下文对象有：request、session

  • request
    • 封装了HTTP请求的内容，针对的是http请求。举例：user = request.args.get(‘user’)，获取的是get请求的参数。

  • session

    • 用来记录请求会话中的信息，针对的是用户信息。举例：session[‘name’] = user.id，可以记录用户信息。还可以通过session.get(‘name’)获取用户信息。

      2 应用上下文(application context)

      它的字面意思是 应用上下文，但它不是一直存在的，它只是request context 中的一个对 app 的代理(人)，所谓local proxy。它的作用主要是帮助 request 获取当前的应用，它是伴 request 而生，随 request 而灭的。
      应用上下文对象有：current_app，g

      current_app

      应用程序上下文,用于存储应用程序中的变量，可以通过current_app.name打印当前app的名称，也可以在current_app中存储一些变量，例如：

  • 应用的启动脚本是哪个文件，启动时指定了哪些参数

  • 加载了哪些配置文件，导入了哪些配置
  • 连了哪个数据库
  • 有哪些public的工具类、常量

  • 应用跑再哪个机器上，IP多少，内存多大

    示例

    创建current_app_demo.py

    1. from flask import Flask, current_app
    2. app1 = Flask(__name__)
    3. app2 = Flask(__name__)
    4. # 以redis客户端对象为例
    5. # 用字符串表示创建的redis客户端
    6. # 为了方便在各个视图中使用，将创建的redis客户端对象保存到flask app中，
    7. # 后续可以在视图中使用current_app.redis_cli获取
    8. app1.redis_cli = 'app1 redis client'
    9. app2.redis_cli = 'app2 redis client'
    10. @app1.route('/route11')
    11. def route11():
    12.   return current_app.redis_cli
    13. @app1.route('/route12')
    14. def route12():
    15.   return current_app.redis_cli
    16. @app2.route('/route21')
    17. def route21():
    18.   return current_app.redis_cli
    19. @app2.route('/route22')
    20. def route22():
    21.   return current_app.redis_cli

    运行

    1. export FLASK_APP=current_app_demo:app1
    2. flask run

  • 访问/route11 显示app1 redis client

  • 访问/route12 显示app1 redis client

    1. export FLASK_APP=current_app_demo:app2
    2. flask run

  • 访问/route21 显示app2 redis client

  • 访问/route22 显示app2 redis client

    作用

    current_app 就是当前运行的flask app，在代码不方便直接操作flask的app对象时，可以操作current_app就等价于操作flask app对象

    g对象

    g 作为 flask 程序全局的一个临时变量，充当中间媒介的作用，我们可以通过它在一次请求调用的多个函数间传递一些数据。每次请求都会重设这个变量。

    示例

    1. from flask import Flask, g
    2. app = Flask(__name__)
    3. def db_query():
    4.   user_id = g.user_id
    5.   user_name = g.user_name
    6.   print('user_id={} user_name={}'.format(user_id, user_name))
    7. @app.route('/')
    8. def get_user_profile():
    9.   g.user_id = 123
    10.   g.user_name = 'itcast'
    11.   db_query()
    12.   return 'hello world'

    g对象与请求钩子的综合案例

    需求

  • 构建认证机制

  • 对于特定视图可以提供强制要求用户登录的限制
  • 对于所有视图，无论是否强制要求用户登录，都可以在视图中尝试获取用户认证后的身份信息

    实现

    1. from flask import Flask, abort, g
    2. app = Flask(__name__)
    3. @app.before_request
    4. def authentication():
    5.   """
    6.   利用before_request请求钩子，在进入所有视图前先尝试判断用户身份
    7.   :return:
    8.   """
    9.   # TODO 此处利用鉴权机制（如cookie、session、jwt等）鉴别用户身份信息
    10.   # if 已登录用户，用户有身份信息
    11.   g.user_id = 123
    12.   # else 未登录用户，用户无身份信息
    13.   # g.user_id = None
    14. def login_required(func):
    15.   def wrapper(*args, **kwargs):
    16.       if g.user_id is not None:
    17.           return func(*args, **kwargs)
    18.       else:
    19.           abort(401)
    20.   return wrapper
    21. @app.route('/')
    22. def index():
    23.   return 'home page user_id={}'.format(g.user_id)
    24. @app.route('/profile')
    25. @login_required
    26. def get_user_profile():
    27.   return 'user profile page user_id={}'.format(g.user_id)

    3 app_context 与 request_context

    思考

    在Flask程序未运行的情况下，调试代码时需要使用current_app、g、request这些对象，会不会有问题？该如何使用？

    app_context

    app_context为我们提供了应用上下文环境，允许我们在外部使用应用上下文current_app、g
    可以通过with语句进行使用
    1. >>> from flask import Flask
    2. >>> app = Flask('')
    3. >>> app.redis_cli = 'redis client'
    4. >>> 
    5. >>> from flask import current_app
    6. >>> current_app.redis_cli   # 错误，没有上下文环境
    7. 报错
    8. >>> with app.app_context():  # 借助with语句使用app_context创建应用上下文
    9. ...     print(current_app.redis_cli)
    10. ...
    11. redis client

    request_context

    request_context为我们提供了请求上下文环境，允许我们在外部使用请求上下文request、session
    可以通过with语句进行使用
    1. >>> from flask import Flask
    2. >>> app = Flask('')
    3. >>> request.args  # 错误，没有上下文环境
    4. 报错
    5. >>> environ = {'wsgi.version':(1,0), 'wsgi.input': '', 'REQUEST_METHOD': 'GET', 'PATH_INFO': '/', 'SERVER_NAME': 'itcast server', 'wsgi.url_scheme': 'http', 'SERVER_PORT': '80'}  # 模拟解析客户端请求之后的wsgi字典数据
    6. >>> with app.request_context(environ):  # 借助with语句使用request_context创建请求上下文
    7. ...     print(request.path)
    8. ...   
    9. /