建立 Observable(二)
通常我们会透过creation operator 来建立Observable 实例,这篇文章会讲解几个较为常用的operator!
Creation Operator
Observable 有许多创建实例的方法,称为creation operator。下面我们列出RxJS 常用的creation operator
- create
- of
- from
- fromEvent
- fromPromise
- never
- empty
- throw
- interval
- timer
of
还记得我们昨天用create
来建立一个同步处理的observable吗?
var source = Rx.Observable
.create(function(observer) {
observer.next('Jerry');
observer.next('Anna');
observer.complete();
});
source.subscribe({
next: function(value) {
console.log(value)
},
complete: function() {
console.log('complete!');
},
error: function(error) {
console.log(error)
}
});
// Jerry
// Anna
// complete!
他先后传递了'Jerry'
,'Anna'
然后结束(complete),这是一个十分常见模式。当我们想要同步的传递几个值时,就可以用of
这个operator来简洁的表达!
下面的程式码行为同上
var source = Rx.Observable.of('Jerry', 'Anna');
source.subscribe({
next: function(value) {
console.log(value)
},
complete: function() {
console.log('complete!');
},
error: function(error) {
console.log(error)
}
});
// Jerry
// Anna
// complete!
是不是相较于原本的程式码简洁许多呢?
from
可能已经有人发现其实of
operator的一个一个参数其实就是一个list,而list在JavaScript中最常见的形式是阵列(array),那我们有没有办法把一个已存在的阵列当作参数呢?
有的,我们可以用from
来接收任何可列举的参数!
var arr = ['Jerry', 'Anna', 2016, 2017, '30 days']
var source = Rx.Observable.from(arr);
source.subscribe({
next: function(value) {
console.log(value)
},
complete: function() {
console.log('complete!');
},
error: function(error) {
console.log(error)
}
});
// Jerry
// Anna
// 2016
// 2017
// 30 days
// complete!
记得任何可列举的参数都可以用喔,也就是说像Set, WeakSet, Iterator 等都可以当作参数!
因为ES6出现后可列举(iterable)的型别变多了,所以
fromArray
就被移除啰。
另外from 还能接收字串(string),如下
var source = Rx.Observable.from('铁人赛');
source.subscribe({
next: function(value) {
console.log(value)
},
complete: function() {
console.log('complete!');
},
error: function(error) {
console.log(error)
}
});
// 铁
// 人
// 赛
// complete!
上面的程式码会把字串里的每个字元一一印出来。
我们也可以传入Promise 物件,如下
var source = Rx.Observable
.from(new Promise((resolve, reject) => {
setTimeout(() => {
resolve('Hello RxJS!');
},3000)
}))
source.subscribe({
next: function(value) {
console.log(value)
},
complete: function() {
console.log('complete!');
},
error: function(error) {
console.log(error)
}
});
// Hello RxJS!
// complete!
如果我们传入Promise 物件实例,当正常回传时,就会被送到next,并立即送出完成通知,如果有错误则会送到error。
这里也可以用
fromPromise
,会有相同的结果。
fromEvent
我们也可以用Event建立Observable,透过fromEvent
的方法,如下
var source = Rx.Observable.fromEvent(document.body, 'click');
source.subscribe({
next: function(value) {
console.log(value)
},
complete: function() {
console.log('complete!');
},
error: function(error) {
console.log(error)
}
});
// MouseEvent {...}
fromEvent
的第一个参数要传入DOM 物件,第二个参数传入要监听的事件名称。上面的程式会针对body 的click 事件做监听,每当点击body 就会印出event。
取得 DOM 物件的常用方法:
document.getElementById()
document.querySelector()
document.getElementsByTagName()
document.getElementsByClassName()
补充:fromEventPattern
要用Event来建立Observable实例还有另一个方法fromEventPattern
,这个方法是给类事件使用。所谓的类事件就是指其行为跟事件相像,同时具有注册监听及移除监听两种行为,就像DOM Event有addEventListener
及removeEventListener
一样!举一个例子,我们在【30天精通RxJS (04):什么是Observable ?】实作的Observer Pattern就是类事件,程式码如下:
class Producer {
constructor() {
this.listeners = [];
}
addListener(listener) {
if(typeof listener === 'function') {
this.listeners.push(listener)
} else {
throw new Error('listener 必须是 function')
}
}
removeListener(listener) {
this.listeners.splice(this.listeners.indexOf(listener), 1)
}
notify(message) {
this.listeners.forEach(listener => {
listener(message);
})
}
}
// ------- 以上都是之前的程式码 -------- //
var egghead = new Producer();
// egghead 同时具有 注册监听者及移除监听者 两种方法
var source = Rx.Observable
.fromEventPattern(
(handler) => egghead.addListener(handler),
(handler) => egghead.removeListener(handler)
);
source.subscribe({
next: function(value) {
console.log(value)
},
complete: function() {
console.log('complete!');
},
error: function(error) {
console.log(error)
}
})
egghead.notify('Hello! Can you hear me?');
// Hello! Can you hear me?
上面的程式码可以看到,egghead
是Producer
的实例,同时具有注册监听及移除监听两种方法,我们可以将这两个方法依序传入fromEventPattern
来建立Observable的物件实例!
这里要注意不要直接将方法传入,避免this出错!也可以用
bind
来写。
Rx.Observable
.fromEventPattern(
egghead.addListener.bind(egghead),
egghead.removeListener.bind(egghead)
)
.subscribe(console.log)
empty, never, throw
接下来我们要看几个比较无趣的operators,之后我们会讲到很多observables 合并(combine)、转换(transforme)的方法,到那个时候无趣的observable 也会很有用!
有点像是数学上的**零(0)**,虽然有时候好像没什么,但却非常的重要。在Observable 的世界里也有类似的东西,像是empty
var source = Rx.Observable.empty();
source.subscribe({
next: function(value) {
console.log(value)
},
complete: function() {
console.log('complete!');
},
error: function(error) {
console.log(error)
}
});
// complete!
empty
会给我们一个空的observable,如果我们订阅这个observable会发生什么事呢?它会立即送出complete的讯息!
可以直接把
empty
想成没有做任何事,但它至少会告诉你它没做任何事。
数学上还有一个跟零(0)很像的数,那就是**无穷(∞)**,在Observable的世界里我们用never
来建立无穷的observable
var source = Rx.Observable.never();
source.subscribe({
next: function(value) {
console.log(value)
},
complete: function() {
console.log('complete!');
},
error: function(error) {
console.log(error)
}
});
never 会给我们一个无穷的observable,如果我们订阅它又会发生什么事呢?...什么事都不会发生,它就是一个一直存在但却什么都不做的observable。
可以把never 想像成一个结束在无穷久以后的observable,但你永远等不到那一天!
题外话,笔者一直很喜欢平行线的解释: 两条平行线就是它们相交于无穷远
最后还有一个operatorthrow
,它也就只做一件事就是抛出错误。
var source = Rx.Observable.throw('Oop!');
source.subscribe({
next: function(value) {
console.log(value)
},
complete: function() {
console.log('complete!');
},
error: function(error) {
console.log('Throw Error: ' + error)
}
});
// Throw Error: Oop!
上面这段程式码就只会log出'Throw Error: Oop!'
。
这三个operators 虽然目前看起来没什么用,但之后在文章中大家就会慢慢发掘它们的用处!
interval, timer
接着我们要看两个跟时间有关的operators,在JS中我们可以用setInterval
来建立一个持续的行为,这也能用在Observable中
var source = Rx.Observable.create(function(observer) {
var i = 0;
setInterval(() => {
observer.next(i++);
}, 1000)
});
source.subscribe({
next: function(value) {
console.log(value)
},
complete: function() {
console.log('complete!');
},
error: function(error) {
console.log('Throw Error: ' + error)
}
});
// 0
// 1
// 2
// .....
上面这段程式码,会每隔一秒送出一个从零开始递增的整数,在Observable 的世界也有一个operator 可以更方便地做到这件事,就是
interval
var source = Rx.Observable.interval(1000);
source.subscribe({
next: function(value) {
console.log(value)
},
complete: function() {
console.log('complete!');
},
error: function(error) {
console.log('Throw Error: ' + error)
}
});
// 0
// 1
// 2
// ...
interval
有一个参数必须是数值(Number),这的数值代表发出讯号的间隔时间(ms)。这两段程式码基本上是等价的,会持续每隔一秒送出一个从零开始递增的数值!
另外有一个很相似的operator叫timer
,timer
可以给两个参数,范例如下
var source = Rx.Observable.timer(1000, 5000);
source.subscribe({
next: function(value) {
console.log(value)
},
complete: function() {
console.log('complete!');
},
error: function(error) {
console.log('Throw Error: ' + error)
}
});
// 0
// 1
// 2 ...
当timer
有两个参数时,第一个参数代表要发出第一个值的等待时间(ms),第二个参数代表第一次之后发送值的间隔时间,所以上面这段程式码会先等一秒送出1之后每五秒送出2, 3, 4, 5...。
timer
第一个参数除了可以是数值(Number)之外,也可以是日期(Date),就会等到指定的时间在发送第一个值。
另外timer
也可以只接收一个参数
var source = Rx.Observable.timer(1000);
source.subscribe({
next: function(value) {
console.log(value)
},
complete: function() {
console.log('complete!');
},
error: function(error) {
console.log('Throw Error: ' + error)
}
});
// 0
// complete!
上面这段程式码就会等一秒后送出1 同时通知结束。
Subscription
今天我们讲到很多无穷的observable,例如interval, never。但有时我们可能会在某些行为后不需要这些资源,要做到这件事最简单的方式就是unsubscribe
。
其实在订阅observable后,会回传一个subscription物件,这个物件具有释放资源的unsubscribe
方法,范例如下
var source = Rx.Observable.timer(1000, 1000);
// 取得 subscription
var subscription = source.subscribe({
next: function(value) {
console.log(value)
},
complete: function() {
console.log('complete!');
},
error: function(error) {
console.log('Throw Error: ' + error)
}
});
setTimeout(() => {
subscription.unsubscribe() // 停止订阅(退订), RxJS 4.x 以前的版本用 dispose()
}, 5000);
// 0
// 1
// 2
// 3
// 4
这里我们用了setTimeout
在5秒后,执行了subscription.unsubscribe()
来停止订阅并释放资源。另外subscription物件还有其他合并订阅等作用,这个我们之后有机会会在提到!
Events observable尽量不要用
unsubscribe
,通常我们会使用takeUntil
,在某个事件发生后来完成Event observable,这个部份我们之后会讲到!
今日小结
今天我们把建立Observable 实例的方法几乎都讲完了,建立Observable 是RxJS 的基础,接下来我们会讲转换(Transformation)、过滤(Filter)、合并(Combination)等Operators,但不会像今天这样一次把一整个类型的operator 讲完,笔者会依照实用程度以及范例搭配穿插着讲各种operator!