Flask03：配置管理

痛定思痛。 2022-12-17 07:12 150阅读 0赞

在Flask中我们推荐通过下面的方式对我们的应用程序进行配置。

*  使用配置文件来配置应用程序不敏感数据
 *  使用环境变量来配置用户敏感数据，比如数据库相关信息，以及一些秘钥等等

Flask内置配置变量

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>描述</th> 
   <th>初始值</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>ENV</td> 
   <td>应用运行于什么环境。 Flask 和 扩展可以根据环境不同而行为不同，如打开或 关闭调试模式。 env 属性映射了这个配置键。本变量由 FLASK_ENV 环境变量设置。如果本变量是在代码中设置的话，可能出 现意外。</td> 
   <td>production</td> 
  </tr> 
  <tr> 
   <td>DEBUG</td> 
   <td>是否开启调试模式。使用 flask run 启动开发服务器时，遇到未能处理的 异常时会显示一个交互调试器，并且当代码变动后服务器会重启。 debug 属性映射了这个配置键。当 ENV 是 ‘development’ 时，本变量会启用，并且会被 FLASK_DEBUG 环境变量 重载。如果本变量是在代码中设置的话，可能会出现意外。</td> 
   <td>ENV 是 ‘development’ 时，为 True ；否则为 False</td> 
  </tr> 
  <tr> 
   <td>TESTING</td> 
   <td>开启测试模式。异常会被广播而不是被应用的错误处理器处理。扩展可能也会为 了测试方便而改变它们的行为。你应当在自己的调试中开启本变量。</td> 
   <td>False</td> 
  </tr> 
  <tr> 
   <td>PROPAGATE_EXCEPTIONS</td> 
   <td>异常会重新引发而不是被应用的错误处理器处理。在没有设置本变量的情况下， 当 TESTING 或 DEBUG 开启时，本变量隐式地为真。</td> 
   <td>None</td> 
  </tr> 
  <tr> 
   <td>PRESERVE_CONTEXT_ON_EXCEPTION</td> 
   <td>当异常发生时，不要弹出请求情境。在没有设置该变量的情况下，如果 DEBUG 为真，则本变量为真。这样允许调试器错误请求数据。本变量通常不 需要直接设置。</td> 
   <td>None</td> 
  </tr> 
  <tr> 
   <td>TRAP_HTTP_EXCEPTIONS</td> 
   <td>如果没有处理 HTTPException 类型异常的处理器，重新引发该异常用于被 交互调试器处理，而不是作为一个简单的错误响应来返回。</td> 
   <td>False</td> 
  </tr> 
  <tr> 
   <td>TRAP_BAD_REQUEST_ERRORS</td> 
   <td>尝试操作一个请求字典中不存在的键，如 args 和 form ，会返回一个 400 Bad Request error 页面。开启本变量，可以把这种错误作为一个未处理的 异常处理，这样就可以使用交互调试器了。本变量是一个特殊版本的 TRAP_HTTP_EXCEPTIONS 。如果没有设置，本变量会在调试模式下开启。</td> 
   <td>None</td> 
  </tr> 
  <tr> 
   <td>SECRET_KEY</td> 
   <td>密钥用于会话 cookie 的安全签名，并可用于应用或者扩展的其他安全需求。本 变量应当是一个字节型长随机字符串，</td> 
   <td>None</td> 
  </tr> 
  <tr> 
   <td>SESSION_COOKIE_NAME</td> 
   <td>会话 cookie 的名称。假如已存在同名 cookie ，本变量可改变。</td> 
   <td>session</td> 
  </tr> 
  <tr> 
   <td>SESSION_COOKIE_PATH</td> 
   <td>认可会话 cookie 的路径。如果没有设置本变量，那么路径为 APPLICATION_ROOT ，如果 APPLICATION_ROOT 也没有设置，那么会是 / 。</td> 
   <td>None</td> 
  </tr> 
  <tr> 
   <td>SESSION_COOKIE_HTTPONLY</td> 
   <td>为了安全，浏览器不会允许 JavaScript 操作标记为“ HTTP only ”的 cookie 。</td> 
   <td>True</td> 
  </tr> 
  <tr> 
   <td>SESSION_COOKIE_SECURE</td> 
   <td>如果 cookie 标记为“ secure ”，那么浏览器只会使用基于 HTTPS 的请求发 送 cookie 。应用必须使用 HTTPS 服务来启用本变量。</td> 
   <td>False</td> 
  </tr> 
  <tr> 
   <td>SESSION_COOKIE_SAMESITE</td> 
   <td>限制来自外部站点的请求如何发送 cookie 。可以被设置为 ‘Lax’ （推荐） 或者 ‘Strict’</td> 
   <td>None</td> 
  </tr> 
  <tr> 
   <td>PERMANENT_SESSION_LIFETIME</td> 
   <td>如果 session.permanent 为真， cookie 的有效期为本变量设置的数字， 单位为秒。本变量可能是一个 datetime.timedelta 或者一个 int 。</td> 
   <td>timedelta(days=31) （ 2678400 秒）</td> 
  </tr> 
  <tr> 
   <td>SESSION_REFRESH_EACH_REQUEST</td> 
   <td>当 session.permanent 为真时，控制是否每个响应都发送 cookie 。每次 都发送 cookie （缺省情况）可以有效地防止会话过期，但是会使用更多的带宽。 会持续会话不受影响。</td> 
   <td>True</td> 
  </tr> 
  <tr> 
   <td>USE_X_SENDFILE</td> 
   <td>当使用 Flask 提供文件服务时，设置 X-Sendfile 头部。有些网络服务器， 如 Apache ，识别这种头部，以利于更有效地提供数据服务。本变量只有使用这 种服务器时才有效。</td> 
   <td>False</td> 
  </tr> 
  <tr> 
   <td>SEND_FILE_MAX_AGE_DEFAULT</td> 
   <td>当提供文件服务时，设置缓存，控制最长存活期，以秒为单位。可以是一个 datetime.timedelta 或者一个 int 。在一个应用或者蓝图上使 用 get_send_file_max_age() 可以基于单个文件重载本变 量</td> 
   <td>timedelta(hours=12) （ 43200 秒）</td> 
  </tr> 
  <tr> 
   <td>SERVER_NAME</td> 
   <td>通知应用其所绑定的主机和端口。子域路由匹配需要本变量。</td> 
   <td>None</td> 
  </tr> 
  <tr> 
   <td>APPLICATION_ROOT</td> 
   <td>通知应用应用的根路径是什么。这个变量用于生成请求环境之外的 URL</td> 
   <td>/</td> 
  </tr> 
  <tr> 
   <td>PREFERRED_URL_SCHEME</td> 
   <td>当不在请求情境内时使用些预案生成外部 URL 。</td> 
   <td>http</td> 
  </tr> 
  <tr> 
   <td>MAX_CONTENT_LENGTH</td> 
   <td>在进来的请求数据中读取的最大字节数。如果本变量没有配置，并且请求没有指 定 CONTENT_LENGTH ，那么为了安全原因，不会读任何数据。</td> 
   <td>None</td> 
  </tr> 
  <tr> 
   <td>JSON_AS_ASCII</td> 
   <td>把对象序列化为 ASCII-encoded JSON 。如果禁用，那么 JSON 会被返回为一个 Unicode 字符串或者被 jsonify 编码为 UTF-8 格式。本变量应当保持 启用，因为在模块内把 JSON 渲染到 JavaScript 时会安全一点。</td> 
   <td>True</td> 
  </tr> 
  <tr> 
   <td>JSON_SORT_KEYS</td> 
   <td>字母排序 JSON 对象的键。这对于缓存是有用的，因为不管 Python 的哈希种 子是什么都能够保证数据以相同的方式序列化。为了以缓存为代价的性能提高可 以禁用它，虽然不推荐这样做。</td> 
   <td>True</td> 
  </tr> 
  <tr> 
   <td>JSONIFY_PRETTYPRINT_REGULAR</td> 
   <td>jsonify 响应会输出新行、空格和缩进以便于阅读。在调试模式下总是启用 的。</td> 
   <td>False</td> 
  </tr> 
  <tr> 
   <td>JSONIFY_MIMETYPE</td> 
   <td>jsonify 响应的媒体类型。</td> 
   <td>application/json</td> 
  </tr> 
  <tr> 
   <td>TEMPLATES_AUTO_RELOAD</td> 
   <td>当模板改变时重载它们。如果没有配置，在调试模式下会启用。</td> 
   <td>None</td> 
  </tr> 
  <tr> 
   <td>EXPLAIN_TEMPLATE_LOADING</td> 
   <td>记录模板文件如何载入的调试信息。使用本变量有助于查找为什么模板没有载入 或者载入了错误的模板的原因。</td> 
   <td>False</td> 
  </tr> 
  <tr> 
   <td>MAX_COOKIE_SIZE</td> 
   <td>当 cookie 头部大于本变量配置的字节数时发出警告。缺省值为 4093 。 更大的 cookie 会被浏览器悄悄地忽略。本变量设置为 0 时关闭警告。</td> 
   <td>4093</td> 
  </tr> 
 </tbody> 
</table>

> 配置文件本身实质是 Python 文件。只有全部是大写字母的变量才会被配置对象所使 用。因此请确保使用大写字母。

典型的配置文件：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Fpbmd5dWxvdmU_size_16_color_FFFFFF_t_70_pic_center]

此时我们需要使用from\_pyfile()来加载配置文件。

app.config.from_pyfile('config.py')

类似的还有使用类和类的继承来配置：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Fpbmd5dWxvdmU_size_16_color_FFFFFF_t_70_pic_center 1]

在使用的时候必须使用 from\_object()进行加载：

from flask import Flask
    
    from config import DevelopmentConfig
    
    app = Flask(__name__)
    app.config.from_object(DevelopmentConfig())

使用环境变量

大多数应用需要一个以上的配置。最起码需要一个配置用于生产服务器，另一个配置 用于开发。应对这种情况的最简单的方法总是载入一个缺省配置，并把这个缺省配置 作为版本控制的一部分。然后，把需要重载的配置，如前文所述，放在一个独立的文 件中:

from flask import Flask
    
    from config import ProductionConfig
    
    app = Flask(__name__)
    app.config.from_object(ProductionConfig())
    app.config.from_envvar('FLASK_PRODUCTION_CONFIG')

然后在环境变量中设置FLASK\_PRODUCTION\_CONFIG为配置文件路径即可。

在pycharm中可参考下面配置步骤：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Fpbmd5dWxvdmU_size_16_color_FFFFFF_t_70_pic_center 2]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Fpbmd5dWxvdmU_size_16_color_FFFFFF_t_70_pic_center 3]

另外可能有些小伙伴都试过在配置文件中开启debug，然并未起作用。

首先，我们前面说过了，在pycharm中开启debug的方法，其中之一为勾选FLASK\_DEBUG：  
![在这里插入图片描述][20201022152646578.png_pic_center]  
运行flask程序后，我们会发现启动日志中有相关环境变量的输出：  
![在这里插入图片描述][20201022152730251.png_pic_center]  
这是pycharm的环境，实际上在操作系统中的环境变量中是不存在的，也就是说这是依托于pycharm运行的。

我们可以打开控制台看看：  
![在这里插入图片描述][20201022155108564.png_pic_center]  
此时，我们打开使用环境变量配置后运行代码：

app.config.from_envvar('FLASK_PRODUCTION_CONFIG')

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Fpbmd5dWxvdmU_size_16_color_FFFFFF_t_70_pic_center 4]

此时会提示我们找不到环境变量：FLASK\_PRODUCTION\_CONFIG。

如果我们需要在找不到环境变量的时候还能够正常的启动程序，那么我们需要指定

app.config.from_envvar('FLASK_PRODUCTION_CONFIG',silent = True)

在windows中我们可以在cmd中使用set命令查看环境变量，

使用`set 变量名=变量内容`来设置环境变量，注意只在cmd窗口有效。

首先我们打开cmd并激活虚拟环境：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Fpbmd5dWxvdmU_size_16_color_FFFFFF_t_70_pic_center 5]  
然后设置env为development，并设置FLASK\_PRODUCTION\_CONFIG：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Fpbmd5dWxvdmU_size_16_color_FFFFFF_t_70_pic_center 6]  
ok，一切正常。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Fpbmd5dWxvdmU_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/a44760f6e9304cc1a9d07793b4d0ad82.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Fpbmd5dWxvdmU_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221123/94dbe07b02234f7297bc8aaf808f160f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Fpbmd5dWxvdmU_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221123/c1c94fcb5ab042cd8345efbe3d3803ed.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Fpbmd5dWxvdmU_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221123/8b78e1083b3e41c1938d9f46b7b49aee.png
[20201022152646578.png_pic_center]: /images/20221123/009c6c4adbcb44c7a1491ae164a31d6a.png
[20201022152730251.png_pic_center]: /images/20221123/add9b7bd31f34baea4dd83cd94e0ffdc.png
[20201022155108564.png_pic_center]: /images/20221123/7d44c5bba6aa49beb0510ccdc0e3c1d6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Fpbmd5dWxvdmU_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221123/75bf9d77533649d5894eb85d5c718d1f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Fpbmd5dWxvdmU_size_16_color_FFFFFF_t_70_pic_center 5]: /images/20221123/7484abcbe0254902bd083e6c108ac6e6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Fpbmd5dWxvdmU_size_16_color_FFFFFF_t_70_pic_center 6]: /images/20221123/5616236b08714bce84a83c96c65baee4.png