從零開始用 Flask 搭建一個網(wǎng)站（四）

CarterLi 發(fā)布于2019-05-29 17:51 / 2235人閱讀

摘要：前言從零開始用搭建一個網(wǎng)站三介紹了網(wǎng)頁前端與后端前端與前端之間數(shù)據(jù)的交流。作者極光為極光團(tuán)隊(duì)賬號，歡迎關(guān)注原文從零開始用搭建一個網(wǎng)站四知乎專欄極光日報(bào)

前言

從零開始用 Flask 搭建一個網(wǎng)站（三）介紹了網(wǎng)頁前端與后端、前端與前端之間數(shù)據(jù)的交流。本節(jié)主要介紹一下如何應(yīng)用 Flask-OAuthlib，使用 Flask-OAuthlib 就可以輕松地請求第三方應(yīng)用提供的 API 。 GitHub 上 example 給出了一些如何使用的簡單例子，但是就實(shí)際運(yùn)用來說還有需要注意的地方。

安裝與初始化

在終端中使用命令：

pip install Flask-OAuthlib

或者：

easy_install Flask-OAuthlib

就可以完成自動安裝。在項(xiàng)目中初始化 oauth 也是比較簡單的，以 QQ 為例：

from flask_oauthlib.client import OAuth

app = Flask(__name__)
oauth = OAuth(app)

qq = oauth.remote_app(   
   "qq",    
  consumer_key=QQ_APP_ID,    
  consumer_secret=QQ_APP_KEY,    
  base_url="https://graph.qq.com",    
  request_token_url=None,    
  request_token_params={"scope": "get_user_info"},    
  access_token_url="/oauth2.0/token",    
  authorize_url="/oauth2.0/authorize",
)

需要注意的是 consumer_key 以及 consumer_secret ，這兩個要替換成自己在第三方提供者中申請的應(yīng)用的 App_ID 以及 App_Key 。如果是生產(chǎn)環(huán)境，通常要把這兩個參數(shù)放到環(huán)境變量中。其他的參數(shù)值在第三方的開發(fā)者文檔中都有提供。另外這個 scope 字段的值表明了在應(yīng)用中你請求的 token 的實(shí)際使用權(quán)限，上面的權(quán)限僅僅是 get_user_info 。這個范圍可以視自己的需求而定。

請求數(shù)據(jù)

首先來介紹一下第三方登錄，在點(diǎn)擊登錄后，登錄按鈕觸發(fā)的視圖函數(shù)如下：

@main.route("/login")
def login():    
    return qq.authorize(callback=url_for("main.authorized", _external=True))

這個 authorize 函數(shù)會發(fā)送一個請求，跳轉(zhuǎn)到第三方登錄界面，用戶登錄完成后，將會回調(diào)傳遞的 Url ，返回一個帶授權(quán) token 的響應(yīng)：

@main.route("/login/authorized")
def authorized():    
    resp = qq.authorized_response()    
    if resp is None:        
        return "Access denied: reason=%s error=%s" % (            
            request.args["error_reason"],            
            request.args["error_description"]        
        )    
    session["qq_token"] = (resp["access_token"], "")

這里把 token 存儲在 session 中，方便下次使用。使用 OAuthlib 可以發(fā)起 Http 請求，比如 GET 請求：

respMe = qq.get("/oauth2.0/me", {"access_token": session["qq_token"][0]})

這里傳了一個 access_token 參數(shù)，需要注意的是這個 token 是一個元組：（“ token ”, ""），第二個元素為空。在使用這些 Http 請求時(shí)，如果沒有帶上 token ，必須使用 oauthlib 提供的 tokengetter 修飾器定義一個返回 token 的函數(shù)：

@qq.tokengetter
def get_qq_oauth_token():    
    return session.get("qq_token")

這里返回的 token 也是一個元組，而不是字符串。在定義了獲取 token 的函數(shù)后，就可以不帶 access_token 參數(shù)了， oauthlib 將會自動調(diào)用這個函數(shù)得到 token 。比如：

response = github.get("user")
username = response.data["login"]

如果要在請求中傳遞數(shù)據(jù)，可以這樣：

data_dict = {
    "name": "web",             
    "active": True,             
    "events": [                 
        "push",                 
        "commit_comment",                 
        "pull_request",                 
        "issues",                 
        "issue_comment"             
    ],             
    "config": {                
        "url": "http://your webhook",                 
        "content_type": "json"             
    }
}
response = github.post("https://api.github.com/repos/{user}/{repo}/hooks", data=data_dict, format="json")

上面是 github 中創(chuàng)建 Webhook 的示例，在 data 中傳遞了一個字典，這個字典將會被解析為 Json 對象并被保留在請求的 body 中。 OAuthlib 0.9.3 版本除了 GET 請求以外必須攜帶一個 data ，這是一個已知的 bug。這里筆者使用的版本是 0.9.2 。

以上就是關(guān)于 OAuthlib 使用的講解。到此為止，我們一起學(xué)習(xí)了如何從零開始用 Flask 搭建了一個網(wǎng)站，我們的網(wǎng)址是： http://jbox.jiguang.cn/ 一個極光寶盒控制臺，可以用來集成第三方應(yīng)用，并及時(shí)在手機(jī)上收到推送。比如使用使用極光寶盒集成一個 GitHub 應(yīng)用，這樣就可以監(jiān)聽自己以及團(tuán)隊(duì)的倉庫，在別人提交 commit 或者 issue 后，可以及時(shí)反饋到手機(jī)上；也可以是自定義的集成，用于小組之間會議通知，活動通知等等。我們后續(xù)也會推出更多的第三方集成，感謝大家一直以來的支持，我們的源碼在 GitHub 上。

作者： KenChoi - 極光（ JPush 為極光團(tuán)隊(duì)賬號，歡迎關(guān)注）

原文：從零開始用 Flask 搭建一個網(wǎng)站（四）

知乎專欄：極光日報(bào)