1. 程式人生 > >32、Flask實戰第32天:優化json數據的返回

32、Flask實戰第32天:優化json數據的返回

新建 地方 必須 密碼錯誤 login form image 返回 定義

接著上節,我們通過jsonify返回json數據非常方便

... 
return jsonify({"code": 400, "message": message})

返回什麽數據則是公司接口編寫的規範

返回值的規範(就算值為空,我們也必須返回以下字段)

{
  "code": 200,   #狀態碼
  "message": "",  #信息提示
  "data": {},  #返回的數據,比如文章列表等等
}

狀態碼的規範

200:成功
401:沒有授權
400:參數錯誤
500:服務器錯誤

前面,我們每一次返回json數據需要寫一串"jsonify({"code": 400, "message": message})

"這樣很麻煩,二期項目後期可能還有很多地方需要返回json。因此我們可以把它抽取出來進行封裝成一個工具

1、先在項目下面建一個python package命名為utils(工具包,以後項目的工具都寫在這裏面)

2、在utils.py下新建restful.py

from flask import jsonify


class HttpCode(object):
    ok = 200,
    unauth_error = 401
    param_error = 400
    server_error = 500

def resetful_result(code, message, data):
    
return jsonify({"code": code, "message": message, "data":data or {}})

這樣,我們就可以在視圖返回json的時候這樣用:

from utils import restful
...
return restful.resetful_result(code=200, message=‘‘, data={})

但是這樣依然不夠方便,我們還是需要加上3個參數。因此我們繼續改造resetful.py

from flask import jsonify


class HttpCode(object):
    ok 
= 200, unauth_error = 401 param_error = 400 server_error = 500 def resetful_result(code, message, data): return jsonify({"code": code, "message": message, "data":data or {}}) def success(message="", data=None): return resetful_result(code=HttpCode.ok, message=message, data=data) def unauth_error(message="", data=None): return resetful_result(code=HttpCode.param_error, message=message, data=data) def param_error(message="", data=None): return resetful_result(code=HttpCode.param_error, message=message, data=data) def server_error(message="", data=None): return resetful_result(code=HttpCode.server_error, message=message, data=data)

這樣,我們只要根據不同的情況使用定義好的函數就行了。

參數: code(已經不用自己傳了),message(成功的狀態下可以不傳,默認為空),data(沒有傳此參數,也會自動為空字典))

把上節內容的代碼,可以寫成如下:

from utils import restful
...

class ResetPwdView(views.MethodView):
    decorators = [login_required]  #修改密碼也要先登錄,這是類視圖使用裝飾器
    def get(self):
        return render_template(cms/cms_resetpwd.html)

    def post(self):
        resetpwd_form = ResetPwdForm(request.form)
        if resetpwd_form.validate():
            oldpwd = resetpwd_form.oldpwd.data
            newpwd = resetpwd_form.newpwd.data
            user = g.cms_user
            if user.check_password(oldpwd):
                user.password = newpwd
                db.session.commit()
                return restful.success()  #可以什麽都不傳
            else:
                return restful.unauth_error(原密碼錯誤)  #只第一個參數message
        else:
            message = resetpwd_form.get_error()
            return restful.param_error(message)  #只第一個參數message

技術分享圖片

32、Flask實戰第32天:優化json數據的返回