教程：在 Visual Studio 中使用 Flask Web 框架

本文是演示如何在 Visual Studio 中使用 Flask 的三个部分教程系列的第一步。 Flask 是 Web 应用程序的轻型 Python 框架，提供 URL 路由和页面呈现的基础知识。 Flask 称为“micro”框架，因为它不直接提供表单验证、数据库抽象、身份验证等功能。 这些功能由名为 Flask 扩展的特殊 Python 包提供。 扩展与 Flask 无缝集成，因此它们看起来就像是 Flask 本身的一部分一样。 例如，Flask 本身不提供页面模板引擎。 模板化由 Jinja 和 Jade 等扩展提供，如本教程所示。

在本教程的步骤 1 中，你将了解如何：

本教程不同于 Flask 快速入门。 了解更多关于 Flask 的知识，以及如何使用 Flask 项目模板为你的项目提供更丰富的起点。 创建项目时，模板会自动安装 Flask 包，而快速入门演示了如何手动安装包。

先决条件

Flask 项目模板包含在适用于 Visual Studio 的所有早期版本的 Python 工具中。 模板详细信息可能与本教程中的说明不同。

不支持 Visual Studio for Mac。 Windows、Mac 和 Linux 上的 Visual Studio Code 通过可用扩展适用于 Python。

创建 Visual Studio 解决方案和 Flask 项目

在本教程的步骤 1 中，将创建一个 Visual Studio 解决方案以包含两个单独的 Flask 项目。 使用 Visual Studio 附带的不同 Flask 项目模板创建项目。 通过将项目保留在同一解决方案中，可以轻松地在不同文件之间来回切换，以便进行比较。

按照此过程创建解决方案和 Flask Web 项目：

检查 Git 控件

完成本教程时，请习惯使用 Visual Studio 中的 Git 控件提交和推送更改。 本教程会在适当时机提醒你。

从头开始使用源代码管理

从项目开头使用源代码管理有几个优点。 从项目开始时使用源代码管理时，尤其是如果你也使用远程存储库，你将获得项目的常规场外备份。 与在本地文件系统上维护项目不同，源代码管理还提供完整的更改历史记录以及将单个文件或整个项目还原到以前的状态的简单功能。 更改历史记录有助于确定回归的原因（测试失败）。

如果多个人员执行一个项目，则源代码管理必不可少，因为它管理重写并提供冲突解决方案。 源代码管理本质上是自动化的一种形式，可让你很好地实现生成、测试和发布管理。 这是将 Azure DevOps 用于项目的第一步，由于进入障碍如此之低，因此从一开始就没有理由不使用源代码管理。

有关源代码管理作为自动化的详细信息，请参阅 “真相来源：DevOps 中的存储库角色”，这是一篇适用于 Web 应用的移动应用的 MSDN 杂志文章。

阻止 Visual Studio 自动提交项目

按照以下步骤防止 Visual Studio 自动提交新项目：

创建虚拟环境并排除源代码管理

为项目配置源代码管理后，可以使用项目所需的必需 Flask 包创建虚拟环境。 然后，可以使用 “Git 更改 ”窗口从源代码管理中排除环境的文件夹。

了解虚拟环境的目的

虚拟环境是隔离应用程序的确切依赖项的好方法。 这种隔离方法可避免全球 Python 环境中的冲突，并有助于测试和协作。 随着时间推移，开发应用时，始终会引入许多有用的 Python 包。 通过将包保存在特定于项目的虚拟环境中，可以轻松更新项目的 requirements.txt 文件，该文件描述该环境（包含在源代码管理中）。 将项目复制到其他计算机（包括生成服务器、部署服务器和其他开发计算机）时，可以轻松重新创建环境。 只能使用 requirements.txt 文件重新创建环境，这就是为什么环境不需要位于源代码管理中的原因。 有关详细信息，请参阅 “使用虚拟环境”。

在源代码管理下删除虚拟环境

可以在受源代码管理后删除虚拟环境。 执行以下步骤：

1. 编辑 .gitignore 文件以排除文件夹：

   1. 通过选择文件>打开>文件来打开该文件。

      还可以从 团队资源管理器打开该文件。 在 “设置” 页上，选择 “存储库设置”。 转到“忽略和属性文件”部分，然后选择 .gitignore 旁边的“编辑”链接。

   2. 找到具有注释 # Python Tools for Visual Studio (PTVS)的末尾的部分。

   3. 在该节之后，为虚拟环境文件夹添加新行，例如 /BasicProject/env。

2. 打开命令提示符，转到包含虚拟环境文件夹（如 env）的文件夹（如 BasicProject）。

3. git rm -r env运行命令以删除当前在源代码管理下的虚拟环境。

4. 使用git commit -m 'Remove venv'命令提交更改，或从团队资源管理器的“更改”页提交更改。

检查样本代码

在本部分中，将检查 Visual Studio 根据模板选择创建的 Project 文件（.py）中的样板代码。

1. 打开 解决方案资源管理器 以查看解决方案和项目文件。 初始项目仅包含两个文件， app.py 和 requirements.txt：

   

   requirements.txt 文件指定 Flask 包依赖项。 此文件的存在是首次创建项目时邀请你创建虚拟环境的内容。

   单个 app.py 文件包含空白 Flask Web 项目的样本代码。

2. 在编辑器中打开 app.py 文件，并检查第一 import 节（Flask 的语句）。

   此语句将创建分配给变量Flask的app类的实例。 本部分还分配了一个 wsgi_app 变量（在部署到 Web 主机时非常有用，但目前未使用）：

   from flask import Flask
   app = Flask(__name__)
   
   # Make the WSGI interface available at the top level so wfastcgi can get it.
   wsgi_app = app.wsgi_app
   

3. 要查看的第二节发生在文件末尾。 本部分包含可用于启动 Flask 开发服务器的可选代码。

   可以定义代码以使用从环境变量获取的特定主机和端口值，或使用默认主机和端口值 localhost:55551。

   if __name__ == '__main__':
       import os
       HOST = os.environ.get('SERVER_HOST', 'localhost')
       try:
           PORT = int(os.environ.get('SERVER_PORT', '5555'))
       except ValueError:
           PORT = 5555
       app.run(HOST, PORT)
   

4. 要检查的代码的第三部分将函数分配给 URL 路由，这意味着该函数提供 URL 标识的资源。

   使用 Flask 的 @app.route 修饰器定义路由，其参数是站点根中的相对 URL。 如代码中所示，该函数仅返回一个文本字符串，该字符串足以让浏览器呈现。 在本教程系列的后续步骤中，将更新代码以使用 HTML 呈现更丰富的页面。

   @app.route('/')
   def hello():
       """Renders a sample page."""
       return "Hello World!"
   

了解 Flask 类中的名称参数

name Flask 类中的参数是应用程序模块或包的名称。 Flask 使用名称来确定在何处查找属于应用的模板、静态文件和其他资源。 对于单个模块中包含的应用， __name__ 始终是正确的值。 该名称对于需要调试信息的扩展也很重要。 有关详细信息和其他参数，请参阅 Flask 类文档 （flask.pocoo.org）。

使用多个路由修饰器

一个函数可以有多个路由修饰器。 如果同一函数提供多个路由，则可以根据需要使用任意数量的修饰器。 例如，若要对hello路由和/路由使用/hello函数，请使用以下代码：

@app.route('/')
@app.route('/hello')
def hello():
    """Renders a sample page."""
    return "Hello World!"

使用变量 URL 路由和查询参数

Flask 可以使用变量 URL 路由和查询参数。 在路由中，您可以将任何变量标记为 <variable_name> 属性。 Flask 使用 URL 路径中的命名参数将变量传递给函数。 例如，一个形式为 /hello/<name> 的路由生成一个名为 name 的字符串参数传递给函数。 查询参数通过 request.args 属性提供，特别是通过 request.args.get 该方法。 以下代码提供了一个示例：

# URL: /hello/<name>?message=Have%20a%20nice%20day
@app.route('/hello/<name>')
def hello(name):
    msg = request.args.get('message','')
    return "Hello " + name + "! "+ msg + "."

若要更改类型，请将变量的前缀加上 int， floatpath （接受斜杠来描述文件夹名称），以及uuid。 有关详细信息，请参阅 Flask 文档中的 变量规则 。

在安装包后生成要求

安装其他包后，Visual Studio 可以从虚拟环境生成 requirements.txt 文件。

• 在 解决方案资源管理器中，展开 Python 环境 节点，右键单击虚拟环境，然后选择“ 生成 requirements.txt。

在修改环境时，最好定期使用此命令。 将您的 requirements.txt 文件的更改以及依赖于该环境的任何其他代码更改提交到源代码管理工具。 如果在生成服务器上设置持续集成，则应在修改环境时生成文件并提交更改。

运行项目

现在，你已准备好按照此过程在 Visual Studio 中运行项目：

1. 在 Visual Studio 中，选择“调试”>“开始调试”（F5），或在主工具栏上选择 Web 服务器（你看到的浏览器可能有所不同）：

   

2. 任一命令将随机端口号分配给 PORT 环境变量，并运行 Python app.py 文件。

   代码使用 Flask 开发服务器中的该端口启动应用程序。

   如果 Visual Studio 发布消息“无法启动调试器”并指示找不到启动文件，请右键单击解决方案资源管理器中的 app.py 文件，然后选择“设置为启动文件”。

3. 服务器启动时，将打开控制台窗口以显示服务器日志。 Visual Studio 会自动将浏览器打开到 http://localhost:<port>，其中应该看到 hello 函数呈现的消息：

   

4. 完成后，关闭控制台窗口，这会停止 Flask 开发服务器。 还可以选择 调试>停止调试。

将调试命令与项目 Python 命令进行比较

使用 调试 菜单命令和项目 Python 子菜单中列出的服务器命令之间存在差异。

这两个命令都打开控制台窗口，在其中可以看到正在运行的服务器的本地 URL（localhost:port）。 但是，必须使用该 URL 手动打开浏览器，并且运行调试服务器不会自动启动 Visual Studio 调试器。 如果希望使用 “调试>附加到进程 ”命令，则可以稍后将调试器附加到正在运行的进程。

后续步骤