flask jsonify之序列化時的default函數、jsonify序列化自定義對象

 


1.看源碼

打開site-package,flask,json,__init__.py

jsonify回去調用default()函數,我們最關心的就是重寫default方法

我們是不是調用jsonify就一定會調用default呢?答案:不是!

發現如上圖所示,並沒有進入jsonify的default方法裏,而是直接把字典給序列化出來了。

那麼什麼時候會調用default呢?

結論:如果flask知道如何序列化你傳入進來的數據結構的時候,是不會調用default,因爲知道如何序列化就直接幫我們序列化了,但是如果我們要序列化一個對象,是我們的user模型,flask默認是不知道怎麼去序列化這個模型的,那麼就會去調用default函數,爲什麼會這樣的,原因就在於flask不知道怎麼序列化,但是它會給我們一個途徑,讓我們來指明這個數據結構應該怎麼序列化,換句話說,default函數最主要的就是我們需要在內部把不能序列化的結構轉化爲可以序列化的結構,比如我們傳入進來的是一個user,user是不能序列化的,但是如果我們可以把user轉化成字典,字典是可以序列化的,那麼這樣就能完成user對象的序列化了,雖然user作爲一個模型他不能序列化,但是我們可以把他的信息讀取出來,轉化爲一個字典,從而保證我們整個序列化的成功執行。可以看到default裏面的源碼,傳入的user對象既不是datetime也不是date、uuid.UUID、__html__,所以最後會拋出一個異常

所以我們要在default中把不能序列化的user轉化成可以序列化的格式。

所以我們繼承,然後重寫default方法,在重寫的函數中實現user的可序列化就OK了

2、重寫默認的default函數,實現自己的序列化機制

我們不要直接修改源碼,要在外部繼承JSONEncoder,然後在用自己的方法覆蓋原來的default方法。

  1.  
    from flask import Flask, jsonify
  2.  
    class hehe:
  3.  
    name = 'zhangsan'
  4.  
    age = 18
  5.  
     
  6.  
    app = Flask(__name__)
  7.  
    ctx = app.app_context()
  8.  
    ctx.push()
  9.  
    # 上面是解決上下文對象的異常RuntimeError: Working outside of application context.
  10.  
     
  11.  
    a = hehe()
  12.  
    print(a)
  13.  
    jsonify(a) # TypeError: Object of type 'hehe' is not JSON serializable

可以看到上圖代碼報錯不能序列化a對象,所以我們要在外部繼承JSONEncoder,然後在用自己的方法覆蓋原來的default方法。

可以看到即使按照上圖所示寫,flask還是沒有調用我們自己定義的default,所以我們還要在flask裏面替換一下

  1.  
    from flask import Flask as _Flask, jsonify
  2.  
    from flask.json import JSONEncoder as _JSONEncoder
  3.  
     
  4.  
     
  5.  
    class JSONEncoder(_JSONEncoder):
  6.  
     
  7.  
    def default(self, o):
  8.  
    pass
  9.  
     
  10.  
     
  11.  
    class Flask(_Flask):
  12.  
    json_encoder = JSONEncoder
  13.  
     
  14.  
     
  15.  
    class hehe():
  16.  
    name = 'zhangsan'
  17.  
    age = 18
  18.  
     
  19.  
     
  20.  
    app = Flask(__name__)
  21.  
    ctx = app.app_context()
  22.  
    ctx.push()
  23.  
    # 上面是解決上下文對象的異常RuntimeError: Working outside of application context.
  24.  
     
  25.  
    a = hehe()
  26.  
    print(a)
  27.  
     
  28.  
    jsonify(a) # 不報錯了

可以看到flask把我們實例化的hehe類當做參數o傳遞了進來,有兩個屬性

3、把對象轉化成字典

3.1 __dict__的方式

現在我們要把對象轉化成字典,因爲字典是可以被序列化的, 但是對象不行。我們想到了對象的__dict__內置方法,但是發現沒有得到任何的結果,輸出的是一個空的json對象。

這是因爲我們在hehe類裏面定義的是類的變量而不是實例的變量。類的變量是不會被存放到對象的__dict__當中的。所以加入一個實例變量的時候就有值了(如下圖)

所以我們看到這種方式是可以的,但是我們想把無論類變量還是實例變量都像把它直接序列化,我們就需要用下面的方法把所有的都轉成字典

3.2、定義keys和__getitem__的方式

python 對象轉字典及序列化對象相關問題,__dict__!!!!必看,多坑

  1.  
    class D:
  2.  
    name = 'zhangsan'
  3.  
    age = 18
  4.  
     
  5.  
    def __init__(self):
  6.  
    self.sex = '男'
  7.  
     
  8.  
    def keys(self):
  9.  
    return ('name', 'sex')
  10.  
     
  11.  
    def __getitem__(self, item):
  12.  
    return getattr(self, item)
  13.  
     
  14.  
     
  15.  
    d = D()
  16.  
    print(d.__dict__) # {'sex': '男'}
  17.  
    print(dict(d)) # {'name': 'zhangsan', 'sex': '男'} 如果註銷了getitem方法就會報錯TypeError: 'D' object is not iterable

4、最終的代碼實現

  1.  
    from flask import Flask as _Flask, jsonify
  2.  
    from flask.json import JSONEncoder as _JSONEncoder
  3.  
     
  4.  
     
  5.  
    class JSONEncoder(_JSONEncoder):
  6.  
    def default(self, o):
  7.  
    if hasattr(o, 'keys') and hasattr(o, '__getitem__'):
  8.  
    print(dict(o))
  9.  
    else:
  10.  
    print("不能序列化對象")
  11.  
     
  12.  
     
  13.  
    class Flask(_Flask):
  14.  
    json_encoder = JSONEncoder
  15.  
     
  16.  
     
  17.  
    class hehe:
  18.  
    name = 'zhangsan'
  19.  
    age = 18
  20.  
     
  21.  
    def __init__(self):
  22.  
    self.sex = '男'
  23.  
     
  24.  
    def keys(self):
  25.  
    return ('name', 'sex')
  26.  
     
  27.  
    def __getitem__(self, item):
  28.  
    return getattr(self, item)
  29.  
     
  30.  
     
  31.  
    app = Flask(__name__)
  32.  
    ctx = app.app_context()
  33.  
    ctx.push()
  34.  
    # 上面是解決上下文對象的異常RuntimeError: Working outside of application context.
  35.  
    a = hehe()
  36.  
    print(a) # <__main__.hehe object at 0x7f0aed3e1e10>
  37.  
    jsonify(a) # {'name': 'zhangsan', 'sex': '男'}

5、關於default函數的其他知識

default函數是被遞歸調用的,之所以我們沒看到被遞歸調用是因爲我們定義的類都太簡單了,如果對象下面的某個屬性是另外一個對象的情況

只要遇到不能序列化的對象,都會傳入default裏面讓我們來解決,

例如下面所示default調用了兩次:

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章