JavaScript中链式调用之研习

 

方法链一般适合对一个对象进行连续操作(集中在一句代码)。一定程度上可以减少代码量，缺点是它占用了函数的返回值。

 

一、方法体内返回对象实例自身(this)

function ClassA(){
	this.prop1 = null;
	this.prop2 = null;
	this.prop3 = null;
}
ClassA.prototype = {
	method1 : function(p1){
		this.prop1 = p1;
		return this;
	},
	method2 : function(p2){
		this.prop2 = p2;
		return this;
	},
	method3 : function(p3){
		this.prop3 = p3;
		return this;
	}
}

 

定义了function/类ClassA。有三个属性/字段prop1,prop2,prop3，三个方法methed1,method2,method3分别设置prop1,prop2,prop3。

链式调用如下：

var obj = new ClassA();
obj.method1(1).method2(2).method(3); // obj -> prop1=1,prop2=2,prop3=3

 

可以看到对obj进行了连续三次操作，只要愿意ClassA的N多方法都这样定义，调用链会一直延续。

该方式缺点是链方法唯一地绑定于一种对象类型(ClaaaA)，按这种方式实现链式操作，每定义一个类，其方法体中都要返回this。第二种方式可以解决这个问题。

 

二、对象传入后每次调用返回函数自身

/**
 * chain 精简版
 * @param {Object} obj
 */
function chain(obj){
	return function(){
		var Self = arguments.callee; Self.obj = obj;
		if(arguments.length==0){
			return Self.obj;
		} 
		Self.obj[arguments[0]].apply(Self.obj,[].slice.call(arguments,1));
		return Self;
	}
}

//定义的function/类ClassB
function ClassB(){
	this.prop1 = null;
	this.prop2 = null;
	this.prop3 = null;
}
ClassB.prototype = {
	method1 : function(p1){
		this.prop1 = p1;
	},
	method2 : function(p2){
		this.prop2 = p2;
	},
	method3 : function(p3){
		this.prop3 = p3;
	}
}

 

注意ClassB的method1,method2,method3中不再返回this了。

 

链式调用如下：

var obj = new ClassB();
chain(obj)('method1',4)('method2',5)('method3',6); // obj -> prop1=4,prop2=5,prop3=6

 

第一种方式3次调用后返回了对象自身，这里使用一个空"()"取回对象

// result -> prop1=4,prop2=5,prop3=6
var result = chain(obj)('method1',4)('method2',5)('method3',6)();

 

这种方式写类时方法体中无须返回this，且可以对任何对象进行链式调用。

从写法上总结下两种的调用方式：

obj
	.method1(arg1)
	.method2(arg2)
	.method3(arg3)
	...
	
chain(obj)
	(method1,arg1)
	(method2,arg2)
	(method3,arg3)
	...

 

最后，感谢沐海，我是从wee库中获取以上灵感的。

 

评论

21 楼 deepthink 2010-09-07  

补充一下，再jquery的weight机制中是默认使用chain的调用样式
举个例子可能说的更加明白：

var tabs = $("#tabs").tabs().tabs("switchTo:,'#tab-1').tabs("method1");

tabs.tabs("switchTo:,'#tab-2').tabs("method1");

weight对象，每一个方法返回的都是 tabs本身，这是LZ所说的第二种方法样式

20 楼 deepthink 2010-09-07  

笨笨狗 写道

另外，说起这个chaing call，不得不推荐dustin diaz的这篇文章：
Asynchronous method queue chaining in JavaScript
http://www.dustindiaz.com/async-method-queues/

异步链式调用更为有趣，也更为实用：）

这种调用方法很久以前用过，但是不是用的jquery，是用的prototype

19 楼 deepthink 2010-09-07  

第一种方法我经常用，有的时候在JAVA中也大量使用，比如构建SQL，URL，或者JSON，或者DataModel 比较繁琐的时候，一般会用

Hql hql = new Hql("from UserInfo o where o.xx = ? ",xx).append("and o.userName = ? and o.yy = ? ",userName,yy) ;
return orm().findFirst(hql);


new UrlEngine(request).remove("arg1").append("arg2",arg2).append("arg3",arg3).toString() ;


new JSONMap().append("k1",val1).appendList("list1").add("list item1").parentMap()


new AppDataModel().setEntity(entity).append("user",user).setRows(entity.getDepts()).setPager(pager);

18 楼 zhouyrt 2010-09-03  

To 笨笨狗,

探讨，学习，进步。

谢谢！

17 楼 笨笨狗 2010-09-03  

另外，说起这个chaing call，不得不推荐dustin diaz的这篇文章：
Asynchronous method queue chaining in JavaScript
http://www.dustindiaz.com/async-method-queues/

异步链式调用更为有趣，也更为实用：）

16 楼 笨笨狗 2010-09-03  

zhouyrt 写道

To 笨笨狗

首先，谢谢您给我戴上“降低代码可读性的典型反面教材”的帽子。既然是教材，虽然是反面的，仍然可以给旁人以警惕作用。

其次，我想说的是

1，代码可读性与精简的代码并不必然关系，可以慢慢多琢磨下。

2， 代码可读性与代码风格也不必然关系，多数喜欢的可能是过程式/面向对象式，为什么一尝试函数式就那么不习惯，不喜欢。

难道这样写才算“提高代码可读性”
if(a){
fn1();
}else{
fn2();
}
这样写就“降低代码可读性”
a ? fn1() : fn2();


3， 我承认我们应该写更良好风格的代码，我也曾经深受自己代码风格不良好之苦并幡然醒悟，但上面这个问题的本质，真的是追求更具可读性的代码风格吗？

顺便提下，其实回复 clue,tangjikey,ccyingfu时也说了附件中有chain的“易读版”，“最易读版”。这里贴出

/**
* chain 最易读版
* @param {Object} obj
*/
function singleChain(obj){
function chain(){
if (arguments.length == 0){
return chain.obj;
}
var methodName = arguments[0], methodArgs = [].slice.call(arguments,1);
chain.obj[methodName].apply(chain.obj,methodArgs);
return chain;
}
chain.obj = obj;
return chain;
}

组织代码的风格千千万万，按需权衡。

最后，感谢您的见解！

楼主不必发火，我没有给你带任何帽子的目的：）其实我说说的“可读性”是针对api的使用者，而不是针对api的具体实现，也就是说我们的关注点在于相比

chain(obj)(method1,arg1)(method2,arg2)(method3,arg3) 

下面这种风格

obj.method1(arg1).method2(arg2).method3(arg3) 

更容易阅读，也更容易理解，不会打断读者的思维，不是么？

当然，话说回来，对于初学者来说，多多了解不同的实现方式那是非常必要的，这方面的推荐去研究Prototype.js的源码，里面对高阶函数的运用可以称得上“炉火纯青”，另外，它的OO类模拟机制是非常新颖的，真让人眼前一亮：）

15 楼 zhouyrt 2010-09-03  

笨笨狗 写道

其实，这是一个降低代码可读性的典型反面教材……
如果嫌在每个方法最后返回this是重复代码，那大可以实现一个wrap函数，用AOP的思路来对需要链式调用的方法进行包装：
function chain(obj, methods){
    for(var i=0; i<methods.length; i++){
        var m = methods[i];
        obj[m] = (function(old){
            return function(){
                old.apply(obj, arguments);
                return obj;
            }
        })(obj[m])
    }
}

有了上面的包装函数，就可以这样使用：
function Test(){}

Test.prototype = {
   methodA: function(){
       alert('methodA');
   },
   methodB: function(arg){
       alert(arg);
   }
}

var test = new Test();
//声明需要链式调用的方法
chain(test, ['methodA', 'methodB']);
//try it:)
test.methodB('chain').methodA()

抛砖引玉，你还可以让chain去修改构造函数（比如这里的Test）的prototype，这样只需要设置一次，所有的实例都具有链式调用的能力了，是不是和rails中的dsl有点类似呢？呵呵……

总之，我们在写代码或者设计API的时候，首要的原则就是要保证代码的可读性，SICP里有句话说的好：“程序是写给人看的，机器顺便执行”。

To 笨笨狗

首先，谢谢您给我戴上“降低代码可读性的典型反面教材”的帽子。既然是教材，虽然是反面的，仍然可以给旁人以警惕作用。

其次，我想说的是

1，代码可读性与精简的代码并不必然关系，可以慢慢多琢磨下。

2， 代码可读性与代码风格也不必然关系，多数喜欢的可能是过程式/面向对象式，为什么一尝试函数式就那么不习惯，不喜欢。

难道这样写才算“提高代码可读性”
if(a){
fn1();
}else{
fn2();
}
这样写就“降低代码可读性”
a ? fn1() : fn2();


3， 我承认我们应该写更良好风格的代码，我也曾经深受自己代码风格不良好之苦并幡然醒悟，但上面这个问题的本质，真的是追求更具可读性的代码风格吗？

顺便提下，其实回复 clue,tangjikey,ccyingfu时也说了附件中有chain的“易读版”，“最易读版”。这里贴出

/**
* chain 最易读版
* @param {Object} obj
*/
function singleChain(obj){
function chain(){
if (arguments.length == 0){
return chain.obj;
}
var methodName = arguments[0], methodArgs = [].slice.call(arguments,1);
chain.obj[methodName].apply(chain.obj,methodArgs);
return chain;
}
chain.obj = obj;
return chain;
}

组织代码的风格千千万万，按需权衡。

最后，感谢您的见解！

14 楼 笨笨狗 2010-09-02  

其实，这是一个降低代码可读性的典型反面教材……
如果嫌在每个方法最后返回this是重复代码，那大可以实现一个wrap函数，用AOP的思路来对需要链式调用的方法进行包装：
function chain(obj, methods){
    for(var i=0; i<methods.length; i++){
        var m = methods[i];
        obj[m] = (function(old){
            return function(){
                old.apply(obj, arguments);
                return obj;
            }
        })(obj[m])
    }
}

有了上面的包装函数，就可以这样使用：
function Test(){}

Test.prototype = {
   methodA: function(){
       alert('methodA');
   },
   methodB: function(arg){
       alert(arg);
   }
}

var test = new Test();
//声明需要链式调用的方法
chain(test, ['methodA', 'methodB']);
//try it:)
test.methodB('chain').methodA()

抛砖引玉，你还可以让chain去修改构造函数（比如这里的Test）的prototype，这样只需要设置一次，所有的实例都具有链式调用的能力了，是不是和rails中的dsl有点类似呢？呵呵……

总之，我们在写代码或者设计API的时候，首要的原则就是要保证代码的可读性，SICP里有句话说的好：“程序是写给人看的，机器顺便执行”。

13 楼 lz12366 2010-09-02  

费解啊   发现自己js学的还是不好

12 楼 icedblog 2010-09-02  

挺巧妙的~

但看上去有点繁琐

11 楼 libmw 2010-08-31  

我来写个小小的注释吧
/**
* 精简版
* @param {Object} obj
*/
function chain(obj){
//执行chain直接返回一个方法(类)，这样执行chain(obj)('method1',4)就相当于执行这个方法，参数是('method1',4)
return function(){
//定义Self = 本方法的调用者
var Self = arguments.callee;
//给调用者一个属性 即obj参数，这样每次链式调用的时候就可以获得最初的那个obj，而这个obj正好是被链式调用的那个方法，这里是classB
Self.obj = obj;
//一个参数都没有，这是链式调用结束的时候发生的事情，即：...('method3',6)()这里的最后一个括号，此时返回最初的那个obj，这里是classB
if(arguments.length==0){
return Self.obj;
}
/*执行Self.obj[arguments[0]]
比如我们第一次链式调用的时候：('method1',4)
这里我们通过 Self.obj[arguments[0]] 取得了method1方法，
Self.obj[arguments[0]].apply(Self.obj,[].slice.call(arguments,1)); 代表把Self.obj[arguments[0]]当做Self.obj的一个方法执行，
参数是后面的[].slice.call(arguments,1)
[].slice.call(arguments,1) 截取arguments数组，从索引第一个截取到最后
*/
Self.obj[arguments[0]].apply(Self.obj,[].slice.call(arguments,1));
//返回Self
return Self;
}
}
function ClassB(){
this.prop1 = null;
this.prop2 = null;
this.prop3 = null;
}
ClassB.prototype = {
method1 : function(p1){
this.prop1 = p1;
},
method2 : function(p2){
this.prop2 = p2;
},
method3 : function(p3){
this.prop3 = p3;
}
}
var obj = new ClassB();
chain(obj)('method1',4)('method2',5)('method3',6); // obj -> prop1=4,prop2=5,prop3=6
var result = chain(obj)('method1',4)('method2',5)('method3',6)(); // result -> prop1=4,prop2=5,prop3=6

10 楼 goddkiller 2010-08-30  

<div class="quote_title">clue 写道</div>
<div class="quote_div">
<div class="quote_title">zhouyrt 写道</div>
<div class="quote_div">
<p> </p>
<h3>
二、对象传入后每次调用返回函数自身</h3>
<p> </p>
<pre name="code" class="js">/**
* chain 精简版
* @param {Object} obj
*/
function chain(obj){
return function(){
var Self = arguments.callee; Self.obj = obj;
if(arguments.length==0){
return Self.obj;
}
Self.obj[arguments[0]].apply(Self.obj,[].slice.call(arguments,1));
return Self;
}
}
</pre>
 
<p> </p>
</div>
<p> </p>
<p>第二种方式还是第一次见，很巧妙的用法</p>
<p> </p>
<p>不过可以简化一下，不使用callee，直接利用闭包：</p>
<pre name="code" class="js">function chain(obj){
var fn = function(method){
if(arguments.length &lt;= 0){
return fn;
}
var args = Array.prototype.slice.call(arguments, 1);
obj[method].apply(obj, args);
return fn;
}
return fn;
}</pre>
<p> PS：那个[].slice的用法还真是。。。够短，不过总觉得凭白无故创建一个数组只为借它的一个方法用用，有点……</p>
</div>
<p>可以Array.prototype.slice......</p>

9 楼 蔡华江 2010-08-30  

以前写个一个invoke方法，很是类似于第二个方法，只是一个返回的运算结果，而一个是调用对象callee。
楼主方法在链式调用功能更强大，更适合于无返回参数的运算

8 楼 ghyghoo8 2010-08-28  

这个……理解上有难度。。

7 楼 zhouyrt 2010-08-28  

To: clue,tangjikey,ccyingfu

附件中有“易读版”，“最易读版”的chain。

6 楼 ccyingfu 2010-08-28  

我在第二种方式上解理起来.....表示压力很大。
我经常用的是第一种。

5 楼 tangjikey 2010-08-27  

第一个还好理解，第二个Self.obj[arguments[0]].apply(Self.obj,[].slice.call(arguments,1));   这句直接看晕了。

4 楼 zhouyrt 2010-08-27  

cloudgamer 写道

使用起来能更舒服就好了
例如
var result = chain(obj).method1(4).method2(5).method3(6);
要实现估计要对obj的方法进行重构 还要判断方法本身有没有return

谢.

3 楼 cloudgamer 2010-08-27  

使用起来能更舒服就好了
例如
var result = chain(obj).method1(4).method2(5).method3(6);
要实现估计要对obj的方法进行重构 还要判断方法本身有没有return

2 楼 clue 2010-08-27  

<div class="quote_title">zhouyrt 写道</div>
<div class="quote_div">
<p> </p>
<h3>
二、对象传入后每次调用返回函数自身</h3>
<p> </p>
<pre name="code" class="js">/**
* chain 精简版
* @param {Object} obj
*/
function chain(obj){
return function(){
var Self = arguments.callee; Self.obj = obj;
if(arguments.length==0){
return Self.obj;
}
Self.obj[arguments[0]].apply(Self.obj,[].slice.call(arguments,1));
return Self;
}
}
</pre>
 
<p> </p>
</div>
<p> </p>
<p>第二种方式还是第一次见，很巧妙的用法</p>
<p> </p>
<p>不过可以简化一下，不使用callee，直接利用闭包：</p>
<pre name="code" class="js">function chain(obj){
var fn = function(method){
if(arguments.length &lt;= 0){
return fn;
}
var args = Array.prototype.slice.call(arguments, 1);
obj[method].apply(obj, args);
return fn;
}
return fn;
}</pre>
<p> PS：那个[].slice的用法还真是。。。够短，不过总觉得凭白无故创建一个数组只为借它的一个方法用用，有点……</p>