Ember应用中适配器决定了数据保存到后台的方式,比如URL格式和请求头部。Ember Data默认的适配器是内置的REST API回调

实际使用中经常会扩展默认的适配器。Ember的立场是应该通过扩展适配器来添加不同的功能,而非添加标识。这样可以使得代码更加容易测试、更加容易理解,同时也降低了可能需要扩展的适配器的代码。

如果你的后端使用的是Ember约定的规则那么可用使用适配器adapters/application.js。适配器application优先级比默认的适配器高,但是比指定的模型适配器优先级低。模型适配器定义规则是:adapter-modelName.js。比如下面的代码定义了一个模型适配器adapter-post

1
2
3
4
5
6
//  app/adapters/adapter-post.js

import Ember from 'ember';
export default DS.JSONAPIAdapter.extend({
namespace: 'api/v1'
});

此时适配器的优先级次序为:JSONAPIAdapter > application> 默认内置适配器;

Ember内置的是配有如下几种:

  1. DS.Adapter 这个适配器是最基础的适配器,它不包含任何功能。如果需要创建一个与Ember适配器有根本性区别的适配器可以使从这个适配器入手。
  2. DS.JSONAPIAdapter 这个适配器是默认适配器,并且是遵循JSON API规范,用于与HTTP服务器之间通过XHR交互JSON数据。
  3. DS.RESTAdapter 这个适配器与第二个适配器功能一样,并且在Ember Data2.0之前是作为默认的适配器。

1,自定义JSONAPIAdapter适配器

JSONAPIAdapter适配器通常用于扩展非标准的后台接口。

1,URL规范

JSONAPIAdapter适配器非常智能,它能够自动确定URL链接是那个模型。比如,如果你需要通过id获取post

1
2
3
this.store.find('post', 1).then(function(post) {
// 处理post
});

JSONAPIAdapter会自动发送get请求到/post/1

下表是Action、请求、URL三者的映射关系(由于本站markdown解析器不支持表格所以直接使用截图替代了)。

Action HTTP URL
find get /posts/1
find all get /posts
update patch /posts/1
create post /posts
delete delete /posts/1

比如在action中执行find()方法,会发送get请求,JSONAPIAdapter会自动解析成形如/posts/1的URL。

2,多元化定制

为了适配复数名字的模型属性名称,可以是使用Ember Inflector绑定别名。

1
2
3
let inflector = Ember.Inflector.inflector;
inflector.irregular('formula', 'formulae');
inflector.uncountable('advice');

这样绑定之后目的是告诉JSONAPIAdapter。你可以使用/formulae/1代替/formulas/1。但是目前我还没搞清楚这个设置是什么意思?又有什么用?如果读者知道请指教。

3,断点路径定制

使用属性namespace可以设置URL的前缀。

1
2
3
4
5
app/adapters/application.js
import Ember from 'ember';
export default DS.JSONAPIAdapter.extend({
namespace: 'api/1'
});

请求person会自动转发到/api/1/people/1

4,自定义主机

默认情况下适配器会转到当前域名下。如果你想让URL转到新的域名可以使用属性host设置。

1
2
3
4
5
app/adapters/application.js
import Ember from 'ember';
export default DS.JSONAPIAdapter.extend({
host: 'http://api.example.com'
});

注意:如果你的项目是使用自己的后台数据库这个设置特别重要!!!属性host所指的就是你服务器接口的地址。

请求person会自动转发到http://api.example.com/people/1

5,自定义路径

默认情况下Ember会尝试去根据复数的模型类名、中划线分隔的模型类名生成URL。如果需要改变这个默认的规则可以使用属性pathForType设置。

1
2
3
4
5
6
7
// app/adapters/application.js
import Ember from ‘ember’;
export default DS.JSONAPIAdapter.extend({
pathForType: function(type) {
return Ember.String.underscore(type);
}
});

修改默认生成路径规则为下滑线分隔。比如请求person会转向/person/1。请求user-profile会转向/user_profile/1(默认情况转向user-profile/1)。

6,自定义请求头

有些请求需要设置请求头信息,比如提供APIkey。可以以键值对的方式设置头部信息,Ember Data会为每个请求都加上这个头信息设置。

1
2
3
4
5
6
7
8
app/adapters/application.js
import Ember from 'ember';
export default DS.JSONAPIAdapter.extend({
headers: {
'API_KEY': 'secret key',
'ANOTHER_HEADER': 'some header value'
}
});

更强大地方是你可以在header中使用计算属性,动态设置请求头信息。下面的代码是将一个session对象设置到适配器中。

1
2
3
4
5
6
7
8
9
app/adapters/application.js
import Ember from ‘ember’;
export default DS.JSONAPIAdapter.extend({
session: Ember.inject.service(‘session’);
headers: Ember.computed(‘session.authToken’, function() {
‘API_KEY’: this.get(‘session.authToken’),
‘ANOTHER_HEADER’: ‘some header value’
});
});

对于session应该非常不陌生,特别是在控制用户登录方面使用非常广泛,另外又一个非常好用的插件,专门用于控制用户登录的,这个插件是Ember Simple Auth,另外有一篇博文是介绍如何使用这个插件实现用户登录的,请看使用ember-simple-auth实现Ember.js应用的权限控制的介绍。

你还可以使用volatile()方法设置计算属性为非缓存属性,这样每次发送请求都会重新计算header里的值。

1
2
3
4
5
6
// app/adapters/application.js
import Ember from ‘ember’;
export default DS.JSONAPIAdapter.extend({
// ⋯⋯
}).volatile();
});

更多有关于适配器的信息浏览下面的网址:

对于适配器主要掌握JSONAPIAdapter足矣,如果你需要个性化定制URL或者请求的域名可以在适配中配置。不过大部分情况下都是使用默认设置。



博文完整代码放在Github(博文经过多次修改,博文上的代码与github代码可能有出入,不过影响不大!),如果你觉得博文对你有点用,请在github项目上给我点个star吧。您的肯定对我来说是最大的动力!!