Java函数不应超过15行

    开发组织都会有代码规范。当我拿到一份代码规范，首先会去查看有没有对于单个函数最大行数做限制。如果没有这个最基本的约定，这份代码规范，在我看来几乎没有意义。

    以Java为例，一个函数不应超过多少行呢？
    大多数人都会说，函数不能太长，但也不能定死，要具体问题具体分析。再追问一下，有人会说，不超过200行，100行，50行，30行都有。另有人说，面向对象风格的可以短些，面向过程风格的可以长些。也有人说，一个方法不超过一屏幕就行（姑且不论显示器大小,字体大小和分辨率问题）。
   
    先摘录一段Martin Fowler《重构》P110-P111 中的一段话：
  

引用

     人们有时会问我，一个函数多长才合适？在我看来，长度不是问题，关键在于函数名称和函数本体之间的语义距离（semantic distance）。如果提炼动作（extracting）可以强化代码的清晰度，那就去做，就算函数名称比提炼出来的代码还长也无所谓。
  

   说了直白点，函数名是干什么，函数体是怎么干。当2者不是那么能容易分辨出来时，就需要提炼出函数来，让代码更好懂。

    既然马大师都说了，长度不是问题了吗，那干吗还要追究函数长度规范呢？
其实马大师讲的是对于懂得编程之道的人而言，不用关心长度，因为小函数是必然的结果。但在开发实践中，适当的函数长度限制值，可以给予我们警示，为什么这个方法写长了？哪里不对劲了？
     对于这个问题我的回答是：Java函数不应超过15行。
     为什么定这个数呢？
     一方面，这个是基于多年开发实践的总结。15行其实已经是一个比较宽松的标准，开发人员稍加培训就可以实际贯彻，而符合这个标准的函数也能达到良好的可读性。

     另一方面，这是基于对函数复杂度和代码行数之间关联关系的认识。
我采用一个简单的数学公式(注1)：

引用

函数复杂度 >= 代码行数^2

以下为了简化，只以最低增长方式，平方数进行计算。
以一个函数的行数，从1行到20行为例，见下图：

当函数行数到达10行以上，函数复杂度就开始大幅度攀升。
当代码行数达到20行时（复杂度400），其复杂度已经是14行时（复杂度 196）的2倍。
因此我将代码规范定在15行。

   下面我们运行此公式，来分析一下提炼小函数的好处。
例如，有1个100行的函数，分解为11（含自身）个10行的函数。
   原复杂度= 100^2=10000。
   分解后复杂度= 11×（10^2）= 1100。
   分解后的复杂几乎是分解前的 1/9,几乎降低了1个数量级。这就解释了为什么长方法分解之后，可维护性大幅度提高。
 
   再运用此公式，来观察那些现实中的长函数。                                                

函数长度(Line)	函数复杂度(Unit)
10	100
15	225
20	400
30	900
50	2500
100	10000
500	250000
1000	1000000

   也就无怪乎有同学表示维护1000行以上的函数，有种生不如死的感受。
     

注1：
   该公式参考于 gerald m. weinberg 《质量·软件·管理（第1卷）——系统思维》

评论

6 楼 huhang1986 2011-04-28  

8C8C。

逻辑划分越细，功能越明确，越好复用。

5 楼 tuti 2010-11-16  

引用

4 楼 constant 1 小时前   引用 删除
这个函数复杂度公式怎么得来的?

请看： 注1

4 楼 constant 2010-11-16  

这个函数复杂度公式怎么得来的?

3 楼 airlink 2010-07-15  

系统论告诉我们，如果你觉得一件事情几乎没有什么成本，而价值似乎是显然的；但居然很多人没有这样做， 那肯定是你漏掉了一些平衡因素。

在这里，平衡的因素就是分解和合并的代价，这个代价是随着分解次数而非线性增长的。

既然这里：
分解次数×平均模块规模 == 常数

所以，不是分得越细越好，不是函数越小越好，而是一个中庸的“度”。 从这个角度，我是蛮赞同15行这个“度”的。

2 楼 tuti 2010-07-14  

你有没有想过为什么？
一种原因是，最原始的那个函数本身过长，包含了多个的功能。
来个新需求，需要改变其中一个功能。初级的程序员，又很难把本来就写得不好的原始函数进行轻易分解，只能Copy Paste再修改。从此走上了“正反馈”的不归路。

1 楼 berlou 2010-07-14  

很好很强大。
其实很多几千行的类，你会发现，都是初级程序员copy paste的结果。