【Python】基於Flask框架開發在線問答社區(一)
本教程也是作者自學flask框架時的筆記,將隨着本人的學習過程持續更新,直至搭建起一個類似於知乎的在線問答社區。
本文主要介紹flask框架的基本使用。
Flask簡介
Flask是一個使用 Python 編寫的__輕量級 Web 應用框架__。其 WSGI 工具箱採用 Werkzeug ,模板引擎則使用 Jinja2 。Flask使用 BSD 授權。Flask也被稱爲 “microframework”,即微框架 ,因爲它使用簡單的核心,用 extension 增加其他功能。
Flask的安裝
pip install flask
關於flask的具體安裝教程,可以國內知名搜索信息服務提供商baidu.com發起業務諮詢。(自行百度安裝)
Linux環境下的配置與運行
export FLASK_APP={python文件}
export FLASK_ENV={development/production}
flask run
Windows環境下的配置與運行
在代碼中加入以下代碼:
if __name__ == '__main__':
app.run()
動態路由的類型
@app.route('/user/<username>')
def show_user_profile(username):
# 顯示用戶名
return 'User {}'.format(username)
@app.route('/post/<int:post_id>')
def show_post(post_id):
# 顯示提交整型的用戶"id"的結果,注意"int"是將輸入的字符串形式轉換爲整型數據
return 'Post {}'.format(post_id)
@app.route('/path/<path:subpath>')
def show_subpath(subpath):
# 顯示 /path/ 之後的路徑名
return 'Subpath {}'.format(subpath)
#路由路徑後帶不帶/的區別
@app.route('/projects/')
def projects():
return 'The project page'
#說明:重路由鏈接帶/,訪問 url/projects 和 url/projects/ 都不會出錯
@app.route('/about')
def about():
return 'The about page'
#說明:重路由不帶鏈接/,訪問 url/about 沒問題,但是訪問 url/about/ 會報Not Found
#HTTP方法的區別
@app.route('/login', methods=['GET', 'POST'])
#可以用methods方法指定http方法,例如GET,POST,HEAD,PUT
def login():
if request.method == 'POST':
do_the_login() # 如果是 POST 方法就執行登錄操作
else:
show_the_login_form() # 如果是 GET 方法就展示登錄表單
類型 | 含義 |
---|---|
string | 默認的數據類型,接受沒有任何斜槓“/”的字符串 |
int | 接受整型 |
float | 接受浮點類型 |
path | 和 string 類似,但是接受斜槓“/” |
uuid | 只接受 uuid 字符串 |
可以用__<type:varname>__來指定路由的類型
靜態文件渲染與模板
from flask import Flask, render_template
app = Flask(__name__)
#該代碼說明,可以使用多個route
@app.route('/hello/')
@app.route('/hello/<name>')
def hello(name=None): # 默認 name 爲 None
return render_template('hello.html', name=name) # 將 name 參數傳遞到模板變量中
其中文件的佈局hello.css
和hello.html
文件存放的位置如下:
/hello.py
/templates
/hello.html
/static
/hello.css
也即,html
文件應該存放在templates
,而css
文件應該存放在static
文件中。
其中html文件中是可以寫一些簡單的代碼,如同jsp
如下:
<!doctype html>
<title>Hello from Flask</title>
{% if name %} <!-- 如果 name 不爲空則將 name 渲染出來 -->
<h1>Hello {{ name }}!</h1>
{% else %} <!-- 如果 name 爲空則打印 Hello World! -->
<h1>Hello World!</h1>
{% endif %}
代碼用{% xxx %}
來裝起來
請求對象
使用request可以訪問請求對象的內容
from flask import request
@app.route('/login', methods=['POST', 'GET'])
def login():
error = None
if request.method == 'POST':
if valid_login(request.form['username'],
request.form['password']):
return log_the_user_in(request.form['username'])
else:
error = 'Invalid username/password'
# 當請求形式爲“GET”或者認證失敗則執行以下代碼
return render_template('login.html', error=error)
#使用如下代碼可以獲取get方法中的參數?value=xxxxx
searchword = request.args.get('key', '')
文件上傳
from flask import request
from werkzeug import secure_filename
#此命令可以配置文件上傳的位置
app.config['UPLOAD_FOLDER'] = UPLOAD_FOLDER
@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))
#使用secure_filename避免出現安全問題
Cookies
注意:如果你要使用會話(sessions
),請不要直接使用 cookies
,相反,請用 Flask 中的會話,因爲Flask 已經在cookies
上增加了一些安全細節;
讀取cookies
關鍵代碼
request.cookies.get('cookies_name')
示例
from flask import request
@app.route('/')
def index():
username = request.cookies.get('username')
# 注意這裏引用cookies字典的鍵值對是使用cookies.get(key)
# 而不是cookies[key],這是防止該字典不存在時報錯"keyerror"
存儲cookies
示例:
from flask import make_response
@app.route('/')
def index():
resp = make_response(render_template(...))
resp.set_cookie('username', 'the username')
return resp
綜合示例:
@app.route('/index')
def index():
username=request.cookies.get('username')
if username==None:
resp = make_response("Hello Eric")
resp.set_cookie('username', 'Eric')
return resp
else:
return username
重定向
from flask import Flask
from flask import abort, redirect, url_for
app = Flask(__name__)
@app.route('/')
def index():
#redirect() 命令可以得到重定向,利用url_for函數得到的login函數的路由地址
return redirect(url_for('login'))
@app.route('/baidu')
def baidu():
#也可以直接重路由到一個http地址中
return redirect("http://www.baidu.com")
@app.route('/login')
def login():
abort(401)
this_is_never_executed()
裝飾器
from flask import render_template
#裝飾了error401的返回界面
@app.errorhandler(401)
def page_not_found(error):
return render_template('page_not_found.html'), 404#函數末尾帶有響應值,404就是頁面沒有找到,如果不寫就是默認200
會話
首先需要簡單介紹一下會話的機制
Session主要可以實現會話身份識別。首先,用戶端向服務端發送一個請求,服務端接收到請求後,初始化會話,生成相應的會話信息,核心是會話ID,把會話ID發送給客戶端,客戶端接收到這個會話ID,把它存儲起來,下一次發送請求的時候,附帶着這個會話ID一起發送給服務端,服務端只要根據這個會話ID,就知道是誰了。這個會話ID,就像我們的身份證號碼,一直伴隨終生。客戶端的會話ID可以通過Cookies來存儲,也可能存儲在url中,但這不安全
- 利用flask框架使用會話需要設置
secret_key
from flask import Flask, session, redirect, url_for, escape, request
app = Flask(__name__)
# 設置密鑰,保證會話安全
# 會話安全的關鍵在於有一個好的密匙
app.secret_key = '_5#y2L"F4Q8z\n\xec]/'
@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 '''
<form method="post">
<p><input type=text name=username>
<p><input type=submit value=Login>
</form>
'''
@app.route('/logout')
def logout():
# 如果用戶名存在,則從會話中移除該用戶名
session.pop('username', None)
return redirect(url_for('index'))
消息閃爍:flash
Flask 提供了一個真正的簡單的方式來通過消息閃現系統給用戶反饋。消息閃現系統基本上使得在請求結束時記錄信息並在下一個 (且僅在下一個)請求中訪問。通常結合模板佈局來顯示消息。
使用flash()
方法來閃現一個消息,使用get_flashed_messages()
能夠獲取消息,get_flashed_messages()
也能用於模板中。
from flask import Flask, flash, redirect, render_template, \
request, url_for
app = Flask(__name__)
app.secret_key = b'_5#y2L"F4Q8z\n\xec]/'
@app.route('/')
def index():
return render_template('index.html')
@app.route('/login', methods=['GET', 'POST'])
def login():
error = None
if request.method == 'POST':
if request.form['username'] != 'admin' or \
request.form['password'] != 'secret':
error = 'Invalid credentials'
else:
flash('You were successfully logged in')
return redirect(url_for('index'))
return render_template('login.html', error=error)
(未完待續)