1. 首页
  2. IT资讯

如何写出让同事好维护的代码?

“u003Cpu003E写出整洁的代码,是每个程序员的追求。《clean code》指出,要想写出好的代码,首先得知道什么是肮脏代码、什么是整洁代码;然后通过大量的刻意练习,才能真正写出整洁的代码。u003Cu002Fpu003Eu003Cpu003EWTFu002Fmin是衡量代码质量的唯一标准,Uncle Bob在书中称糟糕的代码为沼泽(wading),这只突出了我们是糟糕代码的受害者。国内有一个更适合的词汇:屎山,虽然不是很文雅但是更加客观,程序员既是受害者也是加害者。u003Cu002Fpu003Eu003Cpu003E对于什么是整洁的代码,书中给出了大师们的总结:u003Cu002Fpu003Eu003Culu003Eu003Cliu003Eu003Cpu003EBjarne Stroustrup:优雅且高效;直截了当;减少依赖;只做好一件事u003Cu002Fpu003Eu003Cu002Fliu003Eu003Cliu003Eu003Cpu003EGrady booch:简单直接u003Cu002Fpu003Eu003Cu002Fliu003Eu003Cliu003Eu003Cpu003EDave thomas:可读,可维护,单元测试u003Cu002Fpu003Eu003Cu002Fliu003Eu003Cliu003Eu003Cpu003ERon Jeffries:不要重复、单一职责,表达力(Expressiveness)u003Cu002Fpu003Eu003Cu002Fliu003Eu003Cu002Fulu003Eu003Cpu003E其中,我最喜欢的是表达力(Expressiveness)这个描述,这个词似乎道出了好代码的真谛:用简单直接的方式描绘出代码的功能,不多也不少。u003Cu002Fpu003Eu003Cpu003Eu003Cu002Fpu003Eu003Ch1 toutiao-origin=”h2″u003E命名的艺术u003Cu002Fh1u003Eu003Cpu003E坦白的说,命名是一件困难的事情,要想出一个恰到好处的命名需要一番功夫,尤其我们的母语还不是编程语言所通用的英语。不过这一切都是值得了,好的命名让你的代码更直观,更有表达力。u003Cu002Fpu003Eu003Cpu003E好的命名应该有下面的特征:u003Cu002Fpu003Eu003Cpu003Eu003Cstrongu003E名副其实u003Cu002Fstrongu003Eu003Cu002Fpu003Eu003Cpu003E好的变量名告诉你:是什么东西,为什么存在,该怎么使用u003Cu002Fpu003Eu003Cpu003E如果需要通过注释来解释变量,那么就先得不那么名副其实了。u003Cu002Fpu003Eu003Cpu003Eu003Cstrongu003E避免误导u003Cu002Fstrongu003Eu003Cu002Fpu003Eu003Culu003Eu003Cliu003Eu003Cpu003E不要挂羊头卖狗肉u003Cu002Fpu003Eu003Cu002Fliu003Eu003Cliu003Eu003Cpu003E不要覆盖惯用缩略语u003Cu002Fpu003Eu003Cu002Fliu003Eu003Cu002Fulu003Eu003Cpu003E这里不得不吐槽前两天才看到的一份代码,居然使用了 l 作为变量名;而且,user居然是一个list(单复数都没学好!!)u003Cu002Fpu003Eu003Cpu003Eu003Cstrongu003E有意义的区分u003Cu002Fstrongu003Eu003Cu002Fpu003Eu003Cpu003E代码是写给机器执行,也是给人阅读的,所以概念一定要有区分度。u003Cu002Fpu003Eu003Cpu003Eu003Cstrongu003E使用读的出来的单词u003Cu002Fstrongu003Eu003Cu002Fpu003Eu003Cblockquoteu003Eu003Cpu003E如果名称读不出来,那么讨论的时候就会像个傻鸟u003Cu002Fpu003Eu003Cu002Fblockquoteu003Eu003Cpu003Eu003Cstrongu003E使用方便u003Ci class=”chrome-extension-mutihighlight chrome-extension-mutihighlight-style-4″u003E搜索u003Cu002Fiu003E的命名u003Cu002Fstrongu003Eu003Cu002Fpu003Eu003Cblockquoteu003Eu003Cpu003E名字长短应与其作用域大小相对应u003Cu002Fpu003Eu003Cu002Fblockquoteu003Eu003Cpu003Eu003Cstrongu003E避免思维映射u003Cu002Fstrongu003Eu003Cu002Fpu003Eu003Cpu003E比如在代码中写一个temp,那么读者就得每次看到这个单词的时候翻译成其真正的意义u003Cu002Fpu003Eu003Cpu003Eu003Cu002Fpu003Eu003Ch1 toutiao-origin=”h2″u003E注释u003Cu002Fh1u003Eu003Cpu003E有表达力的代码是无需注释的。u003Cu002Fpu003Eu003Cblockquoteu003Eu003Cpu003EThe proper use of comments is to compensate for our failure to express ourself in code.u003Cu002Fpu003Eu003Cu002Fblockquoteu003Eu003Cpu003E注释的适当作用在于弥补我们用代码表达意图时遇到的失败,这听起来让人沮丧,但事实确实如此。The truth is in the code, 注释只是二手信息,二者的不同步或者不等价是注释的最大问题。u003Cu002Fpu003Eu003Cpu003E书中给出了一个非常形象的例子来展示:用代码来阐述,而非注释u003Cu002Fpu003Eu003Cpreu003Eu003Cdivu003Eu003Cpu003Ebadu003Cu002Fpu003Eu003Cpu003Eu002Fu002F check to see if the employee is eligible for full benefitu003Cu002Fpu003Eu003Cpu003Eif ((employee.flags & HOURLY_FLAG) && (employee.age > 65))u003Cu002Fpu003Eu003Cpu003Egoodu003Cu002Fpu003Eu003Cpu003Eif (employee.isEligibleForFullBenefits)u003Cu002Fpu003Eu003Cu002Fdivu003Eu003Cu002Fpreu003Eu003Cpu003E因此,当想要添加注释的时候,可以想想是否可以通过修改命名,或者修改函数(代码)的抽象层级来展示代码的意图。u003Cu002Fpu003Eu003Cpu003E当然,也不能因噎废食,书中指出了以下一些情况属于好的注释u003Cu002Fpu003Eu003Colu003Eu003Cliu003Eu003Cpu003E法务信息u003Cu002Fpu003Eu003Cu002Fliu003Eu003Cliu003Eu003Cpu003E对意图的注释,为什么要这么做u003Cu002Fpu003Eu003Cu002Fliu003Eu003Cliu003Eu003Cpu003E警示u003Cu002Fpu003Eu003Cu002Fliu003Eu003Cliu003Eu003Cpu003ETODO注释u003Cu002Fpu003Eu003Cu002Fliu003Eu003Cliu003Eu003Cpu003E放大看似不合理之物的重要性u003Cu002Fpu003Eu003Cu002Fliu003Eu003Cu002Folu003Eu003Cpu003E其中个人最赞同的是第2点和第5点,做什么很容易通过命名表达,但为什么要这么做则并不直观,特别涉及到专业知识、算法的时候。u003Cu002Fpu003Eu003Cpu003E另外,有些第一感觉“不那么优雅”的代码,也许有其特殊愿意,那么这样的代码就应该u003Ci class=”chrome-extension-mutihighlight chrome-extension-mutihighlight-style-5″u003E加上u003Cu002Fiu003E注释,说明为什么要这样,比如为了提升关键路径的性能,可能会牺牲部分代码的可读性。u003Cu002Fpu003Eu003Cpu003E最坏的注释就是过时或者错误的注释,这对于代码的维护者(也许就是几个月后的自己)是巨大的伤害,可惜除了code review,并没有简单易行的方法来保证代码与注释的同步。u003Cu002Fpu003Eu003Cpu003Eu003Cu002Fpu003Eu003Ch1 toutiao-origin=”h2″u003E函数u003Cu002Fh1u003Eu003Cpu003Eu003Cstrongu003E函数的单一职责u003Cu002Fstrongu003Eu003Cu002Fpu003Eu003Cpu003E一个函数应该只做一件事,这件事应该能通过函数名就能清晰的展示。判断方法很简单:看看函数是否还能再拆出一个函数。u003Cu002Fpu003Eu003Cpu003E函数要么做什么do_sth, 要么查询什么query_sth。最恶心的就是函数名表示只会query_sth, 但事实上却会do_sth, 这使得函数产生了副作用。比如书中的例子u003Cu002Fpu003Eu003Cpreu003Eu003Cdivu003Eu003Cpu003Epublic class UserValidator {u003Cu002Fpu003Eu003Cpu003Eprivate Cryptographer cryptographer;u003Cu002Fpu003Eu003Cpu003Epublic boolean checkPassword(String userName, String password) {u003Cu002Fpu003Eu003Cpu003EUser user = UserGateway.findByName(userName);u003Cu002Fpu003Eu003Cpu003Eif (user != User.) {u003Cu002Fpu003Eu003Cpu003EString codedPhrase = user.getPhraseEncodedByPassword;u003Cu002Fpu003Eu003Cpu003EString phrase = cryptographer.decrypt(codedPhrase, password);u003Cu002Fpu003Eu003Cpu003Eif (“Valid Password”.equals(phrase)) {u003Cu002Fpu003Eu003Cpu003ESession.initialize;u003Cu002Fpu003Eu003Cpu003Ereturn true;u003Cu002Fpu003Eu003Cpu003E}u003Cu002Fpu003Eu003Cpu003E}u003Cu002Fpu003Eu003Cpu003Ereturn false;u003Cu002Fpu003Eu003Cpu003E}u003Cu002Fpu003Eu003Cpu003E}u003Cu002Fpu003Eu003Cu002Fdivu003Eu003Cu002Fpreu003Eu003Cpu003Eu003Cstrongu003E函数的抽象层级u003Cu002Fstrongu003Eu003Cu002Fpu003Eu003Cpu003E每个函数一个抽象层次,函数中的语句都要在同一个抽象层级,不同的抽象层级不能放在一起。比如我们想把大象放进冰箱,应该是这个样子的:u003Cu002Fpu003Eu003Cpreu003Eu003Cdivu003Eu003Cpu003Edef pushElephantIntoRefrige:u003Cu002Fpu003Eu003Cpu003EopenRefrigeu003Cu002Fpu003Eu003Cpu003EpushElephantu003Cu002Fpu003Eu003Cpu003EcloseRefrigeu003Cu002Fpu003Eu003Cu002Fdivu003Eu003Cu002Fpreu003Eu003Cpu003E函数里面的三句代码在同一个层级(高度)描述了要完成把大象放进冰箱这件事顺序相关的三个步骤。显然,pushElephant这个步骤又可能包含很多子步骤,但是在pushElephantIntoRefrige这个层级,是无需知道太多细节的。u003Cu002Fpu003Eu003Cpu003E当我们想通过阅读代码的方式来了解一个新的项目时,一般都是采取广度优先的策略,自上而下的阅读代码,先了解整体结构,然后再深入感兴趣的细节。u003Cu002Fpu003Eu003Cpu003E如果没有对实现细节进行良好的抽象(并凝练出一个名副其实的函数),那么阅读者就容易迷失在细节的汪洋里。u003Cu002Fpu003Eu003Cpu003E某种程度看来,这个跟金字塔原理也很像u003Cu002Fpu003Eu003Cimg src=”http:u002Fu002Fp3.pstatp.comu002Flargeu002Fpgc-imageu002FRfhWOCXzVQm3r” img_width=”939″ img_height=”621″ alt=”如何写出让同事好维护的代码?” inline=”0″u003Eu003Cpu003E每一个层级都是为了论证其上一层级的观点,同时也需要下一层级的支持;同一层级之间的多个论点又需要以某种逻辑关系排序。pushElephantIntoRefrige就是中心论点,需要多个子步骤的支持,同时这些子步骤之间也有逻辑先后顺序。u003Cu002Fpu003Eu003Cpu003Eu003Cstrongu003E函数参数u003Cu002Fstrongu003Eu003Cu002Fpu003Eu003Cpu003E函数的参数越多,组合出的输入情况就愈多,需要的测试用例也就越多,也就越容易出问题。u003Cu002Fpu003Eu003Cpu003E输出参数相比返回值难以理解,这点深有同感,输出参数实在是很不直观。从函数调用者的角度,一眼就能看出返回值,而很难识别输出参数。输出参数通常逼迫调用者去检查函数签名,这个实在不友好。u003Cu002Fpu003Eu003Cpu003E向函数传入Boolean(书中称之为 Flag Argument)通常不是好主意。尤其是传入True or False后的行为并不是一件事情的两面,而是两件不同的事情时。这很明显违背了函数的单一职责约束,解决办法很简单,那就是用两个函数。u003Cu002Fpu003Eu003Cpu003EDont repear yourselfu003Cu002Fpu003Eu003Cpu003E在函数这个层级,是最容易、最直观实现复用的,很多IDE也难帮助我们讲一段代码重构出一个函数。u003Cu002Fpu003Eu003Cpu003E不过在实践中,也会出现这样一种情况:一段代码在多个方法中都有使用,但是又不完全一样,如果抽象成一个通用函数,那么就需要加参数、加if else区别。这样就有点尴尬,貌似可以重构,但又不是很完美。u003Cu002Fpu003Eu003Cpu003E造成上述问题的某种情况是因为,这段代码也违背了单一职责原则,做了不只一件事情,这才导致不好复用,解决办法是进行方法的细分,才能更好复用。也可以考虑template method来处理差异的部分。u003Cu002Fpu003Eu003Cpu003Eu003Cu002Fpu003Eu003Ch1 toutiao-origin=”h2″u003E测试u003Cu002Fh1u003Eu003Cpu003E非常惭愧的是,在我经历的项目中,测试(尤其是单元测试)一直都没有得到足够的重视,也没有试行过TDD。正因为缺失,才更感良好测试的珍贵。u003Cu002Fpu003Eu003Cpu003E我们常说,好的代码需要有可读性、可维护性、可扩展性,好的代码、架构需要不停的重构、迭代,但自动化测试是保证这一切的基础,没有高覆盖率的、自动化的单元测试、回归测试,谁都不敢去修改代码,只能任其腐烂。u003Cu002Fpu003Eu003Cpu003E即使针对核心模块写了单元测试,一般也很随意,认为这只是测试代码,配不上生产代码的地位,以为只要能跑通就行了。这就导致测试代码的可读性、可维护性非常差,然后导致测试代码很难跟随生产代码一起更新、演化,最后导致测试代码失效。所以说,脏测试 – 等同于 – 没测试。u003Cu002Fpu003Eu003Cpu003E因此,测试代码的三要素:可读性,可读性,可读性。u003Cu002Fpu003Eu003Cpu003E对于测试的原则、准则如下:u003Cu002Fpu003Eu003Culu003Eu003Cliu003Eu003Cpu003EYou are not allowed to write any production code unless it is to make a failing unit test pass. 没有测试之前不要写任何功能代码u003Cu002Fpu003Eu003Cu002Fliu003Eu003Cliu003Eu003Cpu003EYou are not allowed to write any more of a unit test than is sufficient to fail; and compilation failures are failures. 只编写恰好能够体现一个失败情况的测试代码u003Cu002Fpu003Eu003Cu002Fliu003Eu003Cliu003Eu003Cpu003EYou are not allowed to write any more production code than is sufficient to pass the one failing unit test. 只编写恰好能通过测试的功能代码u003Cu002Fpu003Eu003Cu002Fliu003Eu003Cu002Fulu003Eu003Cpu003E测试的FIRST准则:u003Cu002Fpu003Eu003Cpu003E1. 快速(Fast)测试应该够快,尽量自动化。u003Cu002Fpu003Eu003Cpu003E2. 独立(Independent) 测试应该应该独立。不要相互依赖u003Cu002Fpu003Eu003Cpu003E3. 可重复(Repeatable) 测试应该在任何环境上都能重复通过。u003Cu002Fpu003Eu003Cpu003E4. 自我验证(Self-Validating) 测试应该有bool输出。不要通过查看日志这种低效率方式来判断测试是否通过u003Cu002Fpu003Eu003Cpu003E5. 及时(Timely) 测试应该及时编写,在其对应的生产代码之前编写u003Cu002Fpu003Eu003Cp class=”pgc-end-source”u003E作者:xybabyu003Cu002Fpu003Eu003Cp class=”pgc-end-source”u003E编辑 :u003Ci class=”chrome-extension-mutihighlight chrome-extension-mutihighlight-style-1″u003Eid:u003Cu002Fiu003Ejavastacku003Cu002Fpu003Eu003Cblockquote toutiao-origin=”span”u003Ehttps:u002Fu002Fwwwu003Ci class=”chrome-extension-mutihighlight chrome-extension-mutihighlight-style-5″u003E.cnu003Cu002Fiu003Eblogsu003Ci class=”chrome-extension-mutihighlight chrome-extension-mutihighlight-style-4″u003E.comu003Cu002Fiu003Eu002Fxybabyu002Fpu002F11335829.htmlu003Cu002Fblockquoteu003E”

原文始发于:如何写出让同事好维护的代码?

主题测试文章,只做测试使用。发布者:℅傍ㄖ免沦陷dε鬼,转转请注明出处:http://www.cxybcw.com/17898.html

联系我们

13687733322

在线咨询:点击这里给我发消息

邮件:1877088071@qq.com

工作时间:周一至周五,9:30-18:30,节假日休息

QR code