Python物件轉json【包括巢狀物件轉json,django的model轉json】
背景:
給app寫介面時經常會遇到將一個model轉為json返回。
問題:
網上也有類似方法,只是搜尋結果多少有些問題,總是搜了好一會兒才找到合適的方法,另外,網上更多集中的只是簡單些的物件,對於複雜的物件,還是不容易找到好的方式。
方案(python3.6):
1物件轉json:
model類
class People():
def __init__(self, name, age, pet):
self.name = name
self.age = age
self.pet = pet
class Pet():
def __init__(self, pet_type, pet_name):
self.pet_type = pet_type
self.pet_name = pet_name
將Pet物件轉json:
import json
def pet2json():
pet = Pet('Cat', 'Lili')
js = json.dumps(pet.__dict__)
print(js)
結果:{“pet_type”: “Cat”, “pet_name”: “Lili”}
小結:充分利用了Python物件的dict
2巢狀物件轉json:
剛才的People類可看做是巢狀類,即有一個屬性是另一個類的例項,此時,若用上面的方法來json化Person物件,會有問題,如下【錯誤】:
def simple_person():
pet = Pet('Cat', 'Lili')
p = People('Xiaoming', 12,pet)
json_data = json.dumps(p.__dict__)
print(json_data)
結果:報異常TypeError: Object of type ‘Pet’ is not JSON serializable
原因:json只能針對JSON serializable物件直接進行json化,而一般只有內建的型別,比如string,int,list和dict等才能直接序列化,程式碼中p._ dict _是個dict型別,但是其pet屬性仍是自定義的類,是不能直接json化的。
解決方式【正確】:
def simple_person():
pet = Pet('Cat', 'Lili')
p = People('Xiaoming', 12,pet.__dict__)
json_data = json.dumps(p.__dict__)
print(json_data)
結果:{“name”: “Xiaoming”, “age”: 12, “pet”: {“pet_type”: “Cat”, “pet_name”: “Lili”}}
小結:充分利用_ dict _方法。
3django的model轉json:
首先有個model類
class Person(models.Model):
name = models.CharField(max_length=50, null=False)
age = models.IntegerField(default=0)
pid = models.CharField(max_length=20, unique=True)
gender = models.IntegerField(default=0)
針對該Person類,有兩種常見情況需要提供其json:
1:根據pid查詢person記錄;
2:根據某些條件,查詢一些person記錄。
此時資料庫裡已經插入了一些資料
這裡要提一下網上比較常見的一種方式,需要用到django.core.serializers,這個類的serialize(format, queryset, **options)方法,很明顯,這個方式只能作用與queryset格式,並且通過例子(不再列出),得到的結果類似這種 [{“model”: “polls.person”, “pk”: 2, “fields”: {“name”: “Cysion”, “age”: 29, “pid”: “3708261989”, “gender”: 0}}],出現了model,pk,field等屬性,不但用不到(對app來說),而且還增加了其它屬性的使用複雜度。這個在官網的說明文件裡也是如此處理,但是作者並不推薦。
方案:
我們還是使用_ dict _這個利器,首先,我們根據pid獲得一個Person物件,然後利用dict方法列印看看結果(錯誤)
req_pid=3708262007//request中得到
try:
rt = Person.objects.get(pid=req_pid)
print(rt.__dict__)
return HttpResponse(json.dumps(rt.__dict__),content_type='application/json')
# return JsonResponse(rt.__dict__, safe=False)//另一種方式
except:
return JsonResponse(datalogic.get_comon_resp(1, '沒有查詢到對應資料'))
結果是:print結果{‘_state’: < django.db.models.base.ModelState object at 0x0000000004C80860 >, ‘id’: 17, ‘name’: ‘zhaoliu’, ‘age’: 10, ‘pid’: ‘3708262007’, ‘gender’: 1},嘖嘖,又多了些屬性,特別是這個_state,是不能序列化的,所以上述並不能直接返回想要的結果。
作者:劉鹹尚
解決方式:既然_state無用,且影響了結果,那我們直接臨時除去,不就返回了想要的結果嗎(正確)。
req_pid = request.POST.get('pid')
try:
rt = Person.objects.get(pid=req_pid)
rt.__dict__.pop("_state")
return JsonResponse(rt.__dict__, safe=False)
except:
return JsonResponse(datalogic.get_comon_resp(1, '沒有查詢到對應資料'))
介面返回結果是:
{
"id": 17,
"name": "zhaoliu",
"age": 10,
"pid": "3708262007",
"gender": 1
}
正是客戶端需要的。
最後,是返回列表的,比如需要這種結果
{
"code": 0,
"msg": "成功",
"data": [
{
"id": 2,
"name": "Cysion",
"age": 29,
"pid": "3708261989",
"gender": 0
},
{
"id": 11,
"name": "Sophia",
"age": 22,
"pid": "3708261998",
"gender": 1
},
{
"id": 15,
"name": "lisi",
"age": 13,
"pid": "3708262005",
"gender": 0
}
]
}
實現思路同上面類似,首先資料庫查詢後得到QuerySet,其不能直接json化(通過serializer得到的不好看,也不好處理,大量的屬性處理還比較費勁),需要將其遍歷得到每個物件,然後將其屬性字典加入到list中,最後將其新增到通用dict中
pers = Person.objects.all()
result = {"code":0,"msg":"成功"}
L = []
for p in pers:
p.__dict__.pop("_state")//需要除去,否則不能json化
L.append(p.__dict__)//注意,實際是個json拼接的過程,不能直接新增物件
result ['data'] = L
這個時候result 就是個可以直接json化的物件了,通過
return JsonResponse(result, safe=False)
可以返回上面需要的結果。
主要提供了思路,詳細程式碼就不提供了。