不要为复用而设计
本文的作者Elliotte是一位著名的IT方面的作家,写20多本关于编程方面的书籍,有很多书籍在国内都有出版,其中包括《重构HTML:改善Web应用的设计》, 《Java I/O》, 《Java网络编程》,《Xml Bible》和《XML in a Nutshell》等,目前他正在研究XML处理器XOM、jaxen XPath引擎和Amateur媒体播放器。
上周,一位同事的一个观点让我深受启发,这个观点是如此的显而易见,以至于当他说出来时我惊奇于为什么以前没有意识到这点:
如果你为复用而设计,那你就做错了。
你现在要写的代码的唯一目的就是服务于你目前手头上的需要解决的任务。不要为复用而设计。不要去考虑复用。不要为让代码复用而浪费一秒钟时间。
事实上,任何你需要的可以复用的代码都已经存在了。想要去连接一个HTTP Server,并且要全面支持安全认证和cookies吗?这个东西听起来很多项目都可以用到,于是,你想把这个东西封装一下做成一个易用的HTTP类或共享包,很好的想法不是?错。你应该使用 Apache HttpClient。
需要解决你的抛物线方法的初始值问题吗?不要去翻看你的《numerical analysis textbook》,你需要做的是下载Flanagan的Java科学计算库,或购买一个NAG许可证。想要给你的同事们做一个日历选择组件吗?直接告诉他们去用JCalendar。尽管它在外观和使用方法上和你想象的不是完全一致,但完全够用。如果你打算做出自己的组件,或找一个现有的修改一下,你会发现,你开发出的这种不一样的表现效果并不适合另外一些人的应用,所以,不要浪费时间去开发自己的可复用的代码。
这些例子都是针对Java来说的,但对于另外一些主流的语言,比如Perl,Python,Ruby,C++,C#,Scala等,都是适用的。事实上,如果一种语言不能提供解决你的问题的可复用的代码,那你就是选错了解决你的问题的语言。
有例外的情况吗?我只能想出两种(目前为止我感觉没有第三种情况了)。
第一种例外是你在开发一种新的东西,你需要的类库不存在,你是第一个进入这个领域的人,你需要写出可复用的代码。例如,当我率先开发出XIncluder类库时,XInclude的规范还处于制订中,你在Java里找不到第二个可用的类库。我写的这个类库成了规范的可实现的一种证明,推动了规范向更完备的状态发展。十年前开发我自己的XInclude类库是明智的,而今天绝对不会再重做这样的事。
第二种例外情况是针对专家的,我甚至还不确定这是否是例外。如果你是某一个领域的真正专家,有可复用的代码能解决你的领域的问题,而你经过认真的研 究现有的解决方案,你认为它们是不完善的,你在寻找一种更好的解决方法,这时,而且只有这时,你可以考虑写出你自己可复用的代码。这就是我为什么要开发XOM的原因。只是在我写了数百页的书稿,详尽的收集了目前Java里处理XML的各种API,知道了它们的优点和缺点后,我才觉得应该坐下来设计一个API来改进它们。尽管我认为我设计的API是最好的API,但我仍然不确定把时间花在它上面是否值得。XOM,按我的观点,比之前的任何API都好,但它并不是好 到能够在大量的其它项目中替代其它的类库。对这个新API的需求不是真正的很大。
还有另外的例外吗?还有另外的一种情况里你需要写出可复用的代码吗?我想不出。有如此多的程序员花了如此多的时间来探索我们生活中存在的问题,并把 他们的成果放在 Sourceforge 和 Github 这样的网站上免费分享。当然,新的问题会不断的出现,但对一些老的问题,如果去再重新研究它们一遍,你并不能从中获得多大的收益。下一次,如果你发现自己 在为复用而设计,请住手,问问自己是否可以复用别人的代码。
[英文原文:Don’t Design for Reuse ]