Emberjs中JSONAPISerializer的常用API

头像
法研鲁迅
    阅读 6 分钟

    Ember Serializer

    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 的变化

    在上面我们可以看到，后端返回数据中的 type为people，但是前端寻找的type 却为person，这是因为 Ember Data 中的约定的关系，但是如果我们就想让它寻找的type 为 people呢？那我们就需要用到 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 下1。
    相应的，还会有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 名称走的，不是跟路由名称。 ↩
    ember.jsjavascript
    法研鲁迅
    40 声望6 粉丝
    « 上一篇
    Emberjs 通过 axios 下载文件
    下一篇 »
    Emberjs 如何与后端服务进行交互-Store/Adapter/Serializer的作用

    引用和评论

    推荐阅读
    头像
    设置 nodejs 的环境变量

    法研鲁迅阅读 4.4k

    头像
    前端如何入门 Go 语言

    robin赞 28阅读 8.4k评论 9

    头像
    100个React最佳实践小技巧

    夕水赞 26阅读 6.7k评论 4

    头像
    前端开发工具

    寒青赞 19阅读 5.3k

    头像
    开发插件集合

    寒青赞 14阅读 3.5k

    头像
    JS校验身份证号

    寒青赞 10阅读 4.5k评论 2

    头像
    Jerry和您聊聊Chrome开发者工具

    注销赞 9阅读 4.8k评论 3

    0 条评论
    得票最新