Django - 如何使用rest framework的serializer给前端datatable返回数据

问题背景

笔者需要在前端显示数据库中一条记录的详细信息,使用datatable按照表格的方式进行展现。如下图所示, 用户在输入一本书的ISBN号码以及UUID之后,点击“OK”按键,后台在执行对应操作之后, 前端会显示对应书籍的详细信息, 以表格的形式呈现。 比如图中的《JavaScript高级程序设计》书籍信息。

前端效果
API格式定义

后端在接受到前端的请求之后,以JSON格式返回信息给前端,数据格式如下:

{
  "status":value,
  "msg": value,
  "bindbook":value,
}

前端datatable的定义如下:

 $("#sample_1").dataTable(
                    { 
                        searching : false,
                        destroy : true,
                        "processing" : true,
                        "serverSide" : false,
                        "autoWidth" : false,
                        "bLengthChange" : false,
                        "ajax": {
                                "url": "#",
                                "dataSrc": "bindbook",
                                "type": "POST",
                                "data": function (d) {
                                    d.isbn=document.getElementById('id_isbn').value;
                                    d.uuid=document.getElementById('id_uid').value
                                },
                                dataFilter:function(data,json){
                                     r = JSON.parse(data)
                                     if (r.status == "OK"){
                                        console.log("信息添加成功");
                                     }else{
                                        console.log(r.msg);
                                     }
                                     $("#id_querylibbookForm")[0].reset();
                  
                                     return data;
                                }                                

                        },
                        "columns": [
                            { data: 'name' },
                            { data: 'isbn' },
                            { data: 'author' },
                            { data: 'press' },
                            { data: 'price' },
                            { data: 'totalAmount' },
                            { data: 'outAmount' },
                            { data: 'totalOutAmount' },
                            { data: 'totalBrokenAmount' }
                        ],                                               
                    });
                });

我们在前端datatable中定义的dataSrc 指定为返回数据中的bindbook field。
Django 后台代码如下:

status = ''
msg = ''
r = []
if form.is_valid():
    isbn = form.cleaned_data['isbn']
    uid  = form.cleaned_data['uuid']

    status = "OK"
    msg = "Bind book success !!"
    book = libraryBookImport(isbn, uid)
    serializer = BooklistSerializer(book)

    resp = {
    'status': status,
    'msg': msg,
    'bindbook': serializer.data,
    }

    return HttpResponse(json.dumps(resp), content_type="application/json")
问题: datatable无法正确显示后台返回的数据
问题分析

经过调试发现,如果后端返回的是多个数据项,前端就能正常显示。返回多个数据的代码如下:

serializer=BooklistSerializer(book.objects.all(), many=True)

那么看一下这两种情况下生成的json数据有什么不同

  • 返回一条数据
{
    "status": "",
    "msg": "",
    "bindbook": {
        "name": "\u9c7c\u7f8a\u91ce\u53f2\u00b7\u7b2c3\u5377",
        "isbn": 9787513905817,
        "author": "\u9ad8\u6653\u677e",
        "press": "\u6c11\u4e3b\u4e0e\u5efa\u8bbe\u51fa\u7248\u793e",
        "price": 3979,
        "totalAmount": 25,
        "outAmount": 0,
        "totalOutAmount": 1,
        "totalBrokenAmount": 0,
        "cover": "/media/lpic/default_cover.jpg"
    }
}
  • 返回多条数据
{
    "status": "",
    "msg": "",
    "bindbook": [{
        "name": "\u4f1a\u5458\u5361",
        "isbn": 0,
        "author": "\u53ee\u549a\u56fe\u4e66",
        "press": "\u53ee\u549a\u56fe\u4e66",
        "price": 1980,
        "totalAmount": 0,
        "outAmount": 0,
        "totalOutAmount": 0,
        "totalBrokenAmount": 0,
        "cover": "/media/lpic/default_cover.jpg"
    }, {
        "name": "JavaScript\u9ad8\u7ea7\u7a0b\u5e8f\u8bbe\u8ba1",
        "isbn": 9787115275790,
        "author": "[\u7f8e]",
        "press": "\u4eba\u6c11\u90ae\u7535\u51fa\u7248\u793e",
        "price": 9900,
        "totalAmount": 1,
        "outAmount": 0,
        "totalOutAmount": 5,
        "totalBrokenAmount": 0,
        "cover": "/media/lpic/default_cover.jpg"
    }]
}

仔细观察了这两个数据, 在bindbook域,一条数据的时候缺一个中阔号[ ]

解决办法

将后台代码改为

r=[]
serializer = BooklistSerializer(book)
r.append(serializer.data)

前端datatable就能正常显示了。

结语

关于django-rest-framework的serializer的传送门其实也有体现两者的区别:

  • 官网介绍单个object序列化
serializer = CommentSerializer(comment)
serializer.data
# {'email': 'leila@example.com', 'content': 'foo bar', 'created': '2016-01-27T15:17:10.375877'}
  • 官网介绍多个object序列化
queryset = Book.objects.all()
serializer = BookSerializer(queryset, many=True)
serializer.data
# [
#     {'id': 0, 'title': 'The electric kool-aid acid test', 'author': 'Tom Wolfe'},
#     {'id': 1, 'title': 'If this is a man', 'author': 'Primo Levi'},
#     {'id': 2, 'title': 'The wind-up bird chronicle', 'author': 'Haruki Murakami'}
# ]

这个小问题卡了好久,真是书到用时方恨少。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,122评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,070评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,491评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,636评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,676评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,541评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,292评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,211评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,655评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,846评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,965评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,684评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,295评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,894评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,012评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,126评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,914评论 2 355

推荐阅读更多精彩内容