Flask学习

Flask是一个 Python 编写的 Web 微框架， 让我们可以使用 Python 语言快速实现一个网站或 Web 服务。与 django 不同的是： django 是一个完善完整高集成的框架，而 flask 不包含数据库抽象层的微框架， database， templates， 都需要自己去组装。

安装Flask

进入 Windows 命令行，输入以下命令：

virtulenv --no-site-packages flaskenv # 创建虚拟环境
cd flaskenv
cd Script
activate  # 启动虚拟环境
pip install flask  # 安装flask

一段简单的flask程序

from flask import Flask

app = Flask(__name__)


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


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

运行该文件， 访问 localhost:5000，我们可以看到浏览器上输出了 Hello Flask!。

调试模式

我们修改代码中的输出，然后查看浏览器上是否有变化。如果你照做的话，可以看到什么变化都没有。其实Flask内置了调试模式，可以自动重载代码并显示调试信息。这需要我们开启调试模式，方法很简单，在app.run()括号里加入debug=True。

然后再次运行程序，会看到有这样的输出。这时候如果再次修改代码，会发现这次Flask会自动重启。

路由

在上面的例子里可以看到路由的使用。如果了解Spring Web MVC的话，应该对路由很熟悉。路由通过使用Flask的app.route装饰器来设置，这类似Java的注解。

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

路径变量

如果希望获取/number/1这样的路径参数，就需要使用路径变量。路径变量的语法是/path/。在路径变量前还可以使用可选的转换器，有以下几种转换器。

转换器	作用
string	默认选项，接受除了斜杠之外的字符串
int	接受整数
float	接受浮点数
path	和string类似，不过可以接受带斜杠的字符串
any	匹配任何一种转换器
uuid	接受UUID字符串

下面是一个例子：

@app.route('/getfloat//')
def hello_float(number):

    return 'float: %s' % number

构造url
在Web程序中常常需要获取某个页面的URL，在Flask中需要使用url_for(方法名)来构造对应方法的URL。下面是Flask官方的例子。

>>> from flask import Flask, url_for
>>> app = Flask(__name__)
>>> @app.route('/')
... def index(): pass
...
>>> @app.route('/login')
... def login(): pass
...
>>> @app.route('/user/')
... def profile(username): pass
...
>>> with app.test_request_context():
...  print url_for('index')
...  print url_for('login')
...  print url_for('login', next='/')
...  print url_for('profile', username='John Doe')
...
/
/login
/login?next=/
/user/John%20Doe

HTTP方法

如果需要处理具体的HTTP方法，在Flask中也很容易，使用route装饰器的methods参数设置即可。

from flask import request

@app.route('/login', methods=['GET', 'POST'])
def login():
    if request.method == 'POST':
        do_the_login()
    else:
        show_the_login_form()

静态文件

Web程序中常常需要处理静态文件，在Flask中需要使用url_for函数并指定static端点名和文件名。在下面的例子中，实际的文件应放在static/文件夹下。

{#    第一种路径写法#}
    <link rel="stylesheet" href="/static/css/index.css">
{#    第二种路径写法#}
{#    <link rel="stylesheet" href="{{ url_for('static', filename='css/index.css') }}">#}

模板生成

Flask默认使用Jinja2作为模板，Flask会自动配置Jinja 模板，所以我们不需要其他配置了。默认情况下，模板文件需要放在templates文件夹下。
使用 Jinja 模板，只需要使用 render_tenplate函数并闯入文件名和参数名即可。

from flask import render_template

@app.route('/hello/')
@app.route('/hello/')
def hello(name=None):
    return render_template('hello.html', name=name)

相应的模板文件如下。

<title>Hello from Flasktitle>
{% if name %}
  <h1>Hello {{ name }}!h1>
{% else %}
  <h1>Hello, World!h1>
{% endif %}

处理请求

在 Flask 中获取请求参数需要使用request等几个全局对象，但是这几个全局对象比较特殊，它们是 Context Locals ，其实就是 Web 上下文中局部变量的代理。虽然我们在程序中使用的是全局变量，但是对于每个请求作用域，它们都是互不相同的变量。理解了这一点，后面就非常简单了。

Request 对象

Request 对象是一个全局对象，利用它的属性和方法，我们可以方便的获取从页面传递过来的参数。

method属性会返回HTTP方法的类似，例如post和get。form属性是一个字典，如果数据是POST类型的表单，就可以从form属性中获取。

如果数据是由GET方法过来的，可以使用args属性获取，这个属性也是一个字典。

文件上传

利用Flask也可以方便的获取表单中上传的文件，只需要利用 request 的files属性即可，这也是一个字典，包含了被上传的文件。如果想获取上传的文件名，可以使用filename属性，不过需要注意这个属性可以被客户端更改，所以并不可靠。更好的办法是利用werkzeug提供的secure_filename方法来获取安全的文件名。

from flask import request
from werkzeug.utils import secure_filename

@app.route('/upload', methods=['GET', 'POST'])
def upload_file():
    if request.method == 'POST':
        f = request.files['the_file']
        f.save('/var/www/uploads/' + secure_filename(f.filename))

Cookies

Flask也可以方便的处理Cookie。使用方法很简单，直接看官方的例子就行了。下面的例子是如何获取cookie。

from flask import request

@app.route('/')
def index():
    username = request.cookies.get('username')
    # 使用 cookies.get(key) 代替 cookies[key] 避免
    # 得到 KeyError 如果cookie不存在

如果需要发送cookie给客户端，参考下面的例子。

from flask import make_response

@app.route('/')
def index():
    resp = make_response(render_template(...))
    resp.set_cookie('username', 'the username')
    return resp

重定向和错误

redirect和abort函数用于重定向和返回错误页面。

from flask import abort, redirect, url_for

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

@app.route('/login')
def login():
    abort(401)
    this_is_never_executed()

默认的错误页面是一个空页面，如果需要自定义错误页面，可以使用errorhandler装饰器。

from flask import render_template

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

响应处理

默认情况下，Flask会根据函数的返回值自动决定如何处理响应：如果返回值是响应对象，则直接传递给客户端；如果返回值是字符串，那么就会将字符串转换为合适的响应对象。我们也可以自己决定如何设置响应对象，方法也很简单，使用make_response函数即可。

@app.errorhandler(404)
def not_found(error):
    resp = make_response(render_template('error.html'), 404)
    resp.headers['X-Something'] = 'A value'
    return resp

Sessions

我们可以使用全局对象session来管理用户会话。Sesison 是建立在 Cookie 技术上的，不过在 Flask 中，我们还可以为 Session 指定密钥，这样存储在 Cookie 中的信息就会被加密，从而更加安全。直接看 Flask 官方的例子吧。

from flask import Flask, session, redirect, url_for, escape, request

app = Flask(__name__)

@app.route('/')
def index():
    if 'username' in session:
        return 'Logged in as %s' % escape(session['username'])
    return 'You are not logged in'

@app.route('/login', methods=['GET', 'POST'])
def login():
    if request.method == 'POST':
        session['username'] = request.form['username']
        return redirect(url_for('index'))
    return '''
        

            

            

        
    '''

@app.route('/logout')
def logout():
    # remove the username from the session if it's there
    session.pop('username', None)
    return redirect(url_for('index'))

# set the secret key.  keep this really secret:
app.secret_key = 'A0Zr98j/3yX R~XHH!jmN]LWX/,?RT'

模板简介
其实Jinja 模板和其他语言和框架的模板类似，反正都是通过某种语法将HTML文件中的特定元素替换为实际的值。如果使用过JSP、Thymeleaf 等模板，应该可以非常容易的学会使用 Jinja模板。

其实从上面的例子中我们应该可以看到Jinja 模板的基本语法了。代码块需要包含在{% %}块中，例如下面的代码。

{% extends 'layout.html' %}
{% block title %}主页{% endblock %}
{% block body %}

    <div class="jumbotron">
        <h1>主页h1>
    div>

{% endblock %}

双大括号中的内容不会被转义，所有内容都会原样输出，它常常和其他辅助函数一起使用。下面是一个例子。

<a class="navbar-brand" href={{ url_for('index') }}>Flask小例子a>

继承

模板可以继承其他模板，我们可以将布局设置为父模板，让其他模板继承，这样可以非常方便的控制整个程序的外观。
例如这里有一个base.html模板，它是整个程序的布局文件。

<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>
        {% block title %}

        {% endblock %}
    title>
    <script type="text/javascript" src="https://code.jquery.com/jquery-3.1.1.min.js">script>
    {% block extCSS %}{% endblock %}
head>
<body>
{% block header %}
{% endblock %}

{% block content %}
{% endblock %}

{% block footer %}
{% endblock %}

{% block extJS %}
{% endblock %}
body>
html>

其他模板可以这么写。对比一下面向对象编程的继承概念，我们可以很容易理解。

{% extends 'base.html' %}

{% block extCSS %}
    <link rel="stylesheet" href="/static/css/index.css">
{% endblock %}

控制流

条件判断可以这么写，{% %}中也可以写Python代码。下面是Flask官方文档的例子。

<div class=metanav>
{% if not session.logged_in %}
    <a href="{{ url_for('login') }}">log ina>
{% else %}
    <a href="{{ url_for('logout') }}">log outa>
{% endif %}
div>