把同事的代码重写得干净又整洁,老板却让我做回滚?

时间: 2020-02-06阅读: 142标签: 代码

夜深了。

我的同事把这周写的代码提交了。我们在开发一个图形编辑器画布,已经实现了形状调整功能,即通过拖拽形状边缘的手柄来调整形状(比如矩形和椭圆形)。

代码可以运行。

但重复代码有点多。每一种形状(比如矩形和椭圆形)有不同的手柄,往不同方向拖拽手柄对形状的位置和大小影响也不一样。如果用户同时按住 Shift 键,在改变大小的同时要保持比例不变。这里涉及了很多数学运算。

代码看起来像这样:

letRectangle = {
resizeTopLeft(position,size,preserveAspect,dx,dy){
// 10 行重复的数学运算代码
},
resizeTopRight(position,size,preserveAspect,dx,dy){
// 10 行重复的数学运算代码
},
resizeBottomLeft(position,size,preserveAspect,dx,dy){
// 10 行重复的数学运算代码
},
resizeBottomRight(position,size,preserveAspect,dx,dy){
// 10 行重复的数学运算代码
},
};

letOval = {
resizeLeft(position,size,preserveAspect,dx,dy){
// 10 行重复的数学运算代码
},
resizeRight(position,size,preserveAspect,dx,dy){
// 10 行重复的数学运算代码
},
resizeTop(position,size,preserveAspect,dx,dy){
// 10 行重复的数学运算代码
},
resizeBottom(position,size,preserveAspect,dx,dy){
// 10 行重复的数学运算代码
},
};

letHeader = {
resizeLeft(position,size,preserveAspect,dx,dy){
// 10 行重复的数学运算代码
},
resizeRight(position,size,preserveAspect,dx,dy){
// 10 行重复的数学运算代码
},
}

letTextBlock = {
resizeTopLeft(position,size,preserveAspect,dx,dy){
// 10 行重复的数学运算代码
},
resizeTopRight(position,size,preserveAspect,dx,dy){
// 10 行重复的数学运算代码
},
resizeBottomLeft(position,size,preserveAspect,dx,dy){
// 10 行重复的数学运算代码
},
resizeBottomRight(position,size,preserveAspect,dx,dy){
// 10 行重复的数学运算代码
},
};

这些重复代码看起来真的很碍眼。

这样的代码不够干净。

大部分重复是因为朝相同方向调整形状的代码都差不多,比如 Oval.resizeLeft() 和 Header.resizeLeft() 就很类似。

其他重复是因为同一种形状的方法之间很相像,比如 Oval.resizeLeft() 和 Oval 其他的方法就很类似。另外,Rectangle、Header 和 TextBlock 之间也有重复的地方,因为文本框也是矩形。

我想到了一个办法。

我们可以给代码分组,把重复代码移除掉,比如像下面这样。

letDirections = {
top(...) {
// 5 行不一样的数学运算代码
},
left(...) {
// 5 行不一样的数学运算代码
},
bottom(...) {
// 5 行不一样的数学运算代码
},
right(...) {
// 5 行不一样的数学运算代码
},
};

letShapes = {
Oval(...) {
// 5 行不一样的数学运算代码
},
Rectangle(...) {
// 5 行不一样的数学运算代码
},
}

然后,把它们的行为组合起来。

let{top, bottom, left, right} = Directions;

functioncreateHandle(directions){
// 20 行代码
}

letfourCorners =[
createHandle([top,left]),
createHandle([top,right]),
createHandle([bottom,left]),
createHandle([bottom,right]),
];
letfourSides =[
createHandle([top]),
createHandle([left]),
createHandle([right]),
createHandle([bottom]),
];
lettwoSides =[
createHandle([left]),
createHandle([right]),
];

functioncreateBox(shape,handles){
// 20 行代码
}

letRectangle = createBox(Shapes.Rectangle,fourCorners);
letOval = createBox(Shapes.Oval,fourSides);
letHeader = createBox(Shapes.Rectangle,twoSides);
letTextBox = createBox(Shapes.Rectangle,fourCorners);

代码量减少了一半,重复代码完全消失了!多么干净。如果要修改某个形状或方向的行为,只需要在一个地方做出改动,不需要修改所有的方法。

夜已深,我把改好的代码提交到 master 分支,然后上床睡觉。因为帮同事把杂乱的代码清理干净了,我心里还引以为豪。


第二天

事情并没有像我期待的那样发生。

老板找我谈话,他们希望我把代码回滚回去。我感到很惊讶,毕竟原先的代码简直就是一团乱麻,而我改得很干净啊!

我很不情愿地答应了,但几年之后,我才意识到他们其实是对的。


必经之路

痴迷于“干净代码”和删除重复代码是我们很多人都会经历的一个阶段。当我们对自己的代码不是很自信时,就很容易将自我价值感和职业自豪感与一些可以被衡量的东西联系在一起,比如严格的 lint 规则、命名模式、文件结构、不重复代码实践。

我们没办法自动去除重复代码,但可以自己动手做。每次修改代码之后,我们可以很容易地知道重复代码是少了还是多了。所以,去除重复代码感觉就像是在改进代码质量。更糟糕的是,它扰乱了人们的认同感,让他们觉得“我是那种编写干净代码的人”,但这其实无异于自我欺骗。

一旦学会了抽象,我们就很容易对这种能力产生很高的期望,每当看到有重复代码就会想要对它们进行抽象。在写了几年代码之后,我们发现重复代码到处都是,而抽象成了我们获得的一项超级能力。如果有人告诉我们说抽象是一种美德,那我们肯定会深信不疑,并且会因为别人不崇尚“干净代码”而对他们品头论足。

现在,我知道之前的代码重构就是一个灾难,原因如下。

  • 首先,我没有事先和写代码的人沟通。我直接修改了他们的代码并提交,没有和他们讨论。即使这是一种改进(但我现在不这么认为了),但我这样的行事方式并不值得称道。一个健康的工程团队应该以信任为基础,不经过讨论就修改他人的代码会对团队协作造成沉重的打击。

  • 其次,天下没有免费的午餐。我以牺牲灵活性为代价,以此来减少重复代码,这算不上是一个好的权衡。例如,后来我们要求不同形状的不同手柄具备一些特殊的行为,被我重构过的代码需要修改多次才能满足需求,而原先“杂乱”的代码却可以很容易实现这些需求。

那么,我的意思是我们应该尽量写“脏”代码吗?当然不是。我只是建议大家在考虑什么是“干净”或“脏”代码时进行深度思考。你当时有什么样的感觉?厌恶?正义?美丽?优雅?你可以肯定这些品质会带来实质性的工程成果吗?它们又是如何影响代码的编写和修改方式的?

我确实没有深入思考过这些事情。我只考虑到代码本身,但从来没有想过代码与团队之间的演化关系。

编码就像是一段旅程,想想你从写第一行代码到现在走了多远。当第一次通过提取函数或重构类让复杂的代码变简单,我觉得那是一种乐趣。如果你对自己的“杰作”感到自豪,那么就很容易掉入追求干净代码的旋涡。

但请不要止步于此,不要只做一个干净代码狂热者。写出干净的代码并不是我们的终极目标,我们只是通过这种方式尝试找到处理系统复杂性的方法。当你不确定代码改动会对代码库造成怎样的影响,在未知的海洋中需要灯塔的指引,那么这不失为一种防御机制。

写出干净的代码可以作为一种指引,但后面的路还是要自己走。

原文链接:Goodbye clean code!
链接:https://www.infoq.cn/article/dNO484YEeumvC6b6ZNWL
吐血推荐

1.站长广告联盟: 整理了目前主流的广告联盟平台,如果你有流量,可以作为参考选择适合你的平台点击进入...

2.休闲娱乐: 直播/交友    优惠券领取   网页游戏   H5游戏

链接: http://www.fly63.com/article/detial/7430

常用的JS代码片段

软件正在吞噬世界,JavaScript正在吞噬软件。JavaScript每年都在变得越来越占主导地位,而且没人知道最终会取代它的是什么。如果您没有充分的理由学习一种新语言(例如您的工作要求您维护非JavaScript代码库),那么我的建议是着重于提高JavaScript的水平。

如何阅读别人的代码?

比起阅读代码,我更喜欢看别人的文章或者书。我喜欢他们跟我面对面的交流,用简单的自然语言或者画图解释他们的思想。有了思想,我自然知道如何把它变成代码,而且是优雅的代码

源代码是什么意思

源代码(也称源程序),是指一系列人类可读的计算机语言指令。 在现代程序语言中,源代码可以是以书籍或者磁带的形式出现,但最为常用的格式是文本文件,这种典型格式的目的是为了编译出计算机程序。

掌握依赖注入5大原则,无需额外编代码!

如果是第一次接触这个概念,可能会一时没有头绪,网上的各种解释可能会让你更加混乱,并觉得它没那么简单。 其实依赖注入本身是单纯、简单的。简单来说,依赖注入是一种方式、方法或者说手段

如何在 React 中优雅的写 CSS?

如果是 ui 组件库中使用建议使用 namespaces 方案,ui 组件库维护人员基本固定,遵守约定的规范较为容易,可通过约定规范来解决不同组件 CSS 相互影响问题,由于 ui 组件库会应用于整个公司的产品

让代码具有可读性的10种最佳实践

如果咱们关注代码本身结构及可读笥,而不是只关心它是否能工作,那么咱们写代码是有一定的水准。专业开发人员将为未来的自己和“其他人”编写代码,而不仅仅只编写能应付当前工作的代码。

如何执行innerHtml中的script代码?

有时候我们会有把一整段 HTML 动态塞进页面的需求,例如渲染了一个模板,从服务器端获取了一段广告代码等。一般情况下我们使用 container.innerHTML 即可

编写可维护的Js代码

不省略分号(在原生及使用工具函数的情况不建议省略,在使用比较完善的框架如vue或者自己配置好 webpack 时可以省略),1行代码长度不超过80个字符(个人比较推荐,毕竟编辑器的自动换行有时真的很难受)

200行代码实现超轻量级编译器

本篇和大家一起学习写一款超级简单轻量,去掉注释只有不到200行代码的编译器。,该编译器将类 lisp 语法函数调用 编译为 类C语言函数调用

什么才是优秀的代码?

究竟什么是优秀的代码?Robert Martin的一句话可以完美诠释。代码质量的唯一衡量标准是每分钟说多少次WTF,我来解释一下这句话。当我在做code review时,通常会有三种不同的感受:

fly63.com版权所有,内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权,请与小编联系!情况属实本人将予以删除!

文章投稿关于web前端网站点搜索站长推荐网站地图站长QQ:522607023

小程序专栏: 土味情话心理测试脑筋急转弯幽默笑话段子句子语录成语大全