Python Flask 之路由和渲染模板讲解与示例演示

2023-05-18 17:52:24

一、概述

Flask 是一款使用 Python 编写的 Web 应用框架，其设计理念是轻量级和简单易学。Flask 框架的核心思想是将应用程序的各个部分组织成一组小而相互独立的模块，其中路由和模板是其中的重要组成部分。

官方官网：https://flask.net.cn/quickstart.html

二、路由

在 Flask 中，路由是将 URL 地址与应用程序中的函数相映射的过程。当用户在浏览器中输入特定的 URL 地址时，Flask 会调用与该地址相匹配的函数并返回相应的结果。下面是一个简单的路由定义：

from flask import Flask

app = Flask(__name__)

@app.route('/')
def hello_world():
return 'Hello, World!'

上述代码中，我们首先创建一个 Flask 应用程序实例，然后使用 @app.route 装饰器定义了一个路由，该路由将 URL / 映射到 hello_world 函数。在该函数中，我们返回了一个简单的字符串 Hello, World!。

除了返回字符串外，我们还可以返回 HTML 代码、JSON 数据或者其他格式的数据。例如，我们可以返回一个 HTML 页面，如下所示：

from flask import Flask, render_template

app = Flask(__name__)

@app.route('/')
def hello_world():
return render_template('hello.html')

在上述代码中，我们使用 render_template 函数来渲染一个名为 hello.html 的模板文件。这个模板文件需要放在应用程序的根目录下的 templates 目录中。下面是一个简单的模板文件示例：

<!DOCTYPE html>
<html>
  <head>
    <title>Hello, Flask!</title>
  </head>
  <body>
    <h1>Hello, Flask!</h1>
  </body>
</html>

三、渲染模板

Flask 中的模板是一种将数据和 HTML 代码组合在一起的方式，使得我们可以生成动态的 HTML 页面。使用模板可以使我们的代码更加简洁、易于维护和复用。下面是一个简单的模板示例：

<!DOCTYPE html>
<html>
  <head>
    <title>{{ title }}</title>
  </head>
  <body>
    <h1>{{ heading }}</h1>
    <p>{{ content }}</p>
  </body>
</html>

在上述模板中，我们使用了 Flask 提供的模板语言 Jinja2 的语法来动态生成 HTML 代码。例如，{{ title }} 会被替换成变量 title 的值。我们可以在路由函数中传递数据给模板，如下所示：

from flask import Flask, render_template

app = Flask(__name__)

@app.route('/')
def index():
    data = {
'title': 'My Website',
'heading': 'Welcome to my website!',
'content': 'This is a sample page generated using Flask and Jinja2.'
    }
return render_template('template.html', **data)

在上述代码中，我们定义了一个名为 index 的路由函数，该函数渲染了一个名为 template.html 的模板文件，并将变量 data 作为参数传递给模板。在模板中，我们使用了变量 title、heading 和 content 来动态生成 HTML 代码。

除了简单的变量替换外，Jinja2 还支持条件语句、循环语句、过滤器等特性。下面是一个使用循环语句的模板示例：

<!DOCTYPE html>
<html>
  <head>
    <title>{{ title }}</title>
  </head>
  <body>
    <h1>{{ heading }}</h1>
    <ul>
      {% for item in items %}
        <li>{{ item }}</li>
      {% endfor %}
    </ul>
  </body>
</html>

在上述模板中，我们使用了 for 循环语句来遍历变量 items 中的元素，并将它们依次插入到一个无序列表中。我们还可以使用 if 语句来根据条件选择不同的代码分支，如下所示：

<!DOCTYPE html>
<html>
  <head>
    <title>{{ title }}</title>
  </head>
  <body>
    {% if user %}
      <p>Welcome, {{ user }}!</p>
    {% else %}
      <p>Please log in.</p>
    {% endif %}
  </body>
</html>

在上述模板中，我们根据变量 user 是否存在来显示不同的代码分支。

模板是 Flask 框架中非常重要的组成部分，可以帮助我们快速构建动态的 Web 应用程序。在实际应用中，我们可以使用 Flask 提供的许多扩展来进一步增强应用程序的功能和性能。

四、重定向和错误

在Python Flask中，可以使用重定向（redirect）和错误（error）来处理不同的情况。

重定向通常用于将用户重定向到其他页面，例如，当用户成功登录后，将其重定向到他们的个人资料页面。要在Flask中进行重定向，可以使用 redirect() 函数。例如，以下代码将用户重定向到 /profile 页面：

from flask import redirect, url_for

@app.route('/')
def index():
return redirect(url_for('profile'))

@app.route('/profile')
def profile():
return 'This is the profile page'

当用户访问根目录时，index() 函数将调用 redirect() 函数，将用户重定向到/profile页面。请注意，url_for() 函数用于获取特定路由的URL。

如果发生错误，可以使用 abort() 函数来返回错误代码。例如，以下代码将返回404错误：

from flask import abort

@app.route('/page-not-found')
def page_not_found():
    abort(404)

当用户访问 /page-not-found 页面时，page_not_found() 函数将调用 abort() 函数，返回404错误。可以使用不同的错误代码来返回不同类型的错误。

缺省情况下每种出错代码都会对应显示一个黑白的出错页面。使用 errorhandler() 装饰器可以定制出错页面:

from flask import render_template

@app.errorhandler(404)
def page_not_found(error):
return render_template('page_not_found.html'), 404

注意 render_template() 后面的 404 ，这表示页面对就的出错代码是 404 ，即页面不存在。缺省情况下 200 表示：一切正常。

五、日志

在Python Flask中，可以使用日志（logging）来记录应用程序中发生的事件和错误，以便在需要时进行调试和故障排除。

Flask使用Python内置的 logging 模块来记录日志。可以通过创建一个Logger对象来配置日志，然后使用该对象记录日志。例如，以下代码将创建一个名为 app_logger 的 Logger 对象，并将其配置为记录到文件中：

import logging
from logging.handlers import RotatingFileHandler
from flask import Flask

app = Flask(__name__)

app_logger = logging.getLogger('app_logger')
app_logger.setLevel(logging.INFO)
handler = RotatingFileHandler('app.log', maxBytes=10000, backupCount=1)
formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
handler.setFormatter(formatter)
app_logger.addHandler(handler)

@app.route('/')
def hello_world():
    app_logger.info('Hello World page accessed')
return 'Hello World!'

代码讲解：

在上面的代码中，我们首先创建了一个名为 app_logger 的 Logger 对象，并将其设置为记录 INFO 级别的日志。我们使用 RotatingFileHandler 处理程序将日志记录到名为 app.log 的文件中，并在文件达到10KB时自动滚动文件。formatter对象用于指定日志格式。
在路由函数 hello_world() 中，我们使用 app_logger 对象记录了一条日志，说明用户已经访问了 Hello World 页面。这将在日志文件中添加一行记录，其中包含时间戳、日志级别和消息。
使用日志记录器可以方便地进行应用程序的调试和故障排除，因为它可以记录每个请求的详细信息，例如请求的路径、参数、IP地址等。可以使用 logging.basicConfig() 方法进行更的日志记录设置。

六、集成 WSGI 中间件

在Python Flask应用程序中，可以通过 WSGI 中间件（middleware）来拓展其功能。WSGI 中间件可以截取请求和响应，并在它们到达应用程序之前或之后执行自定义代码。

WSGI中间件是基于 WSGI 规范实现的，可以使用Python的 WSGI 工具包来编写和集成它们。关于 WSGI 的介绍可以参考我这篇文章：Python 之 WSGI、uWSGI 和 uwsgi 介绍

下面是一个简单的WSGI中间件示例：

class SimpleMiddleware:
def __init__(self, app):
        self.app = app

def __call__(self, environ, start_response):
# 在请求到达应用程序之前执行代码
        response = self.app(environ, start_response)
# 在应用程序响应之后执行代码
return response

代码讲解：

在上面的代码中，我们定义了一个名为 SimpleMiddleware 的 WSGI 中间件类，该类包含一个构造函数和一个 __call__()方法。构造函数接受一个Flask应用程序作为参数，并将其存储在 self.app 属性中。__call__() 方法是WSGI中间件规范要求的方法，它接受两个参数：environ 和 start_response 。environ 是一个包含 HTTP 请求信息的字典，start_response 是一个函数，用于发送HTTP响应。
在__call__()方法中，我们可以在请求到达应用程序之前和响应之后执行自定义代码。在上面的示例中，我们只是调用了应用程序的 environ 和 start_response 参数，并返回了应用程序的响应。

要将 WSGI 中间件集成到Flask应用程序中，可以在应用程序创建之后使用 wsgi_app 属性将其包装在 WSGI 应用程序中，如下所示：

from flask import Flask

app = Flask(__name__)

class SimpleMiddleware:
def __init__(self, app):
        self.app = app

def __call__(self, environ, start_response):
# 在请求到达应用程序之前执行代码
        response = self.app(environ, start_response)
# 在应用程序响应之后执行代码
return response

app.wsgi_app = SimpleMiddleware(app.wsgi_app)