Emberjs中JSONAPISerializer的常用API

2019-07-12 admin

Emberjs 默认使用 JSONAPISerializer ,在我们的项目中也是使用JSONAPISerializer.所以只是涉及关于 JSONAPISerializer 的相关内容。 @[TOC]

前后端通信协议

在目前的版本中,后端我们使用 大驼峰法命名,但是前端基本使用都是 驼峰法,导致有所差异,在数据获取展示过程中,需要统一 key 的名称。这时就可以使用 keyForAttribute 这个方法来实现我们的需求,比如:

//    后端数据
{
    'data': [{
    'type':  'people',
    'id':  '123',
    'attributes': {
        'FirstName':  'Jeff',
        'LastName':  'Atwood',
        'Birthday':  new  Date().getTime()
        }
    }, {
    'type':  'people',
    'id':  '124',
    'attributes': {
        'FirstName':  'Yehuda',
        'LastName':  'Katz',
        'Birthday':  new  Date('2011-11-11 11:11:11').getTime()
        }
    }]
};

而在前端 我们定义的属性名为:

//    person/model.js
import DS from  'ember-data';

export  default  DS.Model.extend({
    firstName:  DS.attr('string'),
    lastName:  DS.attr('string'),
    birthday:  DS.attr('date')
});

前端使用的是 常用的驼峰命名法,在这样的情形下(前后端属性名字不一致),我们就需要修改向后端申请的属性名称来将后端数据合理的传递到我们前端定义的属性名上来:

//    person/serializer.js
import DS from  'ember-data';
import { camelize, capitalize } from  '@ember/string';

export  default  DS.JSONAPISerializer.extend({
    keyForAttribute(key) {
        let newKey = camelize(key);
        return capitalize(newKey);
    }
});

keyForAttribute 这个方法接受 前端 定义的属性名称为参数,如当下的firstName等,经过转换为后端相同的属性名,如FirstName 。这样来达到前后端通信的要求。

前端 modelName 的变化

在上面我们可以看到,后端返回数据中的 typepeople,但是前端寻找的type 却为person,这是因为 Ember Data 中的约定的关系,但是如果我们就想让它寻找的typepeople呢?那我们就需要用到 modelNameFromPayloadKey 这个方法:

//    people/serilizer.js
import DS from  'ember-data';
import { camelize, capitalize } from  '@ember/string';

export  default  DS.JSONAPISerializer.extend({
    modelNameFromPayloadKey(key) {
        return key;
    },
    keyForAttribute(key) {
        let newKey =  camelize(key);
        return  capitalize(newKey);
    }
});

通过复写这个方法就可以禁止 modelName 的单复数转换了。 目前我们是在单独的 model 下执行的这个 serializer 的几个方法,如果需要在全局则需要将 serializer.js文件写在 application 下。 相应的,还会有payloadKeyFromModelName

IDs

在 JSONAPI 中 每个条目都应该使用 id 中的值来作为为一标识,前后端都应如此,如果后端没有将 id 作为唯一标识,那么就可以使用 primaryKey 这个属性来定义一个唯一标识: 这是前端定义的:

//    people/serilizer.js
import DS from  'ember-data';
import { camelize, capitalize } from  '@ember/string';

export  default  DS.JSONAPISerializer.extend({
    primaryKey: 'pKey',
    modelNameFromPayloadKey(key) {
        return key;
    },
    keyForAttribute(key) {
        let newKey = camelize(key);
        return capitalize(newKey);
    }
});

而后端传来的数据即可变更为:

//    后端数据
{
    'data': [{
    'type':  'people',
    'pKey':  '123',
    'attributes': {
        'FirstName':  'Jeff',
        'LastName':  'Atwood',
        'Birthday':  new  Date().getTime()
        }
    }, {
    'type':  'people',
    'pKey':  '124',
    'attributes': {
        'FirstName':  'Yehuda',
        'LastName':  'Katz',
        'Birthday':  new  Date('2011-11-11 11:11:11').getTime()
        }
    }]
};

缩短属性名

在日常工作中的难题之一就是命名,而往往后端的命名和前端的不太一致,如果我们做了大量的展示工作,再更换名称那就有点比较麻烦,这时候我们可以使用 attrs属性来达到我们的目的: 后端传输的数据中有一:

    //    ...
    ThePersonSelfHeight:176
    // ...

前端认为这个名字过于复杂所以想alias:

//    people/serilizer.js
import DS from  'ember-data';

export  default  DS.JSONAPISerializer.extend({
    primaryKey: 'pKey',
    attrs: {
        height: 'ThePersonSelfHeight'
    },
    // ...
});

同时也需要在model.js 文件进行相应的修改:

//    people/model.js
// ...
    height:  DS.attr('number')
// ...

即可在页面中使用.height展示ThePersonSelfHeight 属性的值。

Format Response

在工作中,后端传回来的数据往往会有些许嵌套或者是后端人员有自己的思考方式导致数据的结构和我们设想的有些许不同。这个时候我们可以通过 serialize() 以及 normalizeResponse() 这两个方法来实现我们的需求。 比如后端传给我们的数据有:

data: {
    type:  'phone',
    id:  1,
    attributes: {
        brand:  'Nokia',
        capacity:  64,
        size: {
            width:  70.9,
            height:  143.6,
            depth:  7.7,
            weight:  177
        },
        display:  5.8
    }
}

而我们在数据显示中希望能直接展示的depth,而不想从size中取:

//    phone/model.js
import DS from  'ember-data';

export  default  DS.Model.extend({
    brand:  DS.attr('string'),
    capacity:  DS.attr('number'),
    depth:  DS.attr('number'),
    display:  DS.attr('number')
});

normalizeResponse()

我们可以通过 serializer.js 中的 normalizeResponse()方法来实现我们的需求:

// phone/serializer.js
// ...
normalizeResponse(store, primaryModelClass, payload, id, requestType) {
    payload.data.attributes.depth = payload.data.attributes.size.depth;
    delete payload.data.attributes.size;
    return  this._super(...arguments);
}

之后在 route.js 中我们请求数据:

//    route.js
// ...
model() {
    return this.get('store').queryRecord('phone',{})
}

这样页面中我们就可以直接获取 depth的值了:

<tr>
    <td>{{model.brand}}</td>
    <td>{{model.capacity}}</td>
    <td>{{model.depth}}</td>
    <td>{{model.display}}</td>
</tr>

除了 normalizeResponse()方法,还有其他的几个方法,如:

normalize()

//    phone/serializer.js
// ...
normalize(typeClass, hash) {
    hash.attributes.depth = hash.attributes.size.depth;
    delete hash.attributes.size;
    return  this._super.apply(this, arguments);
}

也可以起到相同的作用。这个方法可以在application中定义特定的 typeClass来针对调用。

normalizeQueryRecordResponse()

在本文中我们获取数据使用了 queryRecord(),所以我们还可以使用:

//    phone/serializer.js
// ...
normalizeQueryRecordResponse(store, primaryModelClass, payload, id, requestType) {
    payload.data.attributes.depth = payload.data.attributes.size.depth;
    delete payload.data.attributes.size;
    return  this._super(...arguments);
},

normalizeFindAllResponse()

相同的也可以联想,当我们获取数据为:

// route.js
    mode() {
        return this.get('store').findAll('phone');
    }

这种情况的时候,可以使用:

//    phone/serializer.js
normalizeFindAllResponse(store, primaryModelClass, payload) {
    let data = payload.data.attributes;

    payload.data.attributes.depth = data.size ? data.size.depth : data.depth;
    delete payload.data.attributes.size;
    return  this._super(...arguments);
}

依然可以达到我们的目的。Emberjs 还提供其他的 normalize hook:

  • normalizeFindBelongsToResponse()
  • normalizeFindHasManyResponse()
  • normalizeFindManyResponse()
  • normalizeFindRecordResponse()
  • normalizeQueryResponse()

等其他修改创建的请求。

normalizeCreateRecordResponse()

这个 hook 的使用需要从 创建一个 record 说起:

//    arcicle/route.js or controller.js
let articles =  this.get('store').createRecord('article', {
    id:  new  Date().getTime(),
    title:  'how to use serialize',
    body:  'let try'
});

在创建了 record 之后,可以在 EmberInspector 中的 Data 中查看到相应的 data。同时在 serializer.js中添加 normalizeCreateRecordResponse():

//    article/serializer.js
import DS from  'ember-data';

export  default  DS.JSONAPISerializer.extend({
    normalizeCreateRecordResponse(store, primaryModelClass, payload, id, requestType) {
        console.log(payload);
        return  this._super(...arguments);
    }
});

这时在浏览器看到这个 hook 并没有执行。这个hook 执行的时机时在 保存 record 的时候:

//    article/route.js or controller.js
// ...
articles.save()

刷新后即可看到 normalizeCreateRecordResponse() 此钩子已经被执行。 同理,其他的更新/删除相似:

至此 DS.JSONAPISerialize 的相关属性与method 已解释完成。

Written By FrankWang.


  1. serializer.js文件除了最顶层的是在 application文件夹下,其余是跟 model 名称走的,不是跟路由名称。

[转载]原文链接:https://segmentfault.com/a/1190000019746393

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处。

转载请注明:文章转载自 JavaScript中文网 [https://www.javascriptcn.com]

本文地址:https://www.javascriptcn.com/read-69576.html

文章标题:Emberjs中JSONAPISerializer的常用API

相关文章
js性能优化 如何更快速加载你的JavaScript页面
确保代码尽量简洁 不要什么都依赖JavaScript。不要编写重复性的脚本。要把JavaScript当作糖果工具,只是起到美化作用。别给你的网站添加大量的JavaScript代码。只有必要的时候用一下。只有确实能改善用户体验的时候用一下。 ...
2015-11-12
10个强大的纯CSS3动画案例分享
我们的网页外观主要由CSS控制,编写CSS代码可以任意改变我们的网页布局以及网页内容的样式。CSS3的出现,更是可以让网页增添了不少动画元素,让我们的网页变得更加生动有趣,并且更易于交互。本文分享了10个非常炫酷的CSS3动画案例,希望大家...
2015-11-16
请前往任务中心完善资料即可激活会员
登录后,点击右上角的用户名,在下拉菜单中可以进去“我的任务” 注册自动激活,本站没有VIP!没有充值!没有推广任务等等 回复即可下载 ...
2015-11-18
Android中Okhttp3实现上传多张图片同时传递参数
之前上传图片都是直接将图片转化为io流传给服务器,没有用框架传图片。 最近做项目,打算换个方法上传图片。 Android发展到现在,Okhttp显得越来越重要,所以,这次我选择用Okhttp上传图片。 Okhttp目前已经更新到Okhttp...
2017-03-17
v-charts | 饿了么团队开源的基于 Vue 和 ECharts 的图表工具
在使用echarts生成图表时,经常需要做繁琐的数据类型转化、修改复杂的配置项,v-charts的出现正是为了解决这个 痛点。基于Vue2.0和echarts封装的v-charts图表组件,只需要统一提供一种对前后端都友好的数据格式 设置简...
2018-05-24
JavaScript常用特效chm下载
下载地址:JavaScript常用特效chm下载 对了,如果打开空白,在手册上右键属性解除锁定即可。 ...
2015-11-12
从2014年的发展来展望JS的未来将会如何
&lt;font face=&quot;寰�杞�闆呴粦, Arial, sans-serif &quot;&gt;2014骞达紝杞�浠惰�屼笟鍙戝睍杩呴€燂紝鍚勭�嶈��瑷€灞傚嚭涓嶇┓锛屼互婊¤冻鐢ㄦ埛涓嶆柇鍙樺寲鐨勯渶姹傘€傝繖浜涜��...
2015-11-12
12个你未必知道的CSS小知识
虽然CSS并不是一种很复杂的技术,但就算你是一个使用CSS多年的高手,仍然会有很多CSS用法/属性/属性值你从来没使用过,甚至从来没听说过。 1.CSS的color属性并非只能用于文本显示 对于CSS的color属性,相信所有Web开发人员...
2015-11-12
ajax为什么令人惊异?ajax的优缺点
使用Ajax的最大优点,就是能在不更新整个页面的前提下维护数据。这使得Web应用程序更为迅捷地回应用户动作,并避免了在网络上发送那些没有改变的信息。 Ajax不需要任何浏览器插件,但需要用户允许JavaScript在浏览器上执行。就像DHT...
2015-11-12
HTML5的5个不错的开发工具推荐
HTML5规范终于在今年正式定稿,对于从事多年HTML5开发的人员来说绝对是一个重大新闻。数字天堂董事长,DCloud CEO王安也发表了文章,从开发者和用户两个角度分析了HTML对两个人群的优势。其实,关于HTML5的开发工具,我们以往的...
2015-11-12
回到顶部