第一个 Flask 项目

安装环境

mkvirtualenv flask_env

pip install flask
1
2
3

创建项目

启动程序

访问项目

http://127.0.0.1:5000/

参数说明

Flask是一个用Python编写的轻量级Web应用框架，它提供了构建Web应用所需的基本工具和功能。以下是Flask的一些主要参数说明：

Flask对象的初始化参数

在创建Flask应用时，可以通过Flask类的构造函数传递一些参数来定制应用的行为。

Flask对象的初始化是通过调用Flask类并传递参数来完成的。虽然Flask类提供了许多参数，但大多数情况下，你只需要关注其中的几个关键参数。下面是对Flask类初始化时常用和可能用到的参数的详细解释：

1. import_name: 这是Flask应用所在的包或模块的名称。Flask使用这个参数来定位应用相对于其他资源的路径（如模板和静态文件）。在大多数情况下，你可以直接传递__name__作为这个参数的值。

2. static_folder: 这是一个可选参数，用于指定静态文件（如CSS、JS、图片等）的文件夹路径。默认情况下，它会被设置为'<yourapplication>/static'。

3. static_url_path: 这也是一个可选参数，用于指定静态文件在Web上访问的URL路径。默认情况下，它会与static_folder的参数值相同，即'/static'。

4. template_folder: 这是一个可选参数，用于指定模板文件的文件夹路径。默认情况下，它会被设置为'<yourapplication>/templates'。

5. instance_path: Flask应用实例的文件夹路径，用于存放应用的一些临时文件（如上传的文件）。默认情况下，它会被设置为'<yourapplication>/instance'。但请注意，这个路径是相对于import_name指定的包或模块的路径的。

6. instance_relative_config: 这是一个布尔值参数，用于指定配置文件是否应该相对于实例文件夹（由instance_path指定）加载。默认为False，意味着配置文件应该位于应用的根目录或指定的绝对路径。

7. root_path: Flask应用的根目录。在大多数情况下，你不需要手动设置这个参数，因为Flask会根据import_name自动推断出根目录。

8. url_map_class: 用于创建URL映射的类的名称。这通常用于自定义URL解析的行为。大多数情况下，你可以忽略这个参数。

9. subdomain_matching: 一个布尔值，用于控制是否应该启用子域匹配。这在构建需要基于子域进行路由的复杂应用时非常有用。

10. template_context_processors: 一个列表，包含用于向模板上下文添加额外变量的函数。这些函数会在模板渲染之前被调用。

11. cli_class: 用于自定义Flask CLI的类。Flask CLI是一个强大的命令行界面，用于执行各种与Flask应用相关的任务。

12. cli_group: 用于将自定义命令分组到特定的Flask CLI子命令中的名称。

13. server_name: 服务器名称的字符串，用于辅助URL生成和子域支持。这通常只在需要知道应用的确切URL前缀时才会用到。

14. application_factory: Flask 1.1.0中引入的，一个布尔值，指示应用工厂模式是否被使用。这通常用于与WSGI服务器和扩展交互，以支持延迟创建应用实例。

请注意，虽然这里列出了许多参数，但在日常开发中，你通常只需要关注import_name、static_folder、static_url_path和template_folder等少数几个参数。其他参数主要用于更高级或特定的用例。

另外，值得注意的是，Flask的run()方法（用于启动开发服务器）也接受一些参数，如host、port、debug等，但这些参数与Flask对象的初始化无关，而是与启动开发服务器时的配置有关。

app.run()参数

app.run() 方法在 Flask 中用于启动开发服务器。虽然对于大多数基本用途，你可能只需要设置 debug、host 和 port 几个参数，但 run() 方法实际上提供了更多的配置选项。以下是 app.run() 方法的一些常用和可能的参数解释：

1. host: 监听的主机名。默认为 127.0.0.1，即服务器仅接收来自运行它的机器的连接。如果你想要你的应用可以从网络上的任何位置被访问，可以设置为 '0.0.0.0'。

2. port: 监听的端口号。默认为 5000。端口号是一个 0 到 65535 之间的整数，用于区分运行在同一台机器上的不同服务。

3. debug: 是否启用 Flask 的调试模式。默认为 False。在调试模式下，Flask 会提供更多关于错误的详细信息，并且允许你在不重启服务器的情况下修改代码并查看更改效果（使用某些开发工具时）。但请注意，在生产环境中应该关闭调试模式，因为它会暴露敏感信息。

4. threaded: 是否使用多线程。默认为 False。如果你的应用需要处理多个并发请求，可以启用此选项。然而，在生产环境中，通常建议使用像 Gunicorn 这样的 WSGI 服务器来处理并发，因为它们提供了更好的性能和配置选项。

5. processes: 如果 threaded 为 False，则这个参数指定启动的进程数。默认为 1。这通常用于在 Unix 系统上，通过多进程而不是多线程来利用多核 CPU。但是，请注意，这与 threaded 参数是互斥的；你不能同时设置 threaded=True 和 processes>1。

6. passthrough_errors: 当设置为 True 时，错误会通过 HTTP 状态码传播。这主要用于调试目的，并允许错误处理程序（如果有的话）处理它们。默认为 False。

7. ssl_context: 一个包含 SSL 证书的元组 (certificate, key)，用于启用 HTTPS。这对于保护你的应用和用户数据非常重要。如果没有提供，服务器将默认使用 HTTP。

8. use_reloader: 是否使用 Flask 的代码重新加载器。在调试模式下，这通常是启用的，但你可以通过将此参数设置为 False 来禁用它。注意，这可能会因 Flask 版本而异，因为某些版本可能直接通过 debug 参数控制代码重新加载。

9. use_debugger: 是否启用 Flask 的交互式调试器。这允许你在出现未捕获的异常时获得一个交互式调试会话。默认为 True 当 debug=True 时，但你可以通过将此参数设置为 False 来禁用它。

10. use_evalex: 是否在调试器的代码执行环境中启用 evalex（一个可以执行任意 Python 代码的交互式 shell）。出于安全考虑，默认为 True 当 debug 未被显式设置或 debug=True 时，但你可以通过将此参数设置为 False 来禁用它。

请注意，这些参数可能会随着 Flask 版本的更新而发生变化。因此，建议查阅你正在使用的 Flask 版本的官方文档以获取最准确的信息。

应用程序配置参数

在 Flask 应用程序中，配置参数是管理和定制应用行为的关键部分。Flask 提供了一种灵活的方式来加载和配置这些参数。以下是一些常用的方法来加载 Flask 应用程序的配置参数：
在 Flask 应用程序中加载配置参数是一个常见的需求，它允许你根据应用程序的不同环境（如开发、测试和生产）来调整其行为。以下是一些在 Flask 应用程序中加载配置参数的方法：

使用 Flask 的 config.from_object() 方法

你可以定义一个或多个配置类（通常是在一个单独的 Python 文件中），然后在 Flask 应用初始化时通过 config.from_object() 方法加载这些配置。

config.py

class Config:
    DEBUG = False
    TESTING = False
    SECRET_KEY = 'a_very_secret_key'

class DevelopmentConfig(Config):
    DEBUG = True

class TestingConfig(Config):
    TESTING = True

class ProductionConfig(Config):
    DEBUG = False
1
2
3
4
5
6
7
8
9
10
11
12
13

app.py

from flask import Flask
from config import DevelopmentConfig

app = Flask(__name__)
app.config.from_object(DevelopmentConfig)

# 现在 app.config 包含了 DevelopmentConfig 中的配置
1
2
3
4
5
6
7

使用 Flask 的 config.from_pyfile() 方法

如果你更喜欢使用配置文件（如 .ini、.cfg 或 .py 文件，但不带类），你可以使用 config.from_pyfile() 方法。

config.py

DEBUG = True
SECRET_KEY = 'a_very_secret_key'
1
2

app.py

from flask import Flask

app = Flask(__name__)
app.config.from_pyfile('config.py')

# 现在 app.config 包含了 config.py 文件中的配置
1
2
3
4
5
6

注意：如果 config.py 文件不在 Flask 应用的根目录下，你需要提供完整的路径。

使用 Flask 的 config.from_envvar() 方法

Flask 的 config.from_envvar() 方法允许你根据环境变量中指定的文件名来加载配置。这种方法特别有用于当你想要根据环境（如开发、测试、生产）动态地选择配置文件时。

首先，你需要在环境变量中设置一个值，该值指向你的配置文件（例如，一个 .py 文件或 .ini 文件，但请注意 Flask 原生只支持 .py 文件或可以被解析为 Python 字典的 .json 文件）。然后，在 Flask 应用初始化时，使用 config.from_envvar() 方法并传入环境变量的名称。

步骤 1: 设置环境变量

在 Unix-like 系统中，你可以在 shell 配置文件（如 .bashrc 或 .bash_profile）中设置环境变量：

export FLASK_CONFIG_FILE=/path/to/your/config.py
1

在 Windows 系统中，你可以在命令提示符或 PowerShell 中设置环境变量：

set FLASK_CONFIG_FILE=C:\path\to\your\config.py
1

或者使用 PowerShell：

$env:FLASK_CONFIG_FILE="C:\path\to\your\config.py"
1

步骤 2: 编写配置文件

假设你的配置文件是一个 Python 文件（config.py），它看起来像这样：

# config.py
DEBUG = True
SECRET_KEY = 'a_very_secret_key'
# 其他配置...
1
2
3
4

步骤 3: 在 Flask 应用中使用 config.from_envvar()

在你的 Flask 应用中，使用 config.from_envvar() 方法来加载配置：

from flask import Flask

app = Flask(__name__)
app.config.from_envvar('FLASK_CONFIG_FILE')

# 现在 app.config 包含了 config.py 文件中的配置
1
2
3
4
5
6

然而，需要注意的是，config.from_envvar() 方法实际上期望环境变量指向一个 Python 文件（或可以解析为 Python 字典的 JSON 文件），并且该文件应该定义了一个 Python 字典或类似字典的对象（通常是通过定义一个或多个配置类来实现的），但在这个例子中，我们直接使用了 Python 文件。

如果你的环境变量指向的是一个 .ini 文件或其他非 Python 文件，并且你希望 Flask 能够加载它，你可能需要使用一个自定义的加载函数或 Flask 扩展（如 Flask-AppConfig，尽管它可能不直接使用 from_envvar() 方法）。

但是，对于 .ini 文件，Flask 没有直接的支持，因此你可能需要编写一些额外的代码来解析这个文件，并将其内容设置为 Flask 的配置。

对于 .json 文件，你可以使用 config.from_json() 方法，但同样，你需要先以某种方式（如通过环境变量）获取到 .json 文件的路径。不过，这通常不是通过 from_envvar() 方法直接完成的，因为 from_envvar() 预期的是一个指向 Python 配置文件的路径。

4. 使用 Flask-AppConfig 或其他扩展

虽然 Flask 核心本身提供了基本的配置加载功能，但你也可以使用 Flask 扩展（如 Flask-AppConfig）来简化配置加载过程。这些扩展通常提供了更灵活的配置加载选项，包括从多个源加载配置的能力。

结论

选择哪种方法取决于你的具体需求和环境。对于大多数项目，结合使用配置类和环境变量是一种灵活且强大的方法。这样，你可以轻松地根据不同的环境调整配置，而无需修改代码或配置文件。