Services

Services是每个Feathers应用的心脏。一个service就是一个简单的JavaScript对象,它提供一个或多个find, get, create, update, remove 以及setup 的服务方法,并且可以像Express 中间件一样使用 app.use('/path', serviceObject).

让我们通过一个简单的service和REST provider来创建一个Feathers应用:

// app.js
const feathers = require('feathers');
const rest = require('feathers-rest');
const app = feathers();

app.configure(rest());
app.use('/todos', {
  get(id, params) {
    return Promise.resolve({
      id,
      params,
      description: `You have to do ${id}!`
    });
  }
});

app.listen(3030);

接着我们来运行它

$ npm install feathers feathers-rest
$ node app.js

我们通过浏览器打开localhost:3030/todos/dishes后,你将看到如下结果:

{
  "id": "dishes",
  "description": "You have to do dishes!",
  "params": {
    "provider": "rest",
    "query": {}
  }
}

加一个参数试试,就像这样localhost:3030/todos/dishes?name=David,我们会看到如下的结果:

{
  "id": "dishes",
  "description": "You have to do dishes!",
  "params": {
    "provider": "rest",
    "query": {
      "name": "David"
    }
  }
}

引用services

当我们通过app.use('/my-service', myService)注册service的时候, Feathers为myService这个对象创建了一个浅拷贝并为扩充了它的功能. 这意味着这个服务继承了Feathers的方法(real-time events, hooks......). 我们可以使用app.service来引用这个服务:

const todos = app.service('todos');
// 我们也可以给它加上 前/后斜杠
const todos = app.service('/todos/');

// 通过如下方法使用这个服务
todos.get('laundry').then(todo => console.log(todo.description));

重要: 原始的service对象并不会被改变,并且永远不会继承Feathers的功能。

Service 方法

完整的service方法列表如下:

const myService = {
  find(params [, callback]) {},
  get(id, params [, callback]) {},
  create(data, params [, callback]) {},
  update(id, data, params [, callback]) {},
  patch(id, data, params [, callback]) {},
  remove(id, params [, callback]) {},
  setup(app, path) {}
}

app.use('/my-service', myService);

使用ES6 class(类)方式定义如下:

'use strict';

class MyService {
  find(params [, callback]) {}
  get(id, params [, callback]) {}
  create(data, params [, callback]) {}
  update(id, data, params [, callback]) {}
  patch(id, data, params [, callback]) {}
  remove(id, params [, callback]) {}
  setup(app, path) {}
}

app.use('/my-service', new MyService());

Service方法需要返回一个Promise对象并且具有下列参数:

  • id 资源标识符,每个资源都是拥有唯一的ID的数据。
  • data 指代资源数据。
  • params 可以包含任何额外的参数, 例如用户验证. params.query 包含来自客户端的查询参数 (参考 REST providersreal-time providers)。
  • callback 是一个可选的回掉函数,可以被一个 Promise 替代. 它是一个节点式回调函数,该函数遵循function(error, result) {}

这些方法基本上映射了CRUD接口:

  • find(params [, callback]) 检索来自服务端的所有资源,Provider的参数将通过params.query进行传递。
  • get(id, params [, callback]) 通过指定的id从服务器中检索单一资源。
  • create(data, params [, callback])data创建一个新的资源。这个方法将返回一个包含新创建的数据的Promise。 data 也可能是一个数组,它将创建并返回一个资源列表.
  • update(id, data, params [, callback]) 用新的data替换原来标识为id 资源。这个方法会返回一个包含着完整的更新资源数据的Promise。当更新多条数据时id也可以为空null.
  • patch(id, data, params [, callback]) 将新的data与标识为id的现有资源合并为新的数据。 合并多个资源时id可以为空null。这个方法会返回一个包含着完整的更新资源数据的Promise。Implement patch additionally to update if you want to separate between partial and full updates and support the PATCH HTTP method.
  • remove(id, params [, callback]) 通过id标识删除资源数据. 这个方法将返回一个包含被删除资源的Promise. 删除多个资源时id可以为空null

setup 方法

setup(app, path) 通过一个Feathers应用的实例和一个已注册的路径来初始化service。使用setup 是用来连接服务器的好方法:

// app.js
'use strict';

const feathers = require('feathers');
const rest = require('feathers-rest');

class TodoService {
  get(id, params) {
    return Promise.resolve({
      id,
      description: `You have to ${id}!`
    });
  }
}

class MyService {
  setup(app) {
    this.app = app;
  }

  get(name, params) {
    const todos = this.app.service('todos');
    
    return todos.get('take out trash')
      .then(todo => {
        return { name, todo };
      });
  }
}

const app = feathers()
  .configure(rest())
  .use('/todos', new TodoService())
  .use('/my-service', new MyService())

app.listen(8000);

你可以通过访问localhost:8000/my-service/test这个地址来查看以上代码的结果。

事件(Events)

Any registered service will automatically turn into an event emitter that emits events when a resource has changed,
当资源发生改变时,任何已注册的服务会自动转变为一个事件发射器来执行发送事件。这个改变包含 create, update, patch 或这是 remove service call returned successfully. 如果你想了解更多关于事件(events)的信息, 请访问如下章节 real-time events.

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

推荐阅读更多精彩内容