Press "Enter" to skip to content

python flask入门

本文是作者在开发api网关过程中的学习成果,以此记录

在阅读本文之前,我假设你已经了解了 Python 和 HTML 的基础知识。如果还没有,那么你可以去各大教程平台自行了解

本文环境如下:

环境版本
操作系统windows10
python3.9.5
IDEpycharm community

1.预备知识

1.1 Flask

追溯到最初,Flask 诞生于 Armin Ronacher 在 2010 年愚人节开的一个玩笑。后来,它逐渐发展成为一个成熟的 Python Web 框架,越来越受到开发者的喜爱。目前它在 GitHub 上是 Star 数量最多的 Python Web 框架,没有之一。

Flask 是典型的微框架,作为 Web 框架来说,它仅保留了核心功能:请求响应处理模板渲染。这两类功能分别由 Werkzeug(WSGI 工具库)完成和 Jinja(模板渲染库)完成,因为 Flask 包装了这两个依赖,我们暂时不用深入了解它们。

1.2 WSGI

Web Server Gateway Interface(Web服务器网关接口,WSGI)已被用作Python Web应用程序开发的标准。 WSGI是Web服务器和Web应用程序之间通用接口的规范。

1.3 Werkzeug

它是一个WSGI工具包,它实现了请求,响应对象和实用函数。 这使得能够在其上构建web框架。 Flask框架使用Werkzeug作为其基础之一。

1.4 jinja2

jinja2是Python的一个流行的模板引擎。Web模板系统将模板与特定数据源组合以呈现动态网页。

Flask通常被称为微框架。 它旨在保持应用程序的核心简单且可扩展。Flask没有用于数据库处理的内置抽象层,也没有形成验证支持。相反,Flask支持扩展以向应用程序添加此类功能。一些受欢迎的Flask扩展将在本教程后续章节进行讨论。

2.环境

virtualenv是一个虚拟的Python环境构建器。它可以帮助用户并行创建多个Python环境。 因此,它可以避免不同版本的库之间的兼容性问题。

使用下列命令安装

pip install virtualenv

此命令需要管理员权限。您可以在Linux / Mac OS上的 pip 之前添加 sudo

如果您使用的是Windows,请以管理员身份登录。在Ubuntu上, virtualenv可以使用它的包管理器安装。

sudo apt-get install virtualenv

安装后,将在文件夹中创建新的虚拟环境。

mkdir newproj
cd newproj
virtualenv venv

要在 Linux / OS X 上激活相应的环境,请使用以下命令:

venv/bin/activate

要在 Windows 上激活相应的环境,可以使用以下命令:

venv\scripts\activate

我们现在准备在这个环境中安装Flask:

pip install Flask

上述命令可以直接运行,不需要系统范围安装的虚拟环境。

3.Hello Flask

3.1 第一个app

为了测试 Flask 安装,请在编辑器中将以下代码输入 Hello.py:

from flask import Flask
app = Flask(__name__)

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

if __name__ == '__main__':
  app.run()

必须在项目中导入Flask模块。

Flask类的一个对象是我们的WSGI应用程序。

Flask构造函数使用当前模块(name )的名称作为参数。

Flask类的route()函数是一个装饰器,它告诉应用程序哪个URL应该调用相关的函数。

app.route(rule, options)
  • rule 参数表示与该函数的URL绑定。
  • options 是要转发给基础Rule对象的参数列表。

在上面的示例中,’/ ‘ URL与hello_world()函数绑定。

因此,当在浏览器中打开web服务器的主页时,将呈现该函数的输出。

最后,Flask类的run()方法在本地开发服务器上运行应用程序。

app.run(host, port, debug, options)

所有参数都是可选的

序号参数与描述
1host 要监听的主机名。 默认为127.0.0.1(localhost)。设置为“0.0.0.0”以使服务器在外部可用
2port 默认值为5000
3debug 默认为false。 如果设置为true,则提供调试信息
4options 要转发到底层的Werkzeug服务器。

上面给出的Python脚本是从Python shell执行的。

python Hello.py

Python shell中的消息通知您:

* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

在浏览器中打开上述URL(localhost:5000)。将显示“Hello World”消息。

3.2 响应GET请求

Http协议是万维网中数据通信的基础。在该协议中定义了从指定URL检索数据的不同方法。

下表总结了不同的http方法:

序号方法与描述
1GET以未加密的形式将数据发送到服务器。最常见的方法。
2HEAD和GET方法相同,但没有响应体。
3POST用于将HTML表单数据发送到服务器。POST方法接收的数据不由服务器缓存。
4PUT用上传的内容替换目标资源的所有当前表示。
5DELETE 删除由URL给出的目标资源的所有当前表示。

默认情况下,Flask路由响应GET请求。但是,可以通过为route()装饰器提供方法参数来更改此首选项。

现在在Python shell中输入以下脚本:

from flask import Flask, redirect, url_for, request
app = Flask(__name__)

@app.route('/success/<name>')
def success(name):
  return 'welcome %s' % name

@app.route('/login',methods = ['GET'])
def login():
     user = request.args.get('name')
     return redirect(url_for('success',name = user))

if __name__ == '__main__':
  app.run(debug = True)

这时,向地址http://localhost:5000/login发送包含参数name=testGET请求,服务器将返回”wlecome test”

3.3 返回html网页

flask返回html网页实际上是基于响应GET请求,返回html页面

视图函数有两个作用:

  • 处理业务逻辑
  • 返回响应内容

在大型应用中,把业务逻辑和表现内容放在一起,会增加代码的复杂度和维护成本.

  • 模板其实是一个包含响应文本的文件,其中用占位符(变量)表示动态部分,告诉模板引擎其具体的值需要从使用的数据中获取
  • 使用真实值替换变量,再返回最终得到的字符串,这个过程称为’渲染’
  • Flask 是使用 Jinja2 这个模板引擎来渲染模板

使用模板的好处

  • 视图函数只负责业务逻辑和数据处理(业务逻辑方面)
  • 而模板则取到视图函数的数据结果进行展示(视图展示方面)
  • 代码结构清晰,耦合度低模板基本使用

在项目下创建 templates 文件夹,用于存放所有模板文件,并在目录下创建一个模板文件 html 文件 hello.html

<!DOCTYPE html>
<html lang="en">
<head>
   <meta charset="UTF-8">
   <title>Title</title>
</head>
<body>
我的模板html内容
</body>
</html>

创建视图函数,将该模板内容进行渲染返回

from flask import Flask, render_template

app = Flask(__name__)

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

模板变量

代码中传入字符串,列表,字典到模板中

from flask import Flask, render_template

app = Flask(__name__)

@app.route('/')
def index():
   # 往模板中传入的数据
   my_str = 'Hello Word'
   my_int = 10
   my_array = [3, 4, 2, 1, 7, 9]
   my_dict = {
       'name': 'xiaoming',
       'age': 18
  }
   return render_template('hello.html',
                          my_str=my_str,
                          my_int=my_int,
                          my_array=my_array,
                          my_dict=my_dict
                          )

模板中代码

<!DOCTYPE html>
<html lang="en">
<head>
 <meta charset="UTF-8">
 <title>Title</title>
</head>
<body>
我的模板html内容
 <br />{{ my_str }}
 <br />{{ my_int }}
 <br />{{ my_array }}
 <br />{{ my_dict }}
</body>
</html>

运行效果

我的模板html内容
Hello Word
10
[3, 4, 2, 1, 7, 9]
{'name': 'xiaoming', 'age': 18}
发表评论

您的电子邮箱地址不会被公开。