易栈网-膘叔

代码重构是所有人的噩梦。怎么样重构一系列代码，是一件非常重要的事情。
在没转这篇文章之前，我的重构都是先从部分非关键代码开始重构，而且把这一部分慢慢的独立成一个模块，在采用新的架构的时候，这一块也可以被嵌入的新的架构中。
当然在其中也会遇到一系列的问题，但这样来说会轻松一点。
OK，让我们来看原文吧。
原文是来自：http://coolshell.cn/articles/5201.html

你曾去想重构一个很老的模块，但是你只看了一眼你就恶心极了。文档，奇怪的函数和类的命名，等等，整个模块就像一个带着脚镣的衣衫褴褛的人，虽然能 走，但是其已经让人感到很不舒服。面对这种情况，真正的程序员会是不会认输的，他们会接受挑战认真分析，那怕重写也在所不惜。最终那个模块会被他们重构， 就像以前和大家介绍过的那些令人销魂的编程方式中的屠宰式编程一样。下面是重构代码的几个阶段，文章来自：The 7 stages of refactoring，下面的翻译只是意译。

第一阶段 - 绝望

在你开始去查看你想要重构的模块的，你会觉得好像很简单，这里需要改一个类，那里需要改两到三个函数，重写几个 函数，看上去没什么大不了的，一两天就搞定了。于是你着手开始重构，然后当你调整重构了一些代码，比如改了一些命名，修理了一些逻辑，渐渐地，你会发现这 个怪物原来体型这么大，你会看到与代码不符甚至含糊不清的注释，完全摸不着头脑的数据结构，还有一些看似不需要方法被调了几次，你还会发现无法搞清一个函 数调用链上的逻辑。你感到这个事可能一周都搞不定，你开始绝望了。

第二阶段 – 找最简单的做

你承认你要重构的这个模块就是一个可怕的怪物，不是一两下就可以搞定的，于是你开始着干一些简单的事，比如重新命名一下几个函数，移除一些代码的阻碍，产生几个常量来消除magic number，等等，你知道这样做至少不会让代码变得更糟糕。

第三阶段 – 再次绝望

但是接下来的事会让你再次撞墙。你会发现那些代码的瑕疵是些不痛不痒的事，改正这些事完全于事无补，你应该要做 的事就是重写所有的东西。但是你却没有时间这么干，而这些代码剪不乱理还乱，耦合得太多，让你再一次绝望。所以，你只能部分重写那些不会花太多时间的部 分，这样至少可以让这些老的代码能被更多的重用。虽然不完美，但是至少可以试试。

第四阶段 – 开始乐观

在你试着部分重构这个模块几天之后，随着重构了几个单元后，虽然你发现改善代码的进度太慢了，但此时，你已知道代码应该要被改成什么样，你在痛苦之 后也锁定了那些那修改的类。是的，虽然你的时间预算已经超支，虽然要干的事比较多，但你还是充满希望，觉得那是值得的。你胸中的那团火又被点燃了。

第五阶段  - 快速了结

在这个时候，你发现你已花了太多的时间，而情况越来越复杂，你感到你所面对的情况越来越让你越到不安，你明白你自己已经陷入了困境。你原本以为只需 要一次简单的重构，然而现在你要面对的是重写所有的东西。你开始意识到原因是因为你是一个完美主义者，你想让代码变得完美。于是你开始在怠慢你文档，并想 找到一个捷径来重写老的代码，你开始采用一些简单而粗暴，快速而有点肮脏的方法。虽然不是很完美，但你就是这样去做了。然后，你开始运行测试做UT，发现 UT报告上全是红色，几乎全都失败了，你恐慌了，于是快速地fix代码，然后让UT 能工作。此时，你拍拍自己胸口，说到，没问题 ，于是就把代码提交了。

第六阶段 – 修改大量的Bug

你的重写并不完美，虽然其过了测试，但是那些UT测试对于你的新的代码有点不太合适，虽然他们都没有报错，但是他们测试得范围太小了，没有覆盖到所 有的情况和边界。所以，在这以后，你还需要几周或是更长的时间不得不来修正越来越多的bug，这使得你的设计和代码在每一次quick-fix后就变得越 来越难看。此时，代码已经不像你所期望的那样完美了，但你依然觉得他还是比一开始要好一些。这个阶段可能历经几个月。

第七阶段  - 觉悟

经过了6个月，你重写的模块又出了一个比较严重的bug。这让你重构的那个模块变得更难堪。你发现出的这个问题是和当初的设计不一致，你还发现被你 重构掉的那段老的代码并不是当初看上去的那么坏，那段老的代码确实考虑到了一些你未曾考虑到的事情。这个时候，你团队里有人站出来说这个模块应该被重构或 是重写，而你却不动声色地一言不发，并希望那个站出来的人能在几个月后能觉悟起来。

——————

不知道这是不是你的经历，我经历过很多次这样的事。对于很多维护性质的项目，我犯过的错误让我成了一个实实在在的保守派，我几乎不敢动，那怕看到代 码很不合口味。当然，那些从来没有写过代码的敏捷咨询师一定会说用TDD或是UT可以让你的重构更有效也更容易，因为这样会让他们显得更我价值，但我想告 诉你，这种脱离实际的说法很不负责任，这就好比说—— 我在杀猪的时候遇到了一些麻烦，因为我对猪的生理结构不清楚，或是这本来就是一头畸形的猪，导致我杀的猪很难看，而伟大的敏捷咨询师却告诉我，要用一把更快更漂亮的刀。软件开发永远不是那么简单的事，杀猪也一样。

-----------------------
不过我想，更多的时候，安排你重构一份代码的时候，你可能想到的就是我情愿重写一份也不愿意重构，对着数据库结构和一些业务逻辑，然后就开始重写了。只是这样的写法，后面遇到的问题会非常非常多。你呢？也是这样的吗？

OK，看我博客的人，可能会看到这个工具条了，嗯，我已经在网站的阅读时候启用了readability这个插件，如果不想看到文章左右的广告的用户，可以点击NOW看一下。当然如果你对文章有兴趣，你可以点击EMAIL发到邮箱。

更重要的是，如果你有kindle，你也可以尝试发送过去。（希望我转载的文章足够吸引人）

放心吧，不要以为很难，其实 你也可以拥有这样的功能。在你的页面上加上这样一段代码就OK了：

<div class="rdbWrapper" data-show-read="1" data-show-send-to-kindle="1" data-show-print="1" data-show-email="1" data-version="1"></div><script type="text/javascript"> (function() { var s = document.getElementsByTagName("script")[0], rdb = document.createElement("script"); rdb.type = "text/javascript"; rdb.async = true; rdb.src = document.location.protocol + "//www.readability.com/embed.js"; s.parentNode.insertBefore(rdb, s); })(); </script>

什么，复制代码无效？没关系，看这里：http://www.readability.com/publishers/tools

你可以自定义你要的样式啦

好吧，上文我说到了HtmlPurifier这个类库，很多人还是云里雾里的，确实，对于国外那些相对比较标准的页面来说，嗯。这些都确实是云里雾里的，但国内还是需要这样的。
它适用于几种场景
1、采集，这个就不用说啦，采的不标准的话，HTML 标签可能不闭合
2、所见所得编辑器：如果COPY一段网上的文章进所见所得编辑器，可能会不闭合，因为你不能保证你复制的内容是一定闭合（大部分编辑器会帮你修复这种问题）
3、还是所见所得编辑器。在这种编辑器里，如果你在内容里加上分页标记，再由他自动分页，则可能会遇到HTML标记不全的情况（这在supesite中特别 多见，但可以理解）

因此，有PHP tidy库的人就有福了，但tidy库需要在服务器上编译，不是很方便，毕竟不是每个人都有服务器的。所以，HtmlPurifier类库就起作用了。
官方这么介绍：

如果对这个类库还不清楚，你可以看一下这里的demo:http://htmlpurifier.org/demo.php
尝试输入<div><p></div>
然后提交一下，你就知道了

说起readability或许知道的人还真的不是特别多，其实 这是一个工作室，叫arc90的开发的一个JS类库，作用是方便各种掌上设备在阅读页面的时候可以只关注真正的内容部分，而忽略掉那些无关的广告或者其他标记。
这，对于国内的开发人员来说，那就是采集利器了，因为在这种情况下，页面里剩下的内容就只有文章主体了。这个结果，你懂的。
arc90这个工作室或许很多人不知道，但flipboard很多人应该听说过，做IPAD上资讯类阅读软件开发的人员应该会知道这个软件啦。
不多说了，我这里是转的PHP版的readability的库，上面的一些内容，转载的文章中也有介绍，可以LOOK一下先，原文来自：http://blog.zol.com.cn/2615/article_2614448.html

阅读是汲取知识的途径之一，但烦杂的网页提了额外我们诸多不需要的信息，这有时候非常干扰我们阅读。回归阅读 内容的本身，其实通过Readability 这个脚本 就能抽取页面的主体内容。

不过，Readability 提供的仅仅是个 Bookmarklet，如果我们需要将其导出、打印等操作时就显 得捉衿见肘。需求驱动行动，于是就有了这个 PHP 库。PS，同时您还可以找到 .net 版本的 Readability，以及 node.js 版本的 Readability。

这个库能做的事情非常的简单，就是找到页面的主体内容并返回。调用这个库非常的容易，实例代码如下：

如果您不在意技术本身，那么这里有个现成的线上工具。只需要粘贴入需要阅读的网页链接，这个工具就能够重新生成适合阅读的页面（例如： 原页面、Readability 以后的页面）。

然后利用 Mac 的 pdf 打印输出功能，就能非常方便在 kindle 等阅读器上使用。

Q&A

输出的页面似乎有乱码？

PHP Readability 库能够指定输入的字符编码并统一返回 utf-8 编码的字符串。如果您在处理过程中碰到了乱码问题，请调整下字符编码。如果还是有问题，欢迎您的反馈。

有些页面提取内容失败或者提取不正确？

Readability 提取的算法其实非常有限。如果页面本身的 HTML 标签不是非常合乎规范，那么提取可能会造成一定的困扰。通常这在国内的页面上会更常见些，同样欢迎您的反馈，这有利于我继续改进 PHP Readability 的算法。

最后，希望这个库和工具能让你找回阅读的乐趣。

------------------------
嗯，在使用这个软件的时候，如果发现HTML标准不规范（你懂的，国内的网页，有超过50%以上的页面是不规范的，嗯，标签不闭合的都有很多），请使用PHP的tidy库修复一下，如果没有tidy库，那就用htmlpurifier修复一下吧。
顺便：YII的自带扩展中已经包含htmlpurifier插件。

这是一个PHP的函数，可以把相对路径转为绝对路径。比如可以把http://www.neatstudio.com/archive/../upload/xxx.jpg，转换成http://www.neatstudio.com/upload/xxx.jpg

正常情况下，都没什么问题。但某一天，居然遇到了这样的网址：http://neatstudio.com/xxx/xxx/../0/abc.jpg，于是就出错了，返回成http://neatstudio.com/xxx/abc.jpg
细心的朋友可能发现了上面的问题，/0这个目录不见了。这是为什么呢？？

居然是因为第7行 ，我对$val的判断是!$val。。。它认为0目录是不为真就跳过了。TNND，所以我改成了$val == ''，真纠结。

粗心啊（请不要纠结上面的代码。花10分钟写的东西，质量不高是肯定的。）