Flask笔记（一）

first_flask_project.py

# 从flask这个包中导入Flask这个类
# Flask这个类是项目的核心，以后很多操作都是基于这个类的对象
# 注册url、注册蓝图等都是基于这个类的对象
from flask import Flask

# 创建一个Flask对象，传递__name__参数进去
# __name__参数的作用：
# 1. 可以规定模版和静态文件的查找路径
# 2. 以后一些Flask插件，比如Flask-migrate、Flask-SQLAlchemy如果报错了，那么Flask可以通过这个参数找到具体的错误位置
app = Flask(__name__)

# @app.route：是一个装饰器
# @app.route('/')就是将url中的 / 映射到hello_world这个视图函数上面
# 以后你访问我这个网站的/目录的时候，会执行hello_world这个函数，然后将这个函数的返回值返回给浏览器。
# wwww.baidu.com/ -> hello_world函数
@app.route('/')
def hello_world():
    return '知了课堂'

# www.baidu.com/list/
@app.route('/list/')
def my_list():
    return 'my list'

# 如果这个文件是作为一个主文件运行，那么就执行app.run()方法
# 也就是启动这个网站
if __name__ == '__main__':
    # app.run()：Flask中的一个测试应用服务器
    # while True:
    #   listen()
    #   input()
    app.run(port=8000)

DEBUG模式：

为什么需要开启DEBUG模式：

1. 如果开启了DEBUG模式，那么在代码中如果抛出了异常，在浏览器的页面中可以看到具体的错误信息，以及具体的错误代码位置。方便开发者调试。
2. 如果开启了DEBUG模式，那么以后在Python代码中修改了任何代码，只要按ctrl+s，flask就会自动的重新记载整个网站。不需要手动点击重新运行。

配置DEBUG模式的四种方式：

1. 在app.run()中传递一个参数debug=True就可以开启DEBUG模式。
2. 给app.deubg=True也可以开启debug模式。
3. 通过配置参数的形式设置DEBUG模式：app.config.update(DEBUG=True)。
4. 通过配置文件的形式设置DEBUG模式：app.config.from_object(config)。

PIN码：

如果想要在网页上调试代码，那么应该输入PIN码。

debug_demo.py

from flask import Flask
import config

app = Flask(__name__)
# app.debug = True      # 第二种方式
# app.config.update(DEBUG=True)     # 第三种方式
# dict
# a = {'a':1}
# b = {'b':2}
# a.update(b=2)
# print(a)
# 设置配置参数的形式
# DEBUG必须要大写，不能小写
app.config.from_object(config)   # 第四种方式

@app.route('/')
def hello_world():
    a = 1
    b = 0
    print('hello zhiliao')
    c = a/b
    return 'Hello World!'

if __name__ == '__main__':
    app.run()
    # app.run(debug=True)   # 第一种方式

config.py

#encoding: utf-8

DEBUG=True

config笔记：

使用app.config.from_object的方式加载配置文件：

1. 导入import config。
2. 使用app.config.from_object(config)。

使用app.config.from_pyfile的方式加载配置文件：

这种方式不需要import，直接使用app.config.from_pyfile('config.py')就可以了。

注意这个地方，必须要写文件的全名，后缀名不能少。

1. 这种方式，加载配置文件，不局限于只能使用py文件，普通的txt文件同样也适合。
2. 这种方式，可以传递silent=True，那么这个静态文件没有找到的时候，不会抛出异常。

config_demo.py

from flask import Flask

app = Flask(__name__)
# app.config.from_object*(config)  # 方式一（此方式需要导入 import config）
# app.config.from_pyfile('config.py') # 方式二（此方式不需要导入）
app.config.from_pyfile('config.tx',silent=True) # 方式二(silent=True，这个静态文件没有找到的时候，不会抛出异常。若为Flase，则会抛出异常。)

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

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

config.txt

DEBUG=True

config.py

#encoding: utf-8

DEBUG = True

URL与视图函数的映射：

传递参数：

传递参数的语法是：/<参数名>/。然后在视图函数中，也要定义同名的参数。

参数的数据类型：

1. 如果没有指定具体的数据类型，那么默认就是使用string数据类型。
2. int数据类型只能传递int类型。
3. float数据类型只能传递float类型。
4. path数据类型和string有点类似，都是可以接收任意的字符串，但是path可以接收路径，也就是说可以包含斜杠。
5. uuid数据类型只能接收符合uuid的字符串。uuid是一个全宇宙都唯一的字符串，一般可以用来作为表的主键。
6. any数据类型可以在一个url中指定多个路径。例如：

   @app.route('/<any(blog,article):url_path>/<id>/')
   def detail(url_path,id):
       if url_path == 'blog':
           return '博客详情：%s' % id
       else:
           return '博客详情：%s' % id
   

接收用户传递的参数：

1. 第一种：使用path的形式（将参数嵌入到路径中），就是上面讲的。
2. 第二种：使用查询字符串的方式，就是通过?key=value的形式传递的。

   @app.route('/d/')
   def d():
       wd = request.args.get('wd')
       return '您通过查询字符串的方式传递的参数是：%s' % wd
   

3. 如果你的这个页面的想要做SEO优化，就是被搜索引擎搜索到，那么推荐使用第一种形式（path的形式）。如果不在乎搜索引擎优化，那么就可以使用第二种（查询字符串的形式）。

url_view_demo.py

from flask import Flask,request

app = Flask(__name__)

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

@app.route('/list/')
def article_list():
    return 'article list'

@app.route('/p/<float:article_id>')
def article_detail(article_id):
    return '您请求的文章是：%s' % article_id

# @app.route('/article/<path:test>/')
# def test_article(test):
#     return 'test article：%s' % test

@app.route('/u/<uuid:user_id>/')
def user_detail(user_id):
    return '用户个人中心页面：%s' % user_id

# /blog/<id>/
# /user/<id>/
@app.route('/<any(blog,article):url_path>/<id>/')
def detail(url_path,id):
    if url_path == 'blog':
        return '博客详情：%s' % id
    else:
        return '博客详情：%s' % id

# 通过问号的形式传递参数
@app.route('/d/')
def d():
    wd = request.args.get('wd')
    ie = request.args.get('ie')
    print('ie:',ie)
    return '您通过查询字符串的方式传递的参数是：%s' % wd

# import uuid
# print(uuid.uuid4())

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

url_for笔记：

url_for的基本使用：

url_for第一个参数，应该是视图函数的名字的字符串。后面的参数就是传递给url。

如果传递的参数之前在url中已经定义了，那么这个参数就会被当成path的形式给

url。如果这个参数之前没有在url中定义，那么将变成查询字符串的形式放到url中。

@app.route('/post/list/<page>/')
def my_list(page):
    return 'my list'

print(url_for('my_list',page=1,count=2))
# 构建出来的url：/my_list/1/?count=2

为什么需要url_for：

1. 将来如果修改了URL，但没有修改该URL对应的函数名，就不用到处去替换URL了。
2. url_for会自动的处理那些特殊的字符，不需要手动去处理。

   url = url_for('login',next='/')
   # 会自动的将/编码，不需要手动去处理。
   # url=/login/?next=%2F
   

强烈建议以后在使用url的时候，使用url_for来反转url。

url_for_demo.py

from flask import Flask,url_for,request

app = Flask(__name__)

# /  =>   hello_world
# hello_world   => /

@app.route('/')
def hello_world():
    print(url_for('my list',page=1)) # 类似这样
    # /list/
    # /list/1/
    # return 'Hello World'
    return url_for('login',next='/')
    # /login/?next=/
    # return '/post/list/1/'

@app.route('/login/')
def login():
    return 'login'

@app.route('/post/list/<page>/')
def my_list(page):
    return 'my list'

@app.route('/post/detail/<id>/')
def detail():
    return 'detail'

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

自定义URL转换器：

自定义URL转换器的方式：

1. 实现一个类，继承自BaseConverter。
2. 在自定义的类中，重写regex，也就是这个变量的正则表达式。
3. 将自定义的类，映射到app.url_map.converters上。比如：

   app.url_map.converters['tel'] = TelephoneConverter
   

to_python的作用：

这个方法的返回值，将会传递到view函数中作为参数。

to_url的作用：

这个方法的返回值，将会在调用url_for函数的时候生成符合要求的URL形式。

custom_url_converter.py

from flask import Flask,url_for
from werkzeug.routing import BaseConverter

app = Flask(__name__)

# 一个url中，含有手机号码的变量，必须限定这个变量的字符串格式满足手机号码的格式
class TelephoneConveter(BaseConverter):
    regex = r'1[85734]\d{9}'

# 用户在访问/posts/a+b/
class ListConverter(BaseConverter):
    def to_python(self, value):
        return value.split('+')

    def to_url(self, value):
        return "+".join(value)
        # return "hello"

app.url_map.converters['tel'] = TelephoneConveter
app.url_map.converters['list'] = ListConverter

@app.route('/')
def hello_world():
    print('='*30)
    print(url_for('posts',boards=['a','b']))
    print('='*30)
    return 'Hello World!'

@app.route('/user/<string:user_id>/')
def user_profile(user_id):
    return '您输入的user_id为：%s' % user_id

@app.route('/telephone/<tel:my_tel>/')
def my_tel(my_tel):
    return '您的手机号码是：%s' % my_tel

@app.route('/posts/<list:boards>/')
def posts(boards):
    print(boards)
    return "您提交的板块是：%s" % boards

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

必会的小细节知识点：

在局域网中让其他电脑访问我的网站：

如果想在同一个局域网下的其他电脑访问自己电脑上的Flask网站，

那么可以设置host='0.0.0.0'才能访问得到。

指定端口号：

Flask项目，默认使用5000端口。如果想更换端口，那么可以设置port=9000。

url唯一：

在定义url的时候，一定要记得在最后加一个斜杠。

1. 如果不加斜杠，那么在浏览器中访问这个url的时候，如果最后加了斜杠，那么就访问不到。这样用户体验不太好。
2. 搜索引擎会将不加斜杠的和加斜杠的视为两个不同的url。而其实加和不加斜杠的都是同一个url，那么就会给搜索引擎造成一个误解。加了斜杠，就不会出现没有斜杠的情况。

GET请求和POST请求：

在网络请求中有许多请求方式，比如：GET、POST、DELETE、PUT请求等。那么最常用的就是GET和POST请求了。

1. GET请求：只会在服务器上获取资源，不会更改服务器的状态。这种请求方式推荐使用GET请求。

2. POST请求：会给服务器提交一些数据或者文件。一般POST请求是会对服务器的状态产生影响，那么这种请求推荐使用POST请求。

3. 关于参数传递：

   • GET请求：把参数放到url中，通过?xx=xxx的形式传递的。因为会把参数放到url中，所以如果视力好，一眼就能看到你传递给服务器的参数。这样不太安全。
   • POST请求：把参数放到Form Data中。会把参数放到Form Data中，避免了被偷瞄的风险，但是如果别人想要偷看你的密码，那么其实可以通过抓包的形式。因为POST请求可以提交一些数据给服务器，比如可以发送文件，那么这就增加了很大的风险。所以POST请求，对于那些有经验的黑客来讲，其实是更不安全的。

4. 在Flask中，route方法，默认将只能使用GET的方式请求这个url，如果想要设置自己的请求方式，那么应该传递一个methods参数。

url_detail.py

from flask import Flask,request,render_template

app = Flask(__name__)

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

@app.route('/list/',methods=['POST'])
def my_list():
    return 'list'

@app.route('/login/',methods=['GET','POST'])
def login():
    if request.method == 'GET':
        return render_template('login.html')
    else:
        return 'success'

if __name__ == '__main__':
    # host
    app.run(debug=True,host='0.0.0.0')

重定向笔记：

重定向分为永久性重定向和暂时性重定向，在页面上体现的操作就是浏览器会从一个页面自动跳转到另外一个页面。比如用户访问了一个需要权限的页面，但是该用户当前并没有登录，因此我们应该给他重定向到登录页面。

• 永久性重定向：http的状态码是301，多用于旧网址被废弃了要转到一个新的网址确保用户的访问，最经典的就是京东网站，你输入www.jingdong.com的时候，会被重定向到www.jd.com，因为jingdong.com这个网址已经被废弃了，被改成jd.com，所以这种情况下应该用永久重定向。

• 暂时性重定向：http的状态码是302，表示页面的暂时性跳转。比如访问一个需要权限的网址，如果当前用户没有登录，应该重定向到登录页面，这种情况下，应该用暂时性重定向。

flask中重定向：

flask中有一个函数叫做redirect，可以重定向到指定的页面。示例代码如下：

from flask import Flask,request,redirect,url_for

app = Flask(__name__)

@app.route('/login/')
def login():
    return '这是登录页面'

@app.route('/profile/')
def profile():
    if request.args.get('name'):
        return '个人中心页面'
    else:
        # redirect 重定向
        return redirect(url_for('login'))

redirect_demo.py

from flask import Flask,request,redirect,url_for

app = Flask(__name__)

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

@app.route('/login/')
def login():
    return '这是登录页面'

@app.route('/profile/')
def profile():
    if request.args.get('name'):
        return '个人中心页面'
    else:
        return redirect(url_for('login'))

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

response笔记：

视图函数中可以返回哪些值：

1. 可以返回字符串：返回的字符串其实底层将这个字符串包装成了一个Response对象。
2. 可以返回元组：元组的形式是(响应体,状态码,头部信息)，也不一定三个都要写，写两个也是可以的。返回的元组，其实在底层也是包装成了一个Response对象。
3. 可以返回Response及其子类。

实现一个自定义的Response对象：

1. 继承自Response类。
2. 实现方法force_type(cls,rv,environ=None)。
3. 指定app.response_class为你自定义的Response对象。
4. 如果视图函数返回的数据，不是字符串，也不是元组，也不是Response对象，那么就会将返回值传给force_type，然后再将force_type的返回值返回给前端。

response_demo.py

from flask import Flask,Response,jsonify,render_template
# flask = werkzeug+sqlalchemy+jinja2
import json

app = Flask(__name__)

# 将视图函数中返回的字典，转换成json对象，然后返回
# restful-api
class JSONResponse(Response):

    @classmethod
    def force_type(cls, response, environ=None):
        """
        这个方法只有视图函数返回非字符、非元组、非Response对象
        才会调用
        response：视图函数的返回值
        """
        if isinstance(response,dict):
            # jsonify除了将字典转换成json对象，还将改对象包装成了一个Response对象
            response = jsonify(response)
        return super(JSONResponse, cls).force_type(response,environ)

app.response_class = JSONResponse

@app.route('/')
def hello_world():
    # Response('Hello World!',status=200,mimetype='text/html')
    # return 'Hello World!'
    return render_template('index.html')

@app.route('/list1/')
def list1():
    resp = Response('list1')
    resp.set_cookie('country','china')
    return resp

@app.route('/list2/')
def list2():
    return 'list2',200,{'X-NAME':'zhiliao'}

@app.route('/list3/')
def list3():
    return {'username':'zhiliao','age':18}

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

templates/index.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
    hello world
</body>
</html>