欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Flask入门很轻松 (一)

程序员文章站 2022-07-10 23:42:42
Flask诞生于2010年,是Armin ronacher(人名)用 Python 语言基于 Werkzeug 工具箱编写的轻量级Web开发框架。 Flask 本身相当于一个内核,其他几乎所有的功能都要用到扩展(邮件扩展Flask Mail,用户认证Flask Login,数据库Flask SQLA ......

flask诞生于2010年,是armin ronacher(人名)用 python 语言基于 werkzeug 工具箱编写的轻量级web开发框架。
flask 本身相当于一个内核,其他几乎所有的功能都要用到扩展(邮件扩展flask-mail,用户认证flask-login,数据库flask-sqlalchemy),都需要用第三方的扩展来实现。比如可以用 flask 扩展加入orm、窗体验证工具,文件上传、身份验证等。flask 没有默认使用的数据库,你可以选择 mysql,也可以用 nosql。

其 wsgi 工具箱采用 werkzeug(路由模块),模板引擎则使用 jinja2。这两个也是 flask 框架的核心。

官网: http://flask.pocoo.org/

官方文档:

flask常用扩展包:

  • flask-sqlalchemy:操作数据库,orm;
  • flask-script:终端脚本工具,脚手架;
  • flask-migrate:管理迁移数据库;
  • flask-session:session存储方式指定;
  • flask-wtf:表单;
  • flask-mail:邮件;
  • flask-bable:提供国际化和本地化支持,翻译;
  • flask-login:认证用户状态;
  • flask-openid:认证, oauth;
  • flask-restful:开发rest api的工具;
  • flask json-rpc: 开发rpc远程服务[过程]调用
  • flask-bootstrap:集成前端twitter bootstrap框架
  • flask-moment:本地化日期和时间
  • flask-admin:简单而可扩展的管理接口的框架

可以通过 http://flask.pocoo.org/extensions/ 查看更多flask官方推荐的扩展

准备

mkvirtualenv flask_demo -p python3

安装

pip install flask==0.12.4

创建flask项目

与django不同,flask不会提供任何的自动操作,所以需要手动创建项目目录,需要手动创建启动项目的管理文件

例如,创建项目目录 flaskdemo,在目录中创建manage.py.在pycharm中打开项目并指定上面创建的虚拟环境

from flask import flask
app = flask(__name__)

@app.route('/')
def index():
    return 'hello world'
    
if __name__ == '__main__':
    app.run()

代码分析:

# 导入flask类
from flask import flask

"""
import_name      flask程序所在的包(模块),传 __name__ 就可以
                 其可以决定 flask 在访问静态文件时查找的路径
static_path      静态文件访问路径(不推荐使用,使用 static_url_path 代替)
static_url_path  静态文件访问路径,可以不传,默认为:/ + static_folder
static_folder    静态文件存储的文件夹,可以不传,默认为 static
template_folder  模板文件存储的文件夹,可以不传,默认为 templates
"""
app = flask(__name__)
# 加载项目配置
# 配置类
class config(object):
    debug = true

app.config.from_object( config )


# 指定服务器ip和端口
app.run(host="0.0.0.0", port=5000, debug = true)

路由的基本定义

# 指定访问路径为 demo1
@app.route('/demo1')
def demo1():
    return 'demo1'

路由可以设置传递参数, 2种方式

# 路由传递参数[没有限定类型]
@app.route('/user/<user_id>')
def user_info(user_id):
    return 'hello %s' % user_id


# 路由传递参数[限定数据类型]
@app.route('/user/<int:user_id>')
def user_info(user_id):
    return 'hello %d' % user_id

路由限定请求方式

from flask import flask, request
@app.route('/demo2', methods=['get', 'post'])
def demo2():
    # 直接从请求中取到请求方式并返回
    return request.method

正则匹配路由

在 web 开发中,可能会出现限制用户访问规则的场景,那么这个时候就需要用到正则匹配,根据自己的规则去限定请求参数再进行访问

具体实现步骤为:

  • 导入转换器基类:在 flask 中,所有的路由的匹配规则都是使用转换器对象进行记录
  • 自定义转换器:自定义类继承于转换器基类
  • 添加转换器到默认的转换器字典中
  • 使用自定义转换器实现自定义匹配规则

代码实现

  • 导入转换器基类
from werkzeug.routing import baseconverter
  • 自定义转换器
# 自定义正则转换器
from werkzeug.routing import baseconverter
class regexconverter(baseconverter):
    def __init__(self,url_map,*args):
        super(regexconverter, self).__init__(url_map)
        # 正则参数
        self.regex = args[0]
  • 添加转换器到默认的转换器字典中,并指定转换器使用时名字为: re
# 将自定义转换器添加到转换器字典中,并指定转换器使用时名字为: re
app.url_map.converters['re'] = regexconverter
  • 使用转换器去实现自定义匹配规则
    • 当前此处定义的规则是:手机号码
# 正则匹配路由
@app.route("/login/<re('1\d{10}'):mobile>")
def login(mobile):
    return mobile

运行测试: ,如果访问的url不符合规则,会提示找不到页面

系统自带转换器

default_converters = {
    'default':          unicodeconverter,
    'path':             pathconverter,
    'string':           unicodeconverter,
    'any':              anyconverter,
    'int':              integerconverter,
    'float':            floatconverter,
    'uuid':             uuidconverter,
}

系统自带的转换器具体使用方式在每种转换器的注释代码中有写,请留意每种转换器初始化的参数。

from flask import flask
# 新增一个配置文件,在配置文件中设置配置信息
from config import config
from flask import request
# from collections import ordereddict  # 有序字典

app = flask(__name__)

# 调用app.config加载配置
app.config.from_object(config)


from werkzeug.routing import baseconverter

class regexconverter(baseconverter):
    def __init__(self,url_map,*args):
        super(regexconverter, self).__init__(url_map)
        # 正则参数
        self.regex = args[0]

# converter["路由转换器名称"] = 实现路由转换功能的自定义类
app.url_map.converters['re'] = regexconverter
# 绑定路由
@app.route("/")
def index():
    return "hello flask"


# 默认情况下,路由使用的就是关键字参数,也叫"命名路由"
# router(路由地址, http请求方式 )
@app.route("/list/<int:page>/<string:content>",methods=["get","post"])
def mylist(content,page):
    return "第%s页<br>内容:%s" % (page,content)

# 正则匹配路由
@app.route("/login/<re('1\d{10}'):mobile>")
def login(mobile):
    return mobile

http的请求与响应

请求

文档: http://docs.jinkan.org/docs/flask/api.html#flask.request

  • request:flask中代表当前请求的 request 对象
  • 作用:在视图函数中取出本次请求数据
  • 导入from flask import request

常用的属性如下:

属性 说明 类型
data 记录请求的数据,并转换为字符串 *
form 记录请求中的表单数据 multidict
args 记录请求中的查询参数 multidict
cookies 记录请求中的cookie信息 dict
headers 记录请求中的请求头 environheaders
method 记录请求使用的http方法 get/post
url 记录请求的url地址 string
files 记录请求上传的文件 *
json 记录请求的json数据 json

获取请求中查询字符串

http://127.0.0.1:5000/demo1?a=10

......

"""获取客户端的请求"""
@app.route("/request")
def req1():
    """获取查询字符串"""
    query_string = request.args
    print(query_string)
    # 浏览器输入 http://127.0.0.1:5000/request?a=1&b=2
    """打印效果: immutablemultidict([('a', '1'), ('b', '2')])"""

    # 获取一个参数的一个值
    http://127.0.0.1:5000/request?username=abcd
    username = request.args.get("username")
    # print(username)
    """打印效果: abcd  """

    # 获取一个参数的多个值
    # http://127.0.0.1:5000/request?username=xiaoming&love=吹牛&love=睡觉
    love = request.args.getlist("love")
    # print(love)
    """打印效果: ['吹牛', '睡觉']"""


    # 把传递过来的数据抓换成原生的字典
    data = request.args.to_dict()
    # print(data)
    """打印效果:{'username': 'xiaoming', 'love': '吹牛'} """

    return "ok"

@app.route("/request2",methods=["post"])
def req2():
    """获取post数据和请求头"""
    # 必须传 json 格式的数据
    # print( request.data )
    # """打印结果:
    # b'{\n\t"username":"xiaoming",\n\t"age":18,\n\t"sex":1\n}'
    # """
    # 方式一
    # import json
    # from flask import json
    # data = json.loads(request.data)
    # print(data)
    # """打印结果:
    # {'username': 'xiaoming', 'age': 18, 'sex': 1}
    #方式二 
    print(request.json)
    # """打印结果:
    # {'username': 'xiaoming', 'age': 18, 'sex': 1}
    # """
    #
    # """获取请求行数据"""
    # print( request.headers )
    # print( request.headers.to_list() )


    """获取上传文件"""
    print( request.files )
    print( request.files.get("avatar") )
    """打印效果: 
    immutablemultidict([('avatar', <filestorage: 'avatar.png' ('image/png')>)])
    <filestorage: 'avatar.png' ('image/png')>
    """

    return "ok"

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

响应

flask默认支持2种响应方式:

  • 数据响应:
    默认响应html文本,也可以返回 json格式
  • 页面响应:
    重定向 url_for

响应的时候,flask也支持自定义http响应状态码

响应html文本

@app.route("/")
def index():
    # [默认支持]响应html文本
    return "<img src='http://flask.pocoo.org/static/logo.png'>"

返回json数据

在 flask 中可以直接使用 jsonify 生成一个 json 的响应

from flask import flask, request, jsonify

@app.route("/")
def index():
    # 也可以响应json格式代码
    data = [
        {"id":1,"username":"liulaoshi","age":18},
        {"id":2,"username":"liulaoshi","age":17},
        {"id":3,"username":"liulaoshi","age":16},
        {"id":4,"username":"liulaoshi","age":15},
    ]
    return jsonify(data)

flask中返回json 数据,都是flask的jsonify方法返回就可以了.

重定向

重定向到百度页面

# 页面跳转响应
from flask import flask, request, jsonify, redirect
@app.route("/user")
def user():
    # 页面跳转 redirect函数就是response对象的页面跳转的封装
    # location: http://www.baidu.com
    return redirect("http://www.baidu.com")

重定向到自己写的视图函数

可以直接填写自己 url 路径

也可以使用 url_for 生成指定视图函数所对应的 url

# 内容响应
@app.route("/")
def index():
    # [默认支持]响应html文本
    # return "<img src='http://flask.pocoo.org/static/logo.png'>"

    # 也可以响应json格式代码
    data = [
        {"id":1,"username":"liulaoshi","age":18},
        {"id":2,"username":"liulaoshi","age":17},
        {"id":3,"username":"liulaoshi","age":16},
        {"id":4,"username":"liulaoshi","age":15},
    ]
    return jsonify(data)

#使用url_for可以实现视图方法之间的内部跳转
# url_for("视图方法名")
from flask import flask, request, jsonify, redirect, url_for
@app.route("/login")
def login():
    return redirect( url_for("index") )

重定向到带有参数的视图函数

在 url_for 函数中传入参数

# 路由传递参数
@app.route('/user/<user_id>')
def user_info(user_id):
    return 'hello %s' % user_id

# 重定向
@app.route('/demo4')
def demo4():
    # 使用 url_for 生成指定视图函数所对应的 url
    return redirect(url_for('user_info', user_id=100))

自定义状态码

在 flask 中,可以很方便的返回自定义状态码,以实现不符合 http 协议的状态码,例如:status code: 666

@app.route('/demo4')
def demo4():
    return '状态码为 666', 400

会话控制

所谓的会话,就是用户和浏览器中网站之间一次交互过程.

会话的开始是在用户打开浏览器以后第一次访问网站.

会话的结束时在用户关闭浏览器以后.

因为 http 是一种无状态协议,浏览器请求服务器是无状态的。

无状态:指一次用户请求时,浏览器、服务器无法知道之前这个用户做过什么,每次请求都是一次新的请求。

无状态原因:浏览器与服务器是使用 socket 套接字进行通信的,服务器将请求结果返回给浏览器之后,会关闭当前的 socket 连接,而且服务器也会在处理页面完毕之后销毁页面对象。

有时需要保持下来用户浏览的状态,比如用户是否登录过,浏览过哪些商品等

实现状态保持主要有两种方式:

  • 在客户端存储信息使用cookie,本地存储,token[jwt,oauth]
  • 在服务器端存储信息使用session,redis

cookie是由服务器端生成,发送给客户端浏览器,浏览器会将cookie的key/value保存,下次请求同一网站时就发送该cookie给服务器(前提是浏览器设置为启用cookie)。cookie的key/value可以由服务器端自己定义。

使用场景: 登录状态, 浏览历史, 网站足迹

cookie是存储在浏览器中的一段纯文本信息,建议不要存储敏感信息如密码,因为电脑上的浏览器可能被其它人使用

cookie基于域名安全,不同域名的cookie是不能互相访问的

如访问luffy.com时向浏览器中写了cookie信息,使用同一浏览器访问baidu.com时,无法访问到luffy.com写的cookie信息

浏览器的同源策略针对cookie也有限制作用.

当浏览器请求某网站时,会将本网站下所有cookie信息提交给服务器,所以在request中可以读取cookie信息

设置cookie

设置cookie需要通过flask的response响应对象来进行设置,由flask内部提供了一个make_response函数给我们可以快速创建响应对象

from flask imoprt flask,make_response
@app.route('/set_cookie')
def set_cookie():
    resp = make_response('this is to set cookie')
    resp.set_cookie('username', 'xiaoming', max_age=3600)
    # max_age 为cookie有效期,单位为秒
    return resp

获取cookie

from flask import flask,request
@app.route('/get_cookie')
def resp_cookie():
    resp = request.cookies.get('username')
    return resp

session

对于敏感、重要的信息,建议要存储在服务器端,不能存储在浏览器中,如用户名、余额、等级、验证码等信息

在服务器端进行状态保持的方案就是session

注意: session依赖于cookie,而且flask中使用session,需要配置secret_key选项,否则报错.

设置session

from flask import session
@app.route('/set_session')
def set_session():
    session['username'] = 'xiaoming'
    return 'ok!'

获取session

@app.route('/get_session')
def get_session():
    return session.get('username')

上一篇: day11-装饰器

下一篇: 我尾巴放哪?