Flask二：路由,配置參數,藍圖,特殊裝飾器

時間 2019-11-09

原文原文鏈接

一：Flask 中路由系統

Flask中的路由系統其實咱們並不陌生了,從一開始到如今都一直在應用

@app.route("/",methods=["GET","POST"])

爲何要這麼用?其中的工做原理咱們知道多少?

1.1：@app.route() 裝飾器中的參數

methods : 當前 url 地址,容許訪問的請求方式

@app.route("/info", methods=["GET", "POST"])
def student_info():
    stu_id = int(request.args["id"])
    return f"Hello Old boy {stu_id}"  # Python3.6的新特性 f"{變量名}"

endpoint : 反向url地址,默認爲視圖函數名 (url_for)

from flask import url_for


@app.route("/info", methods=["GET", "POST"], endpoint="r_info")
def student_info():
    print(url_for("r_info"))  # /info
    stu_id = int(request.args["id"])
    return f"Hello Old boy {stu_id}"  # Python3.6的新特性 f"{變量名}"

defaults : 視圖函數的參數默認值{"nid":1}

from flask import url_for


@app.route("/info", methods=["GET", "POST"], endpoint="r_info", defaults={"nid": 100})
def student_info(nid):
    print(url_for("r_info"))  # /info
    # stu_id = int(request.args["id"])
    print(nid)  # 100
    return f"Hello Old boy {nid}"  # Python3.6的新特性 f"{變量名}"

strict_slashes : url地址結尾符"/"的控制 False : 不管結尾 "/" 是否存在都可以訪問 , True : 結尾必須不能是 "/"

# 訪問地址 : /info 
@app.route("/info", strict_slashes=True)
def student_info():
    return "Hello Old boy info"


# 訪問地址 : /infos  or  /infos/
@app.route("/infos", strict_slashes=False)
def student_infos():
    return "Hello Old boy infos"

redirect_to : url地址重定向


# 訪問地址 : /info 瀏覽器跳轉至 /infos
@app.route("/info", strict_slashes=True, redirect_to="/infos")
def student_info():
    return "Hello Old boy info"

@app.route("/infos", strict_slashes=False)
def student_infos():
    return "Hello Old boy infos"

subdomain : 子域名前綴 subdomian="DragonFire" 這樣寫能夠獲得 DragonFire.oldboyedu.com 前提是app.config["SERVER_NAME"] = "oldboyedu.com"


app.config["SERVER_NAME"] = "oldboy.com"

@app.route("/info",subdomain="DragonFire")
def student_info():
    return "Hello Old boy info"

# 訪問地址爲:  DragonFire.oldboy.com/info

1.2：動態參數路由:

from flask import url_for


# 訪問地址 : http://127.0.0.1:5000/info/1
@app.route("/info/<int:nid>", methods=["GET", "POST"], endpoint="r_info")
def student_info(nid):
    print(url_for("r_info",nid=2))  # /info/2
    return f"Hello Old boy {nid}"  # Python3.6的新特性 f"{變量名}"


# <int:nid> 就是在url後定義一個參數接收

# 可是這種動態參數路由,在url_for的時候,必定要將動態參數名+參數值添加進去,不然會拋出參數錯誤的異常

3.路由正則:

通常不用,若是有特殊需求,不怕麻煩的話,這個東西仍是挺好用的,前提是你的正則玩兒的很6

二：實例化Flask的參數及對app的配置

Flask 是一個很是靈活且短小精幹的web框架 , 那麼靈活性從什麼地方體現呢?html

有一個神奇的東西叫 Flask配置 , 這個東西怎麼用呢? 它能給咱們帶來怎麼樣的方便呢?python

首先展現一下:web

from flask import Flask

app = Flask(__name__)  # type:Flask
app.config["DEBUG"] = True

這句 app.config["DEBUG"] = True 能夠實現的功能可刺激了json

代碼只要發生改動,自動重啓Flask程序(app.run)flask

在控制檯打印的信息很是全面瀏覽器

以上兩個功能就是傳說中的 DEBUG 模式(調試模式)緩存

Flask的配置就是在 app.config 中添加一個鍵值對,可是你存進去的鍵必須是config中應該存在的,若是再也不存在的話,它會默認無用,就這麼放着安全

2.1：config參數

config中有多少有用的key 呢?cookie

{
    'DEBUG': False,  
    # 是否開啓Debug模式 
    # 編碼階段,代碼重啓,日誌輸出級別很低,頁面中會顯示錯誤,代碼錯誤
    
    'TESTING': False,  
    # 是否開啓測試模式   交給測試的時候打開
    # 日誌輸出級別較高,無線接近線上環境 ,錯誤不打印在頁面上 不開debug模式就是test模式
    
    
    'PROPAGATE_EXCEPTIONS': None,  # 異常傳播(是否在控制檯打印LOG) 當Debug或者testing開啓後,自動爲True
    'PRESERVE_CONTEXT_ON_EXCEPTION': None,  # 一兩句話說不清楚,通常不用它
    
    'SECRET_KEY': None,  # 以前遇到過,在啓用Session的時候,必定要有它
    "PERMANENT_SESSION_LIFETIME": timedelta(days=31),  # days , Session的生命週期(天)默認31天
    
    'USE_X_SENDFILE': False,  # 是否棄用 x_sendfile
    'LOGGER_NAME': None,  # 日誌記錄器的名稱
    'LOGGER_HANDLER_POLICY': 'always',
    'SERVER_NAME': None,  # 服務訪問域名
    'APPLICATION_ROOT': None,  # 項目的完整路徑
    
    'SESSION_COOKIE_NAME': 'session',  # 在cookies中存放session加密字符串的名字
    
    'SESSION_COOKIE_DOMAIN': None,  # 在哪一個域名下會產生session記錄在cookies中
    'SESSION_COOKIE_PATH': None,  # cookies的路徑  指定在哪一個路徑開啓session
    'SESSION_COOKIE_HTTPONLY': True,  # 控制 cookie 是否應被設置 httponly 的標誌，
    'SESSION_COOKIE_SECURE': False,  # 控制 cookie 是否應被設置安全標誌
    'SESSION_REFRESH_EACH_REQUEST': True,  # 這個標誌控制永久會話如何刷新
    
    'MAX_CONTENT_LENGTH': None,  
    # 若是設置爲字節數， Flask 會拒絕內容長度大於此值的請求進入，並返回一個 413 狀態碼
    
    'SEND_FILE_MAX_AGE_DEFAULT': 12,  # hours 默認緩存控制的最大期限
    
    'TRAP_BAD_REQUEST_ERRORS': False,
    # 若是這個值被設置爲 True ，Flask不會執行 HTTP 異常的錯誤處理，而是像對待其它異常同樣，
    # 經過異常棧讓它冒泡地拋出。這對於須要找出 HTTP 異常源頭的可怕調試情形是有用的。
    
    'TRAP_HTTP_EXCEPTIONS': False,
    # Werkzeug 處理請求中的特定數據的內部數據結構會拋出一樣也是「錯誤的請求」異常的特殊的 key errors 。
    # 一樣地，爲了保持一致，許多操做能夠顯式地拋出 BadRequest 異常。
    # 由於在調試中，你但願準確地找出異常的緣由，這個設置用於在這些情形下調試。
    # 若是這個值被設置爲 True ，你只會獲得常規的回溯。
    
    'EXPLAIN_TEMPLATE_LOADING': False,
    'PREFERRED_URL_SCHEME': 'http',  # 生成URL的時候若是沒有可用的 URL 模式話將使用這個值
    
    'JSON_AS_ASCII': True,
    # 默認狀況下 Flask 使用 ascii 編碼來序列化對象。若是這個值被設置爲 False ，
    # Flask不會將其編碼爲 ASCII，而且按原樣輸出，返回它的 unicode 字符串。
    # 好比 jsonfiy 會自動地採用 utf-8 來編碼它而後才進行傳輸。
    
    'JSON_SORT_KEYS': True,
    #默認狀況下 Flask 按照 JSON 對象的鍵的順序來序來序列化它。
    # 這樣作是爲了確保鍵的順序不會受到字典的哈希種子的影響，從而返回的值每次都是一致的，不會形成無用的額外     HTTP 緩存。
    # 你能夠經過修改這個配置的值來覆蓋默認的操做。但這是不被推薦的作法由於這個默認的行爲可能會給你在性能的代       價上帶來改善。
    
    'JSONIFY_PRETTYPRINT_REGULAR': True,
    'JSONIFY_MIMETYPE': 'application/json', #反扒 經過配置更改
    'TEMPLATES_AUTO_RELOAD': None,
}

2.2：修改配置的方式

以上這些Key,均可以被改寫,固然他們也都是有默認值存在的,若是沒有特殊狀況,不要改寫它的默認值

修改配置的方式大約是兩種

1.直接對app.config進行修改

app.config["DEBUG"] = True


2.使用類的方式導入

首先要有一個settings.py的文件

class FlaskSetting:
    DEBUG = True
    SECRET_KEY = "DragonFire"
而後咱們在Flask的啓動文件中就能夠這麼寫

from flask import Flask


app = Flask(__name__)  # type:Flask
app.config.from_object("settings.FlaskSetting")
這叫作類導入配置

2.3：初始配置

這是針對一個已經實例化的app進行的配置

那麼在Flask實例化的時候,傳遞的參數是什麼鬼呢?

其實能夠理解爲對Flask實例進行的初始配置,這裏面的參數是很是好理解,注意關鍵字是很是很是很是好理解

static_folder = 'static',  # 靜態文件目錄的路徑 默認當前項目中的static目錄
static_host = None,  # 遠程靜態文件所用的Host地址,默認爲空
static_url_path = None,  # 靜態文件目錄的url路徑 默認不寫是與static_folder同名,遠程靜態文件時複用
# host_matching是否開啓host主機位匹配,是要與static_host一塊兒使用,若是配置了static_host, 則必須賦值爲True
# 這裏要說明一下,@app.route("/",host="localhost:5000") 就必需要這樣寫
# host="localhost:5000" 若是主機頭不是 localhost:5000 則沒法經過當前的路由
host_matching = False,  # 若是不是特別須要的話,慎用,不然全部的route 都須要host=""的參數
subdomain_matching = False,  # 理論上來講是用來限制SERVER_NAME子域名的,可是目前尚未感受出來區別在哪裏
template_folder = 'templates'  # template模板目錄, 默認當前項目中的 templates 目錄
instance_path = None,  # 指向另外一個Flask實例的路徑
instance_relative_config = False  # 是否加載另外一個實例的配置
root_path = None  # 主模塊所在的目錄的絕對路徑,默認項目目錄

這裏面,咱們經常使用的參數有session

static_folder = 'static',  # 靜態文件目錄的路徑 默認當前項目中的static目錄
static_url_path = None,  # 靜態文件目錄的url路徑 默認不寫是與static_folder同名,遠程靜態文件時複用
template_folder = 'templates'  # template模板目錄, 默認當前項目中的 templates 目錄

app = Flask(__name__)
template_folder="templatess" # 更改模板存放目錄 默認值是 templates
static_folder="statics",    # 靜態文件存放路徑  默認值是 static
static_url_path="/static"   # 靜態文件訪問路徑 - 默認是 "/"+static_folder
區分 static_folder 和 static_url_path 之間的關係



app = Flask(__name__,template_folder="templatess",static_folder="statics",static_url_path="/statics")
# 備註
# 模板文件名爲 templatess
# 靜態文件名爲 statics
# HTML中的標籤爲 <img src="/statics/1.jpg">

#記住這些就行了,通常的項目中,只修改這些參數

三：藍圖(BluePrint)

3.1：core.py

from flask import Flask,redirect
from settings import DebugSetting
from settings import TestingSetting

# 從blue文件中導入如下三個藍圖
from blue.login import loginapp
from blue.student import studentapp
from blue.studentdetail import studentdetailapp

app = Flask(__name__)
app.config.from_object(DebugSetting)
# app.config.from_object(TestingSetting)

@app.errorhandler(404)
def error404(error_message):
    print(error_message)    
    return redirect("https://passport.lagou.com/lagouhtml/a44.html")

# 把導入的藍圖對象註冊
app.register_blueprint(loginapp)
app.register_blueprint(studentapp)
app.register_blueprint(studentdetailapp)



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

3.2：blue文件

login.py

from flask import Blueprint, request, render_template, session, redirect

loginapp = Blueprint("loginapp", __name__)


@loginapp.before_request
def a():
    print("aaaaa")
    return None


@loginapp.route("/login", methods=["POST", "GET"])
def login():
    if request.method == "GET":
        return render_template("login.html")

    if request.method == "POST":
        username = request.form.get('username')
        password = request.form.get('pwd')
        if username == "123" and password == "456":
            session["username"] = username
            session["password"] = password
            return redirect("/student")
        else:
            return render_template("login.html")

student.py

from flask import Blueprint,request,render_template,session,redirect

studentapp = Blueprint("studentapp",__name__)

STUDENT_DICT = {
    1: {'name': 'Old', 'age': 38, 'gender': '中'},
    2: {'name': 'Boy', 'age': 73, 'gender': '男'},
    3: {'name': 'EDU', 'age': 84, 'gender': '女'},
}


@studentapp.route("/student/")
def student():
    return render_template("student.html",stu_info = STUDENT_DICT)

studentdetail.py

from flask import Blueprint,request,render_template,session,redirect

studentdetailapp = Blueprint("studentdetailapp",__name__)

STUDENT_DICT = {
    1: {'name': 'Old', 'age': 38, 'gender': '中'},
    2: {'name': 'Boy', 'age': 73, 'gender': '男'},
    3: {'name': 'EDU', 'age': 84, 'gender': '女'},
}


@studentdetailapp.route("/student/detail/<int:id>")
def student_detail(id):
    sid = id
    # id  = request.args.get('id')
    # stu_detail = STUDENT_DICT.get(int(id))
    stu_detail = STUDENT_DICT.get(int(sid))
    return render_template("student_detail.html",stu_detail=stu_detail,sid=sid)

3.3：templates文件

login.html

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <title>Title</title>

</head>
<body>
<form action="/login" method="post">
    用戶名：<input type="text" name="username">
    密碼：<input type="password" name="pwd">
    <input type="submit">
</form>


</body>
</html>

student.html

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <title>Title</title>

</head>
<body>
<table border="1px">
    <thead>
    <tr>
        <td>序號</td>
        <td>姓名</td>
        <td>點擊詳情</td>
    </tr>
    </thead>
    <tbody>
    {% for id,info in stu_info.items() %}
        <tr>
            <td>{{ id }}</td>
            <td>{{ info.name }}</td>
            <td><a href="/student/detail/{{ id }}">點擊詳情</a></td>
        </tr>

    {% endfor %}


    </tbody>

</table>


</body>
</html>

student_detail.html

<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <title>Title</title>

</head>
<body>

<table border="1px">
    <thead>
    <tr>
        <td>序號</td>
        <td>姓名</td>
        <td>年齡</td>
        <td>性別</td>
    </tr>
    </thead>
    <tbody>


    {% if stu_detail %}
        <tr>
            <td>{{ sid }}</td>
            <td>{{ stu_detail.name }}</td>
            <td>{{ stu_detail.age }}</td>
            <td>{{ stu_detail.gender }}</td>
        </tr>

    {% endif %}


    </tbody>

</table>


</body>
</html>

3.4：settings.py

class DebugSetting(object):
    DEBUG = True
    SECRET_KEY = "WJJASNA787AS"
    SESSION_COOKIE_NAME = "I am debug session"


class TestingSetting(object):
    TESTING = True
    SECRET_KEY = "iuhasfiuhas"
    SESSION_COOKIE_NAME = "I am Not session"

3.Flask 藍圖 Blueprint
    當成是一個不可以被run的Flask對象
    藍圖中是不存在Config
    
    藍圖須要註冊在 app 實例上的
    
    app.register_blueprint(Blueprint實例)

四：before_request 和 after_request

Flask咱們已經學習不少基礎知識了,如今有一個問題

咱們如今有一個 Flask 程序其中有3個路由和視圖函數,以下:
    
from flask import Flask

app = Flask(__name__)  # type:Flask


@app.route("/login")
def login():
    return "Login"

@app.route("/index")
def index():
    return "Index"

@app.route("/home")
def home():
    return "Login"

app.run("0.0.0.0", 5000)

若是登錄了,就能夠訪問 index 和 home 頁面,若是沒登陸就跳轉到 login 登陸

要怎麼解決呢, session 對, 用 session 除了 Login 函數以外的全部函數裏面全校驗 session 是否登陸了

太麻煩了,如今我們只有3個函數,若是成百上千個怎麼整啊

裝飾器,對沒錯,裝飾器是一個很好的方案,可是啊,我如今仍是成敗上千個函數,我要在每個函數定義的時候加上@裝飾器,仍是很麻煩

那麼就引出了咱們要學習的第一個知識點:

4.1：@app.before_request

1.@app.before_request 在請求(request)進入視圖函數以前執行

from flask import Flask
from flask import request
from flask import redirect
from flask import session

app = Flask(__name__)  # type:Flask
app.secret_key = "DragonFire"


@app.before_request
def is_login():
    if request.path == "/login":
        return None

    if not session.get("user"):
        return redirect("/login")


@app.route("/login")
def login():
    return "Login"


@app.route("/index")
def index():
    return "Index"


@app.route("/home")
def home():
    return "Login"


app.run("0.0.0.0", 5000)

@app.before_request 也是一個裝飾器,他所裝飾的函數,都會在請求進入視圖函數以前執行

request.path 是來讀取當前的url地址若是是 /login 就容許直接經過 return None 你能夠理解成經過放行

校驗session中是否有user 若是沒有的話,證實沒有登陸,因此絕不留情的 redirect("/login") 跳轉登陸頁面

還有一個要提的 @app.before_first_request 它與 @app.before_request 極爲類似或者說是如出一轍,只不過它只會被執行一次

4.2：@app.after_request

2. @app.after_request 在響應(response)返回客戶端以前執行 , 結束視圖函數以後

@app.after_request
def foot_log(environ):
    if request.path != "/login":
        print("有客人訪問了",request.path)
    return environ

#不多應用,可是要了解有這麼個東西

4.Flask 特殊裝飾器
    1.before_request 請求進入進入視圖函數以前進行處理 return None 繼續執行 不然阻斷
    2.after_request 視圖函數結束 響應客戶端以前
    正常週期: be1 - be2 - be3 - vf - af3 - af2 - af1
    異常週期: be1 - af3 - af2 - af1